sshkey.h revision 1.5.12.2
1 1.5.12.2 snj /* $OpenBSD: sshkey.h,v 1.15 2017/03/10 04:07:20 djm Exp $ */ 2 1.5.12.2 snj 3 1.5.12.2 snj /* 4 1.5.12.2 snj * Copyright (c) 2000, 2001 Markus Friedl. All rights reserved. 5 1.5.12.2 snj * 6 1.5.12.2 snj * Redistribution and use in source and binary forms, with or without 7 1.5.12.2 snj * modification, are permitted provided that the following conditions 8 1.5.12.2 snj * are met: 9 1.5.12.2 snj * 1. Redistributions of source code must retain the above copyright 10 1.5.12.2 snj * notice, this list of conditions and the following disclaimer. 11 1.5.12.2 snj * 2. Redistributions in binary form must reproduce the above copyright 12 1.5.12.2 snj * notice, this list of conditions and the following disclaimer in the 13 1.5.12.2 snj * documentation and/or other materials provided with the distribution. 14 1.5.12.2 snj * 15 1.5.12.2 snj * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 1.5.12.2 snj * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 1.5.12.2 snj * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 1.5.12.2 snj * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 1.5.12.2 snj * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 1.5.12.2 snj * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 1.5.12.2 snj * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 1.5.12.2 snj * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 1.5.12.2 snj * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 1.5.12.2 snj * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 1.5.12.2 snj */ 26 1.5.12.2 snj #ifndef SSHKEY_H 27 1.5.12.2 snj #define SSHKEY_H 28 1.5.12.2 snj 29 1.5.12.2 snj #include "includes.h" 30 1.5.12.2 snj #include <sys/types.h> 31 1.5.12.2 snj 32 1.5.12.2 snj #ifdef WITH_OPENSSL 33 1.5.12.2 snj #include <openssl/rsa.h> 34 1.5.12.2 snj #include <openssl/dsa.h> 35 1.5.12.2 snj #include <openssl/ec.h> 36 1.5.12.2 snj #else /* OPENSSL */ 37 1.5.12.2 snj #define RSA void 38 1.5.12.2 snj #define DSA void 39 1.5.12.2 snj #define EC_KEY void 40 1.5.12.2 snj #define EC_GROUP void 41 1.5.12.2 snj #define EC_POINT void 42 1.5.12.2 snj #endif /* WITH_OPENSSL */ 43 1.5.12.2 snj 44 1.5.12.2 snj #define SSH_RSA_MINIMUM_MODULUS_SIZE 768 45 1.5.12.2 snj #define SSH_KEY_MAX_SIGN_DATA_SIZE (1 << 20) 46 1.5.12.2 snj 47 1.5.12.2 snj struct sshbuf; 48 1.5.12.2 snj 49 1.5.12.2 snj /* Key types */ 50 1.5.12.2 snj enum sshkey_types { 51 1.5.12.2 snj KEY_RSA1, 52 1.5.12.2 snj KEY_RSA, 53 1.5.12.2 snj KEY_DSA, 54 1.5.12.2 snj KEY_ECDSA, 55 1.5.12.2 snj KEY_ED25519, 56 1.5.12.2 snj KEY_RSA_CERT, 57 1.5.12.2 snj KEY_DSA_CERT, 58 1.5.12.2 snj KEY_ECDSA_CERT, 59 1.5.12.2 snj KEY_ED25519_CERT, 60 1.5.12.2 snj KEY_UNSPEC 61 1.5.12.2 snj }; 62 1.5.12.2 snj 63 1.5.12.2 snj /* Default fingerprint hash */ 64 1.5.12.2 snj #define SSH_FP_HASH_DEFAULT SSH_DIGEST_SHA256 65 1.5.12.2 snj 66 1.5.12.2 snj /* Fingerprint representation formats */ 67 1.5.12.2 snj enum sshkey_fp_rep { 68 1.5.12.2 snj SSH_FP_DEFAULT = 0, 69 1.5.12.2 snj SSH_FP_HEX, 70 1.5.12.2 snj SSH_FP_BASE64, 71 1.5.12.2 snj SSH_FP_BUBBLEBABBLE, 72 1.5.12.2 snj SSH_FP_RANDOMART 73 1.5.12.2 snj }; 74 1.5.12.2 snj 75 1.5.12.2 snj /* key is stored in external hardware */ 76 1.5.12.2 snj #define SSHKEY_FLAG_EXT 0x0001 77 1.5.12.2 snj 78 1.5.12.2 snj #define SSHKEY_CERT_MAX_PRINCIPALS 256 79 1.5.12.2 snj /* XXX opaquify? */ 80 1.5.12.2 snj struct sshkey_cert { 81 1.5.12.2 snj struct sshbuf *certblob; /* Kept around for use on wire */ 82 1.5.12.2 snj u_int type; /* SSH2_CERT_TYPE_USER or SSH2_CERT_TYPE_HOST */ 83 1.5.12.2 snj u_int64_t serial; 84 1.5.12.2 snj char *key_id; 85 1.5.12.2 snj u_int nprincipals; 86 1.5.12.2 snj char **principals; 87 1.5.12.2 snj u_int64_t valid_after, valid_before; 88 1.5.12.2 snj struct sshbuf *critical; 89 1.5.12.2 snj struct sshbuf *extensions; 90 1.5.12.2 snj struct sshkey *signature_key; 91 1.5.12.2 snj }; 92 1.5.12.2 snj 93 1.5.12.2 snj /* XXX opaquify? */ 94 1.5.12.2 snj struct sshkey { 95 1.5.12.2 snj int type; 96 1.5.12.2 snj int flags; 97 1.5.12.2 snj RSA *rsa; 98 1.5.12.2 snj DSA *dsa; 99 1.5.12.2 snj int ecdsa_nid; /* NID of curve */ 100 1.5.12.2 snj EC_KEY *ecdsa; 101 1.5.12.2 snj u_char *ed25519_sk; 102 1.5.12.2 snj u_char *ed25519_pk; 103 1.5.12.2 snj struct sshkey_cert *cert; 104 1.5.12.2 snj }; 105 1.5.12.2 snj 106 1.5.12.2 snj #define ED25519_SK_SZ crypto_sign_ed25519_SECRETKEYBYTES 107 1.5.12.2 snj #define ED25519_PK_SZ crypto_sign_ed25519_PUBLICKEYBYTES 108 1.5.12.2 snj 109 1.5.12.2 snj struct sshkey *sshkey_new(int); 110 1.5.12.2 snj int sshkey_add_private(struct sshkey *); 111 1.5.12.2 snj struct sshkey *sshkey_new_private(int); 112 1.5.12.2 snj void sshkey_free(struct sshkey *); 113 1.5.12.2 snj int sshkey_demote(const struct sshkey *, struct sshkey **); 114 1.5.12.2 snj int sshkey_equal_public(const struct sshkey *, 115 1.5.12.2 snj const struct sshkey *); 116 1.5.12.2 snj int sshkey_equal(const struct sshkey *, const struct sshkey *); 117 1.5.12.2 snj char *sshkey_fingerprint(const struct sshkey *, 118 1.5.12.2 snj int, enum sshkey_fp_rep); 119 1.5.12.2 snj int sshkey_fingerprint_raw(const struct sshkey *k, 120 1.5.12.2 snj int, u_char **retp, size_t *lenp); 121 1.5.12.2 snj const char *sshkey_type(const struct sshkey *); 122 1.5.12.2 snj const char *sshkey_cert_type(const struct sshkey *); 123 1.5.12.2 snj int sshkey_write(const struct sshkey *, FILE *); 124 1.5.12.2 snj int sshkey_read(struct sshkey *, char **); 125 1.5.12.2 snj u_int sshkey_size(const struct sshkey *); 126 1.5.12.2 snj 127 1.5.12.2 snj int sshkey_generate(int type, u_int bits, struct sshkey **keyp); 128 1.5.12.2 snj int sshkey_from_private(const struct sshkey *, struct sshkey **); 129 1.5.12.2 snj int sshkey_type_from_name(const char *); 130 1.5.12.2 snj int sshkey_is_cert(const struct sshkey *); 131 1.5.12.2 snj int sshkey_type_is_cert(int); 132 1.5.12.2 snj int sshkey_type_plain(int); 133 1.5.12.2 snj int sshkey_to_certified(struct sshkey *); 134 1.5.12.2 snj int sshkey_drop_cert(struct sshkey *); 135 1.5.12.2 snj int sshkey_certify(struct sshkey *, struct sshkey *, const char *); 136 1.5.12.2 snj int sshkey_cert_copy(const struct sshkey *, struct sshkey *); 137 1.5.12.2 snj int sshkey_cert_check_authority(const struct sshkey *, int, int, 138 1.5.12.2 snj const char *, const char **); 139 1.5.12.2 snj size_t sshkey_format_cert_validity(const struct sshkey_cert *, 140 1.5.12.2 snj char *, size_t) __attribute__((__bounded__(__string__, 2, 3))); 141 1.5.12.2 snj 142 1.5.12.2 snj int sshkey_ecdsa_nid_from_name(const char *); 143 1.5.12.2 snj int sshkey_curve_name_to_nid(const char *); 144 1.5.12.2 snj const char * sshkey_curve_nid_to_name(int); 145 1.5.12.2 snj u_int sshkey_curve_nid_to_bits(int); 146 1.5.12.2 snj int sshkey_ecdsa_bits_to_nid(int); 147 1.5.12.2 snj int sshkey_ecdsa_key_to_nid(EC_KEY *); 148 1.5.12.2 snj int sshkey_ec_nid_to_hash_alg(int nid); 149 1.5.12.2 snj int sshkey_ec_validate_public(const EC_GROUP *, const EC_POINT *); 150 1.5.12.2 snj int sshkey_ec_validate_private(const EC_KEY *); 151 1.5.12.2 snj const char *sshkey_ssh_name(const struct sshkey *); 152 1.5.12.2 snj const char *sshkey_ssh_name_plain(const struct sshkey *); 153 1.5.12.2 snj int sshkey_names_valid2(const char *, int); 154 1.5.12.2 snj char *sshkey_alg_list(int, int, int, char); 155 1.5.12.2 snj 156 1.5.12.2 snj int sshkey_from_blob(const u_char *, size_t, struct sshkey **); 157 1.5.12.2 snj int sshkey_fromb(struct sshbuf *, struct sshkey **); 158 1.5.12.2 snj int sshkey_froms(struct sshbuf *, struct sshkey **); 159 1.5.12.2 snj int sshkey_to_blob(const struct sshkey *, u_char **, size_t *); 160 1.5.12.2 snj int sshkey_to_base64(const struct sshkey *, char **); 161 1.5.12.2 snj int sshkey_putb(const struct sshkey *, struct sshbuf *); 162 1.5.12.2 snj int sshkey_puts(const struct sshkey *, struct sshbuf *); 163 1.5.12.2 snj int sshkey_plain_to_blob(const struct sshkey *, u_char **, size_t *); 164 1.5.12.2 snj int sshkey_putb_plain(const struct sshkey *, struct sshbuf *); 165 1.5.12.2 snj 166 1.5.12.2 snj int sshkey_sign(const struct sshkey *, u_char **, size_t *, 167 1.5.12.2 snj const u_char *, size_t, const char *, u_int); 168 1.5.12.2 snj int sshkey_verify(const struct sshkey *, const u_char *, size_t, 169 1.5.12.2 snj const u_char *, size_t, u_int); 170 1.5.12.2 snj 171 1.5.12.2 snj /* for debug */ 172 1.5.12.2 snj void sshkey_dump_ec_point(const EC_GROUP *, const EC_POINT *); 173 1.5.12.2 snj void sshkey_dump_ec_key(const EC_KEY *); 174 1.5.12.2 snj 175 1.5.12.2 snj /* private key parsing and serialisation */ 176 1.5.12.2 snj int sshkey_private_serialize(const struct sshkey *key, struct sshbuf *buf); 177 1.5.12.2 snj int sshkey_private_deserialize(struct sshbuf *buf, struct sshkey **keyp); 178 1.5.12.2 snj 179 1.5.12.2 snj /* private key file format parsing and serialisation */ 180 1.5.12.2 snj int sshkey_private_to_fileblob(struct sshkey *key, struct sshbuf *blob, 181 1.5.12.2 snj const char *passphrase, const char *comment, 182 1.5.12.2 snj int force_new_format, const char *new_format_cipher, int new_format_rounds); 183 1.5.12.2 snj int sshkey_parse_public_rsa1_fileblob(struct sshbuf *blob, 184 1.5.12.2 snj struct sshkey **keyp, char **commentp); 185 1.5.12.2 snj int sshkey_parse_private_fileblob(struct sshbuf *buffer, 186 1.5.12.2 snj const char *passphrase, struct sshkey **keyp, char **commentp); 187 1.5.12.2 snj int sshkey_parse_private_fileblob_type(struct sshbuf *blob, int type, 188 1.5.12.2 snj const char *passphrase, struct sshkey **keyp, char **commentp); 189 1.5.12.2 snj 190 1.5.12.2 snj #ifdef SSHKEY_INTERNAL 191 1.5.12.2 snj int ssh_rsa_sign(const struct sshkey *key, 192 1.5.12.2 snj u_char **sigp, size_t *lenp, const u_char *data, size_t datalen, 193 1.5.12.2 snj const char *ident); 194 1.5.12.2 snj int ssh_rsa_verify(const struct sshkey *key, 195 1.5.12.2 snj const u_char *sig, size_t siglen, const u_char *data, size_t datalen); 196 1.5.12.2 snj int ssh_dss_sign(const struct sshkey *key, u_char **sigp, size_t *lenp, 197 1.5.12.2 snj const u_char *data, size_t datalen, u_int compat); 198 1.5.12.2 snj int ssh_dss_verify(const struct sshkey *key, 199 1.5.12.2 snj const u_char *signature, size_t signaturelen, 200 1.5.12.2 snj const u_char *data, size_t datalen, u_int compat); 201 1.5.12.2 snj int ssh_ecdsa_sign(const struct sshkey *key, u_char **sigp, size_t *lenp, 202 1.5.12.2 snj const u_char *data, size_t datalen, u_int compat); 203 1.5.12.2 snj int ssh_ecdsa_verify(const struct sshkey *key, 204 1.5.12.2 snj const u_char *signature, size_t signaturelen, 205 1.5.12.2 snj const u_char *data, size_t datalen, u_int compat); 206 1.5.12.2 snj int ssh_ed25519_sign(const struct sshkey *key, u_char **sigp, size_t *lenp, 207 1.5.12.2 snj const u_char *data, size_t datalen, u_int compat); 208 1.5.12.2 snj int ssh_ed25519_verify(const struct sshkey *key, 209 1.5.12.2 snj const u_char *signature, size_t signaturelen, 210 1.5.12.2 snj const u_char *data, size_t datalen, u_int compat); 211 1.5.12.2 snj #endif 212 1.5.12.2 snj 213 1.5.12.2 snj #ifndef WITH_OPENSSL 214 1.5.12.2 snj #undef RSA 215 1.5.12.2 snj #undef DSA 216 1.5.12.2 snj #undef EC_KEY 217 1.5.12.2 snj #undef EC_GROUP 218 1.5.12.2 snj #undef EC_POINT 219 1.5.12.2 snj #endif /* WITH_OPENSSL */ 220 1.5.12.2 snj 221 1.5.12.2 snj #endif /* SSHKEY_H */ 222
Indexes created Mon Apr 06 00:22:49 UTC 2026