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