18d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/*
28d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAP peer: EAP-TLS/PEAP/TTLS/FAST common functions
304949598a23f501be6eec21697465fd46a28840aDmitry Shmidt * Copyright (c) 2004-2009, 2012, Jouni Malinen <j@w1.fi>
48d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt *
5c5ec7f57ead87efa365800228aa0b09a12d9e6c4Dmitry Shmidt * This software may be distributed under the terms of the BSD license.
6c5ec7f57ead87efa365800228aa0b09a12d9e6c4Dmitry Shmidt * See README for more details.
78d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */
88d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
98d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#ifndef EAP_TLS_COMMON_H
108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define EAP_TLS_COMMON_H
118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/**
138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * struct eap_ssl_data - TLS data for EAP methods
148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */
158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct eap_ssl_data {
168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	/**
178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 * conn - TLS connection context data from tls_connection_init()
188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 */
198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	struct tls_connection *conn;
208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	/**
228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 * tls_out - TLS message to be sent out in fragments
238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 */
248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	struct wpabuf *tls_out;
258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	/**
278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 * tls_out_pos - The current position in the outgoing TLS message
288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 */
298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	size_t tls_out_pos;
308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	/**
328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 * tls_out_limit - Maximum fragment size for outgoing TLS messages
338d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 */
348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	size_t tls_out_limit;
358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	/**
378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 * tls_in - Received TLS message buffer for re-assembly
388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 */
398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	struct wpabuf *tls_in;
408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	/**
428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 * tls_in_left - Number of remaining bytes in the incoming TLS message
438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 */
448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	size_t tls_in_left;
458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
468d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	/**
478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 * tls_in_total - Total number of bytes in the incoming TLS message
488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 */
498d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	size_t tls_in_total;
508d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	/**
528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 * phase2 - Whether this TLS connection is used in EAP phase 2 (tunnel)
538d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 */
548d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	int phase2;
558d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
568d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	/**
578d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 * include_tls_length - Whether the TLS length field is included even
588d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 * if the TLS data is not fragmented
598d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 */
608d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	int include_tls_length;
618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
628d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	/**
638d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 * eap - EAP state machine allocated with eap_peer_sm_init()
648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	 */
658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt	struct eap_sm *eap;
6604949598a23f501be6eec21697465fd46a28840aDmitry Shmidt
6704949598a23f501be6eec21697465fd46a28840aDmitry Shmidt	/**
6804949598a23f501be6eec21697465fd46a28840aDmitry Shmidt	 * ssl_ctx - TLS library context to use for the connection
6904949598a23f501be6eec21697465fd46a28840aDmitry Shmidt	 */
7004949598a23f501be6eec21697465fd46a28840aDmitry Shmidt	void *ssl_ctx;
7161d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt
7261d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt	/**
7361d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt	 * eap_type - EAP method used in Phase 1 (EAP_TYPE_TLS/PEAP/TTLS/FAST)
7461d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt	 */
7561d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt	u8 eap_type;
768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt};
778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
798d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* EAP TLS Flags */
808d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define EAP_TLS_FLAGS_LENGTH_INCLUDED 0x80
818d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define EAP_TLS_FLAGS_MORE_FRAGMENTS 0x40
828d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define EAP_TLS_FLAGS_START 0x20
838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define EAP_TLS_VERSION_MASK 0x07
848d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /* could be up to 128 bytes, but only the first 64 bytes are used */
868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define EAP_TLS_KEY_LEN 64
878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
8861d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt/* dummy type used as a flag for UNAUTH-TLS */
8961d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt#define EAP_UNAUTH_TLS_TYPE 255
9061d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt
918d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
928d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint eap_peer_tls_ssl_init(struct eap_sm *sm, struct eap_ssl_data *data,
9361d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt			  struct eap_peer_config *config, u8 eap_type);
948d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_peer_tls_ssl_deinit(struct eap_sm *sm, struct eap_ssl_data *data);
958d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtu8 * eap_peer_tls_derive_key(struct eap_sm *sm, struct eap_ssl_data *data,
968d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt			     const char *label, size_t len);
97f86232838cf712377867cb42417c1613ab5dc425Dmitry Shmidtu8 * eap_peer_tls_derive_session_id(struct eap_sm *sm,
98f86232838cf712377867cb42417c1613ab5dc425Dmitry Shmidt				    struct eap_ssl_data *data, u8 eap_type,
99f86232838cf712377867cb42417c1613ab5dc425Dmitry Shmidt				    size_t *len);
1008d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint eap_peer_tls_process_helper(struct eap_sm *sm, struct eap_ssl_data *data,
1018d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt				EapType eap_type, int peap_version,
1028d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt				u8 id, const u8 *in_data, size_t in_len,
1038d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt				struct wpabuf **out_data);
1048d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct wpabuf * eap_peer_tls_build_ack(u8 id, EapType eap_type,
1058d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt				       int peap_version);
1068d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint eap_peer_tls_reauth_init(struct eap_sm *sm, struct eap_ssl_data *data);
1078d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint eap_peer_tls_status(struct eap_sm *sm, struct eap_ssl_data *data,
1088d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt			char *buf, size_t buflen, int verbose);
1098d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtconst u8 * eap_peer_tls_process_init(struct eap_sm *sm,
1108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt				     struct eap_ssl_data *data,
1118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt				     EapType eap_type,
1128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt				     struct eap_method_ret *ret,
1138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt				     const struct wpabuf *reqData,
1148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt				     size_t *len, u8 *flags);
1158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_peer_tls_reset_input(struct eap_ssl_data *data);
1168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_peer_tls_reset_output(struct eap_ssl_data *data);
1178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint eap_peer_tls_decrypt(struct eap_sm *sm, struct eap_ssl_data *data,
1188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt			 const struct wpabuf *in_data,
1198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt			 struct wpabuf **in_decrypted);
1208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint eap_peer_tls_encrypt(struct eap_sm *sm, struct eap_ssl_data *data,
1218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt			 EapType eap_type, int peap_version, u8 id,
1228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt			 const struct wpabuf *in_data,
1238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt			 struct wpabuf **out_data);
1248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint eap_peer_select_phase2_methods(struct eap_peer_config *config,
1258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt				   const char *prefix,
1268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt				   struct eap_method_type **types,
1278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt				   size_t *num_types);
1288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint eap_peer_tls_phase2_nak(struct eap_method_type *types, size_t num_types,
1298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt			    struct eap_hdr *hdr, struct wpabuf **resp);
1308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt
1318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#endif /* EAP_TLS_COMMON_H */
132