sshkey.h revision 1.3
1 /* $OpenBSD: sshkey.h,v 1.13 2016/05/02 09:36:42 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 768 45 #define SSH_KEY_MAX_SIGN_DATA_SIZE (1 << 20) 46 47 struct sshbuf; 48 49 /* Key types */ 50 enum sshkey_types { 51 KEY_RSA1, 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_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 /* key is stored in external hardware */ 76 #define SSHKEY_FLAG_EXT 0x0001 77 78 #define SSHKEY_CERT_MAX_PRINCIPALS 256 79 /* XXX opaquify? */ 80 struct sshkey_cert { 81 struct sshbuf *certblob; /* Kept around for use on wire */ 82 u_int type; /* SSH2_CERT_TYPE_USER or SSH2_CERT_TYPE_HOST */ 83 u_int64_t serial; 84 char *key_id; 85 u_int nprincipals; 86 char **principals; 87 u_int64_t valid_after, valid_before; 88 struct sshbuf *critical; 89 struct sshbuf *extensions; 90 struct sshkey *signature_key; 91 }; 92 93 /* XXX opaquify? */ 94 struct sshkey { 95 int type; 96 int flags; 97 RSA *rsa; 98 DSA *dsa; 99 int ecdsa_nid; /* NID of curve */ 100 EC_KEY *ecdsa; 101 u_char *ed25519_sk; 102 u_char *ed25519_pk; 103 struct sshkey_cert *cert; 104 }; 105 106 #define ED25519_SK_SZ crypto_sign_ed25519_SECRETKEYBYTES 107 #define ED25519_PK_SZ crypto_sign_ed25519_PUBLICKEYBYTES 108 109 struct sshkey *sshkey_new(int); 110 int sshkey_add_private(struct sshkey *); 111 struct sshkey *sshkey_new_private(int); 112 void sshkey_free(struct sshkey *); 113 int sshkey_demote(const struct sshkey *, struct sshkey **); 114 int sshkey_equal_public(const struct sshkey *, 115 const struct sshkey *); 116 int sshkey_equal(const struct sshkey *, const struct sshkey *); 117 char *sshkey_fingerprint(const struct sshkey *, 118 int, enum sshkey_fp_rep); 119 int sshkey_fingerprint_raw(const struct sshkey *k, 120 int, u_char **retp, size_t *lenp); 121 const char *sshkey_type(const struct sshkey *); 122 const char *sshkey_cert_type(const struct sshkey *); 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_certify(struct sshkey *, struct sshkey *, const char *); 136 int sshkey_cert_copy(const struct sshkey *, struct sshkey *); 137 int sshkey_cert_check_authority(const struct sshkey *, int, int, 138 const char *, const char **); 139 size_t sshkey_format_cert_validity(const struct sshkey_cert *, 140 char *, size_t) __attribute__((__bounded__(__string__, 2, 3))); 141 142 int sshkey_ecdsa_nid_from_name(const char *); 143 int sshkey_curve_name_to_nid(const char *); 144 const char * sshkey_curve_nid_to_name(int); 145 u_int sshkey_curve_nid_to_bits(int); 146 int sshkey_ecdsa_bits_to_nid(int); 147 int sshkey_ecdsa_key_to_nid(EC_KEY *); 148 int sshkey_ec_nid_to_hash_alg(int nid); 149 int sshkey_ec_validate_public(const EC_GROUP *, const EC_POINT *); 150 int sshkey_ec_validate_private(const EC_KEY *); 151 const char *sshkey_ssh_name(const struct sshkey *); 152 const char *sshkey_ssh_name_plain(const struct sshkey *); 153 int sshkey_names_valid2(const char *, int); 154 char *key_alg_list(int, int); 155 156 int sshkey_from_blob(const u_char *, size_t, struct sshkey **); 157 int sshkey_fromb(struct sshbuf *, struct sshkey **); 158 int sshkey_froms(struct sshbuf *, struct sshkey **); 159 int sshkey_to_blob(const struct sshkey *, u_char **, size_t *); 160 int sshkey_to_base64(const struct sshkey *, char **); 161 int sshkey_putb(const struct sshkey *, struct sshbuf *); 162 int sshkey_puts(const struct sshkey *, struct sshbuf *); 163 int sshkey_plain_to_blob(const struct sshkey *, u_char **, size_t *); 164 int sshkey_putb_plain(const struct sshkey *, struct sshbuf *); 165 166 int sshkey_sign(const struct sshkey *, u_char **, size_t *, 167 const u_char *, size_t, const char *, u_int); 168 int sshkey_verify(const struct sshkey *, const u_char *, size_t, 169 const u_char *, size_t, u_int); 170 171 /* for debug */ 172 void sshkey_dump_ec_point(const EC_GROUP *, const EC_POINT *); 173 void sshkey_dump_ec_key(const EC_KEY *); 174 175 /* private key parsing and serialisation */ 176 int sshkey_private_serialize(const struct sshkey *key, struct sshbuf *buf); 177 int sshkey_private_deserialize(struct sshbuf *buf, struct sshkey **keyp); 178 179 /* private key file format parsing and serialisation */ 180 int sshkey_private_to_fileblob(struct sshkey *key, struct sshbuf *blob, 181 const char *passphrase, const char *comment, 182 int force_new_format, const char *new_format_cipher, int new_format_rounds); 183 int sshkey_parse_public_rsa1_fileblob(struct sshbuf *blob, 184 struct sshkey **keyp, char **commentp); 185 int sshkey_parse_private_fileblob(struct sshbuf *buffer, 186 const char *passphrase, struct sshkey **keyp, char **commentp); 187 int sshkey_parse_private_fileblob_type(struct sshbuf *blob, int type, 188 const char *passphrase, struct sshkey **keyp, char **commentp); 189 190 #ifdef SSHKEY_INTERNAL 191 int ssh_rsa_sign(const struct sshkey *key, 192 u_char **sigp, size_t *lenp, const u_char *data, size_t datalen, 193 const char *ident); 194 int ssh_rsa_verify(const struct sshkey *key, 195 const u_char *sig, size_t siglen, const u_char *data, size_t datalen); 196 int ssh_dss_sign(const struct sshkey *key, u_char **sigp, size_t *lenp, 197 const u_char *data, size_t datalen, u_int compat); 198 int ssh_dss_verify(const struct sshkey *key, 199 const u_char *signature, size_t signaturelen, 200 const u_char *data, size_t datalen, u_int compat); 201 int ssh_ecdsa_sign(const struct sshkey *key, u_char **sigp, size_t *lenp, 202 const u_char *data, size_t datalen, u_int compat); 203 int ssh_ecdsa_verify(const struct sshkey *key, 204 const u_char *signature, size_t signaturelen, 205 const u_char *data, size_t datalen, u_int compat); 206 int ssh_ed25519_sign(const struct sshkey *key, u_char **sigp, size_t *lenp, 207 const u_char *data, size_t datalen, u_int compat); 208 int ssh_ed25519_verify(const struct sshkey *key, 209 const u_char *signature, size_t signaturelen, 210 const u_char *data, size_t datalen, u_int compat); 211 #endif 212 213 #ifndef WITH_OPENSSL 214 #undef RSA 215 #undef DSA 216 #undef EC_KEY 217 #undef EC_GROUP 218 #undef EC_POINT 219 #endif /* WITH_OPENSSL */ 220 221 #endif /* SSHKEY_H */ 222
Indexes created Mon Apr 06 00:22:49 UTC 2026