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