1 /* $OpenBSD: sshkey.h,v 1.21 2017/07/01 13:50:45 djm Exp $ */
4 * Copyright (c) 2000, 2001 Markus Friedl. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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.
29 #include <sys/types.h>
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 */
38 # define EC_GROUP void
39 # define EC_POINT void
40 # endif /* OPENSSL_HAS_ECC */
41 #else /* WITH_OPENSSL */
45 # define EC_GROUP void
46 # define EC_POINT void
47 #endif /* WITH_OPENSSL */
49 #define SSH_RSA_MINIMUM_MODULUS_SIZE 1024
50 #define SSH_KEY_MAX_SIGN_DATA_SIZE (1 << 20)
67 /* Default fingerprint hash */
68 #define SSH_FP_HASH_DEFAULT SSH_DIGEST_SHA256
70 /* Fingerprint representation formats */
79 /* key is stored in external hardware */
80 #define SSHKEY_FLAG_EXT 0x0001
82 #define SSHKEY_CERT_MAX_PRINCIPALS 256
85 struct sshbuf
*certblob
; /* Kept around for use on wire */
86 u_int type
; /* SSH2_CERT_TYPE_USER or SSH2_CERT_TYPE_HOST */
91 u_int64_t valid_after
, valid_before
;
92 struct sshbuf
*critical
;
93 struct sshbuf
*extensions
;
94 struct sshkey
*signature_key
;
103 int ecdsa_nid
; /* NID of curve */
107 struct sshkey_cert
*cert
;
110 #define ED25519_SK_SZ crypto_sign_ed25519_SECRETKEYBYTES
111 #define ED25519_PK_SZ crypto_sign_ed25519_PUBLICKEYBYTES
113 struct sshkey
*sshkey_new(int);
114 int sshkey_add_private(struct sshkey
*);
115 struct sshkey
*sshkey_new_private(int);
116 void sshkey_free(struct sshkey
*);
117 int sshkey_demote(const struct sshkey
*, struct sshkey
**);
118 int sshkey_equal_public(const struct sshkey
*,
119 const struct sshkey
*);
120 int sshkey_equal(const struct sshkey
*, const struct sshkey
*);
121 char *sshkey_fingerprint(const struct sshkey
*,
122 int, enum sshkey_fp_rep
);
123 int sshkey_fingerprint_raw(const struct sshkey
*k
,
124 int, u_char
**retp
, size_t *lenp
);
125 const char *sshkey_type(const struct sshkey
*);
126 const char *sshkey_cert_type(const struct sshkey
*);
127 int sshkey_format_text(const struct sshkey
*, struct sshbuf
*);
128 int sshkey_write(const struct sshkey
*, FILE *);
129 int sshkey_read(struct sshkey
*, char **);
130 u_int
sshkey_size(const struct sshkey
*);
132 int sshkey_generate(int type
, u_int bits
, struct sshkey
**keyp
);
133 int sshkey_from_private(const struct sshkey
*, struct sshkey
**);
134 int sshkey_type_from_name(const char *);
135 int sshkey_is_cert(const struct sshkey
*);
136 int sshkey_type_is_cert(int);
137 int sshkey_type_plain(int);
138 int sshkey_to_certified(struct sshkey
*);
139 int sshkey_drop_cert(struct sshkey
*);
140 int sshkey_cert_copy(const struct sshkey
*, struct sshkey
*);
141 int sshkey_cert_check_authority(const struct sshkey
*, int, int,
142 const char *, const char **);
143 size_t sshkey_format_cert_validity(const struct sshkey_cert
*,
144 char *, size_t) __attribute__((__bounded__(__string__
, 2, 3)));
146 int sshkey_certify(struct sshkey
*, struct sshkey
*, const char *);
147 /* Variant allowing use of a custom signature function (e.g. for ssh-agent) */
148 typedef int sshkey_certify_signer(const struct sshkey
*, u_char
**, size_t *,
149 const u_char
*, size_t, const char *, u_int
, void *);
150 int sshkey_certify_custom(struct sshkey
*, struct sshkey
*, const char *,
151 sshkey_certify_signer
*, void *);
153 int sshkey_ecdsa_nid_from_name(const char *);
154 int sshkey_curve_name_to_nid(const char *);
155 const char * sshkey_curve_nid_to_name(int);
156 u_int
sshkey_curve_nid_to_bits(int);
157 int sshkey_ecdsa_bits_to_nid(int);
158 int sshkey_ecdsa_key_to_nid(EC_KEY
*);
159 int sshkey_ec_nid_to_hash_alg(int nid
);
160 int sshkey_ec_validate_public(const EC_GROUP
*, const EC_POINT
*);
161 int sshkey_ec_validate_private(const EC_KEY
*);
162 const char *sshkey_ssh_name(const struct sshkey
*);
163 const char *sshkey_ssh_name_plain(const struct sshkey
*);
164 int sshkey_names_valid2(const char *, int);
165 char *sshkey_alg_list(int, int, int, char);
167 int sshkey_from_blob(const u_char
*, size_t, struct sshkey
**);
168 int sshkey_fromb(struct sshbuf
*, struct sshkey
**);
169 int sshkey_froms(struct sshbuf
*, struct sshkey
**);
170 int sshkey_to_blob(const struct sshkey
*, u_char
**, size_t *);
171 int sshkey_to_base64(const struct sshkey
*, char **);
172 int sshkey_putb(const struct sshkey
*, struct sshbuf
*);
173 int sshkey_puts(const struct sshkey
*, struct sshbuf
*);
174 int sshkey_plain_to_blob(const struct sshkey
*, u_char
**, size_t *);
175 int sshkey_putb_plain(const struct sshkey
*, struct sshbuf
*);
177 int sshkey_sign(const struct sshkey
*, u_char
**, size_t *,
178 const u_char
*, size_t, const char *, u_int
);
179 int sshkey_verify(const struct sshkey
*, const u_char
*, size_t,
180 const u_char
*, size_t, u_int
);
183 void sshkey_dump_ec_point(const EC_GROUP
*, const EC_POINT
*);
184 void sshkey_dump_ec_key(const EC_KEY
*);
186 /* private key parsing and serialisation */
187 int sshkey_private_serialize(const struct sshkey
*key
, struct sshbuf
*buf
);
188 int sshkey_private_deserialize(struct sshbuf
*buf
, struct sshkey
**keyp
);
190 /* private key file format parsing and serialisation */
191 int sshkey_private_to_fileblob(struct sshkey
*key
, struct sshbuf
*blob
,
192 const char *passphrase
, const char *comment
,
193 int force_new_format
, const char *new_format_cipher
, int new_format_rounds
);
194 int sshkey_parse_private_fileblob(struct sshbuf
*buffer
,
195 const char *passphrase
, struct sshkey
**keyp
, char **commentp
);
196 int sshkey_parse_private_fileblob_type(struct sshbuf
*blob
, int type
,
197 const char *passphrase
, struct sshkey
**keyp
, char **commentp
);
199 /* XXX should be internal, but used by ssh-keygen */
200 int ssh_rsa_generate_additional_parameters(struct sshkey
*);
202 #ifdef SSHKEY_INTERNAL
203 int ssh_rsa_sign(const struct sshkey
*key
,
204 u_char
**sigp
, size_t *lenp
, const u_char
*data
, size_t datalen
,
206 int ssh_rsa_verify(const struct sshkey
*key
,
207 const u_char
*sig
, size_t siglen
, const u_char
*data
, size_t datalen
);
208 int ssh_dss_sign(const struct sshkey
*key
, u_char
**sigp
, size_t *lenp
,
209 const u_char
*data
, size_t datalen
, u_int compat
);
210 int ssh_dss_verify(const struct sshkey
*key
,
211 const u_char
*signature
, size_t signaturelen
,
212 const u_char
*data
, size_t datalen
, u_int compat
);
213 int ssh_ecdsa_sign(const struct sshkey
*key
, u_char
**sigp
, size_t *lenp
,
214 const u_char
*data
, size_t datalen
, u_int compat
);
215 int ssh_ecdsa_verify(const struct sshkey
*key
,
216 const u_char
*signature
, size_t signaturelen
,
217 const u_char
*data
, size_t datalen
, u_int compat
);
218 int ssh_ed25519_sign(const struct sshkey
*key
, u_char
**sigp
, size_t *lenp
,
219 const u_char
*data
, size_t datalen
, u_int compat
);
220 int ssh_ed25519_verify(const struct sshkey
*key
,
221 const u_char
*signature
, size_t signaturelen
,
222 const u_char
*data
, size_t datalen
, u_int compat
);
225 #if !defined(WITH_OPENSSL)
231 #elif !defined(OPENSSL_HAS_ECC)
237 #endif /* SSHKEY_H */