xref: /freebsd/contrib/wpa/src/eap_peer/eap_tls_common.h (revision 13ea0450a9c8742119d36f3bf8f47accdce46e54)
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  */
15 struct 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 (EAP_TYPE_TLS/PEAP/TTLS/FAST)
74 	 */
75 	u8 eap_type;
76 
77 	/**
78 	 * tls_v13 - Whether TLS v1.3 or newer is used
79 	 */
80 	int tls_v13;
81 };
82 
83 
84 /* EAP TLS Flags */
85 #define EAP_TLS_FLAGS_LENGTH_INCLUDED 0x80
86 #define EAP_TLS_FLAGS_MORE_FRAGMENTS 0x40
87 #define EAP_TLS_FLAGS_START 0x20
88 #define EAP_TLS_VERSION_MASK 0x07
89 
90  /* could be up to 128 bytes, but only the first 64 bytes are used */
91 #define EAP_TLS_KEY_LEN 64
92 
93 /* dummy type used as a flag for UNAUTH-TLS */
94 #define EAP_UNAUTH_TLS_TYPE 255
95 #define EAP_WFA_UNAUTH_TLS_TYPE 254
96 
97 
98 int eap_peer_tls_ssl_init(struct eap_sm *sm, struct eap_ssl_data *data,
99 			  struct eap_peer_config *config, u8 eap_type);
100 void eap_peer_tls_ssl_deinit(struct eap_sm *sm, struct eap_ssl_data *data);
101 u8 * eap_peer_tls_derive_key(struct eap_sm *sm, struct eap_ssl_data *data,
102 			     const char *label, size_t len);
103 u8 * eap_peer_tls_derive_session_id(struct eap_sm *sm,
104 				    struct eap_ssl_data *data, u8 eap_type,
105 				    size_t *len);
106 int eap_peer_tls_process_helper(struct eap_sm *sm, struct eap_ssl_data *data,
107 				EapType eap_type, int peap_version,
108 				u8 id, const struct wpabuf *in_data,
109 				struct wpabuf **out_data);
110 struct wpabuf * eap_peer_tls_build_ack(u8 id, EapType eap_type,
111 				       int peap_version);
112 int eap_peer_tls_reauth_init(struct eap_sm *sm, struct eap_ssl_data *data);
113 int eap_peer_tls_status(struct eap_sm *sm, struct eap_ssl_data *data,
114 			char *buf, size_t buflen, int verbose);
115 const u8 * eap_peer_tls_process_init(struct eap_sm *sm,
116 				     struct eap_ssl_data *data,
117 				     EapType eap_type,
118 				     struct eap_method_ret *ret,
119 				     const struct wpabuf *reqData,
120 				     size_t *len, u8 *flags);
121 void eap_peer_tls_reset_input(struct eap_ssl_data *data);
122 void eap_peer_tls_reset_output(struct eap_ssl_data *data);
123 int eap_peer_tls_decrypt(struct eap_sm *sm, struct eap_ssl_data *data,
124 			 const struct wpabuf *in_data,
125 			 struct wpabuf **in_decrypted);
126 int eap_peer_tls_encrypt(struct eap_sm *sm, struct eap_ssl_data *data,
127 			 EapType eap_type, int peap_version, u8 id,
128 			 const struct wpabuf *in_data,
129 			 struct wpabuf **out_data);
130 int eap_peer_select_phase2_methods(struct eap_peer_config *config,
131 				   const char *prefix,
132 				   struct eap_method_type **types,
133 				   size_t *num_types);
134 int eap_peer_tls_phase2_nak(struct eap_method_type *types, size_t num_types,
135 			    struct eap_hdr *hdr, struct wpabuf **resp);
136 
137 #endif /* EAP_TLS_COMMON_H */
138