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
38 * er - Whether the local end is an external registrar
44 SEND_M1
, RECV_M2
, SEND_M3
, RECV_M4
, SEND_M5
, RECV_M6
, SEND_M7
,
45 RECV_M8
, RECEIVED_M2D
, WPS_MSG_DONE
, RECV_ACK
, WPS_FINISHED
,
48 /* Registrar states */
49 RECV_M1
, SEND_M2
, RECV_M3
, SEND_M4
, RECV_M5
, SEND_M6
,
50 RECV_M7
, SEND_M8
, RECV_DONE
, SEND_M2D
, RECV_M2D_ACK
53 u8 uuid_e
[WPS_UUID_LEN
];
54 u8 uuid_r
[WPS_UUID_LEN
];
55 u8 mac_addr_e
[ETH_ALEN
];
56 u8 nonce_e
[WPS_NONCE_LEN
];
57 u8 nonce_r
[WPS_NONCE_LEN
];
60 u8 snonce
[2 * WPS_SECRET_NONCE_LEN
];
61 u8 peer_hash1
[WPS_HASH_LEN
];
62 u8 peer_hash2
[WPS_HASH_LEN
];
64 struct wpabuf
*dh_privkey
;
65 struct wpabuf
*dh_pubkey_e
;
66 struct wpabuf
*dh_pubkey_r
;
67 u8 authkey
[WPS_AUTHKEY_LEN
];
68 u8 keywrapkey
[WPS_KEYWRAPKEY_LEN
];
69 u8 emsk
[WPS_EMSK_LEN
];
71 struct wpabuf
*last_msg
;
74 size_t dev_password_len
;
79 * request_type - Request Type attribute from (Re)AssocReq
84 * encr_type - Available encryption types
89 * auth_type - Available authentication types
97 struct wps_credential cred
;
99 struct wps_device_data peer_dev
;
102 * config_error - Configuration Error value to be used in NACK
105 u16 error_indication
;
110 struct wps_credential
*new_ap_settings
;
114 void (*ap_settings_cb
)(void *ctx
, const struct wps_credential
*cred
);
115 void *ap_settings_cb_ctx
;
117 struct wps_credential
*use_cred
;
120 u8 p2p_dev_addr
[ETH_ALEN
]; /* P2P Device Address of the client or
121 * 00:00:00:00:00:00 if not a P2p client */
125 struct wps_parse_attr
{
126 /* fixed length fields */
127 const u8
*version
; /* 1 octet */
128 const u8
*version2
; /* 1 octet */
129 const u8
*msg_type
; /* 1 octet */
130 const u8
*enrollee_nonce
; /* WPS_NONCE_LEN (16) octets */
131 const u8
*registrar_nonce
; /* WPS_NONCE_LEN (16) octets */
132 const u8
*uuid_r
; /* WPS_UUID_LEN (16) octets */
133 const u8
*uuid_e
; /* WPS_UUID_LEN (16) octets */
134 const u8
*auth_type_flags
; /* 2 octets */
135 const u8
*encr_type_flags
; /* 2 octets */
136 const u8
*conn_type_flags
; /* 1 octet */
137 const u8
*config_methods
; /* 2 octets */
138 const u8
*sel_reg_config_methods
; /* 2 octets */
139 const u8
*primary_dev_type
; /* 8 octets */
140 const u8
*rf_bands
; /* 1 octet */
141 const u8
*assoc_state
; /* 2 octets */
142 const u8
*config_error
; /* 2 octets */
143 const u8
*dev_password_id
; /* 2 octets */
144 const u8
*oob_dev_password
; /* WPS_OOB_DEVICE_PASSWORD_ATTR_LEN (54)
146 const u8
*os_version
; /* 4 octets */
147 const u8
*wps_state
; /* 1 octet */
148 const u8
*authenticator
; /* WPS_AUTHENTICATOR_LEN (8) octets */
149 const u8
*r_hash1
; /* WPS_HASH_LEN (32) octets */
150 const u8
*r_hash2
; /* WPS_HASH_LEN (32) octets */
151 const u8
*e_hash1
; /* WPS_HASH_LEN (32) octets */
152 const u8
*e_hash2
; /* WPS_HASH_LEN (32) octets */
153 const u8
*r_snonce1
; /* WPS_SECRET_NONCE_LEN (16) octets */
154 const u8
*r_snonce2
; /* WPS_SECRET_NONCE_LEN (16) octets */
155 const u8
*e_snonce1
; /* WPS_SECRET_NONCE_LEN (16) octets */
156 const u8
*e_snonce2
; /* WPS_SECRET_NONCE_LEN (16) octets */
157 const u8
*key_wrap_auth
; /* WPS_KWA_LEN (8) octets */
158 const u8
*auth_type
; /* 2 octets */
159 const u8
*encr_type
; /* 2 octets */
160 const u8
*network_idx
; /* 1 octet */
161 const u8
*network_key_idx
; /* 1 octet */
162 const u8
*mac_addr
; /* ETH_ALEN (6) octets */
163 const u8
*key_prov_auto
; /* 1 octet (Bool) */
164 const u8
*dot1x_enabled
; /* 1 octet (Bool) */
165 const u8
*selected_registrar
; /* 1 octet (Bool) */
166 const u8
*request_type
; /* 1 octet */
167 const u8
*response_type
; /* 1 octet */
168 const u8
*ap_setup_locked
; /* 1 octet */
169 const u8
*settings_delay_time
; /* 1 octet */
170 const u8
*network_key_shareable
; /* 1 octet (Bool) */
171 const u8
*request_to_enroll
; /* 1 octet (Bool) */
173 /* variable length fields */
174 const u8
*manufacturer
;
175 size_t manufacturer_len
;
176 const u8
*model_name
;
177 size_t model_name_len
;
178 const u8
*model_number
;
179 size_t model_number_len
;
180 const u8
*serial_number
;
181 size_t serial_number_len
;
184 const u8
*public_key
;
185 size_t public_key_len
;
186 const u8
*encr_settings
;
187 size_t encr_settings_len
;
188 const u8
*ssid
; /* <= 32 octets */
190 const u8
*network_key
; /* <= 64 octets */
191 size_t network_key_len
;
192 const u8
*eap_type
; /* <= 8 octets */
194 const u8
*eap_identity
; /* <= 64 octets */
195 size_t eap_identity_len
;
196 const u8
*authorized_macs
; /* <= 30 octets */
197 size_t authorized_macs_len
;
198 const u8
*sec_dev_type_list
; /* <= 128 octets */
199 size_t sec_dev_type_list_len
;
201 /* attributes that can occur multiple times */
202 #define MAX_CRED_COUNT 10
203 const u8
*cred
[MAX_CRED_COUNT
];
204 size_t cred_len
[MAX_CRED_COUNT
];
207 #define MAX_REQ_DEV_TYPE_COUNT 10
208 const u8
*req_dev_type
[MAX_REQ_DEV_TYPE_COUNT
];
209 size_t num_req_dev_type
;
213 void wps_kdf(const u8
*key
, const u8
*label_prefix
, size_t label_prefix_len
,
214 const char *label
, u8
*res
, size_t res_len
);
215 int wps_derive_keys(struct wps_data
*wps
);
216 void wps_derive_psk(struct wps_data
*wps
, const u8
*dev_passwd
,
217 size_t dev_passwd_len
);
218 struct wpabuf
* wps_decrypt_encr_settings(struct wps_data
*wps
, const u8
*encr
,
220 void wps_fail_event(struct wps_context
*wps
, enum wps_msg_type msg
,
221 u16 config_error
, u16 error_indication
);
222 void wps_success_event(struct wps_context
*wps
);
223 void wps_pwd_auth_fail_event(struct wps_context
*wps
, int enrollee
, int part
);
224 void wps_pbc_overlap_event(struct wps_context
*wps
);
225 void wps_pbc_timeout_event(struct wps_context
*wps
);
227 extern struct oob_device_data oob_ufd_device_data
;
228 extern struct oob_device_data oob_nfc_device_data
;
229 extern struct oob_nfc_device_data oob_nfc_pn531_device_data
;
231 struct wpabuf
* wps_build_wsc_ack(struct wps_data
*wps
);
232 struct wpabuf
* wps_build_wsc_nack(struct wps_data
*wps
);
234 /* wps_attr_parse.c */
235 int wps_parse_msg(const struct wpabuf
*msg
, struct wps_parse_attr
*attr
);
237 /* wps_attr_build.c */
238 int wps_build_public_key(struct wps_data
*wps
, struct wpabuf
*msg
);
239 int wps_build_req_type(struct wpabuf
*msg
, enum wps_request_type type
);
240 int wps_build_resp_type(struct wpabuf
*msg
, enum wps_response_type type
);
241 int wps_build_config_methods(struct wpabuf
*msg
, u16 methods
);
242 int wps_build_uuid_e(struct wpabuf
*msg
, const u8
*uuid
);
243 int wps_build_dev_password_id(struct wpabuf
*msg
, u16 id
);
244 int wps_build_config_error(struct wpabuf
*msg
, u16 err
);
245 int wps_build_authenticator(struct wps_data
*wps
, struct wpabuf
*msg
);
246 int wps_build_key_wrap_auth(struct wps_data
*wps
, struct wpabuf
*msg
);
247 int wps_build_encr_settings(struct wps_data
*wps
, struct wpabuf
*msg
,
248 struct wpabuf
*plain
);
249 int wps_build_version(struct wpabuf
*msg
);
250 int wps_build_wfa_ext(struct wpabuf
*msg
, int req_to_enroll
,
251 const u8
*auth_macs
, size_t auth_macs_count
);
252 int wps_build_msg_type(struct wpabuf
*msg
, enum wps_msg_type msg_type
);
253 int wps_build_enrollee_nonce(struct wps_data
*wps
, struct wpabuf
*msg
);
254 int wps_build_registrar_nonce(struct wps_data
*wps
, struct wpabuf
*msg
);
255 int wps_build_auth_type_flags(struct wps_data
*wps
, struct wpabuf
*msg
);
256 int wps_build_encr_type_flags(struct wps_data
*wps
, struct wpabuf
*msg
);
257 int wps_build_conn_type_flags(struct wps_data
*wps
, struct wpabuf
*msg
);
258 int wps_build_assoc_state(struct wps_data
*wps
, struct wpabuf
*msg
);
259 int wps_build_oob_dev_password(struct wpabuf
*msg
, struct wps_context
*wps
);
260 struct wpabuf
* wps_ie_encapsulate(struct wpabuf
*data
);
262 /* wps_attr_process.c */
263 int wps_process_authenticator(struct wps_data
*wps
, const u8
*authenticator
,
264 const struct wpabuf
*msg
);
265 int wps_process_key_wrap_auth(struct wps_data
*wps
, struct wpabuf
*msg
,
266 const u8
*key_wrap_auth
);
267 int wps_process_cred(struct wps_parse_attr
*attr
,
268 struct wps_credential
*cred
);
269 int wps_process_ap_settings(struct wps_parse_attr
*attr
,
270 struct wps_credential
*cred
);
273 struct wpabuf
* wps_enrollee_get_msg(struct wps_data
*wps
,
274 enum wsc_op_code
*op_code
);
275 enum wps_process_res
wps_enrollee_process_msg(struct wps_data
*wps
,
276 enum wsc_op_code op_code
,
277 const struct wpabuf
*msg
);
279 /* wps_registrar.c */
280 struct wpabuf
* wps_registrar_get_msg(struct wps_data
*wps
,
281 enum wsc_op_code
*op_code
);
282 enum wps_process_res
wps_registrar_process_msg(struct wps_data
*wps
,
283 enum wsc_op_code op_code
,
284 const struct wpabuf
*msg
);
285 int wps_build_cred(struct wps_data
*wps
, struct wpabuf
*msg
);
286 int wps_device_store(struct wps_registrar
*reg
,
287 struct wps_device_data
*dev
, const u8
*uuid
);
288 void wps_registrar_selected_registrar_changed(struct wps_registrar
*reg
);
289 const u8
* wps_authorized_macs(struct wps_registrar
*reg
, size_t *count
);
290 int wps_registrar_pbc_overlap(struct wps_registrar
*reg
,
291 const u8
*addr
, const u8
*uuid_e
);
294 struct wpabuf
* ndef_parse_wifi(struct wpabuf
*buf
);
295 struct wpabuf
* ndef_build_wifi(struct wpabuf
*buf
);