sshkey.h revision 1.10
1 /* $NetBSD: sshkey.h,v 1.10 2019/10/12 18:32:22 christos Exp $ */ 2 /* $OpenBSD: sshkey.h,v 1.34 2019/09/03 08:31:20 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/dsa.h> 36 #include <openssl/ec.h> 37 #include <openssl/ecdsa.h> 38 #else /* OPENSSL */ 39 #define BIGNUM void 40 #define RSA void 41 #define DSA void 42 #define EC_KEY void 43 #define EC_GROUP void 44 #define EC_POINT void 45 #endif /* WITH_OPENSSL */ 46 47 #define SSH_RSA_MINIMUM_MODULUS_SIZE 1024 48 #define SSH_KEY_MAX_SIGN_DATA_SIZE (1 << 20) 49 50 struct sshbuf; 51 52 /* Key types */ 53 enum sshkey_types { 54 KEY_RSA, 55 KEY_DSA, 56 KEY_ECDSA, 57 KEY_ED25519, 58 KEY_RSA_CERT, 59 KEY_DSA_CERT, 60 KEY_ECDSA_CERT, 61 KEY_ED25519_CERT, 62 KEY_XMSS, 63 KEY_XMSS_CERT, 64 KEY_UNSPEC 65 }; 66 67 /* Default fingerprint hash */ 68 #define SSH_FP_HASH_DEFAULT SSH_DIGEST_SHA256 69 70 /* Fingerprint representation formats */ 71 enum sshkey_fp_rep { 72 SSH_FP_DEFAULT = 0, 73 SSH_FP_HEX, 74 SSH_FP_BASE64, 75 SSH_FP_BUBBLEBABBLE, 76 SSH_FP_RANDOMART 77 }; 78 79 /* Private key serialisation formats, used on the wire */ 80 enum sshkey_serialize_rep { 81 SSHKEY_SERIALIZE_DEFAULT = 0, 82 SSHKEY_SERIALIZE_STATE = 1, 83 SSHKEY_SERIALIZE_FULL = 2, 84 SSHKEY_SERIALIZE_INFO = 254, 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 RSA *rsa; 118 DSA *dsa; 119 int ecdsa_nid; /* NID of curve */ 120 EC_KEY *ecdsa; 121 u_char *ed25519_sk; 122 u_char *ed25519_pk; 123 char *xmss_name; 124 char *xmss_filename; /* for state file updates */ 125 void *xmss_state; /* depends on xmss_name, opaque */ 126 u_char *xmss_sk; 127 u_char *xmss_pk; 128 struct sshkey_cert *cert; 129 u_char *shielded_private; 130 size_t shielded_len; 131 u_char *shield_prekey; 132 size_t shield_prekey_len; 133 }; 134 135 #define ED25519_SK_SZ crypto_sign_ed25519_SECRETKEYBYTES 136 #define ED25519_PK_SZ crypto_sign_ed25519_PUBLICKEYBYTES 137 138 struct sshkey *sshkey_new(int); 139 void sshkey_free(struct sshkey *); 140 int sshkey_equal_public(const struct sshkey *, 141 const struct sshkey *); 142 int sshkey_equal(const struct sshkey *, const struct sshkey *); 143 char *sshkey_fingerprint(const struct sshkey *, 144 int, enum sshkey_fp_rep); 145 int sshkey_fingerprint_raw(const struct sshkey *k, 146 int, u_char **retp, size_t *lenp); 147 const char *sshkey_type(const struct sshkey *); 148 const char *sshkey_cert_type(const struct sshkey *); 149 int sshkey_format_text(const struct sshkey *, struct sshbuf *); 150 int sshkey_write(const struct sshkey *, FILE *); 151 int sshkey_read(struct sshkey *, char **); 152 u_int sshkey_size(const struct sshkey *); 153 154 int sshkey_generate(int type, u_int bits, struct sshkey **keyp); 155 int sshkey_from_private(const struct sshkey *, struct sshkey **); 156 157 int sshkey_is_shielded(struct sshkey *); 158 int sshkey_shield_private(struct sshkey *); 159 int sshkey_unshield_private(struct sshkey *); 160 161 int sshkey_type_from_name(const char *); 162 int sshkey_is_cert(const struct sshkey *); 163 int sshkey_type_is_cert(int); 164 int sshkey_type_plain(int); 165 int sshkey_to_certified(struct sshkey *); 166 int sshkey_drop_cert(struct sshkey *); 167 int sshkey_cert_copy(const struct sshkey *, struct sshkey *); 168 int sshkey_cert_check_authority(const struct sshkey *, int, int, 169 const char *, const char **); 170 size_t sshkey_format_cert_validity(const struct sshkey_cert *, 171 char *, size_t) __attribute__((__bounded__(__string__, 2, 3))); 172 int sshkey_check_cert_sigtype(const struct sshkey *, const char *); 173 174 int sshkey_certify(struct sshkey *, struct sshkey *, const char *); 175 /* Variant allowing use of a custom signature function (e.g. for ssh-agent) */ 176 typedef int sshkey_certify_signer(struct sshkey *, u_char **, size_t *, 177 const u_char *, size_t, const char *, u_int, void *); 178 int sshkey_certify_custom(struct sshkey *, struct sshkey *, const char *, 179 sshkey_certify_signer *, void *); 180 181 int sshkey_ecdsa_nid_from_name(const char *); 182 int sshkey_curve_name_to_nid(const char *); 183 const char * sshkey_curve_nid_to_name(int); 184 u_int sshkey_curve_nid_to_bits(int); 185 int sshkey_ecdsa_bits_to_nid(int); 186 int sshkey_ecdsa_key_to_nid(EC_KEY *); 187 int sshkey_ec_nid_to_hash_alg(int nid); 188 int sshkey_ec_validate_public(const EC_GROUP *, const EC_POINT *); 189 int sshkey_ec_validate_private(const EC_KEY *); 190 const char *sshkey_ssh_name(const struct sshkey *); 191 const char *sshkey_ssh_name_plain(const struct sshkey *); 192 int sshkey_names_valid2(const char *, int); 193 char *sshkey_alg_list(int, int, int, char); 194 195 int sshkey_from_blob(const u_char *, size_t, struct sshkey **); 196 int sshkey_fromb(struct sshbuf *, struct sshkey **); 197 int sshkey_froms(struct sshbuf *, struct sshkey **); 198 int sshkey_to_blob(const struct sshkey *, u_char **, size_t *); 199 int sshkey_to_base64(const struct sshkey *, char **); 200 int sshkey_putb(const struct sshkey *, struct sshbuf *); 201 int sshkey_puts(const struct sshkey *, struct sshbuf *); 202 int sshkey_puts_opts(const struct sshkey *, struct sshbuf *, 203 enum sshkey_serialize_rep); 204 int sshkey_plain_to_blob(const struct sshkey *, u_char **, size_t *); 205 int sshkey_putb_plain(const struct sshkey *, struct sshbuf *); 206 207 int sshkey_sign(struct sshkey *, u_char **, size_t *, 208 const u_char *, size_t, const char *, u_int); 209 int sshkey_verify(const struct sshkey *, const u_char *, size_t, 210 const u_char *, size_t, const char *, u_int); 211 int sshkey_check_sigtype(const u_char *, size_t, const char *); 212 const char *sshkey_sigalg_by_name(const char *); 213 int sshkey_get_sigtype(const u_char *, size_t, char **); 214 215 /* for debug */ 216 void sshkey_dump_ec_point(const EC_GROUP *, const EC_POINT *); 217 void sshkey_dump_ec_key(const EC_KEY *); 218 219 /* private key parsing and serialisation */ 220 int sshkey_private_serialize(struct sshkey *key, struct sshbuf *buf); 221 int sshkey_private_serialize_opt(struct sshkey *key, struct sshbuf *buf, 222 enum sshkey_serialize_rep); 223 int sshkey_private_deserialize(struct sshbuf *buf, struct sshkey **keyp); 224 225 /* private key file format parsing and serialisation */ 226 int sshkey_private_to_fileblob(struct sshkey *key, struct sshbuf *blob, 227 const char *passphrase, const char *comment, 228 int format, const char *openssh_format_cipher, int openssh_format_rounds); 229 int sshkey_parse_private_fileblob(struct sshbuf *buffer, 230 const char *passphrase, struct sshkey **keyp, char **commentp); 231 int sshkey_parse_private_fileblob_type(struct sshbuf *blob, int type, 232 const char *passphrase, struct sshkey **keyp, char **commentp); 233 234 /* XXX should be internal, but used by ssh-keygen */ 235 int ssh_rsa_complete_crt_parameters(struct sshkey *, const BIGNUM *); 236 237 /* stateful keys (e.g. XMSS) */ 238 typedef void sshkey_printfn(const char *, ...) __attribute__((format(printf, 1, 2))); 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 #ifndef WITH_OPENSSL 276 #undef RSA 277 #undef DSA 278 #undef EC_KEY 279 #undef EC_GROUP 280 #undef EC_POINT 281 #endif /* WITH_OPENSSL */ 282 283 #endif /* SSHKEY_H */ 284
Indexes created Mon Apr 06 00:22:49 UTC 2026