blob: ca6d3f2843fd16d81363899306e23802e218d955 [file] [log] [blame]
Damien Millerf3747bf2013-01-18 11:44:04 +11001/*
2 * Copyright (c) 2012 Damien Miller <djm@mindrot.org>
3 *
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
7 *
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 */
16
djm@openbsd.org6ec74572020-04-03 02:26:56 +000017/* $OpenBSD: krl.h,v 1.8 2020/04/03 02:26:56 djm Exp $ */
Damien Millerf3747bf2013-01-18 11:44:04 +110018
19#ifndef _KRL_H
20#define _KRL_H
21
22/* Functions to manage key revocation lists */
23
24#define KRL_MAGIC "SSHKRL\n\0"
25#define KRL_FORMAT_VERSION 1
26
27/* KRL section types */
28#define KRL_SECTION_CERTIFICATES 1
29#define KRL_SECTION_EXPLICIT_KEY 2
30#define KRL_SECTION_FINGERPRINT_SHA1 3
31#define KRL_SECTION_SIGNATURE 4
djm@openbsd.org9405c622018-09-12 01:21:34 +000032#define KRL_SECTION_FINGERPRINT_SHA256 5
Damien Millerf3747bf2013-01-18 11:44:04 +110033
34/* KRL_SECTION_CERTIFICATES subsection types */
35#define KRL_SECTION_CERT_SERIAL_LIST 0x20
36#define KRL_SECTION_CERT_SERIAL_RANGE 0x21
37#define KRL_SECTION_CERT_SERIAL_BITMAP 0x22
38#define KRL_SECTION_CERT_KEY_ID 0x23
39
djm@openbsd.org74de2542014-12-04 01:49:59 +000040struct sshkey;
41struct sshbuf;
Damien Millerf3747bf2013-01-18 11:44:04 +110042struct ssh_krl;
43
44struct ssh_krl *ssh_krl_init(void);
45void ssh_krl_free(struct ssh_krl *krl);
46void ssh_krl_set_version(struct ssh_krl *krl, u_int64_t version);
djm@openbsd.org74de2542014-12-04 01:49:59 +000047int ssh_krl_set_comment(struct ssh_krl *krl, const char *comment);
48int ssh_krl_revoke_cert_by_serial(struct ssh_krl *krl,
49 const struct sshkey *ca_key, u_int64_t serial);
50int ssh_krl_revoke_cert_by_serial_range(struct ssh_krl *krl,
51 const struct sshkey *ca_key, u_int64_t lo, u_int64_t hi);
52int ssh_krl_revoke_cert_by_key_id(struct ssh_krl *krl,
53 const struct sshkey *ca_key, const char *key_id);
54int ssh_krl_revoke_key_explicit(struct ssh_krl *krl, const struct sshkey *key);
djm@openbsd.org9405c622018-09-12 01:21:34 +000055int ssh_krl_revoke_key_sha1(struct ssh_krl *krl, const u_char *p, size_t len);
56int ssh_krl_revoke_key_sha256(struct ssh_krl *krl, const u_char *p, size_t len);
djm@openbsd.org74de2542014-12-04 01:49:59 +000057int ssh_krl_revoke_key(struct ssh_krl *krl, const struct sshkey *key);
58int ssh_krl_to_blob(struct ssh_krl *krl, struct sshbuf *buf,
djm@openbsd.org4f7a56d2019-06-21 04:21:04 +000059 struct sshkey **sign_keys, u_int nsign_keys);
djm@openbsd.org74de2542014-12-04 01:49:59 +000060int ssh_krl_from_blob(struct sshbuf *buf, struct ssh_krl **krlp,
djm@openbsd.orge7fd9522015-01-13 19:04:35 +000061 const struct sshkey **sign_ca_keys, size_t nsign_ca_keys);
djm@openbsd.org74de2542014-12-04 01:49:59 +000062int ssh_krl_check_key(struct ssh_krl *krl, const struct sshkey *key);
63int ssh_krl_file_contains_key(const char *path, const struct sshkey *key);
djm@openbsd.org6ec74572020-04-03 02:26:56 +000064int krl_dump(struct ssh_krl *krl, FILE *f);
Damien Millerf3747bf2013-01-18 11:44:04 +110065
66#endif /* _KRL_H */
67