2 * Wi-Fi Protected Setup - internal definitions
3 * Copyright (c) 2008-2009, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
21 * struct wps_data - WPS registration protocol data
23 * This data is stored at the EAP-WSC server/peer method and it is kept for a
24 * single registration protocol run.
28 * wps - Pointer to long term WPS context
30 struct wps_context *wps;
33 * registrar - Whether this end is a Registrar
39 SEND_M1, RECV_M2, SEND_M3, RECV_M4, SEND_M5, RECV_M6, SEND_M7,
40 RECV_M8, RECEIVED_M2D, WPS_MSG_DONE, RECV_ACK, WPS_FINISHED,
43 /* Registrar states */
44 RECV_M1, SEND_M2, RECV_M3, SEND_M4, RECV_M5, SEND_M6,
45 RECV_M7, SEND_M8, RECV_DONE, SEND_M2D, RECV_M2D_ACK
48 u8 uuid_e[WPS_UUID_LEN];
49 u8 uuid_r[WPS_UUID_LEN];
50 u8 mac_addr_e[ETH_ALEN];
51 u8 nonce_e[WPS_NONCE_LEN];
52 u8 nonce_r[WPS_NONCE_LEN];
55 u8 snonce[2 * WPS_SECRET_NONCE_LEN];
56 u8 peer_hash1[WPS_HASH_LEN];
57 u8 peer_hash2[WPS_HASH_LEN];
59 struct wpabuf *dh_privkey;
60 struct wpabuf *dh_pubkey_e;
61 struct wpabuf *dh_pubkey_r;
62 u8 authkey[WPS_AUTHKEY_LEN];
63 u8 keywrapkey[WPS_KEYWRAPKEY_LEN];
64 u8 emsk[WPS_EMSK_LEN];
65 u8 mgmt_auth_key[WPS_MGMTAUTHKEY_LEN];
66 u8 mgmt_auth_key_id[WPS_MGMT_KEY_ID_LEN];
67 u8 mgmt_enc_key[WPS_MGMTENCKEY_LEN];
68 u8 mgmt_enc_key_id[WPS_MGMT_KEY_ID_LEN];
70 struct wpabuf *last_msg;
73 size_t dev_password_len;
78 * request_type - Request Type attribute from (Re)AssocReq
83 * encr_type - Available encryption types
88 * auth_type - Available authentication types
96 struct wps_credential cred;
98 struct wps_device_data peer_dev;
101 * config_error - Configuration Error value to be used in NACK
107 struct wps_credential *new_ap_settings;
111 struct wps_parse_attr {
112 /* fixed length fields */
113 const u8 *version; /* 1 octet */
114 const u8 *msg_type; /* 1 octet */
115 const u8 *enrollee_nonce; /* WPS_NONCE_LEN (16) octets */
116 const u8 *registrar_nonce; /* WPS_NONCE_LEN (16) octets */
117 const u8 *uuid_r; /* WPS_UUID_LEN (16) octets */
118 const u8 *uuid_e; /* WPS_UUID_LEN (16) octets */
119 const u8 *auth_type_flags; /* 2 octets */
120 const u8 *encr_type_flags; /* 2 octets */
121 const u8 *conn_type_flags; /* 1 octet */
122 const u8 *config_methods; /* 2 octets */
123 const u8 *sel_reg_config_methods; /* 2 octets */
124 const u8 *primary_dev_type; /* 8 octets */
125 const u8 *rf_bands; /* 1 octet */
126 const u8 *assoc_state; /* 2 octets */
127 const u8 *config_error; /* 2 octets */
128 const u8 *dev_password_id; /* 2 octets */
129 const u8 *oob_dev_password; /* WPS_OOB_DEVICE_PASSWORD_ATTR_LEN (54)
131 const u8 *os_version; /* 4 octets */
132 const u8 *wps_state; /* 1 octet */
133 const u8 *authenticator; /* WPS_AUTHENTICATOR_LEN (8) octets */
134 const u8 *r_hash1; /* WPS_HASH_LEN (32) octets */
135 const u8 *r_hash2; /* WPS_HASH_LEN (32) octets */
136 const u8 *e_hash1; /* WPS_HASH_LEN (32) octets */
137 const u8 *e_hash2; /* WPS_HASH_LEN (32) octets */
138 const u8 *r_snonce1; /* WPS_SECRET_NONCE_LEN (16) octets */
139 const u8 *r_snonce2; /* WPS_SECRET_NONCE_LEN (16) octets */
140 const u8 *e_snonce1; /* WPS_SECRET_NONCE_LEN (16) octets */
141 const u8 *e_snonce2; /* WPS_SECRET_NONCE_LEN (16) octets */
142 const u8 *key_wrap_auth; /* WPS_KWA_LEN (8) octets */
143 const u8 *auth_type; /* 2 octets */
144 const u8 *encr_type; /* 2 octets */
145 const u8 *network_idx; /* 1 octet */
146 const u8 *network_key_idx; /* 1 octet */
147 const u8 *mac_addr; /* ETH_ALEN (6) octets */
148 const u8 *key_prov_auto; /* 1 octet (Bool) */
149 const u8 *dot1x_enabled; /* 1 octet (Bool) */
150 const u8 *selected_registrar; /* 1 octet (Bool) */
151 const u8 *request_type; /* 1 octet */
152 const u8 *response_type; /* 1 octet */
153 const u8 *ap_setup_locked; /* 1 octet */
155 /* variable length fields */
156 const u8 *manufacturer;
157 size_t manufacturer_len;
158 const u8 *model_name;
159 size_t model_name_len;
160 const u8 *model_number;
161 size_t model_number_len;
162 const u8 *serial_number;
163 size_t serial_number_len;
166 const u8 *public_key;
167 size_t public_key_len;
168 const u8 *encr_settings;
169 size_t encr_settings_len;
170 const u8 *ssid; /* <= 32 octets */
172 const u8 *network_key; /* <= 64 octets */
173 size_t network_key_len;
174 const u8 *eap_type; /* <= 8 octets */
176 const u8 *eap_identity; /* <= 64 octets */
177 size_t eap_identity_len;
179 /* attributes that can occur multiple times */
180 #define MAX_CRED_COUNT 10
181 const u8 *cred[MAX_CRED_COUNT];
182 size_t cred_len[MAX_CRED_COUNT];
187 void wps_kdf(const u8 *key, const u8 *label_prefix, size_t label_prefix_len,
188 const char *label, u8 *res, size_t res_len);
189 int wps_derive_keys(struct wps_data *wps);
190 int wps_derive_mgmt_keys(struct wps_data *wps);
191 void wps_derive_psk(struct wps_data *wps, const u8 *dev_passwd,
192 size_t dev_passwd_len);
193 struct wpabuf * wps_decrypt_encr_settings(struct wps_data *wps, const u8 *encr,
195 void wps_fail_event(struct wps_context *wps, enum wps_msg_type msg);
196 void wps_success_event(struct wps_context *wps);
197 void wps_pwd_auth_fail_event(struct wps_context *wps, int enrollee, int part);
199 extern struct oob_device_data oob_ufd_device_data;
200 extern struct oob_device_data oob_nfc_device_data;
201 extern struct oob_nfc_device_data oob_nfc_pn531_device_data;
203 /* wps_attr_parse.c */
204 int wps_parse_msg(const struct wpabuf *msg, struct wps_parse_attr *attr);
206 /* wps_attr_build.c */
207 int wps_build_public_key(struct wps_data *wps, struct wpabuf *msg);
208 int wps_build_req_type(struct wpabuf *msg, enum wps_request_type type);
209 int wps_build_config_methods(struct wpabuf *msg, u16 methods);
210 int wps_build_uuid_e(struct wpabuf *msg, const u8 *uuid);
211 int wps_build_dev_password_id(struct wpabuf *msg, u16 id);
212 int wps_build_config_error(struct wpabuf *msg, u16 err);
213 int wps_build_authenticator(struct wps_data *wps, struct wpabuf *msg);
214 int wps_build_key_wrap_auth(struct wps_data *wps, struct wpabuf *msg);
215 int wps_build_encr_settings(struct wps_data *wps, struct wpabuf *msg,
216 struct wpabuf *plain);
217 int wps_build_version(struct wpabuf *msg);
218 int wps_build_msg_type(struct wpabuf *msg, enum wps_msg_type msg_type);
219 int wps_build_enrollee_nonce(struct wps_data *wps, struct wpabuf *msg);
220 int wps_build_registrar_nonce(struct wps_data *wps, struct wpabuf *msg);
221 int wps_build_auth_type_flags(struct wps_data *wps, struct wpabuf *msg);
222 int wps_build_encr_type_flags(struct wps_data *wps, struct wpabuf *msg);
223 int wps_build_conn_type_flags(struct wps_data *wps, struct wpabuf *msg);
224 int wps_build_assoc_state(struct wps_data *wps, struct wpabuf *msg);
225 int wps_build_oob_dev_password(struct wpabuf *msg, struct wps_context *wps);
227 /* wps_attr_process.c */
228 int wps_process_authenticator(struct wps_data *wps, const u8 *authenticator,
229 const struct wpabuf *msg);
230 int wps_process_key_wrap_auth(struct wps_data *wps, struct wpabuf *msg,
231 const u8 *key_wrap_auth);
232 int wps_process_cred(struct wps_parse_attr *attr,
233 struct wps_credential *cred);
234 int wps_process_ap_settings(struct wps_parse_attr *attr,
235 struct wps_credential *cred);
238 struct wpabuf * wps_enrollee_get_msg(struct wps_data *wps,
239 enum wsc_op_code *op_code);
240 enum wps_process_res wps_enrollee_process_msg(struct wps_data *wps,
241 enum wsc_op_code op_code,
242 const struct wpabuf *msg);
244 /* wps_registrar.c */
245 struct wpabuf * wps_registrar_get_msg(struct wps_data *wps,
246 enum wsc_op_code *op_code);
247 enum wps_process_res wps_registrar_process_msg(struct wps_data *wps,
248 enum wsc_op_code op_code,
249 const struct wpabuf *msg);
250 int wps_build_cred(struct wps_data *wps, struct wpabuf *msg);
251 int wps_device_store(struct wps_registrar *reg,
252 struct wps_device_data *dev, const u8 *uuid);
255 struct wpabuf * ndef_parse_wifi(struct wpabuf *buf);
256 struct wpabuf * ndef_build_wifi(struct wpabuf *buf);
258 static inline int wps_version_supported(const u8 *version)
260 /* Require major version match, but allow minor version differences */
261 return version && (*version & 0xf0) == (WPS_VERSION & 0xf0);