Damien Miller | 5be9d9e | 2013-12-07 11:24:01 +1100 | [diff] [blame] | 1 | /* $OpenBSD: key.h,v 1.40 2013/12/06 13:39:49 markus Exp $ */ |
Ben Lindstrom | 36579d3 | 2001-01-29 07:39:26 +0000 | [diff] [blame] | 2 | |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 3 | /* |
Ben Lindstrom | 4469723 | 2001-07-04 03:32:30 +0000 | [diff] [blame] | 4 | * Copyright (c) 2000, 2001 Markus Friedl. All rights reserved. |
Damien Miller | e4340be | 2000-09-16 13:29:08 +1100 | [diff] [blame] | 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 | */ |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 26 | #ifndef KEY_H |
| 27 | #define KEY_H |
| 28 | |
Damien Miller | 0a80ca1 | 2010-02-27 07:55:05 +1100 | [diff] [blame] | 29 | #include "buffer.h" |
Ben Lindstrom | 226cfa0 | 2001-01-22 05:34:40 +0000 | [diff] [blame] | 30 | #include <openssl/rsa.h> |
| 31 | #include <openssl/dsa.h> |
Damien Miller | 6af914a | 2010-09-10 11:39:26 +1000 | [diff] [blame] | 32 | #ifdef OPENSSL_HAS_ECC |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 33 | #include <openssl/ec.h> |
Damien Miller | 6af914a | 2010-09-10 11:39:26 +1000 | [diff] [blame] | 34 | #endif |
Ben Lindstrom | 226cfa0 | 2001-01-22 05:34:40 +0000 | [diff] [blame] | 35 | |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 36 | typedef struct Key Key; |
| 37 | enum types { |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 38 | KEY_RSA1, |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 39 | KEY_RSA, |
| 40 | KEY_DSA, |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 41 | KEY_ECDSA, |
Damien Miller | 5be9d9e | 2013-12-07 11:24:01 +1100 | [diff] [blame] | 42 | KEY_ED25519, |
Damien Miller | 0a80ca1 | 2010-02-27 07:55:05 +1100 | [diff] [blame] | 43 | KEY_RSA_CERT, |
| 44 | KEY_DSA_CERT, |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 45 | KEY_ECDSA_CERT, |
Damien Miller | 5be9d9e | 2013-12-07 11:24:01 +1100 | [diff] [blame] | 46 | KEY_ED25519_CERT, |
Damien Miller | 4e270b0 | 2010-04-16 15:56:21 +1000 | [diff] [blame] | 47 | KEY_RSA_CERT_V00, |
| 48 | KEY_DSA_CERT_V00, |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 49 | KEY_UNSPEC |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 50 | }; |
Ben Lindstrom | 96e8ea6 | 2001-03-11 20:03:44 +0000 | [diff] [blame] | 51 | enum fp_type { |
| 52 | SSH_FP_SHA1, |
Damien Miller | 3bde12a | 2012-06-20 21:51:11 +1000 | [diff] [blame] | 53 | SSH_FP_MD5, |
| 54 | SSH_FP_SHA256 |
Ben Lindstrom | 96e8ea6 | 2001-03-11 20:03:44 +0000 | [diff] [blame] | 55 | }; |
| 56 | enum fp_rep { |
| 57 | SSH_FP_HEX, |
Darren Tucker | 9c16ac9 | 2008-06-13 04:40:35 +1000 | [diff] [blame] | 58 | SSH_FP_BUBBLEBABBLE, |
| 59 | SSH_FP_RANDOMART |
Ben Lindstrom | 96e8ea6 | 2001-03-11 20:03:44 +0000 | [diff] [blame] | 60 | }; |
Ben Lindstrom | c5b6800 | 2001-07-04 04:52:03 +0000 | [diff] [blame] | 61 | |
| 62 | /* key is stored in external hardware */ |
| 63 | #define KEY_FLAG_EXT 0x0001 |
| 64 | |
Damien Miller | 0a80ca1 | 2010-02-27 07:55:05 +1100 | [diff] [blame] | 65 | #define CERT_MAX_PRINCIPALS 256 |
| 66 | struct KeyCert { |
| 67 | Buffer certblob; /* Kept around for use on wire */ |
| 68 | u_int type; /* SSH2_CERT_TYPE_USER or SSH2_CERT_TYPE_HOST */ |
Damien Miller | 4e270b0 | 2010-04-16 15:56:21 +1000 | [diff] [blame] | 69 | u_int64_t serial; |
Damien Miller | 0a80ca1 | 2010-02-27 07:55:05 +1100 | [diff] [blame] | 70 | char *key_id; |
| 71 | u_int nprincipals; |
| 72 | char **principals; |
| 73 | u_int64_t valid_after, valid_before; |
Damien Miller | 4e270b0 | 2010-04-16 15:56:21 +1000 | [diff] [blame] | 74 | Buffer critical; |
| 75 | Buffer extensions; |
Damien Miller | 0a80ca1 | 2010-02-27 07:55:05 +1100 | [diff] [blame] | 76 | Key *signature_key; |
| 77 | }; |
| 78 | |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 79 | struct Key { |
Ben Lindstrom | c5b6800 | 2001-07-04 04:52:03 +0000 | [diff] [blame] | 80 | int type; |
| 81 | int flags; |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 82 | RSA *rsa; |
| 83 | DSA *dsa; |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 84 | int ecdsa_nid; /* NID of curve */ |
Damien Miller | 6af914a | 2010-09-10 11:39:26 +1000 | [diff] [blame] | 85 | #ifdef OPENSSL_HAS_ECC |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 86 | EC_KEY *ecdsa; |
Damien Miller | 6af914a | 2010-09-10 11:39:26 +1000 | [diff] [blame] | 87 | #else |
| 88 | void *ecdsa; |
| 89 | #endif |
Damien Miller | 0a80ca1 | 2010-02-27 07:55:05 +1100 | [diff] [blame] | 90 | struct KeyCert *cert; |
Damien Miller | 5be9d9e | 2013-12-07 11:24:01 +1100 | [diff] [blame] | 91 | u_char *ed25519_sk; |
| 92 | u_char *ed25519_pk; |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 93 | }; |
| 94 | |
Damien Miller | 5be9d9e | 2013-12-07 11:24:01 +1100 | [diff] [blame] | 95 | #define ED25519_SK_SZ crypto_sign_ed25519_SECRETKEYBYTES |
| 96 | #define ED25519_PK_SZ crypto_sign_ed25519_PUBLICKEYBYTES |
| 97 | |
Damien Miller | f58b58c | 2003-11-17 21:18:23 +1100 | [diff] [blame] | 98 | Key *key_new(int); |
Damien Miller | 0a80ca1 | 2010-02-27 07:55:05 +1100 | [diff] [blame] | 99 | void key_add_private(Key *); |
Damien Miller | f58b58c | 2003-11-17 21:18:23 +1100 | [diff] [blame] | 100 | Key *key_new_private(int); |
| 101 | void key_free(Key *); |
| 102 | Key *key_demote(const Key *); |
Damien Miller | 0a80ca1 | 2010-02-27 07:55:05 +1100 | [diff] [blame] | 103 | int key_equal_public(const Key *, const Key *); |
Damien Miller | f58b58c | 2003-11-17 21:18:23 +1100 | [diff] [blame] | 104 | int key_equal(const Key *, const Key *); |
Darren Tucker | 0acca37 | 2013-06-02 07:41:51 +1000 | [diff] [blame] | 105 | char *key_fingerprint(const Key *, enum fp_type, enum fp_rep); |
Damien Miller | f3747bf | 2013-01-18 11:44:04 +1100 | [diff] [blame] | 106 | u_char *key_fingerprint_raw(const Key *, enum fp_type, u_int *); |
Damien Miller | f58b58c | 2003-11-17 21:18:23 +1100 | [diff] [blame] | 107 | const char *key_type(const Key *); |
Damien Miller | 1cfbfaf | 2010-03-22 05:58:24 +1100 | [diff] [blame] | 108 | const char *key_cert_type(const Key *); |
Damien Miller | f58b58c | 2003-11-17 21:18:23 +1100 | [diff] [blame] | 109 | int key_write(const Key *, FILE *); |
| 110 | int key_read(Key *, char **); |
| 111 | u_int key_size(const Key *); |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 112 | |
Ben Lindstrom | 16ae3d0 | 2001-07-04 04:02:36 +0000 | [diff] [blame] | 113 | Key *key_generate(int, u_int); |
Damien Miller | f58b58c | 2003-11-17 21:18:23 +1100 | [diff] [blame] | 114 | Key *key_from_private(const Key *); |
Ben Lindstrom | 4cc240d | 2001-07-04 04:46:56 +0000 | [diff] [blame] | 115 | int key_type_from_name(char *); |
Damien Miller | 0a80ca1 | 2010-02-27 07:55:05 +1100 | [diff] [blame] | 116 | int key_is_cert(const Key *); |
Damien Miller | 4a3a9d4 | 2013-10-30 22:19:47 +1100 | [diff] [blame] | 117 | int key_type_is_cert(int); |
Damien Miller | 0a80ca1 | 2010-02-27 07:55:05 +1100 | [diff] [blame] | 118 | int key_type_plain(int); |
Damien Miller | 4e270b0 | 2010-04-16 15:56:21 +1000 | [diff] [blame] | 119 | int key_to_certified(Key *, int); |
Damien Miller | 0a80ca1 | 2010-02-27 07:55:05 +1100 | [diff] [blame] | 120 | int key_drop_cert(Key *); |
| 121 | int key_certify(Key *, Key *); |
| 122 | void key_cert_copy(const Key *, struct Key *); |
| 123 | int key_cert_check_authority(const Key *, int, int, const char *, |
| 124 | const char **); |
Damien Miller | f3747bf | 2013-01-18 11:44:04 +1100 | [diff] [blame] | 125 | int key_cert_is_legacy(const Key *); |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 126 | |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 127 | int key_ecdsa_nid_from_name(const char *); |
| 128 | int key_curve_name_to_nid(const char *); |
Damien Miller | ea11119 | 2013-04-23 19:24:32 +1000 | [diff] [blame] | 129 | const char *key_curve_nid_to_name(int); |
Damien Miller | 041ab7c | 2010-09-10 11:23:34 +1000 | [diff] [blame] | 130 | u_int key_curve_nid_to_bits(int); |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 131 | int key_ecdsa_bits_to_nid(int); |
Damien Miller | 6af914a | 2010-09-10 11:39:26 +1000 | [diff] [blame] | 132 | #ifdef OPENSSL_HAS_ECC |
Damien Miller | b472a90 | 2010-11-05 10:19:49 +1100 | [diff] [blame] | 133 | int key_ecdsa_key_to_nid(EC_KEY *); |
Damien Miller | ea11119 | 2013-04-23 19:24:32 +1000 | [diff] [blame] | 134 | const EVP_MD *key_ec_nid_to_evpmd(int nid); |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 135 | int key_ec_validate_public(const EC_GROUP *, const EC_POINT *); |
| 136 | int key_ec_validate_private(const EC_KEY *); |
Damien Miller | 6af914a | 2010-09-10 11:39:26 +1000 | [diff] [blame] | 137 | #endif |
Damien Miller | 5be9d9e | 2013-12-07 11:24:01 +1100 | [diff] [blame] | 138 | char *key_alg_list(int, int); |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 139 | |
Damien Miller | f58b58c | 2003-11-17 21:18:23 +1100 | [diff] [blame] | 140 | Key *key_from_blob(const u_char *, u_int); |
| 141 | int key_to_blob(const Key *, u_char **, u_int *); |
| 142 | const char *key_ssh_name(const Key *); |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 143 | const char *key_ssh_name_plain(const Key *); |
Damien Miller | f58b58c | 2003-11-17 21:18:23 +1100 | [diff] [blame] | 144 | int key_names_valid2(const char *); |
Damien Miller | 0bc1bd8 | 2000-11-13 22:57:25 +1100 | [diff] [blame] | 145 | |
Damien Miller | f58b58c | 2003-11-17 21:18:23 +1100 | [diff] [blame] | 146 | int key_sign(const Key *, u_char **, u_int *, const u_char *, u_int); |
| 147 | int key_verify(const Key *, const u_char *, u_int, const u_char *, u_int); |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 148 | |
Damien Miller | f58b58c | 2003-11-17 21:18:23 +1100 | [diff] [blame] | 149 | int ssh_dss_sign(const Key *, u_char **, u_int *, const u_char *, u_int); |
| 150 | int ssh_dss_verify(const Key *, const u_char *, u_int, const u_char *, u_int); |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 151 | int ssh_ecdsa_sign(const Key *, u_char **, u_int *, const u_char *, u_int); |
| 152 | int ssh_ecdsa_verify(const Key *, const u_char *, u_int, const u_char *, u_int); |
Damien Miller | f58b58c | 2003-11-17 21:18:23 +1100 | [diff] [blame] | 153 | int ssh_rsa_sign(const Key *, u_char **, u_int *, const u_char *, u_int); |
| 154 | int ssh_rsa_verify(const Key *, const u_char *, u_int, const u_char *, u_int); |
Damien Miller | 5be9d9e | 2013-12-07 11:24:01 +1100 | [diff] [blame] | 155 | int ssh_ed25519_sign(const Key *, u_char **, u_int *, const u_char *, u_int); |
| 156 | int ssh_ed25519_verify(const Key *, const u_char *, u_int, const u_char *, u_int); |
Damien Miller | e8a240f | 2003-02-24 12:01:40 +1100 | [diff] [blame] | 157 | |
Damien Miller | 6af914a | 2010-09-10 11:39:26 +1000 | [diff] [blame] | 158 | #if defined(OPENSSL_HAS_ECC) && (defined(DEBUG_KEXECDH) || defined(DEBUG_PK)) |
Damien Miller | eb8b60e | 2010-08-31 22:41:14 +1000 | [diff] [blame] | 159 | void key_dump_ec_point(const EC_GROUP *, const EC_POINT *); |
| 160 | void key_dump_ec_key(const EC_KEY *); |
| 161 | #endif |
| 162 | |
Damien Miller | f0e9060 | 2013-12-07 10:40:26 +1100 | [diff] [blame] | 163 | void key_private_serialize(const Key *, Buffer *); |
| 164 | Key *key_private_deserialize(Buffer *); |
| 165 | |
Damien Miller | 450a7a1 | 2000-03-26 13:04:51 +1000 | [diff] [blame] | 166 | #endif |