Annotation of src/usr.bin/ssh/sshkey.h, Revision 1.37
1.37 ! markus 1: /* $OpenBSD: sshkey.h,v 1.36 2019/10/31 21:23:19 djm Exp $ */
1.1 djm 2:
3: /*
4: * Copyright (c) 2000, 2001 Markus Friedl. All rights reserved.
5: *
6: * Redistribution and use in source and binary forms, with or without
7: * modification, are permitted provided that the following conditions
8: * are met:
9: * 1. Redistributions of source code must retain the above copyright
10: * notice, this list of conditions and the following disclaimer.
11: * 2. Redistributions in binary form must reproduce the above copyright
12: * notice, this list of conditions and the following disclaimer in the
13: * documentation and/or other materials provided with the distribution.
14: *
15: * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16: * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18: * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19: * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24: * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25: */
26: #ifndef SSHKEY_H
27: #define SSHKEY_H
28:
29: #include <sys/types.h>
30:
31: #ifdef WITH_OPENSSL
32: #include <openssl/rsa.h>
33: #include <openssl/dsa.h>
34: #include <openssl/ec.h>
1.31 djm 35: #include <openssl/ecdsa.h>
1.1 djm 36: #else /* OPENSSL */
1.29 djm 37: #define BIGNUM void
1.1 djm 38: #define RSA void
39: #define DSA void
40: #define EC_KEY void
41: #define EC_GROUP void
42: #define EC_POINT void
43: #endif /* WITH_OPENSSL */
44:
1.18 djm 45: #define SSH_RSA_MINIMUM_MODULUS_SIZE 1024
1.1 djm 46: #define SSH_KEY_MAX_SIGN_DATA_SIZE (1 << 20)
47:
48: struct sshbuf;
49:
50: /* Key types */
51: enum sshkey_types {
52: KEY_RSA,
53: KEY_DSA,
54: KEY_ECDSA,
55: KEY_ED25519,
56: KEY_RSA_CERT,
57: KEY_DSA_CERT,
58: KEY_ECDSA_CERT,
59: KEY_ED25519_CERT,
1.24 markus 60: KEY_XMSS,
61: KEY_XMSS_CERT,
1.35 djm 62: KEY_ECDSA_SK,
63: KEY_ECDSA_SK_CERT,
1.37 ! markus 64: KEY_ED25519_SK,
! 65: KEY_ED25519_SK_CERT,
1.1 djm 66: KEY_UNSPEC
67: };
68:
1.2 djm 69: /* Default fingerprint hash */
70: #define SSH_FP_HASH_DEFAULT SSH_DIGEST_SHA256
1.1 djm 71:
72: /* Fingerprint representation formats */
73: enum sshkey_fp_rep {
1.2 djm 74: SSH_FP_DEFAULT = 0,
1.1 djm 75: SSH_FP_HEX,
1.2 djm 76: SSH_FP_BASE64,
1.1 djm 77: SSH_FP_BUBBLEBABBLE,
78: SSH_FP_RANDOMART
79: };
80:
1.24 markus 81: /* Private key serialisation formats, used on the wire */
82: enum sshkey_serialize_rep {
83: SSHKEY_SERIALIZE_DEFAULT = 0,
84: SSHKEY_SERIALIZE_STATE = 1,
85: SSHKEY_SERIALIZE_FULL = 2,
86: SSHKEY_SERIALIZE_INFO = 254,
87: };
88:
1.33 djm 89: /* Private key disk formats */
90: enum sshkey_private_format {
91: SSHKEY_PRIVATE_OPENSSH = 0,
92: SSHKEY_PRIVATE_PEM = 1,
93: SSHKEY_PRIVATE_PKCS8 = 2,
94: };
95:
1.1 djm 96: /* key is stored in external hardware */
97: #define SSHKEY_FLAG_EXT 0x0001
98:
99: #define SSHKEY_CERT_MAX_PRINCIPALS 256
100: /* XXX opaquify? */
101: struct sshkey_cert {
102: struct sshbuf *certblob; /* Kept around for use on wire */
103: u_int type; /* SSH2_CERT_TYPE_USER or SSH2_CERT_TYPE_HOST */
104: u_int64_t serial;
105: char *key_id;
106: u_int nprincipals;
107: char **principals;
108: u_int64_t valid_after, valid_before;
109: struct sshbuf *critical;
110: struct sshbuf *extensions;
111: struct sshkey *signature_key;
1.27 djm 112: char *signature_type;
1.1 djm 113: };
114:
115: /* XXX opaquify? */
116: struct sshkey {
117: int type;
118: int flags;
1.35 djm 119: /* KEY_RSA */
1.1 djm 120: RSA *rsa;
1.35 djm 121: /* KEY_DSA */
1.1 djm 122: DSA *dsa;
1.35 djm 123: /* KEY_ECDSA and KEY_ECDSA_SK */
1.1 djm 124: int ecdsa_nid; /* NID of curve */
125: EC_KEY *ecdsa;
1.35 djm 126: /* KEY_ED25519 */
1.1 djm 127: u_char *ed25519_sk;
128: u_char *ed25519_pk;
1.35 djm 129: /* KEY_XMSS */
1.24 markus 130: char *xmss_name;
131: char *xmss_filename; /* for state file updates */
132: void *xmss_state; /* depends on xmss_name, opaque */
133: u_char *xmss_sk;
134: u_char *xmss_pk;
1.35 djm 135: /* KEY_ECDSA_SK */
136: char *sk_application;
137: uint8_t sk_flags;
138: struct sshbuf *sk_key_handle;
139: struct sshbuf *sk_reserved;
140: /* Certificates */
1.1 djm 141: struct sshkey_cert *cert;
1.35 djm 142: /* Private key shielding */
1.32 djm 143: u_char *shielded_private;
144: size_t shielded_len;
145: u_char *shield_prekey;
146: size_t shield_prekey_len;
1.1 djm 147: };
148:
149: #define ED25519_SK_SZ crypto_sign_ed25519_SECRETKEYBYTES
150: #define ED25519_PK_SZ crypto_sign_ed25519_PUBLICKEYBYTES
151:
152: struct sshkey *sshkey_new(int);
153: void sshkey_free(struct sshkey *);
154: int sshkey_equal_public(const struct sshkey *,
155: const struct sshkey *);
156: int sshkey_equal(const struct sshkey *, const struct sshkey *);
157: char *sshkey_fingerprint(const struct sshkey *,
1.2 djm 158: int, enum sshkey_fp_rep);
1.1 djm 159: int sshkey_fingerprint_raw(const struct sshkey *k,
1.2 djm 160: int, u_char **retp, size_t *lenp);
1.1 djm 161: const char *sshkey_type(const struct sshkey *);
162: const char *sshkey_cert_type(const struct sshkey *);
1.19 djm 163: int sshkey_format_text(const struct sshkey *, struct sshbuf *);
1.1 djm 164: int sshkey_write(const struct sshkey *, FILE *);
165: int sshkey_read(struct sshkey *, char **);
166: u_int sshkey_size(const struct sshkey *);
167:
168: int sshkey_generate(int type, u_int bits, struct sshkey **keyp);
169: int sshkey_from_private(const struct sshkey *, struct sshkey **);
1.32 djm 170:
171: int sshkey_is_shielded(struct sshkey *);
172: int sshkey_shield_private(struct sshkey *);
173: int sshkey_unshield_private(struct sshkey *);
174:
1.1 djm 175: int sshkey_type_from_name(const char *);
176: int sshkey_is_cert(const struct sshkey *);
177: int sshkey_type_is_cert(int);
178: int sshkey_type_plain(int);
1.7 djm 179: int sshkey_to_certified(struct sshkey *);
1.1 djm 180: int sshkey_drop_cert(struct sshkey *);
181: int sshkey_cert_copy(const struct sshkey *, struct sshkey *);
182: int sshkey_cert_check_authority(const struct sshkey *, int, int,
183: const char *, const char **);
1.11 djm 184: size_t sshkey_format_cert_validity(const struct sshkey_cert *,
185: char *, size_t) __attribute__((__bounded__(__string__, 2, 3)));
1.28 djm 186: int sshkey_check_cert_sigtype(const struct sshkey *, const char *);
1.20 djm 187:
1.36 djm 188: int sshkey_certify(struct sshkey *, struct sshkey *,
189: const char *, const char *);
1.20 djm 190: /* Variant allowing use of a custom signature function (e.g. for ssh-agent) */
1.32 djm 191: typedef int sshkey_certify_signer(struct sshkey *, u_char **, size_t *,
1.36 djm 192: const u_char *, size_t, const char *, const char *, u_int, void *);
1.20 djm 193: int sshkey_certify_custom(struct sshkey *, struct sshkey *, const char *,
1.36 djm 194: const char *, sshkey_certify_signer *, void *);
1.1 djm 195:
196: int sshkey_ecdsa_nid_from_name(const char *);
197: int sshkey_curve_name_to_nid(const char *);
198: const char * sshkey_curve_nid_to_name(int);
199: u_int sshkey_curve_nid_to_bits(int);
200: int sshkey_ecdsa_bits_to_nid(int);
201: int sshkey_ecdsa_key_to_nid(EC_KEY *);
202: int sshkey_ec_nid_to_hash_alg(int nid);
203: int sshkey_ec_validate_public(const EC_GROUP *, const EC_POINT *);
204: int sshkey_ec_validate_private(const EC_KEY *);
205: const char *sshkey_ssh_name(const struct sshkey *);
206: const char *sshkey_ssh_name_plain(const struct sshkey *);
1.4 djm 207: int sshkey_names_valid2(const char *, int);
1.15 djm 208: char *sshkey_alg_list(int, int, int, char);
1.1 djm 209:
210: int sshkey_from_blob(const u_char *, size_t, struct sshkey **);
1.5 djm 211: int sshkey_fromb(struct sshbuf *, struct sshkey **);
212: int sshkey_froms(struct sshbuf *, struct sshkey **);
1.1 djm 213: int sshkey_to_blob(const struct sshkey *, u_char **, size_t *);
1.6 djm 214: int sshkey_to_base64(const struct sshkey *, char **);
1.5 djm 215: int sshkey_putb(const struct sshkey *, struct sshbuf *);
216: int sshkey_puts(const struct sshkey *, struct sshbuf *);
1.24 markus 217: int sshkey_puts_opts(const struct sshkey *, struct sshbuf *,
218: enum sshkey_serialize_rep);
1.1 djm 219: int sshkey_plain_to_blob(const struct sshkey *, u_char **, size_t *);
1.5 djm 220: int sshkey_putb_plain(const struct sshkey *, struct sshbuf *);
1.1 djm 221:
1.32 djm 222: int sshkey_sign(struct sshkey *, u_char **, size_t *,
1.36 djm 223: const u_char *, size_t, const char *, const char *, u_int);
1.1 djm 224: int sshkey_verify(const struct sshkey *, const u_char *, size_t,
1.23 djm 225: const u_char *, size_t, const char *, u_int);
1.25 djm 226: int sshkey_check_sigtype(const u_char *, size_t, const char *);
1.26 djm 227: const char *sshkey_sigalg_by_name(const char *);
1.34 djm 228: int sshkey_get_sigtype(const u_char *, size_t, char **);
1.1 djm 229:
230: /* for debug */
231: void sshkey_dump_ec_point(const EC_GROUP *, const EC_POINT *);
232: void sshkey_dump_ec_key(const EC_KEY *);
233:
234: /* private key parsing and serialisation */
1.32 djm 235: int sshkey_private_serialize(struct sshkey *key, struct sshbuf *buf);
236: int sshkey_private_serialize_opt(struct sshkey *key, struct sshbuf *buf,
1.24 markus 237: enum sshkey_serialize_rep);
1.1 djm 238: int sshkey_private_deserialize(struct sshbuf *buf, struct sshkey **keyp);
239:
240: /* private key file format parsing and serialisation */
241: int sshkey_private_to_fileblob(struct sshkey *key, struct sshbuf *blob,
242: const char *passphrase, const char *comment,
1.33 djm 243: int format, const char *openssh_format_cipher, int openssh_format_rounds);
1.1 djm 244: int sshkey_parse_private_fileblob(struct sshbuf *buffer,
1.10 tim 245: const char *passphrase, struct sshkey **keyp, char **commentp);
1.1 djm 246: int sshkey_parse_private_fileblob_type(struct sshbuf *blob, int type,
247: const char *passphrase, struct sshkey **keyp, char **commentp);
1.21 djm 248:
249: /* XXX should be internal, but used by ssh-keygen */
1.29 djm 250: int ssh_rsa_complete_crt_parameters(struct sshkey *, const BIGNUM *);
1.1 djm 251:
1.24 markus 252: /* stateful keys (e.g. XMSS) */
253: typedef void sshkey_printfn(const char *, ...) __attribute__((format(printf, 1, 2)));
254: int sshkey_set_filename(struct sshkey *, const char *);
255: int sshkey_enable_maxsign(struct sshkey *, u_int32_t);
256: u_int32_t sshkey_signatures_left(const struct sshkey *);
257: int sshkey_forward_state(const struct sshkey *, u_int32_t, sshkey_printfn *);
1.32 djm 258: int sshkey_private_serialize_maxsign(struct sshkey *key, struct sshbuf *buf,
1.24 markus 259: u_int32_t maxsign, sshkey_printfn *pr);
260:
1.1 djm 261: #ifdef SSHKEY_INTERNAL
1.12 markus 262: int ssh_rsa_sign(const struct sshkey *key,
263: u_char **sigp, size_t *lenp, const u_char *data, size_t datalen,
264: const char *ident);
1.1 djm 265: int ssh_rsa_verify(const struct sshkey *key,
1.23 djm 266: const u_char *sig, size_t siglen, const u_char *data, size_t datalen,
267: const char *alg);
1.1 djm 268: int ssh_dss_sign(const struct sshkey *key, u_char **sigp, size_t *lenp,
269: const u_char *data, size_t datalen, u_int compat);
270: int ssh_dss_verify(const struct sshkey *key,
271: const u_char *signature, size_t signaturelen,
272: const u_char *data, size_t datalen, u_int compat);
273: int ssh_ecdsa_sign(const struct sshkey *key, u_char **sigp, size_t *lenp,
274: const u_char *data, size_t datalen, u_int compat);
275: int ssh_ecdsa_verify(const struct sshkey *key,
1.35 djm 276: const u_char *signature, size_t signaturelen,
277: const u_char *data, size_t datalen, u_int compat);
278: int ssh_ecdsa_sk_verify(const struct sshkey *key,
1.1 djm 279: const u_char *signature, size_t signaturelen,
280: const u_char *data, size_t datalen, u_int compat);
281: int ssh_ed25519_sign(const struct sshkey *key, u_char **sigp, size_t *lenp,
282: const u_char *data, size_t datalen, u_int compat);
283: int ssh_ed25519_verify(const struct sshkey *key,
1.37 ! markus 284: const u_char *signature, size_t signaturelen,
! 285: const u_char *data, size_t datalen, u_int compat);
! 286: int ssh_ed25519_sk_verify(const struct sshkey *key,
1.24 markus 287: const u_char *signature, size_t signaturelen,
288: const u_char *data, size_t datalen, u_int compat);
289: int ssh_xmss_sign(const struct sshkey *key, u_char **sigp, size_t *lenp,
290: const u_char *data, size_t datalen, u_int compat);
291: int ssh_xmss_verify(const struct sshkey *key,
1.1 djm 292: const u_char *signature, size_t signaturelen,
293: const u_char *data, size_t datalen, u_int compat);
294: #endif
295:
296: #ifndef WITH_OPENSSL
297: #undef RSA
298: #undef DSA
299: #undef EC_KEY
300: #undef EC_GROUP
301: #undef EC_POINT
302: #endif /* WITH_OPENSSL */
303:
304: #endif /* SSHKEY_H */
![[BACK]](/icons/back.gif){kind=icon}
Return to sshkey.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh