xref: /netbsd-src/external/bsd/wpa/dist/src/wps/wps.h (revision 51c5f9b7c2b2cc93506078d2cab158634a65201f)
1 /*
2  * Wi-Fi Protected Setup
3  * Copyright (c) 2007-2009, Jouni Malinen <j@w1.fi>
4  *
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.
8  *
9  * Alternatively, this software may be distributed under the terms of BSD
10  * license.
11  *
12  * See README and COPYING for more details.
13  */
14 
15 #ifndef WPS_H
16 #define WPS_H
17 
18 #include "wps_defs.h"
19 
20 /**
21  * enum wsc_op_code - EAP-WSC OP-Code values
22  */
23 enum wsc_op_code {
24 	WSC_UPnP = 0 /* No OP Code in UPnP transport */,
25 	WSC_Start = 0x01,
26 	WSC_ACK = 0x02,
27 	WSC_NACK = 0x03,
28 	WSC_MSG = 0x04,
29 	WSC_Done = 0x05,
30 	WSC_FRAG_ACK = 0x06
31 };
32 
33 struct wps_registrar;
34 struct upnp_wps_device_sm;
35 struct wps_er;
36 
37 /**
38  * struct wps_credential - WPS Credential
39  * @ssid: SSID
40  * @ssid_len: Length of SSID
41  * @auth_type: Authentication Type (WPS_AUTH_OPEN, .. flags)
42  * @encr_type: Encryption Type (WPS_ENCR_NONE, .. flags)
43  * @key_idx: Key index
44  * @key: Key
45  * @key_len: Key length in octets
46  * @mac_addr: MAC address of the Credential receiver
47  * @cred_attr: Unparsed Credential attribute data (used only in cred_cb());
48  *	this may be %NULL, if not used
49  * @cred_attr_len: Length of cred_attr in octets
50  */
51 struct wps_credential {
52 	u8 ssid[32];
53 	size_t ssid_len;
54 	u16 auth_type;
55 	u16 encr_type;
56 	u8 key_idx;
57 	u8 key[64];
58 	size_t key_len;
59 	u8 mac_addr[ETH_ALEN];
60 	const u8 *cred_attr;
61 	size_t cred_attr_len;
62 };
63 
64 #define WPS_DEV_TYPE_LEN 8
65 #define WPS_DEV_TYPE_BUFSIZE 21
66 #define WPS_SEC_DEV_TYPE_MAX_LEN 128
67 /* maximum number of advertised WPS vendor extension attributes */
68 #define MAX_WPS_VENDOR_EXTENSIONS 10
69 /* maximum size of WPS Vendor extension attribute */
70 #define WPS_MAX_VENDOR_EXT_LEN 1024
71 /* maximum number of parsed WPS vendor extension attributes */
72 #define MAX_WPS_PARSE_VENDOR_EXT 10
73 
74 /**
75  * struct wps_device_data - WPS Device Data
76  * @mac_addr: Device MAC address
77  * @device_name: Device Name (0..32 octets encoded in UTF-8)
78  * @manufacturer: Manufacturer (0..64 octets encoded in UTF-8)
79  * @model_name: Model Name (0..32 octets encoded in UTF-8)
80  * @model_number: Model Number (0..32 octets encoded in UTF-8)
81  * @serial_number: Serial Number (0..32 octets encoded in UTF-8)
82  * @pri_dev_type: Primary Device Type
83  * @sec_dev_type: Array of secondary device types
84  * @num_sec_dev_type: Number of secondary device types
85  * @os_version: OS Version
86  * @rf_bands: RF bands (WPS_RF_24GHZ, WPS_RF_50GHZ flags)
87  * @p2p: Whether the device is a P2P device
88  */
89 struct wps_device_data {
90 	u8 mac_addr[ETH_ALEN];
91 	char *device_name;
92 	char *manufacturer;
93 	char *model_name;
94 	char *model_number;
95 	char *serial_number;
96 	u8 pri_dev_type[WPS_DEV_TYPE_LEN];
97 #define WPS_SEC_DEVICE_TYPES 5
98 	u8 sec_dev_type[WPS_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
99 	u8 num_sec_dev_types;
100 	u32 os_version;
101 	u8 rf_bands;
102 	u16 config_methods;
103 	struct wpabuf *vendor_ext[MAX_WPS_VENDOR_EXTENSIONS];
104 
105 	int p2p;
106 };
107 
108 struct oob_conf_data {
109 	enum {
110 		OOB_METHOD_UNKNOWN = 0,
111 		OOB_METHOD_DEV_PWD_E,
112 		OOB_METHOD_DEV_PWD_R,
113 		OOB_METHOD_CRED,
114 	} oob_method;
115 	struct wpabuf *dev_password;
116 	struct wpabuf *pubkey_hash;
117 };
118 
119 /**
120  * struct wps_config - WPS configuration for a single registration protocol run
121  */
122 struct wps_config {
123 	/**
124 	 * wps - Pointer to long term WPS context
125 	 */
126 	struct wps_context *wps;
127 
128 	/**
129 	 * registrar - Whether this end is a Registrar
130 	 */
131 	int registrar;
132 
133 	/**
134 	 * pin - Enrollee Device Password (%NULL for Registrar or PBC)
135 	 */
136 	const u8 *pin;
137 
138 	/**
139 	 * pin_len - Length on pin in octets
140 	 */
141 	size_t pin_len;
142 
143 	/**
144 	 * pbc - Whether this is protocol run uses PBC
145 	 */
146 	int pbc;
147 
148 	/**
149 	 * assoc_wps_ie: (Re)AssocReq WPS IE (in AP; %NULL if not AP)
150 	 */
151 	const struct wpabuf *assoc_wps_ie;
152 
153 	/**
154 	 * new_ap_settings - New AP settings (%NULL if not used)
155 	 *
156 	 * This parameter provides new AP settings when using a wireless
157 	 * stations as a Registrar to configure the AP. %NULL means that AP
158 	 * will not be reconfigured, i.e., the station will only learn the
159 	 * current AP settings by using AP PIN.
160 	 */
161 	const struct wps_credential *new_ap_settings;
162 
163 	/**
164 	 * peer_addr: MAC address of the peer in AP; %NULL if not AP
165 	 */
166 	const u8 *peer_addr;
167 
168 	/**
169 	 * use_psk_key - Use PSK format key in Credential
170 	 *
171 	 * Force PSK format to be used instead of ASCII passphrase when
172 	 * building Credential for an Enrollee. The PSK value is set in
173 	 * struct wpa_context::psk.
174 	 */
175 	int use_psk_key;
176 
177 	/**
178 	 * dev_pw_id - Device Password ID for Enrollee when PIN is used
179 	 */
180 	u16 dev_pw_id;
181 
182 	/**
183 	 * p2p_dev_addr - P2P Device Address from (Re)Association Request
184 	 *
185 	 * On AP/GO, this is set to the P2P Device Address of the associating
186 	 * P2P client if a P2P IE is included in the (Re)Association Request
187 	 * frame and the P2P Device Address is included. Otherwise, this is set
188 	 * to %NULL to indicate the station does not have a P2P Device Address.
189 	 */
190 	const u8 *p2p_dev_addr;
191 
192 	/**
193 	 * pbc_in_m1 - Do not remove PushButton config method in M1 (AP)
194 	 *
195 	 * This can be used to enable a workaround to allow Windows 7 to use
196 	 * PBC with the AP.
197 	 */
198 	int pbc_in_m1;
199 };
200 
201 struct wps_data * wps_init(const struct wps_config *cfg);
202 
203 void wps_deinit(struct wps_data *data);
204 
205 /**
206  * enum wps_process_res - WPS message processing result
207  */
208 enum wps_process_res {
209 	/**
210 	 * WPS_DONE - Processing done
211 	 */
212 	WPS_DONE,
213 
214 	/**
215 	 * WPS_CONTINUE - Processing continues
216 	 */
217 	WPS_CONTINUE,
218 
219 	/**
220 	 * WPS_FAILURE - Processing failed
221 	 */
222 	WPS_FAILURE,
223 
224 	/**
225 	 * WPS_PENDING - Processing continues, but waiting for an external
226 	 *	event (e.g., UPnP message from an external Registrar)
227 	 */
228 	WPS_PENDING
229 };
230 enum wps_process_res wps_process_msg(struct wps_data *wps,
231 				     enum wsc_op_code op_code,
232 				     const struct wpabuf *msg);
233 
234 struct wpabuf * wps_get_msg(struct wps_data *wps, enum wsc_op_code *op_code);
235 
236 int wps_is_selected_pbc_registrar(const struct wpabuf *msg);
237 int wps_is_selected_pin_registrar(const struct wpabuf *msg);
238 int wps_ap_priority_compar(const struct wpabuf *wps_a,
239 			   const struct wpabuf *wps_b);
240 int wps_is_addr_authorized(const struct wpabuf *msg, const u8 *addr,
241 			   int ver1_compat);
242 const u8 * wps_get_uuid_e(const struct wpabuf *msg);
243 int wps_is_20(const struct wpabuf *msg);
244 
245 struct wpabuf * wps_build_assoc_req_ie(enum wps_request_type req_type);
246 struct wpabuf * wps_build_assoc_resp_ie(void);
247 struct wpabuf * wps_build_probe_req_ie(int pbc, struct wps_device_data *dev,
248 				       const u8 *uuid,
249 				       enum wps_request_type req_type,
250 				       unsigned int num_req_dev_types,
251 				       const u8 *req_dev_types);
252 
253 
254 /**
255  * struct wps_registrar_config - WPS Registrar configuration
256  */
257 struct wps_registrar_config {
258 	/**
259 	 * new_psk_cb - Callback for new PSK
260 	 * @ctx: Higher layer context data (cb_ctx)
261 	 * @mac_addr: MAC address of the Enrollee
262 	 * @psk: The new PSK
263 	 * @psk_len: The length of psk in octets
264 	 * Returns: 0 on success, -1 on failure
265 	 *
266 	 * This callback is called when a new per-device PSK is provisioned.
267 	 */
268 	int (*new_psk_cb)(void *ctx, const u8 *mac_addr, const u8 *psk,
269 			  size_t psk_len);
270 
271 	/**
272 	 * set_ie_cb - Callback for WPS IE changes
273 	 * @ctx: Higher layer context data (cb_ctx)
274 	 * @beacon_ie: WPS IE for Beacon
275 	 * @probe_resp_ie: WPS IE for Probe Response
276 	 * Returns: 0 on success, -1 on failure
277 	 *
278 	 * This callback is called whenever the WPS IE in Beacon or Probe
279 	 * Response frames needs to be changed (AP only). Callee is responsible
280 	 * for freeing the buffers.
281 	 */
282 	int (*set_ie_cb)(void *ctx, struct wpabuf *beacon_ie,
283 			 struct wpabuf *probe_resp_ie);
284 
285 	/**
286 	 * pin_needed_cb - Callback for requesting a PIN
287 	 * @ctx: Higher layer context data (cb_ctx)
288 	 * @uuid_e: UUID-E of the unknown Enrollee
289 	 * @dev: Device Data from the unknown Enrollee
290 	 *
291 	 * This callback is called whenever an unknown Enrollee requests to use
292 	 * PIN method and a matching PIN (Device Password) is not found in
293 	 * Registrar data.
294 	 */
295 	void (*pin_needed_cb)(void *ctx, const u8 *uuid_e,
296 			      const struct wps_device_data *dev);
297 
298 	/**
299 	 * reg_success_cb - Callback for reporting successful registration
300 	 * @ctx: Higher layer context data (cb_ctx)
301 	 * @mac_addr: MAC address of the Enrollee
302 	 * @uuid_e: UUID-E of the Enrollee
303 	 *
304 	 * This callback is called whenever an Enrollee completes registration
305 	 * successfully.
306 	 */
307 	void (*reg_success_cb)(void *ctx, const u8 *mac_addr,
308 			       const u8 *uuid_e);
309 
310 	/**
311 	 * set_sel_reg_cb - Callback for reporting selected registrar changes
312 	 * @ctx: Higher layer context data (cb_ctx)
313 	 * @sel_reg: Whether the Registrar is selected
314 	 * @dev_passwd_id: Device Password ID to indicate with method or
315 	 *	specific password the Registrar intends to use
316 	 * @sel_reg_config_methods: Bit field of active config methods
317 	 *
318 	 * This callback is called whenever the Selected Registrar state
319 	 * changes (e.g., a new PIN becomes available or PBC is invoked). This
320 	 * callback is only used by External Registrar implementation;
321 	 * set_ie_cb() is used by AP implementation in similar caes, but it
322 	 * provides the full WPS IE data instead of just the minimal Registrar
323 	 * state information.
324 	 */
325 	void (*set_sel_reg_cb)(void *ctx, int sel_reg, u16 dev_passwd_id,
326 			       u16 sel_reg_config_methods);
327 
328 	/**
329 	 * enrollee_seen_cb - Callback for reporting Enrollee based on ProbeReq
330 	 * @ctx: Higher layer context data (cb_ctx)
331 	 * @addr: MAC address of the Enrollee
332 	 * @uuid_e: UUID of the Enrollee
333 	 * @pri_dev_type: Primary device type
334 	 * @config_methods: Config Methods
335 	 * @dev_password_id: Device Password ID
336 	 * @request_type: Request Type
337 	 * @dev_name: Device Name (if available)
338 	 */
339 	void (*enrollee_seen_cb)(void *ctx, const u8 *addr, const u8 *uuid_e,
340 				 const u8 *pri_dev_type, u16 config_methods,
341 				 u16 dev_password_id, u8 request_type,
342 				 const char *dev_name);
343 
344 	/**
345 	 * cb_ctx: Higher layer context data for Registrar callbacks
346 	 */
347 	void *cb_ctx;
348 
349 	/**
350 	 * skip_cred_build: Do not build credential
351 	 *
352 	 * This option can be used to disable internal code that builds
353 	 * Credential attribute into M8 based on the current network
354 	 * configuration and Enrollee capabilities. The extra_cred data will
355 	 * then be used as the Credential(s).
356 	 */
357 	int skip_cred_build;
358 
359 	/**
360 	 * extra_cred: Additional Credential attribute(s)
361 	 *
362 	 * This optional data (set to %NULL to disable) can be used to add
363 	 * Credential attribute(s) for other networks into M8. If
364 	 * skip_cred_build is set, this will also override the automatically
365 	 * generated Credential attribute.
366 	 */
367 	const u8 *extra_cred;
368 
369 	/**
370 	 * extra_cred_len: Length of extra_cred in octets
371 	 */
372 	size_t extra_cred_len;
373 
374 	/**
375 	 * disable_auto_conf - Disable auto-configuration on first registration
376 	 *
377 	 * By default, the AP that is started in not configured state will
378 	 * generate a random PSK and move to configured state when the first
379 	 * registration protocol run is completed successfully. This option can
380 	 * be used to disable this functionality and leave it up to an external
381 	 * program to take care of configuration. This requires the extra_cred
382 	 * to be set with a suitable Credential and skip_cred_build being used.
383 	 */
384 	int disable_auto_conf;
385 
386 	/**
387 	 * static_wep_only - Whether the BSS supports only static WEP
388 	 */
389 	int static_wep_only;
390 
391 	/**
392 	 * dualband - Whether this is a concurrent dualband AP
393 	 */
394 	int dualband;
395 };
396 
397 
398 /**
399  * enum wps_event - WPS event types
400  */
401 enum wps_event {
402 	/**
403 	 * WPS_EV_M2D - M2D received (Registrar did not know us)
404 	 */
405 	WPS_EV_M2D,
406 
407 	/**
408 	 * WPS_EV_FAIL - Registration failed
409 	 */
410 	WPS_EV_FAIL,
411 
412 	/**
413 	 * WPS_EV_SUCCESS - Registration succeeded
414 	 */
415 	WPS_EV_SUCCESS,
416 
417 	/**
418 	 * WPS_EV_PWD_AUTH_FAIL - Password authentication failed
419 	 */
420 	WPS_EV_PWD_AUTH_FAIL,
421 
422 	/**
423 	 * WPS_EV_PBC_OVERLAP - PBC session overlap detected
424 	 */
425 	WPS_EV_PBC_OVERLAP,
426 
427 	/**
428 	 * WPS_EV_PBC_TIMEOUT - PBC walktime expired before protocol run start
429 	 */
430 	WPS_EV_PBC_TIMEOUT,
431 
432 	/**
433 	 * WPS_EV_ER_AP_ADD - ER: AP added
434 	 */
435 	WPS_EV_ER_AP_ADD,
436 
437 	/**
438 	 * WPS_EV_ER_AP_REMOVE - ER: AP removed
439 	 */
440 	WPS_EV_ER_AP_REMOVE,
441 
442 	/**
443 	 * WPS_EV_ER_ENROLLEE_ADD - ER: Enrollee added
444 	 */
445 	WPS_EV_ER_ENROLLEE_ADD,
446 
447 	/**
448 	 * WPS_EV_ER_ENROLLEE_REMOVE - ER: Enrollee removed
449 	 */
450 	WPS_EV_ER_ENROLLEE_REMOVE,
451 
452 	/**
453 	 * WPS_EV_ER_AP_SETTINGS - ER: AP Settings learned
454 	 */
455 	WPS_EV_ER_AP_SETTINGS,
456 
457 	/**
458 	 * WPS_EV_ER_SET_SELECTED_REGISTRAR - ER: SetSelectedRegistrar event
459 	 */
460 	WPS_EV_ER_SET_SELECTED_REGISTRAR,
461 
462 	/**
463 	 * WPS_EV_AP_PIN_SUCCESS - External Registrar used correct AP PIN
464 	 */
465 	WPS_EV_AP_PIN_SUCCESS
466 };
467 
468 /**
469  * union wps_event_data - WPS event data
470  */
471 union wps_event_data {
472 	/**
473 	 * struct wps_event_m2d - M2D event data
474 	 */
475 	struct wps_event_m2d {
476 		u16 config_methods;
477 		const u8 *manufacturer;
478 		size_t manufacturer_len;
479 		const u8 *model_name;
480 		size_t model_name_len;
481 		const u8 *model_number;
482 		size_t model_number_len;
483 		const u8 *serial_number;
484 		size_t serial_number_len;
485 		const u8 *dev_name;
486 		size_t dev_name_len;
487 		const u8 *primary_dev_type; /* 8 octets */
488 		u16 config_error;
489 		u16 dev_password_id;
490 	} m2d;
491 
492 	/**
493 	 * struct wps_event_fail - Registration failure information
494 	 * @msg: enum wps_msg_type
495 	 */
496 	struct wps_event_fail {
497 		int msg;
498 		u16 config_error;
499 		u16 error_indication;
500 	} fail;
501 
502 	struct wps_event_pwd_auth_fail {
503 		int enrollee;
504 		int part;
505 	} pwd_auth_fail;
506 
507 	struct wps_event_er_ap {
508 		const u8 *uuid;
509 		const u8 *mac_addr;
510 		const char *friendly_name;
511 		const char *manufacturer;
512 		const char *manufacturer_url;
513 		const char *model_description;
514 		const char *model_name;
515 		const char *model_number;
516 		const char *model_url;
517 		const char *serial_number;
518 		const char *upc;
519 		const u8 *pri_dev_type;
520 		u8 wps_state;
521 	} ap;
522 
523 	struct wps_event_er_enrollee {
524 		const u8 *uuid;
525 		const u8 *mac_addr;
526 		int m1_received;
527 		u16 config_methods;
528 		u16 dev_passwd_id;
529 		const u8 *pri_dev_type;
530 		const char *dev_name;
531 		const char *manufacturer;
532 		const char *model_name;
533 		const char *model_number;
534 		const char *serial_number;
535 	} enrollee;
536 
537 	struct wps_event_er_ap_settings {
538 		const u8 *uuid;
539 		const struct wps_credential *cred;
540 	} ap_settings;
541 
542 	struct wps_event_er_set_selected_registrar {
543 		const u8 *uuid;
544 		int sel_reg;
545 		u16 dev_passwd_id;
546 		u16 sel_reg_config_methods;
547 		enum {
548 			WPS_ER_SET_SEL_REG_START,
549 			WPS_ER_SET_SEL_REG_DONE,
550 			WPS_ER_SET_SEL_REG_FAILED
551 		} state;
552 	} set_sel_reg;
553 };
554 
555 /**
556  * struct upnp_pending_message - Pending PutWLANResponse messages
557  * @next: Pointer to next pending message or %NULL
558  * @addr: NewWLANEventMAC
559  * @msg: NewMessage
560  * @type: Message Type
561  */
562 struct upnp_pending_message {
563 	struct upnp_pending_message *next;
564 	u8 addr[ETH_ALEN];
565 	struct wpabuf *msg;
566 	enum wps_msg_type type;
567 };
568 
569 /**
570  * struct wps_context - Long term WPS context data
571  *
572  * This data is stored at the higher layer Authenticator or Supplicant data
573  * structures and it is maintained over multiple registration protocol runs.
574  */
575 struct wps_context {
576 	/**
577 	 * ap - Whether the local end is an access point
578 	 */
579 	int ap;
580 
581 	/**
582 	 * registrar - Pointer to WPS registrar data from wps_registrar_init()
583 	 */
584 	struct wps_registrar *registrar;
585 
586 	/**
587 	 * wps_state - Current WPS state
588 	 */
589 	enum wps_state wps_state;
590 
591 	/**
592 	 * ap_setup_locked - Whether AP setup is locked (only used at AP)
593 	 */
594 	int ap_setup_locked;
595 
596 	/**
597 	 * uuid - Own UUID
598 	 */
599 	u8 uuid[16];
600 
601 	/**
602 	 * ssid - SSID
603 	 *
604 	 * This SSID is used by the Registrar to fill in information for
605 	 * Credentials. In addition, AP uses it when acting as an Enrollee to
606 	 * notify Registrar of the current configuration.
607 	 */
608 	u8 ssid[32];
609 
610 	/**
611 	 * ssid_len - Length of ssid in octets
612 	 */
613 	size_t ssid_len;
614 
615 	/**
616 	 * dev - Own WPS device data
617 	 */
618 	struct wps_device_data dev;
619 
620 	/**
621 	 * oob_conf - OOB Config data
622 	 */
623 	struct oob_conf_data oob_conf;
624 
625 	/**
626 	 * oob_dev_pw_id - OOB Device password id
627 	 */
628 	u16 oob_dev_pw_id;
629 
630 	/**
631 	 * dh_ctx - Context data for Diffie-Hellman operation
632 	 */
633 	void *dh_ctx;
634 
635 	/**
636 	 * dh_privkey - Diffie-Hellman private key
637 	 */
638 	struct wpabuf *dh_privkey;
639 
640 	/**
641 	 * dh_pubkey_oob - Diffie-Hellman public key
642 	 */
643 	struct wpabuf *dh_pubkey;
644 
645 	/**
646 	 * config_methods - Enabled configuration methods
647 	 *
648 	 * Bit field of WPS_CONFIG_*
649 	 */
650 	u16 config_methods;
651 
652 	/**
653 	 * encr_types - Enabled encryption types (bit field of WPS_ENCR_*)
654 	 */
655 	u16 encr_types;
656 
657 	/**
658 	 * auth_types - Authentication types (bit field of WPS_AUTH_*)
659 	 */
660 	u16 auth_types;
661 
662 	/**
663 	 * network_key - The current Network Key (PSK) or %NULL to generate new
664 	 *
665 	 * If %NULL, Registrar will generate per-device PSK. In addition, AP
666 	 * uses this when acting as an Enrollee to notify Registrar of the
667 	 * current configuration.
668 	 *
669 	 * When using WPA/WPA2-Person, this key can be either the ASCII
670 	 * passphrase (8..63 characters) or the 32-octet PSK (64 hex
671 	 * characters). When this is set to the ASCII passphrase, the PSK can
672 	 * be provided in the psk buffer and used per-Enrollee to control which
673 	 * key type is included in the Credential (e.g., to reduce calculation
674 	 * need on low-powered devices by provisioning PSK while still allowing
675 	 * other devices to get the passphrase).
676 	 */
677 	u8 *network_key;
678 
679 	/**
680 	 * network_key_len - Length of network_key in octets
681 	 */
682 	size_t network_key_len;
683 
684 	/**
685 	 * psk - The current network PSK
686 	 *
687 	 * This optional value can be used to provide the current PSK if
688 	 * network_key is set to the ASCII passphrase.
689 	 */
690 	u8 psk[32];
691 
692 	/**
693 	 * psk_set - Whether psk value is set
694 	 */
695 	int psk_set;
696 
697 	/**
698 	 * ap_settings - AP Settings override for M7 (only used at AP)
699 	 *
700 	 * If %NULL, AP Settings attributes will be generated based on the
701 	 * current network configuration.
702 	 */
703 	u8 *ap_settings;
704 
705 	/**
706 	 * ap_settings_len - Length of ap_settings in octets
707 	 */
708 	size_t ap_settings_len;
709 
710 	/**
711 	 * friendly_name - Friendly Name (required for UPnP)
712 	 */
713 	char *friendly_name;
714 
715 	/**
716 	 * manufacturer_url - Manufacturer URL (optional for UPnP)
717 	 */
718 	char *manufacturer_url;
719 
720 	/**
721 	 * model_description - Model Description (recommended for UPnP)
722 	 */
723 	char *model_description;
724 
725 	/**
726 	 * model_url - Model URL (optional for UPnP)
727 	 */
728 	char *model_url;
729 
730 	/**
731 	 * upc - Universal Product Code (optional for UPnP)
732 	 */
733 	char *upc;
734 
735 	/**
736 	 * cred_cb - Callback to notify that new Credentials were received
737 	 * @ctx: Higher layer context data (cb_ctx)
738 	 * @cred: The received Credential
739 	 * Return: 0 on success, -1 on failure
740 	 */
741 	int (*cred_cb)(void *ctx, const struct wps_credential *cred);
742 
743 	/**
744 	 * event_cb - Event callback (state information about progress)
745 	 * @ctx: Higher layer context data (cb_ctx)
746 	 * @event: Event type
747 	 * @data: Event data
748 	 */
749 	void (*event_cb)(void *ctx, enum wps_event event,
750 			 union wps_event_data *data);
751 
752 	/**
753 	 * cb_ctx: Higher layer context data for callbacks
754 	 */
755 	void *cb_ctx;
756 
757 	struct upnp_wps_device_sm *wps_upnp;
758 
759 	/* Pending messages from UPnP PutWLANResponse */
760 	struct upnp_pending_message *upnp_msgs;
761 };
762 
763 struct oob_device_data {
764 	char *device_name;
765 	char *device_path;
766 	void * (*init_func)(struct wps_context *, struct oob_device_data *,
767 			    int);
768 	struct wpabuf * (*read_func)(void *);
769 	int (*write_func)(void *, struct wpabuf *);
770 	void (*deinit_func)(void *);
771 };
772 
773 struct oob_nfc_device_data {
774 	int (*init_func)(char *);
775 	void * (*read_func)(size_t *);
776 	int (*write_func)(void *, size_t);
777 	void (*deinit_func)(void);
778 };
779 
780 struct wps_registrar *
781 wps_registrar_init(struct wps_context *wps,
782 		   const struct wps_registrar_config *cfg);
783 void wps_registrar_deinit(struct wps_registrar *reg);
784 int wps_registrar_add_pin(struct wps_registrar *reg, const u8 *addr,
785 			  const u8 *uuid, const u8 *pin, size_t pin_len,
786 			  int timeout);
787 int wps_registrar_invalidate_pin(struct wps_registrar *reg, const u8 *uuid);
788 int wps_registrar_wps_cancel(struct wps_registrar *reg);
789 int wps_registrar_unlock_pin(struct wps_registrar *reg, const u8 *uuid);
790 int wps_registrar_button_pushed(struct wps_registrar *reg,
791 				const u8 *p2p_dev_addr);
792 void wps_registrar_complete(struct wps_registrar *registrar, const u8 *uuid_e);
793 void wps_registrar_probe_req_rx(struct wps_registrar *reg, const u8 *addr,
794 				const struct wpabuf *wps_data,
795 				int p2p_wildcard);
796 int wps_registrar_update_ie(struct wps_registrar *reg);
797 int wps_registrar_get_info(struct wps_registrar *reg, const u8 *addr,
798 			   char *buf, size_t buflen);
799 int wps_registrar_config_ap(struct wps_registrar *reg,
800 			    struct wps_credential *cred);
801 
802 int wps_build_credential_wrap(struct wpabuf *msg,
803 			      const struct wps_credential *cred);
804 
805 unsigned int wps_pin_checksum(unsigned int pin);
806 unsigned int wps_pin_valid(unsigned int pin);
807 unsigned int wps_generate_pin(void);
808 void wps_free_pending_msgs(struct upnp_pending_message *msgs);
809 
810 struct oob_device_data * wps_get_oob_device(char *device_type);
811 struct oob_nfc_device_data * wps_get_oob_nfc_device(char *device_name);
812 int wps_get_oob_method(char *method);
813 int wps_process_oob(struct wps_context *wps, struct oob_device_data *oob_dev,
814 		    int registrar);
815 int wps_attr_text(struct wpabuf *data, char *buf, char *end);
816 
817 struct wps_er * wps_er_init(struct wps_context *wps, const char *ifname,
818 			    const char *filter);
819 void wps_er_refresh(struct wps_er *er);
820 void wps_er_deinit(struct wps_er *er, void (*cb)(void *ctx), void *ctx);
821 void wps_er_set_sel_reg(struct wps_er *er, int sel_reg, u16 dev_passwd_id,
822 			u16 sel_reg_config_methods);
823 int wps_er_pbc(struct wps_er *er, const u8 *uuid);
824 int wps_er_learn(struct wps_er *er, const u8 *uuid, const u8 *pin,
825 		 size_t pin_len);
826 int wps_er_set_config(struct wps_er *er, const u8 *uuid,
827 		      const struct wps_credential *cred);
828 int wps_er_config(struct wps_er *er, const u8 *uuid, const u8 *pin,
829 		  size_t pin_len, const struct wps_credential *cred);
830 
831 int wps_dev_type_str2bin(const char *str, u8 dev_type[WPS_DEV_TYPE_LEN]);
832 char * wps_dev_type_bin2str(const u8 dev_type[WPS_DEV_TYPE_LEN], char *buf,
833 			    size_t buf_len);
834 void uuid_gen_mac_addr(const u8 *mac_addr, u8 *uuid);
835 u16 wps_config_methods_str2bin(const char *str);
836 
837 #ifdef CONFIG_WPS_STRICT
838 int wps_validate_beacon(const struct wpabuf *wps_ie);
839 int wps_validate_beacon_probe_resp(const struct wpabuf *wps_ie, int probe,
840 				   const u8 *addr);
841 int wps_validate_probe_req(const struct wpabuf *wps_ie, const u8 *addr);
842 int wps_validate_assoc_req(const struct wpabuf *wps_ie);
843 int wps_validate_assoc_resp(const struct wpabuf *wps_ie);
844 int wps_validate_m1(const struct wpabuf *tlvs);
845 int wps_validate_m2(const struct wpabuf *tlvs);
846 int wps_validate_m2d(const struct wpabuf *tlvs);
847 int wps_validate_m3(const struct wpabuf *tlvs);
848 int wps_validate_m4(const struct wpabuf *tlvs);
849 int wps_validate_m4_encr(const struct wpabuf *tlvs, int wps2);
850 int wps_validate_m5(const struct wpabuf *tlvs);
851 int wps_validate_m5_encr(const struct wpabuf *tlvs, int wps2);
852 int wps_validate_m6(const struct wpabuf *tlvs);
853 int wps_validate_m6_encr(const struct wpabuf *tlvs, int wps2);
854 int wps_validate_m7(const struct wpabuf *tlvs);
855 int wps_validate_m7_encr(const struct wpabuf *tlvs, int ap, int wps2);
856 int wps_validate_m8(const struct wpabuf *tlvs);
857 int wps_validate_m8_encr(const struct wpabuf *tlvs, int ap, int wps2);
858 int wps_validate_wsc_ack(const struct wpabuf *tlvs);
859 int wps_validate_wsc_nack(const struct wpabuf *tlvs);
860 int wps_validate_wsc_done(const struct wpabuf *tlvs);
861 int wps_validate_upnp_set_selected_registrar(const struct wpabuf *tlvs);
862 #else /* CONFIG_WPS_STRICT */
863 static inline int wps_validate_beacon(const struct wpabuf *wps_ie){
864 	return 0;
865 }
866 
867 static inline int wps_validate_beacon_probe_resp(const struct wpabuf *wps_ie,
868 						 int probe, const u8 *addr)
869 {
870 	return 0;
871 }
872 
873 static inline int wps_validate_probe_req(const struct wpabuf *wps_ie,
874 					 const u8 *addr)
875 {
876 	return 0;
877 }
878 
879 static inline int wps_validate_assoc_req(const struct wpabuf *wps_ie)
880 {
881 	return 0;
882 }
883 
884 static inline int wps_validate_assoc_resp(const struct wpabuf *wps_ie)
885 {
886 	return 0;
887 }
888 
889 static inline int wps_validate_m1(const struct wpabuf *tlvs)
890 {
891 	return 0;
892 }
893 
894 static inline int wps_validate_m2(const struct wpabuf *tlvs)
895 {
896 	return 0;
897 }
898 
899 static inline int wps_validate_m2d(const struct wpabuf *tlvs)
900 {
901 	return 0;
902 }
903 
904 static inline int wps_validate_m3(const struct wpabuf *tlvs)
905 {
906 	return 0;
907 }
908 
909 static inline int wps_validate_m4(const struct wpabuf *tlvs)
910 {
911 	return 0;
912 }
913 
914 static inline int wps_validate_m4_encr(const struct wpabuf *tlvs, int wps2)
915 {
916 	return 0;
917 }
918 
919 static inline int wps_validate_m5(const struct wpabuf *tlvs)
920 {
921 	return 0;
922 }
923 
924 static inline int wps_validate_m5_encr(const struct wpabuf *tlvs, int wps2)
925 {
926 	return 0;
927 }
928 
929 static inline int wps_validate_m6(const struct wpabuf *tlvs)
930 {
931 	return 0;
932 }
933 
934 static inline int wps_validate_m6_encr(const struct wpabuf *tlvs, int wps2)
935 {
936 	return 0;
937 }
938 
939 static inline int wps_validate_m7(const struct wpabuf *tlvs)
940 {
941 	return 0;
942 }
943 
944 static inline int wps_validate_m7_encr(const struct wpabuf *tlvs, int ap,
945 				       int wps2)
946 {
947 	return 0;
948 }
949 
950 static inline int wps_validate_m8(const struct wpabuf *tlvs)
951 {
952 	return 0;
953 }
954 
955 static inline int wps_validate_m8_encr(const struct wpabuf *tlvs, int ap,
956 				       int wps2)
957 {
958 	return 0;
959 }
960 
961 static inline int wps_validate_wsc_ack(const struct wpabuf *tlvs)
962 {
963 	return 0;
964 }
965 
966 static inline int wps_validate_wsc_nack(const struct wpabuf *tlvs)
967 {
968 	return 0;
969 }
970 
971 static inline int wps_validate_wsc_done(const struct wpabuf *tlvs)
972 {
973 	return 0;
974 }
975 
976 static inline int wps_validate_upnp_set_selected_registrar(
977 	const struct wpabuf *tlvs)
978 {
979 	return 0;
980 }
981 #endif /* CONFIG_WPS_STRICT */
982 
983 #endif /* WPS_H */
984