sshkey.h revision 1.24
1 /* $NetBSD: sshkey.h,v 1.24 2025/12/28 09:39:35 nia Exp $ */ 2 /* $OpenBSD: sshkey.h,v 1.70 2025/08/29 03:50:38 djm Exp $ */ 3 4 /* 5 * Copyright (c) 2000, 2001 Markus Friedl. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 */ 27 #ifndef SSHKEY_H 28 #define SSHKEY_H 29 30 #include "includes.h" 31 #include <sys/types.h> 32 #include <stdio.h> 33 34 #ifdef WITH_OPENSSL 35 #include <openssl/rsa.h> 36 #include <openssl/ec.h> 37 #include <openssl/ecdsa.h> 38 #include <openssl/evp.h> 39 #define SSH_OPENSSL_VERSION OpenSSL_version(OPENSSL_VERSION) 40 #else /* OPENSSL */ 41 #define BIGNUM void 42 #define RSA void 43 #define EC_KEY void 44 #define EC_GROUP void 45 #define EC_POINT void 46 #define EVP_PKEY void 47 #define SSH_OPENSSL_VERSION "without OpenSSL" 48 #endif /* WITH_OPENSSL */ 49 50 #define SSH_RSA_MINIMUM_MODULUS_SIZE 1024 51 #define SSH_KEY_MAX_SIGN_DATA_SIZE (1 << 20) 52 53 struct sshbuf; 54 55 /* Key types */ 56 enum sshkey_types { 57 KEY_RSA, 58 KEY_ECDSA, 59 KEY_ED25519, 60 KEY_RSA_CERT, 61 KEY_ECDSA_CERT, 62 KEY_ED25519_CERT, 63 KEY_ECDSA_SK, 64 KEY_ECDSA_SK_CERT, 65 KEY_ED25519_SK, 66 KEY_ED25519_SK_CERT, 67 KEY_UNSPEC 68 }; 69 70 /* Default fingerprint hash */ 71 #define SSH_FP_HASH_DEFAULT SSH_DIGEST_SHA256 72 73 /* Fingerprint representation formats */ 74 enum sshkey_fp_rep { 75 SSH_FP_DEFAULT = 0, 76 SSH_FP_HEX, 77 SSH_FP_BASE64, 78 SSH_FP_BUBBLEBABBLE, 79 SSH_FP_RANDOMART 80 }; 81 82 /* Private key serialisation formats, used on the wire */ 83 enum sshkey_serialize_rep { 84 SSHKEY_SERIALIZE_DEFAULT = 0, 85 }; 86 87 /* Private key disk formats */ 88 enum sshkey_private_format { 89 SSHKEY_PRIVATE_OPENSSH = 0, 90 SSHKEY_PRIVATE_PEM = 1, 91 SSHKEY_PRIVATE_PKCS8 = 2, 92 }; 93 94 /* key is stored in external hardware */ 95 #define SSHKEY_FLAG_EXT 0x0001 96 97 #define SSHKEY_CERT_MAX_PRINCIPALS 256 98 /* XXX opaquify? */ 99 struct sshkey_cert { 100 struct sshbuf *certblob; /* Kept around for use on wire */ 101 u_int type; /* SSH2_CERT_TYPE_USER or SSH2_CERT_TYPE_HOST */ 102 u_int64_t serial; 103 char *key_id; 104 u_int nprincipals; 105 char **principals; 106 u_int64_t valid_after, valid_before; 107 struct sshbuf *critical; 108 struct sshbuf *extensions; 109 struct sshkey *signature_key; 110 char *signature_type; 111 }; 112 113 /* XXX opaquify? */ 114 struct sshkey { 115 int type; 116 int flags; 117 /* KEY_ECDSA and KEY_ECDSA_SK */ 118 int ecdsa_nid; /* NID of curve */ 119 /* libcrypto-backed keys */ 120 EVP_PKEY *pkey; 121 /* KEY_ED25519 and KEY_ED25519_SK */ 122 u_char *ed25519_sk; 123 u_char *ed25519_pk; 124 /* KEY_ECDSA_SK and KEY_ED25519_SK */ 125 char *sk_application; 126 uint8_t sk_flags; 127 struct sshbuf *sk_key_handle; 128 struct sshbuf *sk_reserved; 129 /* Certificates */ 130 struct sshkey_cert *cert; 131 /* Private key shielding */ 132 u_char *shielded_private; 133 size_t shielded_len; 134 u_char *shield_prekey; 135 size_t shield_prekey_len; 136 }; 137 138 #define ED25519_SK_SZ crypto_sign_ed25519_SECRETKEYBYTES 139 #define ED25519_PK_SZ crypto_sign_ed25519_PUBLICKEYBYTES 140 141 /* Additional fields contained in signature */ 142 struct sshkey_sig_details { 143 uint32_t sk_counter; /* U2F signature counter */ 144 uint8_t sk_flags; /* U2F signature flags; see ssh-sk.h */ 145 }; 146 147 struct sshkey_impl_funcs { 148 u_int (*size)(const struct sshkey *); /* optional */ 149 int (*alloc)(struct sshkey *); /* optional */ 150 void (*cleanup)(struct sshkey *); /* optional */ 151 int (*equal)(const struct sshkey *, const struct sshkey *); 152 int (*serialize_public)(const struct sshkey *, struct sshbuf *, 153 enum sshkey_serialize_rep); 154 int (*deserialize_public)(const char *, struct sshbuf *, 155 struct sshkey *); 156 int (*serialize_private)(const struct sshkey *, struct sshbuf *, 157 enum sshkey_serialize_rep); 158 int (*deserialize_private)(const char *, struct sshbuf *, 159 struct sshkey *); 160 int (*generate)(struct sshkey *, int); /* optional */ 161 int (*copy_public)(const struct sshkey *, struct sshkey *); 162 int (*sign)(struct sshkey *, u_char **, size_t *, 163 const u_char *, size_t, const char *, 164 const char *, const char *, u_int); /* optional */ 165 int (*verify)(const struct sshkey *, const u_char *, size_t, 166 const u_char *, size_t, const char *, u_int, 167 struct sshkey_sig_details **); 168 }; 169 170 struct sshkey_impl { 171 const char *name; 172 const char *shortname; 173 const char *sigalg; 174 int type; 175 int nid; 176 int cert; 177 int sigonly; 178 int keybits; 179 const struct sshkey_impl_funcs *funcs; 180 }; 181 182 struct sshkey *sshkey_new(int); 183 void sshkey_free(struct sshkey *); 184 int sshkey_equal_public(const struct sshkey *, 185 const struct sshkey *); 186 int sshkey_equal(const struct sshkey *, const struct sshkey *); 187 char *sshkey_fingerprint(const struct sshkey *, 188 int, enum sshkey_fp_rep); 189 int sshkey_fingerprint_raw(const struct sshkey *k, 190 int, u_char **retp, size_t *lenp); 191 const char *sshkey_type(const struct sshkey *); 192 const char *sshkey_cert_type(const struct sshkey *); 193 int sshkey_format_text(const struct sshkey *, struct sshbuf *); 194 int sshkey_write(const struct sshkey *, FILE *); 195 int sshkey_read(struct sshkey *, char **); 196 u_int sshkey_size(const struct sshkey *); 197 198 int sshkey_generate(int type, u_int bits, struct sshkey **keyp); 199 int sshkey_from_private(const struct sshkey *, struct sshkey **); 200 201 int sshkey_is_shielded(struct sshkey *); 202 int sshkey_shield_private(struct sshkey *); 203 int sshkey_unshield_private(struct sshkey *); 204 205 int sshkey_type_from_name(const char *); 206 int sshkey_type_from_shortname(const char *); 207 int sshkey_is_cert(const struct sshkey *); 208 int sshkey_is_sk(const struct sshkey *); 209 int sshkey_type_is_cert(int); 210 int sshkey_type_plain(int); 211 212 /* Returns non-zero if key name match sigalgs pattern list. (handles RSA) */ 213 int sshkey_match_keyname_to_sigalgs(const char *, const char *); 214 215 int sshkey_to_certified(struct sshkey *); 216 int sshkey_drop_cert(struct sshkey *); 217 int sshkey_cert_copy(const struct sshkey *, struct sshkey *); 218 int sshkey_cert_check_authority(const struct sshkey *, int, int, int, 219 uint64_t, const char *, const char **); 220 int sshkey_cert_check_authority_now(const struct sshkey *, int, int, int, 221 const char *, const char **); 222 int sshkey_cert_check_host(const struct sshkey *, const char *, 223 int , const char *, const char **); 224 size_t sshkey_format_cert_validity(const struct sshkey_cert *, 225 char *, size_t) __attribute__((__bounded__(__string__, 2, 3))); 226 int sshkey_check_cert_sigtype(const struct sshkey *, const char *); 227 228 int sshkey_certify(struct sshkey *, struct sshkey *, 229 const char *, const char *, const char *); 230 /* Variant allowing use of a custom signature function (e.g. for ssh-agent) */ 231 typedef int sshkey_certify_signer(struct sshkey *, u_char **, size_t *, 232 const u_char *, size_t, const char *, const char *, const char *, 233 u_int, void *); 234 int sshkey_certify_custom(struct sshkey *, struct sshkey *, const char *, 235 const char *, const char *, sshkey_certify_signer *, void *); 236 237 int sshkey_ecdsa_nid_from_name(const char *); 238 int sshkey_curve_name_to_nid(const char *); 239 const char * sshkey_curve_nid_to_name(int); 240 u_int sshkey_curve_nid_to_bits(int); 241 int sshkey_ecdsa_bits_to_nid(int); 242 int sshkey_ecdsa_key_to_nid(const EC_KEY *); 243 int sshkey_ecdsa_pkey_to_nid(EVP_PKEY *); 244 int sshkey_ec_nid_to_hash_alg(int nid); 245 int sshkey_ec_validate_public(const EC_GROUP *, const EC_POINT *); 246 int sshkey_ec_validate_private(const EC_KEY *); 247 const char *sshkey_ssh_name(const struct sshkey *); 248 const char *sshkey_ssh_name_plain(const struct sshkey *); 249 int sshkey_names_valid2(const char *, int, int); 250 char *sshkey_alg_list(int, int, int, char); 251 252 int sshkey_from_blob(const u_char *, size_t, struct sshkey **); 253 int sshkey_fromb(struct sshbuf *, struct sshkey **); 254 int sshkey_froms(struct sshbuf *, struct sshkey **); 255 int sshkey_to_blob(const struct sshkey *, u_char **, size_t *); 256 int sshkey_to_base64(const struct sshkey *, char **); 257 int sshkey_putb(const struct sshkey *, struct sshbuf *); 258 int sshkey_puts(const struct sshkey *, struct sshbuf *); 259 int sshkey_plain_to_blob(const struct sshkey *, u_char **, size_t *); 260 int sshkey_putb_plain(const struct sshkey *, struct sshbuf *); 261 int sshkey_puts_plain(const struct sshkey *, struct sshbuf *); 262 263 int sshkey_sign(struct sshkey *, u_char **, size_t *, 264 const u_char *, size_t, const char *, const char *, const char *, u_int); 265 int sshkey_verify(const struct sshkey *, const u_char *, size_t, 266 const u_char *, size_t, const char *, u_int, struct sshkey_sig_details **); 267 int sshkey_check_sigtype(const u_char *, size_t, const char *); 268 const char *sshkey_sigalg_by_name(const char *); 269 int sshkey_get_sigtype(const u_char *, size_t, char **); 270 271 /* Signing and verification backend for libcrypto-backed keys */ 272 int sshkey_pkey_digest_sign(EVP_PKEY*, int, u_char **, 273 size_t *, const u_char *, size_t); 274 int sshkey_pkey_digest_verify(EVP_PKEY *, int, const u_char *, 275 size_t, u_char *, size_t); 276 277 /* for debug */ 278 void sshkey_dump_ec_point(const EC_GROUP *, const EC_POINT *); 279 void sshkey_dump_ec_key(const EC_KEY *); 280 281 /* private key parsing and serialisation */ 282 int sshkey_private_serialize(struct sshkey *key, struct sshbuf *buf); 283 int sshkey_private_deserialize(struct sshbuf *buf, struct sshkey **keyp); 284 285 /* private key file format parsing and serialisation */ 286 int sshkey_private_to_fileblob(struct sshkey *key, struct sshbuf *blob, 287 const char *passphrase, const char *comment, 288 int format, const char *openssh_format_cipher, int openssh_format_rounds); 289 int sshkey_parse_private_fileblob(struct sshbuf *buffer, 290 const char *passphrase, struct sshkey **keyp, char **commentp); 291 int sshkey_parse_private_fileblob_type(struct sshbuf *blob, int type, 292 const char *passphrase, struct sshkey **keyp, char **commentp); 293 int sshkey_parse_pubkey_from_private_fileblob_type(struct sshbuf *blob, 294 int type, struct sshkey **pubkeyp); 295 296 int sshkey_check_rsa_length(const struct sshkey *, int); 297 /* XXX should be internal, but used by ssh-keygen */ 298 int ssh_rsa_complete_crt_parameters(const BIGNUM *, const BIGNUM *, 299 const BIGNUM *, const BIGNUM *, BIGNUM **, BIGNUM **); 300 301 void sshkey_sig_details_free(struct sshkey_sig_details *); 302 303 #ifdef WITH_OPENSSL 304 int sshkey_ecdsa_fixup_group(EVP_PKEY *k); /* ssh-ecdsa.c */ 305 #endif 306 307 #ifdef SSHKEY_INTERNAL 308 int sshkey_sk_fields_equal(const struct sshkey *a, const struct sshkey *b); 309 void sshkey_sk_cleanup(struct sshkey *k); 310 int sshkey_serialize_sk(const struct sshkey *key, struct sshbuf *b); 311 int sshkey_copy_public_sk(const struct sshkey *from, struct sshkey *to); 312 int sshkey_deserialize_sk(struct sshbuf *b, struct sshkey *key); 313 int sshkey_serialize_private_sk(const struct sshkey *key, 314 struct sshbuf *buf); 315 int sshkey_private_deserialize_sk(struct sshbuf *buf, struct sshkey *k); 316 #ifdef WITH_OPENSSL 317 int check_rsa_length(const RSA *rsa); /* XXX remove */ 318 int ssh_rsa_hash_id_from_keyname(const char *); 319 const char *ssh_rsa_hash_alg_ident(int); 320 int ssh_rsa_encode_store_sig(int, const u_char *, size_t, 321 u_char **, size_t *); 322 int ssh_ecdsa_encode_store_sig(const struct sshkey *, 323 const BIGNUM *, const BIGNUM *, u_char **, size_t *); 324 #endif 325 int ssh_ed25519_encode_store_sig(const u_char *, size_t, 326 u_char **, size_t *); 327 #endif 328 329 #ifndef WITH_OPENSSL 330 #undef RSA 331 #undef EC_KEY 332 #undef EC_GROUP 333 #undef EC_POINT 334 #undef EVP_PKEY 335 #endif /* WITH_OPENSSL */ 336 337 #endif /* SSHKEY_H */ 338
Indexes created Mon Apr 06 00:22:49 UTC 2026