WPS: Make Config Methods configurable for wpa_supplicant
[libeap.git] / src / wps / wps.h
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
67 /**
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  */
79 struct wps_device_data {
80         u8 mac_addr[ETH_ALEN];
81         char *device_name;
82         char *manufacturer;
83         char *model_name;
84         char *model_number;
85         char *serial_number;
86         u8 pri_dev_type[WPS_DEV_TYPE_LEN];
87         u32 os_version;
88         u8 rf_bands;
89 };
90
91 struct oob_conf_data {
92         enum {
93                 OOB_METHOD_UNKNOWN = 0,
94                 OOB_METHOD_DEV_PWD_E,
95                 OOB_METHOD_DEV_PWD_R,
96                 OOB_METHOD_CRED,
97         } oob_method;
98         struct wpabuf *dev_password;
99         struct wpabuf *pubkey_hash;
100 };
101
102 /**
103  * struct wps_config - WPS configuration for a single registration protocol run
104  */
105 struct wps_config {
106         /**
107          * wps - Pointer to long term WPS context
108          */
109         struct wps_context *wps;
110
111         /**
112          * registrar - Whether this end is a Registrar
113          */
114         int registrar;
115
116         /**
117          * pin - Enrollee Device Password (%NULL for Registrar or PBC)
118          */
119         const u8 *pin;
120
121         /**
122          * pin_len - Length on pin in octets
123          */
124         size_t pin_len;
125
126         /**
127          * pbc - Whether this is protocol run uses PBC
128          */
129         int pbc;
130
131         /**
132          * assoc_wps_ie: (Re)AssocReq WPS IE (in AP; %NULL if not AP)
133          */
134         const struct wpabuf *assoc_wps_ie;
135
136         /**
137          * new_ap_settings - New AP settings (%NULL if not used)
138          *
139          * This parameter provides new AP settings when using a wireless
140          * stations as a Registrar to configure the AP. %NULL means that AP
141          * will not be reconfigured, i.e., the station will only learn the
142          * current AP settings by using AP PIN.
143          */
144         const struct wps_credential *new_ap_settings;
145
146         /**
147          * peer_addr: MAC address of the peer in AP; %NULL if not AP
148          */
149         const u8 *peer_addr;
150
151         /**
152          * use_psk_key - Use PSK format key in Credential
153          *
154          * Force PSK format to be used instead of ASCII passphrase when
155          * building Credential for an Enrollee. The PSK value is set in
156          * struct wpa_context::psk.
157          */
158         int use_psk_key;
159 };
160
161 struct wps_data * wps_init(const struct wps_config *cfg);
162
163 void wps_deinit(struct wps_data *data);
164
165 /**
166  * enum wps_process_res - WPS message processing result
167  */
168 enum wps_process_res {
169         /**
170          * WPS_DONE - Processing done
171          */
172         WPS_DONE,
173
174         /**
175          * WPS_CONTINUE - Processing continues
176          */
177         WPS_CONTINUE,
178
179         /**
180          * WPS_FAILURE - Processing failed
181          */
182         WPS_FAILURE,
183
184         /**
185          * WPS_PENDING - Processing continues, but waiting for an external
186          *      event (e.g., UPnP message from an external Registrar)
187          */
188         WPS_PENDING
189 };
190 enum wps_process_res wps_process_msg(struct wps_data *wps,
191                                      enum wsc_op_code op_code,
192                                      const struct wpabuf *msg);
193
194 struct wpabuf * wps_get_msg(struct wps_data *wps, enum wsc_op_code *op_code);
195
196 int wps_is_selected_pbc_registrar(const struct wpabuf *msg);
197 int wps_is_selected_pin_registrar(const struct wpabuf *msg);
198 const u8 * wps_get_uuid_e(const struct wpabuf *msg);
199
200 struct wpabuf * wps_build_assoc_req_ie(enum wps_request_type req_type);
201 struct wpabuf * wps_build_probe_req_ie(int pbc, struct wps_device_data *dev,
202                                        const u8 *uuid,
203                                        enum wps_request_type req_type);
204
205
206 /**
207  * struct wps_registrar_config - WPS Registrar configuration
208  */
209 struct wps_registrar_config {
210         /**
211          * new_psk_cb - Callback for new PSK
212          * @ctx: Higher layer context data (cb_ctx)
213          * @mac_addr: MAC address of the Enrollee
214          * @psk: The new PSK
215          * @psk_len: The length of psk in octets
216          * Returns: 0 on success, -1 on failure
217          *
218          * This callback is called when a new per-device PSK is provisioned.
219          */
220         int (*new_psk_cb)(void *ctx, const u8 *mac_addr, const u8 *psk,
221                           size_t psk_len);
222
223         /**
224          * set_ie_cb - Callback for WPS IE changes
225          * @ctx: Higher layer context data (cb_ctx)
226          * @beacon_ie: WPS IE for Beacon
227          * @beacon_ie_len: WPS IE length for Beacon
228          * @probe_resp_ie: WPS IE for Probe Response
229          * @probe_resp_ie_len: WPS IE length for Probe Response
230          * Returns: 0 on success, -1 on failure
231          *
232          * This callback is called whenever the WPS IE in Beacon or Probe
233          * Response frames needs to be changed (AP only).
234          */
235         int (*set_ie_cb)(void *ctx, const u8 *beacon_ie, size_t beacon_ie_len,
236                          const u8 *probe_resp_ie, size_t probe_resp_ie_len);
237
238         /**
239          * pin_needed_cb - Callback for requesting a PIN
240          * @ctx: Higher layer context data (cb_ctx)
241          * @uuid_e: UUID-E of the unknown Enrollee
242          * @dev: Device Data from the unknown Enrollee
243          *
244          * This callback is called whenever an unknown Enrollee requests to use
245          * PIN method and a matching PIN (Device Password) is not found in
246          * Registrar data.
247          */
248         void (*pin_needed_cb)(void *ctx, const u8 *uuid_e,
249                               const struct wps_device_data *dev);
250
251         /**
252          * reg_success_cb - Callback for reporting successful registration
253          * @ctx: Higher layer context data (cb_ctx)
254          * @mac_addr: MAC address of the Enrollee
255          * @uuid_e: UUID-E of the Enrollee
256          *
257          * This callback is called whenever an Enrollee completes registration
258          * successfully.
259          */
260         void (*reg_success_cb)(void *ctx, const u8 *mac_addr,
261                                const u8 *uuid_e);
262
263         /**
264          * set_sel_reg_cb - Callback for reporting selected registrar changes
265          * @ctx: Higher layer context data (cb_ctx)
266          * @sel_reg: Whether the Registrar is selected
267          * @dev_passwd_id: Device Password ID to indicate with method or
268          *      specific password the Registrar intends to use
269          * @sel_reg_config_methods: Bit field of active config methods
270          *
271          * This callback is called whenever the Selected Registrar state
272          * changes (e.g., a new PIN becomes available or PBC is invoked). This
273          * callback is only used by External Registrar implementation;
274          * set_ie_cb() is used by AP implementation in similar caes, but it
275          * provides the full WPS IE data instead of just the minimal Registrar
276          * state information.
277          */
278         void (*set_sel_reg_cb)(void *ctx, int sel_reg, u16 dev_passwd_id,
279                                u16 sel_reg_config_methods);
280
281         /**
282          * cb_ctx: Higher layer context data for Registrar callbacks
283          */
284         void *cb_ctx;
285
286         /**
287          * skip_cred_build: Do not build credential
288          *
289          * This option can be used to disable internal code that builds
290          * Credential attribute into M8 based on the current network
291          * configuration and Enrollee capabilities. The extra_cred data will
292          * then be used as the Credential(s).
293          */
294         int skip_cred_build;
295
296         /**
297          * extra_cred: Additional Credential attribute(s)
298          *
299          * This optional data (set to %NULL to disable) can be used to add
300          * Credential attribute(s) for other networks into M8. If
301          * skip_cred_build is set, this will also override the automatically
302          * generated Credential attribute.
303          */
304         const u8 *extra_cred;
305
306         /**
307          * extra_cred_len: Length of extra_cred in octets
308          */
309         size_t extra_cred_len;
310
311         /**
312          * disable_auto_conf - Disable auto-configuration on first registration
313          *
314          * By default, the AP that is started in not configured state will
315          * generate a random PSK and move to configured state when the first
316          * registration protocol run is completed successfully. This option can
317          * be used to disable this functionality and leave it up to an external
318          * program to take care of configuration. This requires the extra_cred
319          * to be set with a suitable Credential and skip_cred_build being used.
320          */
321         int disable_auto_conf;
322
323         /**
324          * static_wep_only - Whether the BSS supports only static WEP
325          */
326         int static_wep_only;
327 };
328
329
330 /**
331  * enum wps_event - WPS event types
332  */
333 enum wps_event {
334         /**
335          * WPS_EV_M2D - M2D received (Registrar did not know us)
336          */
337         WPS_EV_M2D,
338
339         /**
340          * WPS_EV_FAIL - Registration failed
341          */
342         WPS_EV_FAIL,
343
344         /**
345          * WPS_EV_SUCCESS - Registration succeeded
346          */
347         WPS_EV_SUCCESS,
348
349         /**
350          * WPS_EV_PWD_AUTH_FAIL - Password authentication failed
351          */
352         WPS_EV_PWD_AUTH_FAIL,
353
354         /**
355          * WPS_EV_PBC_OVERLAP - PBC session overlap detected
356          */
357         WPS_EV_PBC_OVERLAP,
358
359         /**
360          * WPS_EV_PBC_TIMEOUT - PBC walktime expired before protocol run start
361          */
362         WPS_EV_PBC_TIMEOUT,
363
364         /**
365          * WPS_EV_ER_AP_ADD - ER: AP added
366          */
367         WPS_EV_ER_AP_ADD,
368
369         /**
370          * WPS_EV_ER_AP_REMOVE - ER: AP removed
371          */
372         WPS_EV_ER_AP_REMOVE,
373
374         /**
375          * WPS_EV_ER_ENROLLEE_ADD - ER: Enrollee added
376          */
377         WPS_EV_ER_ENROLLEE_ADD,
378
379         /**
380          * WPS_EV_ER_ENROLLEE_REMOVE - ER: Enrollee removed
381          */
382         WPS_EV_ER_ENROLLEE_REMOVE
383 };
384
385 /**
386  * union wps_event_data - WPS event data
387  */
388 union wps_event_data {
389         /**
390          * struct wps_event_m2d - M2D event data
391          */
392         struct wps_event_m2d {
393                 u16 config_methods;
394                 const u8 *manufacturer;
395                 size_t manufacturer_len;
396                 const u8 *model_name;
397                 size_t model_name_len;
398                 const u8 *model_number;
399                 size_t model_number_len;
400                 const u8 *serial_number;
401                 size_t serial_number_len;
402                 const u8 *dev_name;
403                 size_t dev_name_len;
404                 const u8 *primary_dev_type; /* 8 octets */
405                 u16 config_error;
406                 u16 dev_password_id;
407         } m2d;
408
409         /**
410          * struct wps_event_fail - Registration failure information
411          * @msg: enum wps_msg_type
412          */
413         struct wps_event_fail {
414                 int msg;
415         } fail;
416
417         struct wps_event_pwd_auth_fail {
418                 int enrollee;
419                 int part;
420         } pwd_auth_fail;
421
422         struct wps_event_er_ap {
423                 const u8 *uuid;
424                 const u8 *mac_addr;
425                 const char *friendly_name;
426                 const char *manufacturer;
427                 const char *manufacturer_url;
428                 const char *model_description;
429                 const char *model_name;
430                 const char *model_number;
431                 const char *model_url;
432                 const char *serial_number;
433                 const char *upc;
434                 const u8 *pri_dev_type;
435                 u8 wps_state;
436         } ap;
437
438         struct wps_event_er_enrollee {
439                 const u8 *uuid;
440                 const u8 *mac_addr;
441                 int m1_received;
442                 u16 config_methods;
443                 u16 dev_passwd_id;
444                 const u8 *pri_dev_type;
445                 const char *dev_name;
446                 const char *manufacturer;
447                 const char *model_name;
448                 const char *model_number;
449                 const char *serial_number;
450         } enrollee;
451 };
452
453 /**
454  * struct upnp_pending_message - Pending PutWLANResponse messages
455  * @next: Pointer to next pending message or %NULL
456  * @addr: NewWLANEventMAC
457  * @msg: NewMessage
458  * @type: Message Type
459  */
460 struct upnp_pending_message {
461         struct upnp_pending_message *next;
462         u8 addr[ETH_ALEN];
463         struct wpabuf *msg;
464         enum wps_msg_type type;
465 };
466
467 /**
468  * struct wps_context - Long term WPS context data
469  *
470  * This data is stored at the higher layer Authenticator or Supplicant data
471  * structures and it is maintained over multiple registration protocol runs.
472  */
473 struct wps_context {
474         /**
475          * ap - Whether the local end is an access point
476          */
477         int ap;
478
479         /**
480          * registrar - Pointer to WPS registrar data from wps_registrar_init()
481          */
482         struct wps_registrar *registrar;
483
484         /**
485          * wps_state - Current WPS state
486          */
487         enum wps_state wps_state;
488
489         /**
490          * ap_setup_locked - Whether AP setup is locked (only used at AP)
491          */
492         int ap_setup_locked;
493
494         /**
495          * uuid - Own UUID
496          */
497         u8 uuid[16];
498
499         /**
500          * ssid - SSID
501          *
502          * This SSID is used by the Registrar to fill in information for
503          * Credentials. In addition, AP uses it when acting as an Enrollee to
504          * notify Registrar of the current configuration.
505          */
506         u8 ssid[32];
507
508         /**
509          * ssid_len - Length of ssid in octets
510          */
511         size_t ssid_len;
512
513         /**
514          * dev - Own WPS device data
515          */
516         struct wps_device_data dev;
517
518         /**
519          * oob_conf - OOB Config data
520          */
521         struct oob_conf_data oob_conf;
522
523         /**
524          * oob_dev_pw_id - OOB Device password id
525          */
526         u16 oob_dev_pw_id;
527
528         /**
529          * dh_ctx - Context data for Diffie-Hellman operation
530          */
531         void *dh_ctx;
532
533         /**
534          * dh_privkey - Diffie-Hellman private key
535          */
536         struct wpabuf *dh_privkey;
537
538         /**
539          * dh_pubkey_oob - Diffie-Hellman public key
540          */
541         struct wpabuf *dh_pubkey;
542
543         /**
544          * config_methods - Enabled configuration methods
545          *
546          * Bit field of WPS_CONFIG_*
547          */
548         u16 config_methods;
549
550         /**
551          * encr_types - Enabled encryption types (bit field of WPS_ENCR_*)
552          */
553         u16 encr_types;
554
555         /**
556          * auth_types - Authentication types (bit field of WPS_AUTH_*)
557          */
558         u16 auth_types;
559
560         /**
561          * network_key - The current Network Key (PSK) or %NULL to generate new
562          *
563          * If %NULL, Registrar will generate per-device PSK. In addition, AP
564          * uses this when acting as an Enrollee to notify Registrar of the
565          * current configuration.
566          *
567          * When using WPA/WPA2-Person, this key can be either the ASCII
568          * passphrase (8..63 characters) or the 32-octet PSK (64 hex
569          * characters). When this is set to the ASCII passphrase, the PSK can
570          * be provided in the psk buffer and used per-Enrollee to control which
571          * key type is included in the Credential (e.g., to reduce calculation
572          * need on low-powered devices by provisioning PSK while still allowing
573          * other devices to get the passphrase).
574          */
575         u8 *network_key;
576
577         /**
578          * network_key_len - Length of network_key in octets
579          */
580         size_t network_key_len;
581
582         /**
583          * psk - The current network PSK
584          *
585          * This optional value can be used to provide the current PSK if
586          * network_key is set to the ASCII passphrase.
587          */
588         u8 psk[32];
589
590         /**
591          * psk_set - Whether psk value is set
592          */
593         int psk_set;
594
595         /**
596          * ap_settings - AP Settings override for M7 (only used at AP)
597          *
598          * If %NULL, AP Settings attributes will be generated based on the
599          * current network configuration.
600          */
601         u8 *ap_settings;
602
603         /**
604          * ap_settings_len - Length of ap_settings in octets
605          */
606         size_t ap_settings_len;
607
608         /**
609          * friendly_name - Friendly Name (required for UPnP)
610          */
611         char *friendly_name;
612
613         /**
614          * manufacturer_url - Manufacturer URL (optional for UPnP)
615          */
616         char *manufacturer_url;
617
618         /**
619          * model_description - Model Description (recommended for UPnP)
620          */
621         char *model_description;
622
623         /**
624          * model_url - Model URL (optional for UPnP)
625          */
626         char *model_url;
627
628         /**
629          * upc - Universal Product Code (optional for UPnP)
630          */
631         char *upc;
632
633         /**
634          * cred_cb - Callback to notify that new Credentials were received
635          * @ctx: Higher layer context data (cb_ctx)
636          * @cred: The received Credential
637          * Return: 0 on success, -1 on failure
638          */
639         int (*cred_cb)(void *ctx, const struct wps_credential *cred);
640
641         /**
642          * event_cb - Event callback (state information about progress)
643          * @ctx: Higher layer context data (cb_ctx)
644          * @event: Event type
645          * @data: Event data
646          */
647         void (*event_cb)(void *ctx, enum wps_event event,
648                          union wps_event_data *data);
649
650         /**
651          * cb_ctx: Higher layer context data for callbacks
652          */
653         void *cb_ctx;
654
655         struct upnp_wps_device_sm *wps_upnp;
656
657         /* Pending messages from UPnP PutWLANResponse */
658         struct upnp_pending_message *upnp_msgs;
659 };
660
661 struct oob_device_data {
662         char *device_name;
663         char *device_path;
664         void * (*init_func)(struct wps_context *, struct oob_device_data *,
665                             int);
666         struct wpabuf * (*read_func)(void *);
667         int (*write_func)(void *, struct wpabuf *);
668         void (*deinit_func)(void *);
669 };
670
671 struct oob_nfc_device_data {
672         int (*init_func)(char *);
673         void * (*read_func)(size_t *);
674         int (*write_func)(void *, size_t);
675         void (*deinit_func)(void);
676 };
677
678 struct wps_registrar *
679 wps_registrar_init(struct wps_context *wps,
680                    const struct wps_registrar_config *cfg);
681 void wps_registrar_deinit(struct wps_registrar *reg);
682 int wps_registrar_add_pin(struct wps_registrar *reg, const u8 *uuid,
683                           const u8 *pin, size_t pin_len, int timeout);
684 int wps_registrar_invalidate_pin(struct wps_registrar *reg, const u8 *uuid);
685 int wps_registrar_unlock_pin(struct wps_registrar *reg, const u8 *uuid);
686 int wps_registrar_button_pushed(struct wps_registrar *reg);
687 void wps_registrar_probe_req_rx(struct wps_registrar *reg, const u8 *addr,
688                                 const struct wpabuf *wps_data);
689 int wps_registrar_update_ie(struct wps_registrar *reg);
690 int wps_registrar_get_info(struct wps_registrar *reg, const u8 *addr,
691                            char *buf, size_t buflen);
692
693 unsigned int wps_pin_checksum(unsigned int pin);
694 unsigned int wps_pin_valid(unsigned int pin);
695 unsigned int wps_generate_pin(void);
696 void wps_free_pending_msgs(struct upnp_pending_message *msgs);
697
698 struct oob_device_data * wps_get_oob_device(char *device_type);
699 struct oob_nfc_device_data * wps_get_oob_nfc_device(char *device_name);
700 int wps_get_oob_method(char *method);
701 int wps_process_oob(struct wps_context *wps, struct oob_device_data *oob_dev,
702                     int registrar);
703 int wps_attr_text(struct wpabuf *data, char *buf, char *end);
704
705 struct wps_er * wps_er_init(struct wps_context *wps, const char *ifname);
706 void wps_er_refresh(struct wps_er *er);
707 void wps_er_deinit(struct wps_er *er, void (*cb)(void *ctx), void *ctx);
708 void wps_er_set_sel_reg(struct wps_er *er, int sel_reg, u16 dev_passwd_id,
709                         u16 sel_reg_config_methods);
710 int wps_er_pbc(struct wps_er *er, const u8 *uuid);
711 int wps_er_learn(struct wps_er *er, const u8 *uuid, const u8 *pin,
712                  size_t pin_len);
713
714 int wps_dev_type_str2bin(const char *str, u8 dev_type[WPS_DEV_TYPE_LEN]);
715 char * wps_dev_type_bin2str(const u8 dev_type[WPS_DEV_TYPE_LEN], char *buf,
716                             size_t buf_len);
717 void uuid_gen_mac_addr(const u8 *mac_addr, u8 *uuid);
718 u16 wps_config_methods_str2bin(const char *str);
719
720 #endif /* WPS_H */