1 /* $OpenBSD: kex.h,v 1.123 2024/05/17 00:30:23 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 KEX_H 27 #define KEX_H 28 29 #include "mac.h" 30 #include "crypto_api.h" 31 32 #ifdef WITH_OPENSSL 33 # include <openssl/bn.h> 34 # include <openssl/dh.h> 35 # include <openssl/ecdsa.h> 36 # ifdef OPENSSL_HAS_ECC 37 # include <openssl/ec.h> 38 # else /* OPENSSL_HAS_ECC */ 39 # define EC_KEY void 40 # define EC_GROUP void 41 # define EC_POINT void 42 # endif /* OPENSSL_HAS_ECC */ 43 #else /* WITH_OPENSSL */ 44 # define DH void 45 # define BIGNUM void 46 # define EC_KEY void 47 # define EC_GROUP void 48 # define EC_POINT void 49 #endif /* WITH_OPENSSL */ 50 51 #define KEX_COOKIE_LEN 16 52 53 #define KEX_DH1 "diffie-hellman-group1-sha1" 54 #define KEX_DH14_SHA1 "diffie-hellman-group14-sha1" 55 #define KEX_DH14_SHA256 "diffie-hellman-group14-sha256" 56 #define KEX_DH16_SHA512 "diffie-hellman-group16-sha512" 57 #define KEX_DH18_SHA512 "diffie-hellman-group18-sha512" 58 #define KEX_DHGEX_SHA1 "diffie-hellman-group-exchange-sha1" 59 #define KEX_DHGEX_SHA256 "diffie-hellman-group-exchange-sha256" 60 #define KEX_ECDH_SHA2_NISTP256 "ecdh-sha2-nistp256" 61 #define KEX_ECDH_SHA2_NISTP384 "ecdh-sha2-nistp384" 62 #define KEX_ECDH_SHA2_NISTP521 "ecdh-sha2-nistp521" 63 #define KEX_CURVE25519_SHA256 "curve25519-sha256" 64 #define KEX_CURVE25519_SHA256_OLD "curve25519-sha256@libssh.org" 65 #define KEX_SNTRUP761X25519_SHA512 "sntrup761x25519-sha512@openssh.com" 66 67 #define COMP_NONE 0 68 /* pre-auth compression (COMP_ZLIB) is only supported in the client */ 69 #define COMP_ZLIB 1 70 #define COMP_DELAYED 2 71 72 #define CURVE25519_SIZE 32 73 74 enum kex_init_proposals { 75 PROPOSAL_KEX_ALGS, 76 PROPOSAL_SERVER_HOST_KEY_ALGS, 77 PROPOSAL_ENC_ALGS_CTOS, 78 PROPOSAL_ENC_ALGS_STOC, 79 PROPOSAL_MAC_ALGS_CTOS, 80 PROPOSAL_MAC_ALGS_STOC, 81 PROPOSAL_COMP_ALGS_CTOS, 82 PROPOSAL_COMP_ALGS_STOC, 83 PROPOSAL_LANG_CTOS, 84 PROPOSAL_LANG_STOC, 85 PROPOSAL_MAX 86 }; 87 88 enum kex_modes { 89 MODE_IN, 90 MODE_OUT, 91 MODE_MAX 92 }; 93 94 enum kex_exchange { 95 KEX_DH_GRP1_SHA1 = 1, 96 KEX_DH_GRP14_SHA1, 97 KEX_DH_GRP14_SHA256, 98 KEX_DH_GRP16_SHA512, 99 KEX_DH_GRP18_SHA512, 100 KEX_DH_GEX_SHA1, 101 KEX_DH_GEX_SHA256, 102 KEX_ECDH_SHA2, 103 KEX_C25519_SHA256, 104 KEX_KEM_SNTRUP761X25519_SHA512, 105 KEX_MAX 106 }; 107 108 /* kex->flags */ 109 #define KEX_INIT_SENT 0x0001 110 #define KEX_INITIAL 0x0002 111 #define KEX_HAS_PUBKEY_HOSTBOUND 0x0004 112 #define KEX_RSA_SHA2_256_SUPPORTED 0x0008 /* only set in server for now */ 113 #define KEX_RSA_SHA2_512_SUPPORTED 0x0010 /* only set in server for now */ 114 #define KEX_HAS_PING 0x0020 115 #define KEX_HAS_EXT_INFO_IN_AUTH 0x0040 116 117 struct sshenc { 118 char *name; 119 const struct sshcipher *cipher; 120 int enabled; 121 u_int key_len; 122 u_int iv_len; 123 u_int block_size; 124 u_char *key; 125 u_char *iv; 126 }; 127 struct sshcomp { 128 u_int type; 129 int enabled; 130 char *name; 131 }; 132 struct newkeys { 133 struct sshenc enc; 134 struct sshmac mac; 135 struct sshcomp comp; 136 }; 137 138 struct ssh; 139 struct sshbuf; 140 141 struct kex { 142 struct newkeys *newkeys[MODE_MAX]; 143 u_int we_need; 144 u_int dh_need; 145 int server; 146 char *name; 147 char *hostkey_alg; 148 int hostkey_type; 149 int hostkey_nid; 150 u_int kex_type; 151 char *server_sig_algs; 152 int ext_info_c; 153 int ext_info_s; 154 int kex_strict; 155 int ext_info_received; 156 struct sshbuf *my; 157 struct sshbuf *peer; 158 struct sshbuf *client_version; 159 struct sshbuf *server_version; 160 struct sshbuf *session_id; 161 struct sshbuf *initial_sig; 162 struct sshkey *initial_hostkey; 163 sig_atomic_t done; 164 u_int flags; 165 int hash_alg; 166 int ec_nid; 167 char *failed_choice; 168 int (*verify_host_key)(struct sshkey *, struct ssh *); 169 struct sshkey *(*load_host_public_key)(int, int, struct ssh *); 170 struct sshkey *(*load_host_private_key)(int, int, struct ssh *); 171 int (*host_key_index)(struct sshkey *, int, struct ssh *); 172 int (*sign)(struct ssh *, struct sshkey *, struct sshkey *, 173 u_char **, size_t *, const u_char *, size_t, const char *); 174 int (*kex[KEX_MAX])(struct ssh *); 175 /* kex specific state */ 176 DH *dh; /* DH */ 177 u_int min, max, nbits; /* GEX */ 178 EC_KEY *ec_client_key; /* ECDH */ 179 const EC_GROUP *ec_group; /* ECDH */ 180 u_char c25519_client_key[CURVE25519_SIZE]; /* 25519 + KEM */ 181 u_char c25519_client_pubkey[CURVE25519_SIZE]; /* 25519 */ 182 u_char sntrup761_client_key[crypto_kem_sntrup761_SECRETKEYBYTES]; /* KEM */ 183 struct sshbuf *client_pub; 184 }; 185 186 int kex_name_valid(const char *); 187 u_int kex_type_from_name(const char *); 188 int kex_hash_from_name(const char *); 189 int kex_nid_from_name(const char *); 190 int kex_names_valid(const char *); 191 char *kex_alg_list(char); 192 char *kex_names_cat(const char *, const char *); 193 int kex_has_any_alg(const char *, const char *); 194 int kex_assemble_names(char **, const char *, const char *); 195 void kex_proposal_populate_entries(struct ssh *, char *prop[PROPOSAL_MAX], 196 const char *, const char *, const char *, const char *, const char *); 197 void kex_proposal_free_entries(char *prop[PROPOSAL_MAX]); 198 199 int kex_exchange_identification(struct ssh *, int, const char *); 200 201 struct kex *kex_new(void); 202 int kex_ready(struct ssh *, char *[PROPOSAL_MAX]); 203 int kex_setup(struct ssh *, char *[PROPOSAL_MAX]); 204 void kex_free_newkeys(struct newkeys *); 205 void kex_free(struct kex *); 206 207 int kex_buf2prop(struct sshbuf *, int *, char ***); 208 int kex_prop2buf(struct sshbuf *, char *proposal[PROPOSAL_MAX]); 209 void kex_prop_free(char **); 210 int kex_load_hostkey(struct ssh *, struct sshkey **, struct sshkey **); 211 int kex_verify_host_key(struct ssh *, struct sshkey *); 212 213 int kex_send_kexinit(struct ssh *); 214 int kex_input_kexinit(int, u_int32_t, struct ssh *); 215 int kex_input_ext_info(int, u_int32_t, struct ssh *); 216 int kex_protocol_error(int, u_int32_t, struct ssh *); 217 int kex_derive_keys(struct ssh *, u_char *, u_int, const struct sshbuf *); 218 int kex_send_newkeys(struct ssh *); 219 int kex_start_rekex(struct ssh *); 220 int kex_server_update_ext_info(struct ssh *); 221 void kex_set_server_sig_algs(struct ssh *, const char *); 222 223 int kexgex_client(struct ssh *); 224 int kexgex_server(struct ssh *); 225 int kex_gen_client(struct ssh *); 226 int kex_gen_server(struct ssh *); 227 228 int kex_dh_keypair(struct kex *); 229 int kex_dh_enc(struct kex *, const struct sshbuf *, struct sshbuf **, 230 struct sshbuf **); 231 int kex_dh_dec(struct kex *, const struct sshbuf *, struct sshbuf **); 232 233 int kex_ecdh_keypair(struct kex *); 234 int kex_ecdh_enc(struct kex *, const struct sshbuf *, struct sshbuf **, 235 struct sshbuf **); 236 int kex_ecdh_dec(struct kex *, const struct sshbuf *, struct sshbuf **); 237 238 int kex_c25519_keypair(struct kex *); 239 int kex_c25519_enc(struct kex *, const struct sshbuf *, struct sshbuf **, 240 struct sshbuf **); 241 int kex_c25519_dec(struct kex *, const struct sshbuf *, struct sshbuf **); 242 243 int kex_kem_sntrup761x25519_keypair(struct kex *); 244 int kex_kem_sntrup761x25519_enc(struct kex *, const struct sshbuf *, 245 struct sshbuf **, struct sshbuf **); 246 int kex_kem_sntrup761x25519_dec(struct kex *, const struct sshbuf *, 247 struct sshbuf **); 248 249 int kex_dh_keygen(struct kex *); 250 int kex_dh_compute_key(struct kex *, BIGNUM *, struct sshbuf *); 251 252 int kexgex_hash(int, const struct sshbuf *, const struct sshbuf *, 253 const struct sshbuf *, const struct sshbuf *, const struct sshbuf *, 254 int, int, int, 255 const BIGNUM *, const BIGNUM *, const BIGNUM *, 256 const BIGNUM *, const u_char *, size_t, 257 u_char *, size_t *); 258 259 void kexc25519_keygen(u_char key[CURVE25519_SIZE], u_char pub[CURVE25519_SIZE]) 260 __attribute__((__bounded__(__minbytes__, 1, CURVE25519_SIZE))) 261 __attribute__((__bounded__(__minbytes__, 2, CURVE25519_SIZE))); 262 int kexc25519_shared_key(const u_char key[CURVE25519_SIZE], 263 const u_char pub[CURVE25519_SIZE], struct sshbuf *out) 264 __attribute__((__bounded__(__minbytes__, 1, CURVE25519_SIZE))) 265 __attribute__((__bounded__(__minbytes__, 2, CURVE25519_SIZE))); 266 int kexc25519_shared_key_ext(const u_char key[CURVE25519_SIZE], 267 const u_char pub[CURVE25519_SIZE], struct sshbuf *out, int) 268 __attribute__((__bounded__(__minbytes__, 1, CURVE25519_SIZE))) 269 __attribute__((__bounded__(__minbytes__, 2, CURVE25519_SIZE))); 270 271 #if defined(DEBUG_KEX) || defined(DEBUG_KEXDH) || defined(DEBUG_KEXECDH) 272 void dump_digest(const char *, const u_char *, int); 273 #endif 274 275 #if !defined(WITH_OPENSSL) || !defined(OPENSSL_HAS_ECC) 276 # undef EC_KEY 277 # undef EC_GROUP 278 # undef EC_POINT 279 #endif 280 281 #endif 282