Annotation of src/usr.bin/ssh/kex.h, Revision 1.108
1.108 ! djm 1: /* $OpenBSD: kex.h,v 1.107 2019/01/23 00:30:41 djm Exp $ */
1.12 niklas 2:
1.1 markus 3: /*
1.24 markus 4: * Copyright (c) 2000, 2001 Markus Friedl. All rights reserved.
1.1 markus 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:
1.65 markus 29: #include "mac.h"
1.99 djm 30: #include "crypto_api.h"
1.69 markus 31:
1.47 andreas 32: #define KEX_COOKIE_LEN 16
1.14 markus 33:
1.79 djm 34: #define KEX_DH1 "diffie-hellman-group1-sha1"
35: #define KEX_DH14_SHA1 "diffie-hellman-group14-sha1"
36: #define KEX_DH14_SHA256 "diffie-hellman-group14-sha256"
37: #define KEX_DH16_SHA512 "diffie-hellman-group16-sha512"
38: #define KEX_DH18_SHA512 "diffie-hellman-group18-sha512"
39: #define KEX_DHGEX_SHA1 "diffie-hellman-group-exchange-sha1"
40: #define KEX_DHGEX_SHA256 "diffie-hellman-group-exchange-sha256"
41: #define KEX_ECDH_SHA2_NISTP256 "ecdh-sha2-nistp256"
42: #define KEX_ECDH_SHA2_NISTP384 "ecdh-sha2-nistp384"
43: #define KEX_ECDH_SHA2_NISTP521 "ecdh-sha2-nistp521"
44: #define KEX_CURVE25519_SHA256 "curve25519-sha256"
45: #define KEX_CURVE25519_SHA256_OLD "curve25519-sha256@libssh.org"
1.99 djm 46: #define KEX_SNTRUP4591761X25519_SHA512 "sntrup4591761x25519-sha512@tinyssh.org"
1.37 markus 47:
48: #define COMP_NONE 0
1.90 sf 49: /* pre-auth compression (COMP_ZLIB) is only supported in the client */
1.87 sf 50: #define COMP_ZLIB 1
1.88 sf 51: #define COMP_DELAYED 2
1.1 markus 52:
1.69 markus 53: #define CURVE25519_SIZE 32
54:
1.1 markus 55: enum kex_init_proposals {
56: PROPOSAL_KEX_ALGS,
57: PROPOSAL_SERVER_HOST_KEY_ALGS,
58: PROPOSAL_ENC_ALGS_CTOS,
59: PROPOSAL_ENC_ALGS_STOC,
60: PROPOSAL_MAC_ALGS_CTOS,
61: PROPOSAL_MAC_ALGS_STOC,
62: PROPOSAL_COMP_ALGS_CTOS,
63: PROPOSAL_COMP_ALGS_STOC,
64: PROPOSAL_LANG_CTOS,
65: PROPOSAL_LANG_STOC,
66: PROPOSAL_MAX
67: };
68:
69: enum kex_modes {
70: MODE_IN,
71: MODE_OUT,
72: MODE_MAX
73: };
74:
1.5 provos 75: enum kex_exchange {
1.33 markus 76: KEX_DH_GRP1_SHA1,
1.35 djm 77: KEX_DH_GRP14_SHA1,
1.78 djm 78: KEX_DH_GRP14_SHA256,
79: KEX_DH_GRP16_SHA512,
80: KEX_DH_GRP18_SHA512,
1.33 markus 81: KEX_DH_GEX_SHA1,
1.39 djm 82: KEX_DH_GEX_SHA256,
1.50 djm 83: KEX_ECDH_SHA2,
1.57 markus 84: KEX_C25519_SHA256,
1.99 djm 85: KEX_KEM_SNTRUP4591761X25519_SHA512,
1.33 markus 86: KEX_MAX
1.5 provos 87: };
1.13 stevesk 88:
1.19 markus 89: #define KEX_INIT_SENT 0x0001
1.92 djm 90: #define KEX_INITIAL 0x0002
1.19 markus 91:
1.67 markus 92: struct sshenc {
1.19 markus 93: char *name;
1.67 markus 94: const struct sshcipher *cipher;
1.19 markus 95: int enabled;
1.29 markus 96: u_int key_len;
1.54 markus 97: u_int iv_len;
1.29 markus 98: u_int block_size;
1.10 markus 99: u_char *key;
100: u_char *iv;
1.1 markus 101: };
1.67 markus 102: struct sshcomp {
103: u_int type;
1.19 markus 104: int enabled;
105: char *name;
106: };
1.67 markus 107: struct newkeys {
108: struct sshenc enc;
109: struct sshmac mac;
1.69 markus 110: struct sshcomp comp;
1.1 markus 111: };
1.69 markus 112:
113: struct ssh;
114:
1.67 markus 115: struct kex {
1.19 markus 116: u_char *session_id;
1.67 markus 117: size_t session_id_len;
118: struct newkeys *newkeys[MODE_MAX];
1.36 djm 119: u_int we_need;
1.61 dtucker 120: u_int dh_need;
1.19 markus 121: int server;
122: char *name;
1.74 markus 123: char *hostkey_alg;
1.19 markus 124: int hostkey_type;
1.70 djm 125: int hostkey_nid;
1.69 markus 126: u_int kex_type;
1.84 djm 127: char *server_sig_algs;
1.74 markus 128: int ext_info_c;
1.67 markus 129: struct sshbuf *my;
130: struct sshbuf *peer;
1.93 djm 131: struct sshbuf *client_version;
132: struct sshbuf *server_version;
1.42 djm 133: sig_atomic_t done;
1.69 markus 134: u_int flags;
1.59 djm 135: int hash_alg;
1.55 djm 136: int ec_nid;
1.72 djm 137: char *failed_choice;
1.69 markus 138: int (*verify_host_key)(struct sshkey *, struct ssh *);
1.70 djm 139: struct sshkey *(*load_host_public_key)(int, int, struct ssh *);
140: struct sshkey *(*load_host_private_key)(int, int, struct ssh *);
1.71 djm 141: int (*host_key_index)(struct sshkey *, int, struct ssh *);
1.94 djm 142: int (*sign)(struct ssh *, struct sshkey *, struct sshkey *,
143: u_char **, size_t *, const u_char *, size_t, const char *);
1.69 markus 144: int (*kex[KEX_MAX])(struct ssh *);
145: /* kex specific state */
146: DH *dh; /* DH */
147: u_int min, max, nbits; /* GEX */
148: EC_KEY *ec_client_key; /* ECDH */
149: const EC_GROUP *ec_group; /* ECDH */
1.99 djm 150: u_char c25519_client_key[CURVE25519_SIZE]; /* 25519 + KEM */
1.69 markus 151: u_char c25519_client_pubkey[CURVE25519_SIZE]; /* 25519 */
1.99 djm 152: u_char sntrup4591761_client_key[crypto_kem_sntrup4591761_SECRETKEYBYTES]; /* KEM */
1.106 djm 153: struct sshbuf *client_pub;
1.1 markus 154: };
1.52 djm 155:
156: int kex_names_valid(const char *);
1.58 dtucker 157: char *kex_alg_list(char);
1.73 djm 158: char *kex_names_cat(const char *, const char *);
1.85 djm 159: int kex_assemble_names(char **, const char *, const char *);
1.1 markus 160:
1.93 djm 161: int kex_exchange_identification(struct ssh *, int, const char *);
162:
163: struct kex *kex_new(void);
164: int kex_ready(struct ssh *, char *[PROPOSAL_MAX]);
1.69 markus 165: int kex_setup(struct ssh *, char *[PROPOSAL_MAX]);
166: void kex_free_newkeys(struct newkeys *);
167: void kex_free(struct kex *);
168:
169: int kex_buf2prop(struct sshbuf *, int *, char ***);
170: int kex_prop2buf(struct sshbuf *, char *proposal[PROPOSAL_MAX]);
171: void kex_prop_free(char **);
1.97 djm 172: int kex_load_hostkey(struct ssh *, struct sshkey **, struct sshkey **);
1.98 djm 173: int kex_verify_host_key(struct ssh *, struct sshkey *);
1.20 markus 174:
1.69 markus 175: int kex_send_kexinit(struct ssh *);
1.83 markus 176: int kex_input_kexinit(int, u_int32_t, struct ssh *);
177: int kex_input_ext_info(int, u_int32_t, struct ssh *);
1.69 markus 178: int kex_derive_keys(struct ssh *, u_char *, u_int, const struct sshbuf *);
179: int kex_send_newkeys(struct ssh *);
1.76 djm 180: int kex_start_rekex(struct ssh *);
1.69 markus 181:
182: int kexgex_client(struct ssh *);
183: int kexgex_server(struct ssh *);
1.105 djm 184: int kex_gen_client(struct ssh *);
185: int kex_gen_server(struct ssh *);
1.100 djm 186:
1.101 djm 187: int kex_dh_keypair(struct kex *);
1.104 djm 188: int kex_dh_enc(struct kex *, const struct sshbuf *, struct sshbuf **,
1.101 djm 189: struct sshbuf **);
1.104 djm 190: int kex_dh_dec(struct kex *, const struct sshbuf *, struct sshbuf **);
1.101 djm 191:
1.102 djm 192: int kex_ecdh_keypair(struct kex *);
1.104 djm 193: int kex_ecdh_enc(struct kex *, const struct sshbuf *, struct sshbuf **,
1.102 djm 194: struct sshbuf **);
1.104 djm 195: int kex_ecdh_dec(struct kex *, const struct sshbuf *, struct sshbuf **);
1.102 djm 196:
1.100 djm 197: int kex_c25519_keypair(struct kex *);
1.104 djm 198: int kex_c25519_enc(struct kex *, const struct sshbuf *, struct sshbuf **,
1.100 djm 199: struct sshbuf **);
1.104 djm 200: int kex_c25519_dec(struct kex *, const struct sshbuf *, struct sshbuf **);
1.99 djm 201:
202: int kex_kem_sntrup4591761x25519_keypair(struct kex *);
1.104 djm 203: int kex_kem_sntrup4591761x25519_enc(struct kex *, const struct sshbuf *,
1.99 djm 204: struct sshbuf **, struct sshbuf **);
1.104 djm 205: int kex_kem_sntrup4591761x25519_dec(struct kex *, const struct sshbuf *,
1.99 djm 206: struct sshbuf **);
1.69 markus 207:
1.95 djm 208: int kex_dh_keygen(struct kex *);
1.96 djm 209: int kex_dh_compute_key(struct kex *, BIGNUM *, struct sshbuf *);
1.69 markus 210:
1.93 djm 211: int kexgex_hash(int, const struct sshbuf *, const struct sshbuf *,
1.107 djm 212: const struct sshbuf *, const struct sshbuf *, const struct sshbuf *,
1.69 markus 213: int, int, int,
214: const BIGNUM *, const BIGNUM *, const BIGNUM *,
1.96 djm 215: const BIGNUM *, const u_char *, size_t,
1.69 markus 216: u_char *, size_t *);
1.19 markus 217:
1.69 markus 218: void kexc25519_keygen(u_char key[CURVE25519_SIZE], u_char pub[CURVE25519_SIZE])
1.64 djm 219: __attribute__((__bounded__(__minbytes__, 1, CURVE25519_SIZE)))
220: __attribute__((__bounded__(__minbytes__, 2, CURVE25519_SIZE)));
1.69 markus 221: int kexc25519_shared_key(const u_char key[CURVE25519_SIZE],
222: const u_char pub[CURVE25519_SIZE], struct sshbuf *out)
1.64 djm 223: __attribute__((__bounded__(__minbytes__, 1, CURVE25519_SIZE)))
224: __attribute__((__bounded__(__minbytes__, 2, CURVE25519_SIZE)));
1.99 djm 225: int kexc25519_shared_key_ext(const u_char key[CURVE25519_SIZE],
226: const u_char pub[CURVE25519_SIZE], struct sshbuf *out, int)
227: __attribute__((__bounded__(__minbytes__, 1, CURVE25519_SIZE)))
228: __attribute__((__bounded__(__minbytes__, 2, CURVE25519_SIZE)));
1.18 markus 229:
1.50 djm 230: #if defined(DEBUG_KEX) || defined(DEBUG_KEXDH) || defined(DEBUG_KEXECDH)
1.99 djm 231: void dump_digest(const char *, const u_char *, int);
1.18 markus 232: #endif
1.1 markus 233:
234: #endif