1  /*
2   * Wi-Fi Protected Setup - internal definitions
3   * Copyright (c) 2008-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 WPS_I_H
10  #define WPS_I_H
11  
12  #include "wps.h"
13  #include "wps_attr_parse.h"
14  
15  struct wps_nfc_pw_token;
16  
17  /**
18   * struct wps_data - WPS registration protocol data
19   *
20   * This data is stored at the EAP-WSC server/peer method and it is kept for a
21   * single registration protocol run.
22   */
23  struct wps_data {
24  	/**
25  	 * wps - Pointer to long term WPS context
26  	 */
27  	struct wps_context *wps;
28  
29  	/**
30  	 * registrar - Whether this end is a Registrar
31  	 */
32  	int registrar;
33  
34  	/**
35  	 * er - Whether the local end is an external registrar
36  	 */
37  	int er;
38  
39  	enum {
40  		/* Enrollee states */
41  		SEND_M1, RECV_M2, SEND_M3, RECV_M4, SEND_M5, RECV_M6, SEND_M7,
42  		RECV_M8, RECEIVED_M2D, WPS_MSG_DONE, RECV_ACK, WPS_FINISHED,
43  		SEND_WSC_NACK,
44  
45  		/* Registrar states */
46  		RECV_M1, SEND_M2, RECV_M3, SEND_M4, RECV_M5, SEND_M6,
47  		RECV_M7, SEND_M8, RECV_DONE, SEND_M2D, RECV_M2D_ACK
48  	} state;
49  
50  	u8 uuid_e[WPS_UUID_LEN];
51  	u8 uuid_r[WPS_UUID_LEN];
52  	u8 mac_addr_e[ETH_ALEN];
53  	u8 nonce_e[WPS_NONCE_LEN];
54  	u8 nonce_r[WPS_NONCE_LEN];
55  	u8 psk1[WPS_PSK_LEN];
56  	u8 psk2[WPS_PSK_LEN];
57  	u8 snonce[2 * WPS_SECRET_NONCE_LEN];
58  	u8 peer_hash1[WPS_HASH_LEN];
59  	u8 peer_hash2[WPS_HASH_LEN];
60  
61  	struct wpabuf *dh_privkey;
62  	struct wpabuf *dh_pubkey_e;
63  	struct wpabuf *dh_pubkey_r;
64  	u8 authkey[WPS_AUTHKEY_LEN];
65  	u8 keywrapkey[WPS_KEYWRAPKEY_LEN];
66  	u8 emsk[WPS_EMSK_LEN];
67  
68  	struct wpabuf *last_msg;
69  
70  	u8 *dev_password;
71  	size_t dev_password_len;
72  	u16 dev_pw_id;
73  	int pbc;
74  	u8 *alt_dev_password;
75  	size_t alt_dev_password_len;
76  	u16 alt_dev_pw_id;
77  
78  	u8 peer_pubkey_hash[WPS_OOB_PUBKEY_HASH_LEN];
79  	int peer_pubkey_hash_set;
80  
81  	/**
82  	 * request_type - Request Type attribute from (Re)AssocReq
83  	 */
84  	u8 request_type;
85  
86  	/**
87  	 * encr_type - Available encryption types
88  	 */
89  	u16 encr_type;
90  
91  	/**
92  	 * auth_type - Available authentication types
93  	 */
94  	u16 auth_type;
95  
96  	u8 *new_psk;
97  	size_t new_psk_len;
98  
99  	int wps_pin_revealed;
100  	struct wps_credential cred;
101  
102  	struct wps_device_data peer_dev;
103  
104  	/**
105  	 * config_error - Configuration Error value to be used in NACK
106  	 */
107  	u16 config_error;
108  	u16 error_indication;
109  
110  	int ext_reg;
111  	int int_reg;
112  
113  	struct wps_credential *new_ap_settings;
114  
115  	void *dh_ctx;
116  
117  	void (*ap_settings_cb)(void *ctx, const struct wps_credential *cred);
118  	void *ap_settings_cb_ctx;
119  
120  	struct wps_credential *use_cred;
121  
122  	int use_psk_key;
123  	u8 p2p_dev_addr[ETH_ALEN]; /* P2P Device Address of the client or
124  				    * 00:00:00:00:00:00 if not a P2p client */
125  	int pbc_in_m1;
126  
127  	struct wps_nfc_pw_token *nfc_pw_token;
128  
129  	int multi_ap_backhaul_sta;
130  	int multi_ap_profile;
131  };
132  
133  
134  /* wps_common.c */
135  void wps_kdf(const u8 *key, const u8 *label_prefix, size_t label_prefix_len,
136  	     const char *label, u8 *res, size_t res_len);
137  int wps_derive_keys(struct wps_data *wps);
138  int wps_derive_psk(struct wps_data *wps, const u8 *dev_passwd,
139  		   size_t dev_passwd_len);
140  struct wpabuf * wps_decrypt_encr_settings(struct wps_data *wps, const u8 *encr,
141  					  size_t encr_len);
142  void wps_fail_event(struct wps_context *wps, enum wps_msg_type msg,
143  		    u16 config_error, u16 error_indication, const u8 *mac_addr);
144  void wps_success_event(struct wps_context *wps, const u8 *mac_addr);
145  void wps_pwd_auth_fail_event(struct wps_context *wps, int enrollee, int part,
146  			     const u8 *mac_addr);
147  void wps_pbc_overlap_event(struct wps_context *wps);
148  void wps_pbc_timeout_event(struct wps_context *wps);
149  void wps_pbc_active_event(struct wps_context *wps);
150  void wps_pbc_disable_event(struct wps_context *wps);
151  
152  struct wpabuf * wps_build_wsc_ack(struct wps_data *wps);
153  struct wpabuf * wps_build_wsc_nack(struct wps_data *wps);
154  
155  /* wps_attr_build.c */
156  int wps_build_public_key(struct wps_data *wps, struct wpabuf *msg);
157  int wps_build_req_type(struct wpabuf *msg, enum wps_request_type type);
158  int wps_build_resp_type(struct wpabuf *msg, enum wps_response_type type);
159  int wps_build_config_methods(struct wpabuf *msg, u16 methods);
160  int wps_build_uuid_e(struct wpabuf *msg, const u8 *uuid);
161  int wps_build_dev_password_id(struct wpabuf *msg, u16 id);
162  int wps_build_config_error(struct wpabuf *msg, u16 err);
163  int wps_build_authenticator(struct wps_data *wps, struct wpabuf *msg);
164  int wps_build_key_wrap_auth(struct wps_data *wps, struct wpabuf *msg);
165  int wps_build_encr_settings(struct wps_data *wps, struct wpabuf *msg,
166  			    struct wpabuf *plain);
167  int wps_build_version(struct wpabuf *msg);
168  int wps_build_wfa_ext(struct wpabuf *msg, int req_to_enroll,
169  		      const u8 *auth_macs, size_t auth_macs_count,
170  		      u8 multi_ap_subelem);
171  int wps_build_msg_type(struct wpabuf *msg, enum wps_msg_type msg_type);
172  int wps_build_enrollee_nonce(struct wps_data *wps, struct wpabuf *msg);
173  int wps_build_registrar_nonce(struct wps_data *wps, struct wpabuf *msg);
174  int wps_build_auth_type_flags(struct wps_data *wps, struct wpabuf *msg);
175  int wps_build_encr_type_flags(struct wps_data *wps, struct wpabuf *msg);
176  int wps_build_conn_type_flags(struct wps_data *wps, struct wpabuf *msg);
177  int wps_build_assoc_state(struct wps_data *wps, struct wpabuf *msg);
178  int wps_build_oob_dev_pw(struct wpabuf *msg, u16 dev_pw_id,
179  			 const struct wpabuf *pubkey, const u8 *dev_pw,
180  			 size_t dev_pw_len);
181  struct wpabuf * wps_ie_encapsulate(struct wpabuf *data);
182  int wps_build_mac_addr(struct wpabuf *msg, const u8 *addr);
183  int wps_build_rf_bands_attr(struct wpabuf *msg, u8 rf_bands);
184  int wps_build_ap_channel(struct wpabuf *msg, u16 ap_channel);
185  
186  /* wps_attr_process.c */
187  int wps_process_authenticator(struct wps_data *wps, const u8 *authenticator,
188  			      const struct wpabuf *msg);
189  int wps_process_key_wrap_auth(struct wps_data *wps, struct wpabuf *msg,
190  			      const u8 *key_wrap_auth);
191  int wps_process_cred(struct wps_parse_attr *attr,
192  		     struct wps_credential *cred);
193  int wps_process_ap_settings(struct wps_parse_attr *attr,
194  			    struct wps_credential *cred);
195  
196  /* wps_enrollee.c */
197  struct wpabuf * wps_enrollee_get_msg(struct wps_data *wps,
198  				     enum wsc_op_code *op_code);
199  enum wps_process_res wps_enrollee_process_msg(struct wps_data *wps,
200  					      enum wsc_op_code op_code,
201  					      const struct wpabuf *msg);
202  
203  /* wps_registrar.c */
204  struct wpabuf * wps_registrar_get_msg(struct wps_data *wps,
205  				      enum wsc_op_code *op_code);
206  enum wps_process_res wps_registrar_process_msg(struct wps_data *wps,
207  					       enum wsc_op_code op_code,
208  					       const struct wpabuf *msg);
209  int wps_build_cred(struct wps_data *wps, struct wpabuf *msg);
210  int wps_device_store(struct wps_registrar *reg,
211  		     struct wps_device_data *dev, const u8 *uuid);
212  void wps_registrar_selected_registrar_changed(struct wps_registrar *reg,
213  					      u16 dev_pw_id);
214  const u8 * wps_authorized_macs(struct wps_registrar *reg, size_t *count);
215  int wps_registrar_pbc_overlap(struct wps_registrar *reg,
216  			      const u8 *addr, const u8 *uuid_e);
217  void wps_registrar_remove_nfc_pw_token(struct wps_registrar *reg,
218  				       struct wps_nfc_pw_token *token);
219  int wps_cb_new_psk(struct wps_registrar *reg, const u8 *mac_addr,
220  		   const u8 *p2p_dev_addr, const u8 *psk, size_t psk_len);
221  
222  #endif /* WPS_I_H */
223