[openssh.git] / kex.h

/* $OpenBSD: kex.h,v 1.48 2009/10/24 11:13:54 andreas Exp $ */

/*
 * Copyright (c) 2000, 2001 Markus Friedl.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef KEX_H
#define KEX_H

#include <signal.h>
#include <openssl/evp.h>
#include <openssl/hmac.h>

#define KEX_COOKIE_LEN	16

#define	KEX_DH1			"diffie-hellman-group1-sha1"
#define	KEX_DH14		"diffie-hellman-group14-sha1"
#define	KEX_DHGEX_SHA1		"diffie-hellman-group-exchange-sha1"
#define	KEX_DHGEX_SHA256	"diffie-hellman-group-exchange-sha256"
#define	KEX_RESUME		"resume@appgate.com"

#define COMP_NONE	0
#define COMP_ZLIB	1
#define COMP_DELAYED	2

enum kex_init_proposals {
	PROPOSAL_KEX_ALGS,
	PROPOSAL_SERVER_HOST_KEY_ALGS,
	PROPOSAL_ENC_ALGS_CTOS,
	PROPOSAL_ENC_ALGS_STOC,
	PROPOSAL_MAC_ALGS_CTOS,
	PROPOSAL_MAC_ALGS_STOC,
	PROPOSAL_COMP_ALGS_CTOS,
	PROPOSAL_COMP_ALGS_STOC,
	PROPOSAL_LANG_CTOS,
	PROPOSAL_LANG_STOC,
	PROPOSAL_MAX
};

enum kex_modes {
	MODE_IN,
	MODE_OUT,
	MODE_MAX
};

enum kex_exchange {
	KEX_DH_GRP1_SHA1,
	KEX_DH_GRP14_SHA1,
	KEX_DH_GEX_SHA1,
	KEX_DH_GEX_SHA256,
	KEX_MAX
};

#define KEX_INIT_SENT	0x0001

typedef struct Kex Kex;
typedef struct Mac Mac;
typedef struct Comp Comp;
typedef struct Enc Enc;
typedef struct Newkeys Newkeys;

struct Enc {
	char	*name;
	Cipher	*cipher;
	int	enabled;
	u_int	key_len;
	u_int	block_size;
	u_char	*key;
	u_char	*iv;
};
struct Mac {
	char	*name;
	int	enabled;
	u_int	mac_len;
	u_char	*key;
	u_int	key_len;
	int	type;
	const EVP_MD	*evp_md;
	HMAC_CTX	evp_ctx;
	struct umac_ctx *umac_ctx;
};
struct Comp {
	int	type;
	int	enabled;
	char	*name;
};
struct Newkeys {
	Enc	enc;
	Mac	mac;
	Comp	comp;
};
struct Kex {
	u_char	*session_id;
	u_int	session_id_len;
	Newkeys	*newkeys[MODE_MAX];
	u_int	we_need;
	int	server;
	char	*name;
	int	hostkey_type;
	int	kex_type;
	int	roaming;
	Buffer	my;
	Buffer	peer;
	sig_atomic_t done;
	int	flags;
	const EVP_MD *evp_md;
	char	*client_version_string;
	char	*server_version_string;
	int	(*verify_host_key)(Key *);
	Key	*(*load_host_key)(int);
	int	(*host_key_index)(Key *);
	void	(*kex[KEX_MAX])(Kex *);
};

Kex	*kex_setup(char *[PROPOSAL_MAX]);
void	 kex_finish(Kex *);

void	 kex_send_kexinit(Kex *);
void	 kex_input_kexinit(int, u_int32_t, void *);
void	 kex_derive_keys(Kex *, u_char *, u_int, BIGNUM *);

Newkeys *kex_get_newkeys(int);

void	 kexdh_client(Kex *);
void	 kexdh_server(Kex *);
void	 kexgex_client(Kex *);
void	 kexgex_server(Kex *);

void
kex_dh_hash(char *, char *, char *, int, char *, int, u_char *, int,
    BIGNUM *, BIGNUM *, BIGNUM *, u_char **, u_int *);
void
kexgex_hash(const EVP_MD *, char *, char *, char *, int, char *,
    int, u_char *, int, int, int, int, BIGNUM *, BIGNUM *, BIGNUM *,
    BIGNUM *, BIGNUM *, u_char **, u_int *);

void
derive_ssh1_session_id(BIGNUM *, BIGNUM *, u_int8_t[8], u_int8_t[16]);

#if defined(DEBUG_KEX) || defined(DEBUG_KEXDH)
void	dump_digest(char *, u_char *, int);
#endif

#endif
Commit	Line	Data
d8b0d145	1	/* $OpenBSD: kex.h,v 1.48 2009/10/24 11:13:54 andreas Exp $ */
23c2a7a5	2
7e7327a1	3	/*
a96070d4	4	* Copyright (c) 2000, 2001 Markus Friedl. All rights reserved.
7e7327a1	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.
7e7327a1	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
0ca1dcaf	29	#include <signal.h>
b2552997	30	#include <openssl/evp.h>
a3de8da1	31	#include <openssl/hmac.h>
519fc2b7	32
87db7000	33	#define KEX_COOKIE_LEN 16
87db7000	34
47e5dc72	35	#define KEX_DH1 "diffie-hellman-group1-sha1"
	36	#define KEX_DH14 "diffie-hellman-group14-sha1"
	37	#define KEX_DHGEX_SHA1 "diffie-hellman-group-exchange-sha1"
2ff8003a	38	#define KEX_DHGEX_SHA256 "diffie-hellman-group-exchange-sha256"
d8b0d145	39	#define KEX_RESUME "resume@appgate.com"
7e7327a1	40
07200973	41	#define COMP_NONE 0
	42	#define COMP_ZLIB 1
	43	#define COMP_DELAYED 2
	44
7e7327a1	45	enum kex_init_proposals {
	46	PROPOSAL_KEX_ALGS,
	47	PROPOSAL_SERVER_HOST_KEY_ALGS,
	48	PROPOSAL_ENC_ALGS_CTOS,
	49	PROPOSAL_ENC_ALGS_STOC,
	50	PROPOSAL_MAC_ALGS_CTOS,
	51	PROPOSAL_MAC_ALGS_STOC,
	52	PROPOSAL_COMP_ALGS_CTOS,
	53	PROPOSAL_COMP_ALGS_STOC,
	54	PROPOSAL_LANG_CTOS,
	55	PROPOSAL_LANG_STOC,
	56	PROPOSAL_MAX
	57	};
	58
	59	enum kex_modes {
	60	MODE_IN,
	61	MODE_OUT,
	62	MODE_MAX
	63	};
	64
94ec8c6b	65	enum kex_exchange {
98a58eda	66	KEX_DH_GRP1_SHA1,
41e5bd9a	67	KEX_DH_GRP14_SHA1,
98a58eda	68	KEX_DH_GEX_SHA1,
2ff8003a	69	KEX_DH_GEX_SHA256,
98a58eda	70	KEX_MAX
94ec8c6b	71	};
2b87da3b	72
d1ac6175	73	#define KEX_INIT_SENT 0x0001
d1ac6175	74
7e7327a1	75	typedef struct Kex Kex;
	76	typedef struct Mac Mac;
	77	typedef struct Comp Comp;
	78	typedef struct Enc Enc;
d1ac6175	79	typedef struct Newkeys Newkeys;
7e7327a1	80
7e7327a1	81	struct Enc {
d1ac6175	82	char *name;
	83	Cipher *cipher;
	84	int enabled;
3ee832e5	85	u_int key_len;
3ee832e5	86	u_int block_size;
1e3b8b07	87	u_char *key;
1e3b8b07	88	u_char *iv;
7e7327a1	89	};
7e7327a1	90	struct Mac {
d1ac6175	91	char *name;
d1ac6175	92	int enabled;
2ceb8101	93	u_int mac_len;
1e3b8b07	94	u_char *key;
2ceb8101	95	u_int key_len;
f444d0f8	96	int type;
	97	const EVP_MD *evp_md;
	98	HMAC_CTX evp_ctx;
	99	struct umac_ctx *umac_ctx;
7e7327a1	100	};
7e7327a1	101	struct Comp {
d1ac6175	102	int type;
	103	int enabled;
	104	char *name;
	105	};
	106	struct Newkeys {
	107	Enc enc;
	108	Mac mac;
	109	Comp comp;
7e7327a1	110	};
7e7327a1	111	struct Kex {
d1ac6175	112	u_char *session_id;
661e45a0	113	u_int session_id_len;
c422989b	114	Newkeys *newkeys[MODE_MAX];
2ceb8101	115	u_int we_need;
d1ac6175	116	int server;
	117	char *name;
	118	int hostkey_type;
	119	int kex_type;
d8b0d145	120	int roaming;
d1ac6175	121	Buffer my;
d1ac6175	122	Buffer peer;
50394f26	123	sig_atomic_t done;
d1ac6175	124	int flags;
47e5dc72	125	const EVP_MD *evp_md;
d1ac6175	126	char *client_version_string;
d1ac6175	127	char *server_version_string;
2a1e4639	128	int (verify_host_key)(Key );
2a1e4639	129	Key (load_host_key)(int);
1853d1ef	130	int (host_key_index)(Key );
98a58eda	131	void (kex[KEX_MAX])(Kex );
7e7327a1	132	};
7e7327a1	133
2a1e4639	134	Kex kex_setup(char [PROPOSAL_MAX]);
255cabd9	135	void kex_finish(Kex *);
d8ee838b	136
255cabd9	137	void kex_send_kexinit(Kex *);
7819b5c3	138	void kex_input_kexinit(int, u_int32_t, void *);
47e5dc72	139	void kex_derive_keys(Kex , u_char , u_int, BIGNUM *);
7e7327a1	140
2a1e4639	141	Newkeys *kex_get_newkeys(int);
d1ac6175	142
98a58eda	143	void kexdh_client(Kex *);
	144	void kexdh_server(Kex *);
	145	void kexgex_client(Kex *);
	146	void kexgex_server(Kex *);
	147
47e5dc72	148	void
98a58eda	149	kex_dh_hash(char , char , char , int, char , int, u_char *, int,
47e5dc72	150	BIGNUM , BIGNUM , BIGNUM , u_char , u_int );
	151	void
	152	kexgex_hash(const EVP_MD , char , char , char , int, char *,
0e03e3d0	153	int, u_char , int, int, int, int, BIGNUM , BIGNUM , BIGNUM ,
47e5dc72	154	BIGNUM , BIGNUM , u_char *, u_int );
98a58eda	155
7e9a0e92	156	void
	157	derive_ssh1_session_id(BIGNUM , BIGNUM , u_int8_t[8], u_int8_t[16]);
	158
a5c9ffdb	159	#if defined(DEBUG_KEX) \|\| defined(DEBUG_KEXDH)
2a1e4639	160	void dump_digest(char , u_char , int);
a5c9ffdb	161	#endif
7e7327a1	162
7e7327a1	163	#endif