src/wps/wps.h

   1 /*
   2  * Wi-Fi Protected Setup
   3  * Copyright (c) 2007-2013, Jouni Malinen <j@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          * force_per_enrollee_psk - Force per-Enrollee random PSK
 388          *
 389          * This forces per-Enrollee random PSK to be generated even if a default
 390          * PSK is set for a network.
 391          */
 392         int force_per_enrollee_psk;
 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_PBC_ACTIVE - PBC mode was activated
 432          */
 433         WPS_EV_PBC_ACTIVE,
 434
 435         /**
 436          * WPS_EV_PBC_DISABLE - PBC mode was disabled
 437          */
 438         WPS_EV_PBC_DISABLE,
 439
 440         /**
 441          * WPS_EV_ER_AP_ADD - ER: AP added
 442          */
 443         WPS_EV_ER_AP_ADD,
 444
 445         /**
 446          * WPS_EV_ER_AP_REMOVE - ER: AP removed
 447          */
 448         WPS_EV_ER_AP_REMOVE,
 449
 450         /**
 451          * WPS_EV_ER_ENROLLEE_ADD - ER: Enrollee added
 452          */
 453         WPS_EV_ER_ENROLLEE_ADD,
 454
 455         /**
 456          * WPS_EV_ER_ENROLLEE_REMOVE - ER: Enrollee removed
 457          */
 458         WPS_EV_ER_ENROLLEE_REMOVE,
 459
 460         /**
 461          * WPS_EV_ER_AP_SETTINGS - ER: AP Settings learned
 462          */
 463         WPS_EV_ER_AP_SETTINGS,
 464
 465         /**
 466          * WPS_EV_ER_SET_SELECTED_REGISTRAR - ER: SetSelectedRegistrar event
 467          */
 468         WPS_EV_ER_SET_SELECTED_REGISTRAR,
 469
 470         /**
 471          * WPS_EV_AP_PIN_SUCCESS - External Registrar used correct AP PIN
 472          */
 473         WPS_EV_AP_PIN_SUCCESS
 474 };
 475
 476 /**
 477  * union wps_event_data - WPS event data
 478  */
 479 union wps_event_data {
 480         /**
 481          * struct wps_event_m2d - M2D event data
 482          */
 483         struct wps_event_m2d {
 484                 u16 config_methods;
 485                 const u8 *manufacturer;
 486                 size_t manufacturer_len;
 487                 const u8 *model_name;
 488                 size_t model_name_len;
 489                 const u8 *model_number;
 490                 size_t model_number_len;
 491                 const u8 *serial_number;
 492                 size_t serial_number_len;
 493                 const u8 *dev_name;
 494                 size_t dev_name_len;
 495                 const u8 *primary_dev_type; /* 8 octets */
 496                 u16 config_error;
 497                 u16 dev_password_id;
 498         } m2d;
 499
 500         /**
 501          * struct wps_event_fail - Registration failure information
 502          * @msg: enum wps_msg_type
 503          */
 504         struct wps_event_fail {
 505                 int msg;
 506                 u16 config_error;
 507                 u16 error_indication;
 508                 u8 peer_macaddr[ETH_ALEN];
 509         } fail;
 510
 511         struct wps_event_success {
 512                 u8 peer_macaddr[ETH_ALEN];
 513         } success;
 514
 515         struct wps_event_pwd_auth_fail {
 516                 int enrollee;
 517                 int part;
 518                 u8 peer_macaddr[ETH_ALEN];
 519         } pwd_auth_fail;
 520
 521         struct wps_event_er_ap {
 522                 const u8 *uuid;
 523                 const u8 *mac_addr;
 524                 const char *friendly_name;
 525                 const char *manufacturer;
 526                 const char *manufacturer_url;
 527                 const char *model_description;
 528                 const char *model_name;
 529                 const char *model_number;
 530                 const char *model_url;
 531                 const char *serial_number;
 532                 const char *upc;
 533                 const u8 *pri_dev_type;
 534                 u8 wps_state;
 535         } ap;
 536
 537         struct wps_event_er_enrollee {
 538                 const u8 *uuid;
 539                 const u8 *mac_addr;
 540                 int m1_received;
 541                 u16 config_methods;
 542                 u16 dev_passwd_id;
 543                 const u8 *pri_dev_type;
 544                 const char *dev_name;
 545                 const char *manufacturer;
 546                 const char *model_name;
 547                 const char *model_number;
 548                 const char *serial_number;
 549         } enrollee;
 550
 551         struct wps_event_er_ap_settings {
 552                 const u8 *uuid;
 553                 const struct wps_credential *cred;
 554         } ap_settings;
 555
 556         struct wps_event_er_set_selected_registrar {
 557                 const u8 *uuid;
 558                 int sel_reg;
 559                 u16 dev_passwd_id;
 560                 u16 sel_reg_config_methods;
 561                 enum {
 562                         WPS_ER_SET_SEL_REG_START,
 563                         WPS_ER_SET_SEL_REG_DONE,
 564                         WPS_ER_SET_SEL_REG_FAILED
 565                 } state;
 566         } set_sel_reg;
 567 };
 568
 569 /**
 570  * struct upnp_pending_message - Pending PutWLANResponse messages
 571  * @next: Pointer to next pending message or %NULL
 572  * @addr: NewWLANEventMAC
 573  * @msg: NewMessage
 574  * @type: Message Type
 575  */
 576 struct upnp_pending_message {
 577         struct upnp_pending_message *next;
 578         u8 addr[ETH_ALEN];
 579         struct wpabuf *msg;
 580         enum wps_msg_type type;
 581 };
 582
 583 /**
 584  * struct wps_context - Long term WPS context data
 585  *
 586  * This data is stored at the higher layer Authenticator or Supplicant data
 587  * structures and it is maintained over multiple registration protocol runs.
 588  */
 589 struct wps_context {
 590         /**
 591          * ap - Whether the local end is an access point
 592          */
 593         int ap;
 594
 595         /**
 596          * registrar - Pointer to WPS registrar data from wps_registrar_init()
 597          */
 598         struct wps_registrar *registrar;
 599
 600         /**
 601          * wps_state - Current WPS state
 602          */
 603         enum wps_state wps_state;
 604
 605         /**
 606          * ap_setup_locked - Whether AP setup is locked (only used at AP)
 607          */
 608         int ap_setup_locked;
 609
 610         /**
 611          * uuid - Own UUID
 612          */
 613         u8 uuid[16];
 614
 615         /**
 616          * ssid - SSID
 617          *
 618          * This SSID is used by the Registrar to fill in information for
 619          * Credentials. In addition, AP uses it when acting as an Enrollee to
 620          * notify Registrar of the current configuration.
 621          */
 622         u8 ssid[32];
 623
 624         /**
 625          * ssid_len - Length of ssid in octets
 626          */
 627         size_t ssid_len;
 628
 629         /**
 630          * dev - Own WPS device data
 631          */
 632         struct wps_device_data dev;
 633
 634         /**
 635          * dh_ctx - Context data for Diffie-Hellman operation
 636          */
 637         void *dh_ctx;
 638
 639         /**
 640          * dh_privkey - Diffie-Hellman private key
 641          */
 642         struct wpabuf *dh_privkey;
 643
 644         /**
 645          * dh_pubkey_oob - Diffie-Hellman public key
 646          */
 647         struct wpabuf *dh_pubkey;
 648
 649         /**
 650          * config_methods - Enabled configuration methods
 651          *
 652          * Bit field of WPS_CONFIG_*
 653          */
 654         u16 config_methods;
 655
 656         /**
 657          * encr_types - Enabled encryption types (bit field of WPS_ENCR_*)
 658          */
 659         u16 encr_types;
 660
 661         /**
 662          * auth_types - Authentication types (bit field of WPS_AUTH_*)
 663          */
 664         u16 auth_types;
 665
 666         /**
 667          * network_key - The current Network Key (PSK) or %NULL to generate new
 668          *
 669          * If %NULL, Registrar will generate per-device PSK. In addition, AP
 670          * uses this when acting as an Enrollee to notify Registrar of the
 671          * current configuration.
 672          *
 673          * When using WPA/WPA2-Person, this key can be either the ASCII
 674          * passphrase (8..63 characters) or the 32-octet PSK (64 hex
 675          * characters). When this is set to the ASCII passphrase, the PSK can
 676          * be provided in the psk buffer and used per-Enrollee to control which
 677          * key type is included in the Credential (e.g., to reduce calculation
 678          * need on low-powered devices by provisioning PSK while still allowing
 679          * other devices to get the passphrase).
 680          */
 681         u8 *network_key;
 682
 683         /**
 684          * network_key_len - Length of network_key in octets
 685          */
 686         size_t network_key_len;
 687
 688         /**
 689          * psk - The current network PSK
 690          *
 691          * This optional value can be used to provide the current PSK if
 692          * network_key is set to the ASCII passphrase.
 693          */
 694         u8 psk[32];
 695
 696         /**
 697          * psk_set - Whether psk value is set
 698          */
 699         int psk_set;
 700
 701         /**
 702          * ap_settings - AP Settings override for M7 (only used at AP)
 703          *
 704          * If %NULL, AP Settings attributes will be generated based on the
 705          * current network configuration.
 706          */
 707         u8 *ap_settings;
 708
 709         /**
 710          * ap_settings_len - Length of ap_settings in octets
 711          */
 712         size_t ap_settings_len;
 713
 714         /**
 715          * friendly_name - Friendly Name (required for UPnP)
 716          */
 717         char *friendly_name;
 718
 719         /**
 720          * manufacturer_url - Manufacturer URL (optional for UPnP)
 721          */
 722         char *manufacturer_url;
 723
 724         /**
 725          * model_description - Model Description (recommended for UPnP)
 726          */
 727         char *model_description;
 728
 729         /**
 730          * model_url - Model URL (optional for UPnP)
 731          */
 732         char *model_url;
 733
 734         /**
 735          * upc - Universal Product Code (optional for UPnP)
 736          */
 737         char *upc;
 738
 739         /**
 740          * cred_cb - Callback to notify that new Credentials were received
 741          * @ctx: Higher layer context data (cb_ctx)
 742          * @cred: The received Credential
 743          * Return: 0 on success, -1 on failure
 744          */
 745         int (*cred_cb)(void *ctx, const struct wps_credential *cred);
 746
 747         /**
 748          * event_cb - Event callback (state information about progress)
 749          * @ctx: Higher layer context data (cb_ctx)
 750          * @event: Event type
 751          * @data: Event data
 752          */
 753         void (*event_cb)(void *ctx, enum wps_event event,
 754                          union wps_event_data *data);
 755
 756         /**
 757          * rf_band_cb - Fetch currently used RF band
 758          * @ctx: Higher layer context data (cb_ctx)
 759          * Return: Current used RF band or 0 if not known
 760          */
 761         int (*rf_band_cb)(void *ctx);
 762
 763         /**
 764          * cb_ctx: Higher layer context data for callbacks
 765          */
 766         void *cb_ctx;
 767
 768         struct upnp_wps_device_sm *wps_upnp;
 769
 770         /* Pending messages from UPnP PutWLANResponse */
 771         struct upnp_pending_message *upnp_msgs;
 772
 773         u16 ap_nfc_dev_pw_id;
 774         struct wpabuf *ap_nfc_dh_pubkey;
 775         struct wpabuf *ap_nfc_dh_privkey;
 776         struct wpabuf *ap_nfc_dev_pw;
 777 };
 778
 779 struct wps_registrar *
 780 wps_registrar_init(struct wps_context *wps,
 781                    const struct wps_registrar_config *cfg);
 782 void wps_registrar_deinit(struct wps_registrar *reg);
 783 int wps_registrar_add_pin(struct wps_registrar *reg, const u8 *addr,
 784                           const u8 *uuid, const u8 *pin, size_t pin_len,
 785                           int timeout);
 786 int wps_registrar_invalidate_pin(struct wps_registrar *reg, const u8 *uuid);
 787 int wps_registrar_wps_cancel(struct wps_registrar *reg);
 788 int wps_registrar_unlock_pin(struct wps_registrar *reg, const u8 *uuid);
 789 int wps_registrar_button_pushed(struct wps_registrar *reg,
 790                                 const u8 *p2p_dev_addr);
 791 void wps_registrar_complete(struct wps_registrar *registrar, const u8 *uuid_e,
 792                             const u8 *dev_pw, size_t dev_pw_len);
 793 void wps_registrar_probe_req_rx(struct wps_registrar *reg, const u8 *addr,
 794                                 const struct wpabuf *wps_data,
 795                                 int p2p_wildcard);
 796 int wps_registrar_update_ie(struct wps_registrar *reg);
 797 int wps_registrar_get_info(struct wps_registrar *reg, const u8 *addr,
 798                            char *buf, size_t buflen);
 799 int wps_registrar_config_ap(struct wps_registrar *reg,
 800                             struct wps_credential *cred);
 801 int wps_registrar_add_nfc_pw_token(struct wps_registrar *reg,
 802                                    const u8 *pubkey_hash, u16 pw_id,
 803                                    const u8 *dev_pw, size_t dev_pw_len);
 804 int wps_registrar_add_nfc_password_token(struct wps_registrar *reg,
 805                                          const u8 *oob_dev_pw,
 806                                          size_t oob_dev_pw_len);
 807
 808 int wps_build_credential_wrap(struct wpabuf *msg,
 809                               const struct wps_credential *cred);
 810
 811 unsigned int wps_pin_checksum(unsigned int pin);
 812 unsigned int wps_pin_valid(unsigned int pin);
 813 unsigned int wps_generate_pin(void);
 814 int wps_pin_str_valid(const char *pin);
 815 void wps_free_pending_msgs(struct upnp_pending_message *msgs);
 816
 817 struct wpabuf * wps_get_oob_cred(struct wps_context *wps);
 818 int wps_oob_use_cred(struct wps_context *wps, struct wps_parse_attr *attr);
 819 int wps_attr_text(struct wpabuf *data, char *buf, char *end);
 820 const char * wps_ei_str(enum wps_error_indication ei);
 821
 822 struct wps_er * wps_er_init(struct wps_context *wps, const char *ifname,
 823                             const char *filter);
 824 void wps_er_refresh(struct wps_er *er);
 825 void wps_er_deinit(struct wps_er *er, void (*cb)(void *ctx), void *ctx);
 826 void wps_er_set_sel_reg(struct wps_er *er, int sel_reg, u16 dev_passwd_id,
 827                         u16 sel_reg_config_methods);
 828 int wps_er_pbc(struct wps_er *er, const u8 *uuid, const u8 *addr);
 829 const u8 * wps_er_get_sta_uuid(struct wps_er *er, const u8 *addr);
 830 int wps_er_learn(struct wps_er *er, const u8 *uuid, const u8 *addr,
 831                  const u8 *pin, size_t pin_len);
 832 int wps_er_set_config(struct wps_er *er, const u8 *uuid, const u8 *addr,
 833                       const struct wps_credential *cred);
 834 int wps_er_config(struct wps_er *er, const u8 *uuid, const u8 *addr,
 835                   const u8 *pin, size_t pin_len,
 836                   const struct wps_credential *cred);
 837 struct wpabuf * wps_er_config_token_from_cred(struct wps_context *wps,
 838                                               struct wps_credential *cred);
 839 struct wpabuf * wps_er_nfc_config_token(struct wps_er *er, const u8 *uuid,
 840                                         const u8 *addr);
 841
 842 int wps_dev_type_str2bin(const char *str, u8 dev_type[WPS_DEV_TYPE_LEN]);
 843 char * wps_dev_type_bin2str(const u8 dev_type[WPS_DEV_TYPE_LEN], char *buf,
 844                             size_t buf_len);
 845 void uuid_gen_mac_addr(const u8 *mac_addr, u8 *uuid);
 846 u16 wps_config_methods_str2bin(const char *str);
 847 struct wpabuf * wps_build_nfc_pw_token(u16 dev_pw_id,
 848                                        const struct wpabuf *pubkey,
 849                                        const struct wpabuf *dev_pw);
 850 struct wpabuf * wps_nfc_token_build(int ndef, int id, struct wpabuf *pubkey,
 851                                     struct wpabuf *dev_pw);
 852 struct wpabuf * wps_nfc_token_gen(int ndef, int *id, struct wpabuf **pubkey,
 853                                   struct wpabuf **privkey,
 854                                   struct wpabuf **dev_pw);
 855
 856 /* ndef.c */
 857 struct wpabuf * ndef_parse_wifi(const struct wpabuf *buf);
 858 struct wpabuf * ndef_build_wifi(const struct wpabuf *buf);
 859 struct wpabuf * ndef_build_wifi_hc(int begin);
 860 struct wpabuf * ndef_build_wifi_hr(void);
 861
 862 #ifdef CONFIG_WPS_STRICT
 863 int wps_validate_beacon(const struct wpabuf *wps_ie);
 864 int wps_validate_beacon_probe_resp(const struct wpabuf *wps_ie, int probe,
 865                                    const u8 *addr);
 866 int wps_validate_probe_req(const struct wpabuf *wps_ie, const u8 *addr);
 867 int wps_validate_assoc_req(const struct wpabuf *wps_ie);
 868 int wps_validate_assoc_resp(const struct wpabuf *wps_ie);
 869 int wps_validate_m1(const struct wpabuf *tlvs);
 870 int wps_validate_m2(const struct wpabuf *tlvs);
 871 int wps_validate_m2d(const struct wpabuf *tlvs);
 872 int wps_validate_m3(const struct wpabuf *tlvs);
 873 int wps_validate_m4(const struct wpabuf *tlvs);
 874 int wps_validate_m4_encr(const struct wpabuf *tlvs, int wps2);
 875 int wps_validate_m5(const struct wpabuf *tlvs);
 876 int wps_validate_m5_encr(const struct wpabuf *tlvs, int wps2);
 877 int wps_validate_m6(const struct wpabuf *tlvs);
 878 int wps_validate_m6_encr(const struct wpabuf *tlvs, int wps2);
 879 int wps_validate_m7(const struct wpabuf *tlvs);
 880 int wps_validate_m7_encr(const struct wpabuf *tlvs, int ap, int wps2);
 881 int wps_validate_m8(const struct wpabuf *tlvs);
 882 int wps_validate_m8_encr(const struct wpabuf *tlvs, int ap, int wps2);
 883 int wps_validate_wsc_ack(const struct wpabuf *tlvs);
 884 int wps_validate_wsc_nack(const struct wpabuf *tlvs);
 885 int wps_validate_wsc_done(const struct wpabuf *tlvs);
 886 int wps_validate_upnp_set_selected_registrar(const struct wpabuf *tlvs);
 887 #else /* CONFIG_WPS_STRICT */
 888 static inline int wps_validate_beacon(const struct wpabuf *wps_ie){
 889         return 0;
 890 }
 891
 892 static inline int wps_validate_beacon_probe_resp(const struct wpabuf *wps_ie,
 893                                                  int probe, const u8 *addr)
 894 {
 895         return 0;
 896 }
 897
 898 static inline int wps_validate_probe_req(const struct wpabuf *wps_ie,
 899                                          const u8 *addr)
 900 {
 901         return 0;
 902 }
 903
 904 static inline int wps_validate_assoc_req(const struct wpabuf *wps_ie)
 905 {
 906         return 0;
 907 }
 908
 909 static inline int wps_validate_assoc_resp(const struct wpabuf *wps_ie)
 910 {
 911         return 0;
 912 }
 913
 914 static inline int wps_validate_m1(const struct wpabuf *tlvs)
 915 {
 916         return 0;
 917 }
 918
 919 static inline int wps_validate_m2(const struct wpabuf *tlvs)
 920 {
 921         return 0;
 922 }
 923
 924 static inline int wps_validate_m2d(const struct wpabuf *tlvs)
 925 {
 926         return 0;
 927 }
 928
 929 static inline int wps_validate_m3(const struct wpabuf *tlvs)
 930 {
 931         return 0;
 932 }
 933
 934 static inline int wps_validate_m4(const struct wpabuf *tlvs)
 935 {
 936         return 0;
 937 }
 938
 939 static inline int wps_validate_m4_encr(const struct wpabuf *tlvs, int wps2)
 940 {
 941         return 0;
 942 }
 943
 944 static inline int wps_validate_m5(const struct wpabuf *tlvs)
 945 {
 946         return 0;
 947 }
 948
 949 static inline int wps_validate_m5_encr(const struct wpabuf *tlvs, int wps2)
 950 {
 951         return 0;
 952 }
 953
 954 static inline int wps_validate_m6(const struct wpabuf *tlvs)
 955 {
 956         return 0;
 957 }
 958
 959 static inline int wps_validate_m6_encr(const struct wpabuf *tlvs, int wps2)
 960 {
 961         return 0;
 962 }
 963
 964 static inline int wps_validate_m7(const struct wpabuf *tlvs)
 965 {
 966         return 0;
 967 }
 968
 969 static inline int wps_validate_m7_encr(const struct wpabuf *tlvs, int ap,
 970                                        int wps2)
 971 {
 972         return 0;
 973 }
 974
 975 static inline int wps_validate_m8(const struct wpabuf *tlvs)
 976 {
 977         return 0;
 978 }
 979
 980 static inline int wps_validate_m8_encr(const struct wpabuf *tlvs, int ap,
 981                                        int wps2)
 982 {
 983         return 0;
 984 }
 985
 986 static inline int wps_validate_wsc_ack(const struct wpabuf *tlvs)
 987 {
 988         return 0;
 989 }
 990
 991 static inline int wps_validate_wsc_nack(const struct wpabuf *tlvs)
 992 {
 993         return 0;
 994 }
 995
 996 static inline int wps_validate_wsc_done(const struct wpabuf *tlvs)
 997 {
 998         return 0;
 999 }
1000
1001 static inline int wps_validate_upnp_set_selected_registrar(
1002         const struct wpabuf *tlvs)
1003 {
1004         return 0;
1005 }
1006 #endif /* CONFIG_WPS_STRICT */
1007
1008 #endif /* WPS_H */