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