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