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