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