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