eap_tls_common.h revision 351611 
1/*
2 * EAP peer: EAP-TLS/PEAP/TTLS/FAST common functions
3 * Copyright (c) 2004-2009, 2012, Jouni Malinen <j@w1.fi>
4 *
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
7 */
8
9#ifndef EAP_TLS_COMMON_H
10#define EAP_TLS_COMMON_H
11
12/**
13 * struct eap_ssl_data - TLS data for EAP methods
14 */
15struct eap_ssl_data {
16	/**
17	 * conn - TLS connection context data from tls_connection_init()
18	 */
19	struct tls_connection *conn;
20
21	/**
22	 * tls_out - TLS message to be sent out in fragments
23	 */
24	struct wpabuf *tls_out;
25
26	/**
27	 * tls_out_pos - The current position in the outgoing TLS message
28	 */
29	size_t tls_out_pos;
30
31	/**
32	 * tls_out_limit - Maximum fragment size for outgoing TLS messages
33	 */
34	size_t tls_out_limit;
35
36	/**
37	 * tls_in - Received TLS message buffer for re-assembly
38	 */
39	struct wpabuf *tls_in;
40
41	/**
42	 * tls_in_left - Number of remaining bytes in the incoming TLS message
43	 */
44	size_t tls_in_left;
45
46	/**
47	 * tls_in_total - Total number of bytes in the incoming TLS message
48	 */
49	size_t tls_in_total;
50
51	/**
52	 * phase2 - Whether this TLS connection is used in EAP phase 2 (tunnel)
53	 */
54	int phase2;
55
56	/**
57	 * include_tls_length - Whether the TLS length field is included even
58	 * if the TLS data is not fragmented
59	 */
60	int include_tls_length;
61
62	/**
63	 * eap - EAP state machine allocated with eap_peer_sm_init()
64	 */
65	struct eap_sm *eap;
66
67	/**
68	 * ssl_ctx - TLS library context to use for the connection
69	 */
70	void *ssl_ctx;
71
72	/**
73	 * eap_type - EAP method used in Phase 1
74	 * (EAP_TYPE_TLS/PEAP/TTLS/FAST/TEAP)
75	 */
76	u8 eap_type;
77
78	/**
79	 * tls_v13 - Whether TLS v1.3 or newer is used
80	 */
81	int tls_v13;
82};
83
84
85/* EAP TLS Flags */
86#define EAP_TLS_FLAGS_LENGTH_INCLUDED 0x80
87#define EAP_TLS_FLAGS_MORE_FRAGMENTS 0x40
88#define EAP_TLS_FLAGS_START 0x20
89#define EAP_TEAP_FLAGS_OUTER_TLV_LEN 0x10
90#define EAP_TLS_VERSION_MASK 0x07
91
92 /* could be up to 128 bytes, but only the first 64 bytes are used */
93#define EAP_TLS_KEY_LEN 64
94
95/* dummy type used as a flag for UNAUTH-TLS */
96#define EAP_UNAUTH_TLS_TYPE 255
97#define EAP_WFA_UNAUTH_TLS_TYPE 254
98
99
100int eap_peer_tls_ssl_init(struct eap_sm *sm, struct eap_ssl_data *data,
101			  struct eap_peer_config *config, u8 eap_type);
102void eap_peer_tls_ssl_deinit(struct eap_sm *sm, struct eap_ssl_data *data);
103u8 * eap_peer_tls_derive_key(struct eap_sm *sm, struct eap_ssl_data *data,
104			     const char *label, const u8 *context,
105			     size_t context_len, size_t len);
106u8 * eap_peer_tls_derive_session_id(struct eap_sm *sm,
107				    struct eap_ssl_data *data, u8 eap_type,
108				    size_t *len);
109int eap_peer_tls_process_helper(struct eap_sm *sm, struct eap_ssl_data *data,
110				EapType eap_type, int peap_version,
111				u8 id, const struct wpabuf *in_data,
112				struct wpabuf **out_data);
113struct wpabuf * eap_peer_tls_build_ack(u8 id, EapType eap_type,
114				       int peap_version);
115int eap_peer_tls_reauth_init(struct eap_sm *sm, struct eap_ssl_data *data);
116int eap_peer_tls_status(struct eap_sm *sm, struct eap_ssl_data *data,
117			char *buf, size_t buflen, int verbose);
118const u8 * eap_peer_tls_process_init(struct eap_sm *sm,
119				     struct eap_ssl_data *data,
120				     EapType eap_type,
121				     struct eap_method_ret *ret,
122				     const struct wpabuf *reqData,
123				     size_t *len, u8 *flags);
124void eap_peer_tls_reset_input(struct eap_ssl_data *data);
125void eap_peer_tls_reset_output(struct eap_ssl_data *data);
126int eap_peer_tls_decrypt(struct eap_sm *sm, struct eap_ssl_data *data,
127			 const struct wpabuf *in_data,
128			 struct wpabuf **in_decrypted);
129int eap_peer_tls_encrypt(struct eap_sm *sm, struct eap_ssl_data *data,
130			 EapType eap_type, int peap_version, u8 id,
131			 const struct wpabuf *in_data,
132			 struct wpabuf **out_data);
133int eap_peer_select_phase2_methods(struct eap_peer_config *config,
134				   const char *prefix,
135				   struct eap_method_type **types,
136				   size_t *num_types);
137int eap_peer_tls_phase2_nak(struct eap_method_type *types, size_t num_types,
138			    struct eap_hdr *hdr, struct wpabuf **resp);
139
140#endif /* EAP_TLS_COMMON_H */
141