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