Annotation of src/usr.bin/ssh/sshkey.h, Revision 1.43
1.43 ! djm 1: /* $OpenBSD: sshkey.h,v 1.42 2019/12/13 19:11:14 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)
1.41 djm 47:
48: /* Version of protocol expected from ssh-sk-helper */
1.42 djm 49: #define SSH_SK_HELPER_VERSION 2
50:
51: /* ssh-sk-helper messages */
52: #define SSH_SK_HELPER_SIGN 1
53: #define SSH_SK_HELPER_ENROLL 2
1.43 ! djm 54: #define SSH_SK_HELPER_LOAD_RESIDENT 3
1.1 djm 55:
56: struct sshbuf;
57:
58: /* Key types */
59: enum sshkey_types {
60: KEY_RSA,
61: KEY_DSA,
62: KEY_ECDSA,
63: KEY_ED25519,
64: KEY_RSA_CERT,
65: KEY_DSA_CERT,
66: KEY_ECDSA_CERT,
67: KEY_ED25519_CERT,
1.24 markus 68: KEY_XMSS,
69: KEY_XMSS_CERT,
1.35 djm 70: KEY_ECDSA_SK,
71: KEY_ECDSA_SK_CERT,
1.37 markus 72: KEY_ED25519_SK,
73: KEY_ED25519_SK_CERT,
1.1 djm 74: KEY_UNSPEC
75: };
76:
1.2 djm 77: /* Default fingerprint hash */
78: #define SSH_FP_HASH_DEFAULT SSH_DIGEST_SHA256
1.1 djm 79:
80: /* Fingerprint representation formats */
81: enum sshkey_fp_rep {
1.2 djm 82: SSH_FP_DEFAULT = 0,
1.1 djm 83: SSH_FP_HEX,
1.2 djm 84: SSH_FP_BASE64,
1.1 djm 85: SSH_FP_BUBBLEBABBLE,
86: SSH_FP_RANDOMART
87: };
88:
1.24 markus 89: /* Private key serialisation formats, used on the wire */
90: enum sshkey_serialize_rep {
91: SSHKEY_SERIALIZE_DEFAULT = 0,
1.39 markus 92: SSHKEY_SERIALIZE_STATE = 1, /* only state is serialized */
93: SSHKEY_SERIALIZE_FULL = 2, /* include keys for saving to disk */
94: SSHKEY_SERIALIZE_SHIELD = 3, /* everything, for encrypting in ram */
95: SSHKEY_SERIALIZE_INFO = 254, /* minimal information */
1.24 markus 96: };
97:
1.33 djm 98: /* Private key disk formats */
99: enum sshkey_private_format {
100: SSHKEY_PRIVATE_OPENSSH = 0,
101: SSHKEY_PRIVATE_PEM = 1,
102: SSHKEY_PRIVATE_PKCS8 = 2,
103: };
104:
1.1 djm 105: /* key is stored in external hardware */
106: #define SSHKEY_FLAG_EXT 0x0001
107:
108: #define SSHKEY_CERT_MAX_PRINCIPALS 256
109: /* XXX opaquify? */
110: struct sshkey_cert {
111: struct sshbuf *certblob; /* Kept around for use on wire */
112: u_int type; /* SSH2_CERT_TYPE_USER or SSH2_CERT_TYPE_HOST */
113: u_int64_t serial;
114: char *key_id;
115: u_int nprincipals;
116: char **principals;
117: u_int64_t valid_after, valid_before;
118: struct sshbuf *critical;
119: struct sshbuf *extensions;
120: struct sshkey *signature_key;
1.27 djm 121: char *signature_type;
1.1 djm 122: };
123:
124: /* XXX opaquify? */
125: struct sshkey {
126: int type;
127: int flags;
1.35 djm 128: /* KEY_RSA */
1.1 djm 129: RSA *rsa;
1.35 djm 130: /* KEY_DSA */
1.1 djm 131: DSA *dsa;
1.35 djm 132: /* KEY_ECDSA and KEY_ECDSA_SK */
1.1 djm 133: int ecdsa_nid; /* NID of curve */
134: EC_KEY *ecdsa;
1.38 markus 135: /* KEY_ED25519 and KEY_ED25519_SK */
1.1 djm 136: u_char *ed25519_sk;
137: u_char *ed25519_pk;
1.35 djm 138: /* KEY_XMSS */
1.24 markus 139: char *xmss_name;
140: char *xmss_filename; /* for state file updates */
141: void *xmss_state; /* depends on xmss_name, opaque */
142: u_char *xmss_sk;
143: u_char *xmss_pk;
1.38 markus 144: /* KEY_ECDSA_SK and KEY_ED25519_SK */
1.35 djm 145: char *sk_application;
146: uint8_t sk_flags;
147: struct sshbuf *sk_key_handle;
148: struct sshbuf *sk_reserved;
149: /* Certificates */
1.1 djm 150: struct sshkey_cert *cert;
1.35 djm 151: /* Private key shielding */
1.32 djm 152: u_char *shielded_private;
153: size_t shielded_len;
154: u_char *shield_prekey;
155: size_t shield_prekey_len;
1.1 djm 156: };
157:
158: #define ED25519_SK_SZ crypto_sign_ed25519_SECRETKEYBYTES
159: #define ED25519_PK_SZ crypto_sign_ed25519_PUBLICKEYBYTES
160:
1.40 djm 161: /* Additional fields contained in signature */
162: struct sshkey_sig_details {
163: uint32_t sk_counter; /* U2F signature counter */
164: uint8_t sk_flags; /* U2F signature flags; see ssh-sk.h */
165: };
166:
1.1 djm 167: struct sshkey *sshkey_new(int);
168: void sshkey_free(struct sshkey *);
169: int sshkey_equal_public(const struct sshkey *,
170: const struct sshkey *);
171: int sshkey_equal(const struct sshkey *, const struct sshkey *);
172: char *sshkey_fingerprint(const struct sshkey *,
1.2 djm 173: int, enum sshkey_fp_rep);
1.1 djm 174: int sshkey_fingerprint_raw(const struct sshkey *k,
1.2 djm 175: int, u_char **retp, size_t *lenp);
1.1 djm 176: const char *sshkey_type(const struct sshkey *);
177: const char *sshkey_cert_type(const struct sshkey *);
1.19 djm 178: int sshkey_format_text(const struct sshkey *, struct sshbuf *);
1.1 djm 179: int sshkey_write(const struct sshkey *, FILE *);
180: int sshkey_read(struct sshkey *, char **);
181: u_int sshkey_size(const struct sshkey *);
182:
183: int sshkey_generate(int type, u_int bits, struct sshkey **keyp);
184: int sshkey_from_private(const struct sshkey *, struct sshkey **);
1.32 djm 185:
186: int sshkey_is_shielded(struct sshkey *);
187: int sshkey_shield_private(struct sshkey *);
188: int sshkey_unshield_private(struct sshkey *);
189:
1.1 djm 190: int sshkey_type_from_name(const char *);
191: int sshkey_is_cert(const struct sshkey *);
1.38 markus 192: int sshkey_is_sk(const struct sshkey *);
1.1 djm 193: int sshkey_type_is_cert(int);
194: int sshkey_type_plain(int);
1.7 djm 195: int sshkey_to_certified(struct sshkey *);
1.1 djm 196: int sshkey_drop_cert(struct sshkey *);
197: int sshkey_cert_copy(const struct sshkey *, struct sshkey *);
198: int sshkey_cert_check_authority(const struct sshkey *, int, int,
199: const char *, const char **);
1.11 djm 200: size_t sshkey_format_cert_validity(const struct sshkey_cert *,
201: char *, size_t) __attribute__((__bounded__(__string__, 2, 3)));
1.28 djm 202: int sshkey_check_cert_sigtype(const struct sshkey *, const char *);
1.20 djm 203:
1.36 djm 204: int sshkey_certify(struct sshkey *, struct sshkey *,
205: const char *, const char *);
1.20 djm 206: /* Variant allowing use of a custom signature function (e.g. for ssh-agent) */
1.32 djm 207: typedef int sshkey_certify_signer(struct sshkey *, u_char **, size_t *,
1.36 djm 208: const u_char *, size_t, const char *, const char *, u_int, void *);
1.20 djm 209: int sshkey_certify_custom(struct sshkey *, struct sshkey *, const char *,
1.36 djm 210: const char *, sshkey_certify_signer *, void *);
1.1 djm 211:
212: int sshkey_ecdsa_nid_from_name(const char *);
213: int sshkey_curve_name_to_nid(const char *);
214: const char * sshkey_curve_nid_to_name(int);
215: u_int sshkey_curve_nid_to_bits(int);
216: int sshkey_ecdsa_bits_to_nid(int);
217: int sshkey_ecdsa_key_to_nid(EC_KEY *);
218: int sshkey_ec_nid_to_hash_alg(int nid);
219: int sshkey_ec_validate_public(const EC_GROUP *, const EC_POINT *);
220: int sshkey_ec_validate_private(const EC_KEY *);
221: const char *sshkey_ssh_name(const struct sshkey *);
222: const char *sshkey_ssh_name_plain(const struct sshkey *);
1.4 djm 223: int sshkey_names_valid2(const char *, int);
1.15 djm 224: char *sshkey_alg_list(int, int, int, char);
1.1 djm 225:
226: int sshkey_from_blob(const u_char *, size_t, struct sshkey **);
1.5 djm 227: int sshkey_fromb(struct sshbuf *, struct sshkey **);
228: int sshkey_froms(struct sshbuf *, struct sshkey **);
1.1 djm 229: int sshkey_to_blob(const struct sshkey *, u_char **, size_t *);
1.6 djm 230: int sshkey_to_base64(const struct sshkey *, char **);
1.5 djm 231: int sshkey_putb(const struct sshkey *, struct sshbuf *);
232: int sshkey_puts(const struct sshkey *, struct sshbuf *);
1.24 markus 233: int sshkey_puts_opts(const struct sshkey *, struct sshbuf *,
234: enum sshkey_serialize_rep);
1.1 djm 235: int sshkey_plain_to_blob(const struct sshkey *, u_char **, size_t *);
1.5 djm 236: int sshkey_putb_plain(const struct sshkey *, struct sshbuf *);
1.1 djm 237:
1.32 djm 238: int sshkey_sign(struct sshkey *, u_char **, size_t *,
1.36 djm 239: const u_char *, size_t, const char *, const char *, u_int);
1.1 djm 240: int sshkey_verify(const struct sshkey *, const u_char *, size_t,
1.40 djm 241: const u_char *, size_t, const char *, u_int, struct sshkey_sig_details **);
1.25 djm 242: int sshkey_check_sigtype(const u_char *, size_t, const char *);
1.26 djm 243: const char *sshkey_sigalg_by_name(const char *);
1.34 djm 244: int sshkey_get_sigtype(const u_char *, size_t, char **);
1.1 djm 245:
246: /* for debug */
247: void sshkey_dump_ec_point(const EC_GROUP *, const EC_POINT *);
248: void sshkey_dump_ec_key(const EC_KEY *);
249:
250: /* private key parsing and serialisation */
1.32 djm 251: int sshkey_private_serialize(struct sshkey *key, struct sshbuf *buf);
252: int sshkey_private_serialize_opt(struct sshkey *key, struct sshbuf *buf,
1.24 markus 253: enum sshkey_serialize_rep);
1.1 djm 254: int sshkey_private_deserialize(struct sshbuf *buf, struct sshkey **keyp);
255:
256: /* private key file format parsing and serialisation */
257: int sshkey_private_to_fileblob(struct sshkey *key, struct sshbuf *blob,
258: const char *passphrase, const char *comment,
1.33 djm 259: int format, const char *openssh_format_cipher, int openssh_format_rounds);
1.1 djm 260: int sshkey_parse_private_fileblob(struct sshbuf *buffer,
1.10 tim 261: const char *passphrase, struct sshkey **keyp, char **commentp);
1.1 djm 262: int sshkey_parse_private_fileblob_type(struct sshbuf *blob, int type,
263: const char *passphrase, struct sshkey **keyp, char **commentp);
1.21 djm 264:
265: /* XXX should be internal, but used by ssh-keygen */
1.29 djm 266: int ssh_rsa_complete_crt_parameters(struct sshkey *, const BIGNUM *);
1.1 djm 267:
1.24 markus 268: /* stateful keys (e.g. XMSS) */
269: typedef void sshkey_printfn(const char *, ...) __attribute__((format(printf, 1, 2)));
270: int sshkey_set_filename(struct sshkey *, const char *);
271: int sshkey_enable_maxsign(struct sshkey *, u_int32_t);
272: u_int32_t sshkey_signatures_left(const struct sshkey *);
273: int sshkey_forward_state(const struct sshkey *, u_int32_t, sshkey_printfn *);
1.32 djm 274: int sshkey_private_serialize_maxsign(struct sshkey *key, struct sshbuf *buf,
1.24 markus 275: u_int32_t maxsign, sshkey_printfn *pr);
276:
1.40 djm 277: void sshkey_sig_details_free(struct sshkey_sig_details *);
278:
1.1 djm 279: #ifdef SSHKEY_INTERNAL
1.12 markus 280: int ssh_rsa_sign(const struct sshkey *key,
281: u_char **sigp, size_t *lenp, const u_char *data, size_t datalen,
282: const char *ident);
1.1 djm 283: int ssh_rsa_verify(const struct sshkey *key,
1.23 djm 284: const u_char *sig, size_t siglen, const u_char *data, size_t datalen,
285: const char *alg);
1.1 djm 286: int ssh_dss_sign(const struct sshkey *key, u_char **sigp, size_t *lenp,
287: const u_char *data, size_t datalen, u_int compat);
288: int ssh_dss_verify(const struct sshkey *key,
289: const u_char *signature, size_t signaturelen,
290: const u_char *data, size_t datalen, u_int compat);
291: int ssh_ecdsa_sign(const struct sshkey *key, u_char **sigp, size_t *lenp,
292: const u_char *data, size_t datalen, u_int compat);
293: int ssh_ecdsa_verify(const struct sshkey *key,
1.35 djm 294: const u_char *signature, size_t signaturelen,
295: const u_char *data, size_t datalen, u_int compat);
296: int ssh_ecdsa_sk_verify(const struct sshkey *key,
1.1 djm 297: const u_char *signature, size_t signaturelen,
1.40 djm 298: const u_char *data, size_t datalen, u_int compat,
299: struct sshkey_sig_details **detailsp);
1.1 djm 300: int ssh_ed25519_sign(const struct sshkey *key, u_char **sigp, size_t *lenp,
301: const u_char *data, size_t datalen, u_int compat);
302: int ssh_ed25519_verify(const struct sshkey *key,
1.37 markus 303: const u_char *signature, size_t signaturelen,
304: const u_char *data, size_t datalen, u_int compat);
305: int ssh_ed25519_sk_verify(const struct sshkey *key,
1.24 markus 306: const u_char *signature, size_t signaturelen,
1.40 djm 307: const u_char *data, size_t datalen, u_int compat,
308: struct sshkey_sig_details **detailsp);
1.24 markus 309: int ssh_xmss_sign(const struct sshkey *key, u_char **sigp, size_t *lenp,
310: const u_char *data, size_t datalen, u_int compat);
311: int ssh_xmss_verify(const struct sshkey *key,
1.1 djm 312: const u_char *signature, size_t signaturelen,
313: const u_char *data, size_t datalen, u_int compat);
314: #endif
315:
316: #ifndef WITH_OPENSSL
317: #undef RSA
318: #undef DSA
319: #undef EC_KEY
320: #undef EC_GROUP
321: #undef EC_POINT
322: #endif /* WITH_OPENSSL */
323:
324: #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