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