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