2 * Wi-Fi Protected Setup
3 * Copyright (c) 2007-2009, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
21 * enum wsc_op_code - EAP-WSC OP-Code values
24 WSC_UPnP
= 0 /* No OP Code in UPnP transport */,
34 struct upnp_wps_device_sm
;
38 * struct wps_credential - WPS Credential
40 * @ssid_len: Length of SSID
41 * @auth_type: Authentication Type (WPS_AUTH_OPEN, .. flags)
42 * @encr_type: Encryption Type (WPS_ENCR_NONE, .. flags)
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
51 struct wps_credential
{
59 u8 mac_addr
[ETH_ALEN
];
64 #define WPS_DEV_TYPE_LEN 8
65 #define WPS_DEV_TYPE_BUFSIZE 21
68 * struct wps_device_data - WPS Device Data
69 * @mac_addr: Device MAC address
70 * @device_name: Device Name (0..32 octets encoded in UTF-8)
71 * @manufacturer: Manufacturer (0..64 octets encoded in UTF-8)
72 * @model_name: Model Name (0..32 octets encoded in UTF-8)
73 * @model_number: Model Number (0..32 octets encoded in UTF-8)
74 * @serial_number: Serial Number (0..32 octets encoded in UTF-8)
75 * @pri_dev_type: Primary Device Type
76 * @os_version: OS Version
77 * @rf_bands: RF bands (WPS_RF_24GHZ, WPS_RF_50GHZ flags)
78 * @p2p: Whether the device is a P2P device
80 struct wps_device_data
{
81 u8 mac_addr
[ETH_ALEN
];
87 u8 pri_dev_type
[WPS_DEV_TYPE_LEN
];
94 struct oob_conf_data
{
96 OOB_METHOD_UNKNOWN
= 0,
101 struct wpabuf
*dev_password
;
102 struct wpabuf
*pubkey_hash
;
106 * struct wps_config - WPS configuration for a single registration protocol run
110 * wps - Pointer to long term WPS context
112 struct wps_context
*wps
;
115 * registrar - Whether this end is a Registrar
120 * pin - Enrollee Device Password (%NULL for Registrar or PBC)
125 * pin_len - Length on pin in octets
130 * pbc - Whether this is protocol run uses PBC
135 * assoc_wps_ie: (Re)AssocReq WPS IE (in AP; %NULL if not AP)
137 const struct wpabuf
*assoc_wps_ie
;
140 * new_ap_settings - New AP settings (%NULL if not used)
142 * This parameter provides new AP settings when using a wireless
143 * stations as a Registrar to configure the AP. %NULL means that AP
144 * will not be reconfigured, i.e., the station will only learn the
145 * current AP settings by using AP PIN.
147 const struct wps_credential
*new_ap_settings
;
150 * peer_addr: MAC address of the peer in AP; %NULL if not AP
155 * use_psk_key - Use PSK format key in Credential
157 * Force PSK format to be used instead of ASCII passphrase when
158 * building Credential for an Enrollee. The PSK value is set in
159 * struct wpa_context::psk.
164 * dev_pw_id - Device Password ID for Enrollee when PIN is used
169 * p2p_dev_addr - P2P Device Address from (Re)Association Request
171 * On AP/GO, this is set to the P2P Device Address of the associating
172 * P2P client if a P2P IE is included in the (Re)Association Request
173 * frame and the P2P Device Address is included. Otherwise, this is set
174 * to %NULL to indicate the station does not have a P2P Device Address.
176 const u8
*p2p_dev_addr
;
179 struct wps_data
* wps_init(const struct wps_config
*cfg
);
181 void wps_deinit(struct wps_data
*data
);
184 * enum wps_process_res - WPS message processing result
186 enum wps_process_res
{
188 * WPS_DONE - Processing done
193 * WPS_CONTINUE - Processing continues
198 * WPS_FAILURE - Processing failed
203 * WPS_PENDING - Processing continues, but waiting for an external
204 * event (e.g., UPnP message from an external Registrar)
208 enum wps_process_res
wps_process_msg(struct wps_data
*wps
,
209 enum wsc_op_code op_code
,
210 const struct wpabuf
*msg
);
212 struct wpabuf
* wps_get_msg(struct wps_data
*wps
, enum wsc_op_code
*op_code
);
214 int wps_is_selected_pbc_registrar(const struct wpabuf
*msg
);
215 int wps_is_selected_pin_registrar(const struct wpabuf
*msg
);
216 int wps_ap_priority_compar(const struct wpabuf
*wps_a
,
217 const struct wpabuf
*wps_b
);
218 int wps_is_addr_authorized(const struct wpabuf
*msg
, const u8
*addr
,
220 const u8
* wps_get_uuid_e(const struct wpabuf
*msg
);
222 struct wpabuf
* wps_build_assoc_req_ie(enum wps_request_type req_type
);
223 struct wpabuf
* wps_build_assoc_resp_ie(void);
224 struct wpabuf
* wps_build_probe_req_ie(int pbc
, struct wps_device_data
*dev
,
226 enum wps_request_type req_type
);
230 * struct wps_registrar_config - WPS Registrar configuration
232 struct wps_registrar_config
{
234 * new_psk_cb - Callback for new PSK
235 * @ctx: Higher layer context data (cb_ctx)
236 * @mac_addr: MAC address of the Enrollee
238 * @psk_len: The length of psk in octets
239 * Returns: 0 on success, -1 on failure
241 * This callback is called when a new per-device PSK is provisioned.
243 int (*new_psk_cb
)(void *ctx
, const u8
*mac_addr
, const u8
*psk
,
247 * set_ie_cb - Callback for WPS IE changes
248 * @ctx: Higher layer context data (cb_ctx)
249 * @beacon_ie: WPS IE for Beacon
250 * @probe_resp_ie: WPS IE for Probe Response
251 * Returns: 0 on success, -1 on failure
253 * This callback is called whenever the WPS IE in Beacon or Probe
254 * Response frames needs to be changed (AP only). Callee is responsible
255 * for freeing the buffers.
257 int (*set_ie_cb
)(void *ctx
, struct wpabuf
*beacon_ie
,
258 struct wpabuf
*probe_resp_ie
);
261 * pin_needed_cb - Callback for requesting a PIN
262 * @ctx: Higher layer context data (cb_ctx)
263 * @uuid_e: UUID-E of the unknown Enrollee
264 * @dev: Device Data from the unknown Enrollee
266 * This callback is called whenever an unknown Enrollee requests to use
267 * PIN method and a matching PIN (Device Password) is not found in
270 void (*pin_needed_cb
)(void *ctx
, const u8
*uuid_e
,
271 const struct wps_device_data
*dev
);
274 * reg_success_cb - Callback for reporting successful registration
275 * @ctx: Higher layer context data (cb_ctx)
276 * @mac_addr: MAC address of the Enrollee
277 * @uuid_e: UUID-E of the Enrollee
279 * This callback is called whenever an Enrollee completes registration
282 void (*reg_success_cb
)(void *ctx
, const u8
*mac_addr
,
286 * set_sel_reg_cb - Callback for reporting selected registrar changes
287 * @ctx: Higher layer context data (cb_ctx)
288 * @sel_reg: Whether the Registrar is selected
289 * @dev_passwd_id: Device Password ID to indicate with method or
290 * specific password the Registrar intends to use
291 * @sel_reg_config_methods: Bit field of active config methods
293 * This callback is called whenever the Selected Registrar state
294 * changes (e.g., a new PIN becomes available or PBC is invoked). This
295 * callback is only used by External Registrar implementation;
296 * set_ie_cb() is used by AP implementation in similar caes, but it
297 * provides the full WPS IE data instead of just the minimal Registrar
300 void (*set_sel_reg_cb
)(void *ctx
, int sel_reg
, u16 dev_passwd_id
,
301 u16 sel_reg_config_methods
);
304 * enrollee_seen_cb - Callback for reporting Enrollee based on ProbeReq
305 * @ctx: Higher layer context data (cb_ctx)
306 * @addr: MAC address of the Enrollee
307 * @uuid_e: UUID of the Enrollee
308 * @pri_dev_type: Primary device type
309 * @config_methods: Config Methods
310 * @dev_password_id: Device Password ID
311 * @request_type: Request Type
312 * @dev_name: Device Name (if available)
314 void (*enrollee_seen_cb
)(void *ctx
, const u8
*addr
, const u8
*uuid_e
,
315 const u8
*pri_dev_type
, u16 config_methods
,
316 u16 dev_password_id
, u8 request_type
,
317 const char *dev_name
);
320 * cb_ctx: Higher layer context data for Registrar callbacks
325 * skip_cred_build: Do not build credential
327 * This option can be used to disable internal code that builds
328 * Credential attribute into M8 based on the current network
329 * configuration and Enrollee capabilities. The extra_cred data will
330 * then be used as the Credential(s).
335 * extra_cred: Additional Credential attribute(s)
337 * This optional data (set to %NULL to disable) can be used to add
338 * Credential attribute(s) for other networks into M8. If
339 * skip_cred_build is set, this will also override the automatically
340 * generated Credential attribute.
342 const u8
*extra_cred
;
345 * extra_cred_len: Length of extra_cred in octets
347 size_t extra_cred_len
;
350 * disable_auto_conf - Disable auto-configuration on first registration
352 * By default, the AP that is started in not configured state will
353 * generate a random PSK and move to configured state when the first
354 * registration protocol run is completed successfully. This option can
355 * be used to disable this functionality and leave it up to an external
356 * program to take care of configuration. This requires the extra_cred
357 * to be set with a suitable Credential and skip_cred_build being used.
359 int disable_auto_conf
;
362 * static_wep_only - Whether the BSS supports only static WEP
367 * dualband - Whether this is a concurrent dualband AP
374 * enum wps_event - WPS event types
378 * WPS_EV_M2D - M2D received (Registrar did not know us)
383 * WPS_EV_FAIL - Registration failed
388 * WPS_EV_SUCCESS - Registration succeeded
393 * WPS_EV_PWD_AUTH_FAIL - Password authentication failed
395 WPS_EV_PWD_AUTH_FAIL
,
398 * WPS_EV_PBC_OVERLAP - PBC session overlap detected
403 * WPS_EV_PBC_TIMEOUT - PBC walktime expired before protocol run start
408 * WPS_EV_ER_AP_ADD - ER: AP added
413 * WPS_EV_ER_AP_REMOVE - ER: AP removed
418 * WPS_EV_ER_ENROLLEE_ADD - ER: Enrollee added
420 WPS_EV_ER_ENROLLEE_ADD
,
423 * WPS_EV_ER_ENROLLEE_REMOVE - ER: Enrollee removed
425 WPS_EV_ER_ENROLLEE_REMOVE
,
428 * WPS_EV_ER_AP_SETTINGS - ER: AP Settings learned
430 WPS_EV_ER_AP_SETTINGS
,
433 * WPS_EV_ER_SET_SELECTED_REGISTRAR - ER: SetSelectedRegistrar event
435 WPS_EV_ER_SET_SELECTED_REGISTRAR
439 * union wps_event_data - WPS event data
441 union wps_event_data
{
443 * struct wps_event_m2d - M2D event data
445 struct wps_event_m2d
{
447 const u8
*manufacturer
;
448 size_t manufacturer_len
;
449 const u8
*model_name
;
450 size_t model_name_len
;
451 const u8
*model_number
;
452 size_t model_number_len
;
453 const u8
*serial_number
;
454 size_t serial_number_len
;
457 const u8
*primary_dev_type
; /* 8 octets */
463 * struct wps_event_fail - Registration failure information
464 * @msg: enum wps_msg_type
466 struct wps_event_fail
{
469 u16 error_indication
;
472 struct wps_event_pwd_auth_fail
{
477 struct wps_event_er_ap
{
480 const char *friendly_name
;
481 const char *manufacturer
;
482 const char *manufacturer_url
;
483 const char *model_description
;
484 const char *model_name
;
485 const char *model_number
;
486 const char *model_url
;
487 const char *serial_number
;
489 const u8
*pri_dev_type
;
493 struct wps_event_er_enrollee
{
499 const u8
*pri_dev_type
;
500 const char *dev_name
;
501 const char *manufacturer
;
502 const char *model_name
;
503 const char *model_number
;
504 const char *serial_number
;
507 struct wps_event_er_ap_settings
{
509 const struct wps_credential
*cred
;
512 struct wps_event_er_set_selected_registrar
{
516 u16 sel_reg_config_methods
;
518 WPS_ER_SET_SEL_REG_START
,
519 WPS_ER_SET_SEL_REG_DONE
,
520 WPS_ER_SET_SEL_REG_FAILED
526 * struct upnp_pending_message - Pending PutWLANResponse messages
527 * @next: Pointer to next pending message or %NULL
528 * @addr: NewWLANEventMAC
530 * @type: Message Type
532 struct upnp_pending_message
{
533 struct upnp_pending_message
*next
;
536 enum wps_msg_type type
;
540 * struct wps_context - Long term WPS context data
542 * This data is stored at the higher layer Authenticator or Supplicant data
543 * structures and it is maintained over multiple registration protocol runs.
547 * ap - Whether the local end is an access point
552 * registrar - Pointer to WPS registrar data from wps_registrar_init()
554 struct wps_registrar
*registrar
;
557 * wps_state - Current WPS state
559 enum wps_state wps_state
;
562 * ap_setup_locked - Whether AP setup is locked (only used at AP)
574 * This SSID is used by the Registrar to fill in information for
575 * Credentials. In addition, AP uses it when acting as an Enrollee to
576 * notify Registrar of the current configuration.
581 * ssid_len - Length of ssid in octets
586 * dev - Own WPS device data
588 struct wps_device_data dev
;
591 * oob_conf - OOB Config data
593 struct oob_conf_data oob_conf
;
596 * oob_dev_pw_id - OOB Device password id
601 * dh_ctx - Context data for Diffie-Hellman operation
606 * dh_privkey - Diffie-Hellman private key
608 struct wpabuf
*dh_privkey
;
611 * dh_pubkey_oob - Diffie-Hellman public key
613 struct wpabuf
*dh_pubkey
;
616 * config_methods - Enabled configuration methods
618 * Bit field of WPS_CONFIG_*
623 * encr_types - Enabled encryption types (bit field of WPS_ENCR_*)
628 * auth_types - Authentication types (bit field of WPS_AUTH_*)
633 * network_key - The current Network Key (PSK) or %NULL to generate new
635 * If %NULL, Registrar will generate per-device PSK. In addition, AP
636 * uses this when acting as an Enrollee to notify Registrar of the
637 * current configuration.
639 * When using WPA/WPA2-Person, this key can be either the ASCII
640 * passphrase (8..63 characters) or the 32-octet PSK (64 hex
641 * characters). When this is set to the ASCII passphrase, the PSK can
642 * be provided in the psk buffer and used per-Enrollee to control which
643 * key type is included in the Credential (e.g., to reduce calculation
644 * need on low-powered devices by provisioning PSK while still allowing
645 * other devices to get the passphrase).
650 * network_key_len - Length of network_key in octets
652 size_t network_key_len
;
655 * psk - The current network PSK
657 * This optional value can be used to provide the current PSK if
658 * network_key is set to the ASCII passphrase.
663 * psk_set - Whether psk value is set
668 * ap_settings - AP Settings override for M7 (only used at AP)
670 * If %NULL, AP Settings attributes will be generated based on the
671 * current network configuration.
676 * ap_settings_len - Length of ap_settings in octets
678 size_t ap_settings_len
;
681 * friendly_name - Friendly Name (required for UPnP)
686 * manufacturer_url - Manufacturer URL (optional for UPnP)
688 char *manufacturer_url
;
691 * model_description - Model Description (recommended for UPnP)
693 char *model_description
;
696 * model_url - Model URL (optional for UPnP)
701 * upc - Universal Product Code (optional for UPnP)
706 * cred_cb - Callback to notify that new Credentials were received
707 * @ctx: Higher layer context data (cb_ctx)
708 * @cred: The received Credential
709 * Return: 0 on success, -1 on failure
711 int (*cred_cb
)(void *ctx
, const struct wps_credential
*cred
);
714 * event_cb - Event callback (state information about progress)
715 * @ctx: Higher layer context data (cb_ctx)
719 void (*event_cb
)(void *ctx
, enum wps_event event
,
720 union wps_event_data
*data
);
723 * cb_ctx: Higher layer context data for callbacks
727 struct upnp_wps_device_sm
*wps_upnp
;
729 /* Pending messages from UPnP PutWLANResponse */
730 struct upnp_pending_message
*upnp_msgs
;
733 struct oob_device_data
{
736 void * (*init_func
)(struct wps_context
*, struct oob_device_data
*,
738 struct wpabuf
* (*read_func
)(void *);
739 int (*write_func
)(void *, struct wpabuf
*);
740 void (*deinit_func
)(void *);
743 struct oob_nfc_device_data
{
744 int (*init_func
)(char *);
745 void * (*read_func
)(size_t *);
746 int (*write_func
)(void *, size_t);
747 void (*deinit_func
)(void);
750 struct wps_registrar
*
751 wps_registrar_init(struct wps_context
*wps
,
752 const struct wps_registrar_config
*cfg
);
753 void wps_registrar_deinit(struct wps_registrar
*reg
);
754 int wps_registrar_add_pin(struct wps_registrar
*reg
, const u8
*addr
,
755 const u8
*uuid
, const u8
*pin
, size_t pin_len
,
757 int wps_registrar_invalidate_pin(struct wps_registrar
*reg
, const u8
*uuid
);
758 int wps_registrar_wps_cancel(struct wps_registrar
*reg
);
759 int wps_registrar_unlock_pin(struct wps_registrar
*reg
, const u8
*uuid
);
760 int wps_registrar_button_pushed(struct wps_registrar
*reg
,
761 const u8
*p2p_dev_addr
);
762 void wps_registrar_probe_req_rx(struct wps_registrar
*reg
, const u8
*addr
,
763 const struct wpabuf
*wps_data
,
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
);
771 unsigned int wps_pin_checksum(unsigned int pin
);
772 unsigned int wps_pin_valid(unsigned int pin
);
773 unsigned int wps_generate_pin(void);
774 void wps_free_pending_msgs(struct upnp_pending_message
*msgs
);
776 struct oob_device_data
* wps_get_oob_device(char *device_type
);
777 struct oob_nfc_device_data
* wps_get_oob_nfc_device(char *device_name
);
778 int wps_get_oob_method(char *method
);
779 int wps_process_oob(struct wps_context
*wps
, struct oob_device_data
*oob_dev
,
781 int wps_attr_text(struct wpabuf
*data
, char *buf
, char *end
);
783 struct wps_er
* wps_er_init(struct wps_context
*wps
, const char *ifname
,
785 void wps_er_refresh(struct wps_er
*er
);
786 void wps_er_deinit(struct wps_er
*er
, void (*cb
)(void *ctx
), void *ctx
);
787 void wps_er_set_sel_reg(struct wps_er
*er
, int sel_reg
, u16 dev_passwd_id
,
788 u16 sel_reg_config_methods
);
789 int wps_er_pbc(struct wps_er
*er
, const u8
*uuid
);
790 int wps_er_learn(struct wps_er
*er
, const u8
*uuid
, const u8
*pin
,
792 int wps_er_set_config(struct wps_er
*er
, const u8
*uuid
,
793 const struct wps_credential
*cred
);
794 int wps_er_config(struct wps_er
*er
, const u8
*uuid
, const u8
*pin
,
795 size_t pin_len
, const struct wps_credential
*cred
);
797 int wps_dev_type_str2bin(const char *str
, u8 dev_type
[WPS_DEV_TYPE_LEN
]);
798 char * wps_dev_type_bin2str(const u8 dev_type
[WPS_DEV_TYPE_LEN
], char *buf
,
800 void uuid_gen_mac_addr(const u8
*mac_addr
, u8
*uuid
);
801 u16
wps_config_methods_str2bin(const char *str
);
803 #ifdef CONFIG_WPS_STRICT
804 int wps_validate_beacon(const struct wpabuf
*wps_ie
);
805 int wps_validate_beacon_probe_resp(const struct wpabuf
*wps_ie
, int probe
,
807 int wps_validate_probe_req(const struct wpabuf
*wps_ie
, const u8
*addr
);
808 int wps_validate_assoc_req(const struct wpabuf
*wps_ie
);
809 int wps_validate_assoc_resp(const struct wpabuf
*wps_ie
);
810 int wps_validate_m1(const struct wpabuf
*tlvs
);
811 int wps_validate_m2(const struct wpabuf
*tlvs
);
812 int wps_validate_m2d(const struct wpabuf
*tlvs
);
813 int wps_validate_m3(const struct wpabuf
*tlvs
);
814 int wps_validate_m4(const struct wpabuf
*tlvs
);
815 int wps_validate_m4_encr(const struct wpabuf
*tlvs
, int wps2
);
816 int wps_validate_m5(const struct wpabuf
*tlvs
);
817 int wps_validate_m5_encr(const struct wpabuf
*tlvs
, int wps2
);
818 int wps_validate_m6(const struct wpabuf
*tlvs
);
819 int wps_validate_m6_encr(const struct wpabuf
*tlvs
, int wps2
);
820 int wps_validate_m7(const struct wpabuf
*tlvs
);
821 int wps_validate_m7_encr(const struct wpabuf
*tlvs
, int ap
, int wps2
);
822 int wps_validate_m8(const struct wpabuf
*tlvs
);
823 int wps_validate_m8_encr(const struct wpabuf
*tlvs
, int ap
, int wps2
);
824 int wps_validate_wsc_ack(const struct wpabuf
*tlvs
);
825 int wps_validate_wsc_nack(const struct wpabuf
*tlvs
);
826 int wps_validate_wsc_done(const struct wpabuf
*tlvs
);
827 int wps_validate_upnp_set_selected_registrar(const struct wpabuf
*tlvs
);
828 #else /* CONFIG_WPS_STRICT */
829 static inline int wps_validate_beacon(const struct wpabuf
*wps_ie
){
833 static inline int wps_validate_beacon_probe_resp(const struct wpabuf
*wps_ie
,
834 int probe
, const u8
*addr
)
839 static inline int wps_validate_probe_req(const struct wpabuf
*wps_ie
,
845 static inline int wps_validate_assoc_req(const struct wpabuf
*wps_ie
)
850 static inline int wps_validate_assoc_resp(const struct wpabuf
*wps_ie
)
855 static inline int wps_validate_m1(const struct wpabuf
*tlvs
)
860 static inline int wps_validate_m2(const struct wpabuf
*tlvs
)
865 static inline int wps_validate_m2d(const struct wpabuf
*tlvs
)
870 static inline int wps_validate_m3(const struct wpabuf
*tlvs
)
875 static inline int wps_validate_m4(const struct wpabuf
*tlvs
)
880 static inline int wps_validate_m4_encr(const struct wpabuf
*tlvs
, int wps2
)
885 static inline int wps_validate_m5(const struct wpabuf
*tlvs
)
890 static inline int wps_validate_m5_encr(const struct wpabuf
*tlvs
, int wps2
)
895 static inline int wps_validate_m6(const struct wpabuf
*tlvs
)
900 static inline int wps_validate_m6_encr(const struct wpabuf
*tlvs
, int wps2
)
905 static inline int wps_validate_m7(const struct wpabuf
*tlvs
)
910 static inline int wps_validate_m7_encr(const struct wpabuf
*tlvs
, int ap
,
916 static inline int wps_validate_m8(const struct wpabuf
*tlvs
)
921 static inline int wps_validate_m8_encr(const struct wpabuf
*tlvs
, int ap
,
927 static inline int wps_validate_wsc_ack(const struct wpabuf
*tlvs
)
932 static inline int wps_validate_wsc_nack(const struct wpabuf
*tlvs
)
937 static inline int wps_validate_wsc_done(const struct wpabuf
*tlvs
)
942 static inline int wps_validate_upnp_set_selected_registrar(
943 const struct wpabuf
*tlvs
)
947 #endif /* CONFIG_WPS_STRICT */