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