1 /* $NetBSD: sshkey.h,v 1.27 2026/09/21 21:31:00 christos Exp $ */ 2 /* $OpenBSD: sshkey.h,v 1.74 2026/06/14 03:59:34 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 33 #ifdef WITH_OPENSSL 34 #include <openssl/rsa.h> 35 #include <openssl/ec.h> 36 #include <openssl/ecdsa.h> 37 #include <openssl/evp.h> 38 #define SSH_OPENSSL_VERSION OpenSSL_version(OPENSSL_VERSION) 39 #else /* OPENSSL */ 40 #define BIGNUM void 41 #define RSA void 42 #define EC_KEY void 43 #define EC_GROUP void 44 #define EC_POINT void 45 #define EVP_PKEY void 46 #define SSH_OPENSSL_VERSION "without OpenSSL" 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_ECDSA, 58 KEY_ED25519, 59 KEY_RSA_CERT, 60 KEY_ECDSA_CERT, 61 KEY_ED25519_CERT, 62 KEY_ECDSA_SK, 63 KEY_ECDSA_SK_CERT, 64 KEY_ED25519_SK, 65 KEY_ED25519_SK_CERT, 66 KEY_MLDSA44_ED25519, 67 KEY_MLDSA44_ED25519_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 }; 87 88 /* Private key disk formats */ 89 enum sshkey_private_format { 90 SSHKEY_PRIVATE_OPENSSH = 0, 91 SSHKEY_PRIVATE_PEM = 1, 92 SSHKEY_PRIVATE_PKCS8 = 2, 93 }; 94 95 /* key is stored in external hardware */ 96 #define SSHKEY_FLAG_EXT 0x0001 97 98 #define SSHKEY_CERT_MAX_PRINCIPALS 256 99 /* XXX opacify? */ 100 struct sshkey_cert { 101 struct sshbuf *certblob; /* Kept around for use on wire */ 102 u_int type; /* SSH2_CERT_TYPE_USER or SSH2_CERT_TYPE_HOST */ 103 uint64_t serial; 104 char *key_id; 105 u_int nprincipals; 106 char **principals; 107 uint64_t valid_after, valid_before; 108 struct sshbuf *critical; 109 struct sshbuf *extensions; 110 struct sshkey *signature_key; 111 char *signature_type; 112 }; 113 114 /* XXX opacify? */ 115 struct sshkey { 116 int type; 117 int flags; 118 /* KEY_ECDSA and KEY_ECDSA_SK */ 119 int ecdsa_nid; /* NID of curve */ 120 /* libcrypto-backed keys */ 121 EVP_PKEY *pkey; 122 /* KEY_ED25519 and KEY_ED25519_SK */ 123 u_char *ed25519_sk; 124 u_char *ed25519_pk; 125 /* KEY_MLDSA44_ED25519 */ 126 u_char *mldsa_ed25519_sk; 127 u_char *mldsa_ed25519_pk; 128 /* KEY_ECDSA_SK and KEY_ED25519_SK */ 129 char *sk_application; 130 uint8_t sk_flags; 131 struct sshbuf *sk_key_handle; 132 struct sshbuf *sk_reserved; 133 /* Certificates */ 134 struct sshkey_cert *cert; 135 /* Private key shielding */ 136 u_char *shielded_private; 137 size_t shielded_len; 138 u_char *shield_prekey; 139 size_t shield_prekey_len; 140 }; 141 142 #define ED25519_SK_SZ crypto_sign_ed25519_SECRETKEYBYTES 143 #define ED25519_PK_SZ crypto_sign_ed25519_PUBLICKEYBYTES 144 145 /* Additional fields contained in signature */ 146 struct sshkey_sig_details { 147 uint32_t sk_counter; /* U2F signature counter */ 148 uint8_t sk_flags; /* U2F signature flags; see ssh-sk.h */ 149 }; 150 151 struct sshkey_impl_funcs { 152 u_int (*size)(const struct sshkey *); /* optional */ 153 int (*alloc)(struct sshkey *); /* optional */ 154 void (*cleanup)(struct sshkey *); /* optional */ 155 int (*equal)(const struct sshkey *, const struct sshkey *); 156 int (*serialize_public)(const struct sshkey *, struct sshbuf *, 157 enum sshkey_serialize_rep); 158 int (*deserialize_public)(const char *, struct sshbuf *, 159 struct sshkey *); 160 int (*serialize_private)(const struct sshkey *, struct sshbuf *, 161 enum sshkey_serialize_rep); 162 int (*deserialize_private)(const char *, struct sshbuf *, 163 struct sshkey *); 164 int (*generate)(struct sshkey *, int); /* optional */ 165 int (*copy_public)(const struct sshkey *, struct sshkey *); 166 int (*sign)(struct sshkey *, u_char **, size_t *, 167 const u_char *, size_t, const char *, 168 const char *, const char *, u_int); /* optional */ 169 int (*verify)(const struct sshkey *, const u_char *, size_t, 170 const u_char *, size_t, const char *, u_int, 171 struct sshkey_sig_details **); 172 }; 173 174 struct sshkey_impl { 175 const char *name; 176 const char *shortname; 177 const char *sigalg; 178 int type; 179 int nid; 180 int cert; 181 int sigonly; 182 int keybits; 183 const struct sshkey_impl_funcs *funcs; 184 }; 185 186 struct sshkey *sshkey_new(int); 187 void sshkey_free(struct sshkey *); 188 int sshkey_equal_public(const struct sshkey *, 189 const struct sshkey *); 190 int sshkey_equal(const struct sshkey *, const struct sshkey *); 191 char *sshkey_fingerprint(const struct sshkey *, 192 int, enum sshkey_fp_rep); 193 int sshkey_fingerprint_raw(const struct sshkey *k, 194 int, u_char **retp, size_t *lenp); 195 const char *sshkey_type(const struct sshkey *); 196 const char *sshkey_cert_type(const struct sshkey *); 197 int sshkey_format_text(const struct sshkey *, struct sshbuf *); 198 int sshkey_write(const struct sshkey *, FILE *); 199 int sshkey_read(struct sshkey *, char **); 200 u_int sshkey_size(const struct sshkey *); 201 202 int sshkey_generate(int type, u_int bits, struct sshkey **keyp); 203 int sshkey_from_private(const struct sshkey *, struct sshkey **); 204 205 int sshkey_is_shielded(struct sshkey *); 206 int sshkey_shield_private(struct sshkey *); 207 int sshkey_unshield_private(struct sshkey *); 208 209 int sshkey_type_from_name(const char *); 210 int sshkey_type_from_shortname(const char *); 211 int sshkey_is_cert(const struct sshkey *); 212 int sshkey_is_sk(const struct sshkey *); 213 int sshkey_type_is_cert(int); 214 int sshkey_type_plain(int); 215 216 /* Returns non-zero if key name match sigalgs pattern list. (handles RSA) */ 217 int sshkey_match_keyname_to_sigalgs(const char *, const char *); 218 219 int sshkey_to_certified(struct sshkey *); 220 int sshkey_drop_cert(struct sshkey *); 221 int sshkey_cert_copy(const struct sshkey *, struct sshkey *); 222 int sshkey_cert_check_authority(const struct sshkey *, int, int, 223 uint64_t, const char *, const char **); 224 int sshkey_cert_check_authority_now(const struct sshkey *, int, int, 225 const char *, const char **); 226 int sshkey_cert_check_host(const struct sshkey *, const char *, 227 const char *, const char **); 228 size_t sshkey_format_cert_validity(const struct sshkey_cert *, 229 char *, size_t) __attribute__((__bounded__(__string__, 2, 3))); 230 int sshkey_check_cert_sigtype(const struct sshkey *, const char *); 231 232 int sshkey_certify(struct sshkey *, struct sshkey *, 233 const char *, const char *, const char *); 234 /* Variant allowing use of a custom signature function (e.g. for ssh-agent) */ 235 typedef int sshkey_certify_signer(struct sshkey *, u_char **, size_t *, 236 const u_char *, size_t, const char *, const char *, const char *, 237 u_int, void *); 238 int sshkey_certify_custom(struct sshkey *, struct sshkey *, const char *, 239 const char *, const char *, sshkey_certify_signer *, void *); 240 241 int sshkey_ecdsa_nid_from_name(const char *); 242 int sshkey_curve_name_to_nid(const char *); 243 const char * sshkey_curve_nid_to_name(int); 244 u_int sshkey_curve_nid_to_bits(int); 245 int sshkey_ecdsa_bits_to_nid(int); 246 int sshkey_ecdsa_key_to_nid(const EC_KEY *); 247 int sshkey_ecdsa_pkey_to_nid(EVP_PKEY *); 248 int sshkey_ec_nid_to_hash_alg(int nid); 249 int sshkey_ec_validate_public(const EC_GROUP *, const EC_POINT *); 250 int sshkey_ec_validate_private(const EC_KEY *); 251 const char *sshkey_ssh_name(const struct sshkey *); 252 const char *sshkey_ssh_name_plain(const struct sshkey *); 253 int sshkey_names_valid2(const char *, int, int); 254 char *sshkey_alg_list(int, int, int, char); 255 256 int sshkey_from_blob(const u_char *, size_t, struct sshkey **); 257 int sshkey_fromb(struct sshbuf *, struct sshkey **); 258 int sshkey_froms(struct sshbuf *, struct sshkey **); 259 int sshkey_to_blob(const struct sshkey *, u_char **, size_t *); 260 int sshkey_to_base64(const struct sshkey *, char **); 261 int sshkey_putb(const struct sshkey *, struct sshbuf *); 262 int sshkey_puts(const struct sshkey *, struct sshbuf *); 263 int sshkey_plain_to_blob(const struct sshkey *, u_char **, size_t *); 264 int sshkey_putb_plain(const struct sshkey *, struct sshbuf *); 265 int sshkey_puts_plain(const struct sshkey *, struct sshbuf *); 266 267 int sshkey_sign(struct sshkey *, u_char **, size_t *, 268 const u_char *, size_t, const char *, const char *, const char *, u_int); 269 int sshkey_verify(const struct sshkey *, const u_char *, size_t, 270 const u_char *, size_t, const char *, u_int, struct sshkey_sig_details **); 271 int sshkey_check_sigtype(const u_char *, size_t, const char *); 272 const char *sshkey_sigalg_by_name(const char *); 273 int sshkey_get_sigtype(const u_char *, size_t, char **); 274 275 /* Signing and verification backend for libcrypto-backed keys */ 276 int sshkey_pkey_digest_sign(EVP_PKEY*, int, u_char **, 277 size_t *, const u_char *, size_t); 278 int sshkey_pkey_digest_verify(EVP_PKEY *, int, const u_char *, 279 size_t, u_char *, size_t); 280 281 /* for debug */ 282 void sshkey_dump_ec_point(const EC_GROUP *, const EC_POINT *); 283 void sshkey_dump_ec_key(const EC_KEY *); 284 285 /* private key parsing and serialisation */ 286 int sshkey_private_serialize(struct sshkey *key, struct sshbuf *buf); 287 int sshkey_private_deserialize(struct sshbuf *buf, struct sshkey **keyp); 288 289 /* private key file format parsing and serialisation */ 290 int sshkey_private_to_fileblob(struct sshkey *key, struct sshbuf *blob, 291 const char *passphrase, const char *comment, 292 int format, const char *openssh_format_cipher, int openssh_format_rounds); 293 int sshkey_parse_private_fileblob(struct sshbuf *buffer, 294 const char *passphrase, struct sshkey **keyp, char **commentp); 295 int sshkey_parse_private_fileblob_type(struct sshbuf *blob, int type, 296 const char *passphrase, struct sshkey **keyp, char **commentp); 297 int sshkey_parse_pubkey_from_private_fileblob_type(struct sshbuf *blob, 298 int type, struct sshkey **pubkeyp); 299 300 int sshkey_check_rsa_length(const struct sshkey *, int); 301 /* XXX should be internal, but used by ssh-keygen */ 302 int ssh_rsa_complete_crt_parameters(const BIGNUM *, const BIGNUM *, 303 const BIGNUM *, const BIGNUM *, BIGNUM **, BIGNUM **); 304 305 void sshkey_sig_details_free(struct sshkey_sig_details *); 306 307 #ifdef WITH_OPENSSL 308 int sshkey_ecdsa_fixup_group(EVP_PKEY *k); /* ssh-ecdsa.c */ 309 #endif 310 311 #ifdef SSHKEY_INTERNAL 312 int sshkey_sk_fields_equal(const struct sshkey *a, const struct sshkey *b); 313 void sshkey_sk_cleanup(struct sshkey *k); 314 int sshkey_serialize_sk(const struct sshkey *key, struct sshbuf *b); 315 int sshkey_copy_public_sk(const struct sshkey *from, struct sshkey *to); 316 int sshkey_deserialize_sk(struct sshbuf *b, struct sshkey *key); 317 int sshkey_serialize_private_sk(const struct sshkey *key, 318 struct sshbuf *buf); 319 int sshkey_private_deserialize_sk(struct sshbuf *buf, struct sshkey *k); 320 #ifdef WITH_OPENSSL 321 int check_rsa_length(const RSA *rsa); /* XXX remove */ 322 int ssh_rsa_hash_id_from_keyname(const char *); 323 const char *ssh_rsa_hash_alg_ident(int); 324 int ssh_rsa_encode_store_sig(int, const u_char *, size_t, 325 u_char **, size_t *); 326 int ssh_ecdsa_encode_store_sig(const struct sshkey *, 327 const BIGNUM *, const BIGNUM *, u_char **, size_t *); 328 #endif 329 int ssh_ed25519_encode_store_sig(const u_char *, size_t, 330 u_char **, size_t *); 331 #endif 332 333 #ifndef WITH_OPENSSL 334 #undef RSA 335 #undef EC_KEY 336 #undef EC_GROUP 337 #undef EC_POINT 338 #undef EVP_PKEY 339 #endif /* WITH_OPENSSL */ 340 341 #endif /* SSHKEY_H */ 342
Indexes created Wed Oct 07 00:25:59 UTC 2026