wps.h

/*
 * Wi-Fi Protected Setup
 * Copyright (c) 2007-2016, Jouni Malinen <j@w1.fi>
 *
 * This software may be distributed under the terms of the BSD license.
 * See README for more details.
 */

#ifndef WPS_H
#define WPS_H

#include "common/ieee802_11_defs.h"
#include "wps_defs.h"

enum wsc_op_code {
    WSC_UPnP = 0 /* No OP Code in UPnP transport */,
    WSC_Start = 0x01,
    WSC_ACK = 0x02,
    WSC_NACK = 0x03,
    WSC_MSG = 0x04,
    WSC_Done = 0x05,
    WSC_FRAG_ACK = 0x06
};

struct wps_registrar;
struct upnp_wps_device_sm;
struct wps_er;
struct wps_parse_attr;

struct wps_credential {
    u8 ssid[SSID_MAX_LEN];
    size_t ssid_len;
    u16 auth_type;
    u16 encr_type;
    u8 key_idx;
    u8 key[64];
    size_t key_len;
    u8 mac_addr[ETH_ALEN];
    const u8 *cred_attr;
    size_t cred_attr_len;
};

#define WPS_DEV_TYPE_LEN 8
#define WPS_DEV_TYPE_BUFSIZE 21
#define WPS_SEC_DEV_TYPE_MAX_LEN 128
/* maximum number of advertised WPS vendor extension attributes */
#define MAX_WPS_VENDOR_EXTENSIONS 10
/* maximum size of WPS Vendor extension attribute */
#define WPS_MAX_VENDOR_EXT_LEN 1024
/* maximum number of parsed WPS vendor extension attributes */
#define MAX_WPS_PARSE_VENDOR_EXT 10

struct wps_device_data {
    u8 mac_addr[ETH_ALEN];
    char *device_name;
    char *manufacturer;
    char *model_name;
    char *model_number;
    char *serial_number;
    u8 pri_dev_type[WPS_DEV_TYPE_LEN];
#define WPS_SEC_DEVICE_TYPES 5
    u8 sec_dev_type[WPS_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
    u8 num_sec_dev_types;
    u32 os_version;
    u8 rf_bands;
    u16 config_methods;
    struct wpabuf *vendor_ext_m1;
    struct wpabuf *vendor_ext[MAX_WPS_VENDOR_EXTENSIONS];

    int p2p;
};

struct wps_config {
    struct wps_context *wps;

    int registrar;

    const u8 *pin;

    size_t pin_len;

    int pbc;

    const struct wpabuf *assoc_wps_ie;

    const struct wps_credential *new_ap_settings;

    const u8 *peer_addr;

    int use_psk_key;

    u16 dev_pw_id;

    const u8 *p2p_dev_addr;

    int pbc_in_m1;

    const u8 *peer_pubkey_hash;
};

struct wps_data * wps_init(const struct wps_config *cfg);

void wps_deinit(struct wps_data *data);

enum wps_process_res {
    WPS_DONE,

    WPS_CONTINUE,

    WPS_FAILURE,

    WPS_PENDING
};
enum wps_process_res wps_process_msg(struct wps_data *wps,
                     enum wsc_op_code op_code,
                     const struct wpabuf *msg);

struct wpabuf * wps_get_msg(struct wps_data *wps, enum wsc_op_code *op_code);

int wps_is_selected_pbc_registrar(const struct wpabuf *msg);
int wps_is_selected_pin_registrar(const struct wpabuf *msg);
int wps_ap_priority_compar(const struct wpabuf *wps_a,
               const struct wpabuf *wps_b);
int wps_is_addr_authorized(const struct wpabuf *msg, const u8 *addr,
               int ver1_compat);
const u8 * wps_get_uuid_e(const struct wpabuf *msg);
int wps_is_20(const struct wpabuf *msg);

struct wpabuf * wps_build_assoc_req_ie(enum wps_request_type req_type);
struct wpabuf * wps_build_assoc_resp_ie(void);
struct wpabuf * wps_build_probe_req_ie(u16 pw_id, struct wps_device_data *dev,
                       const u8 *uuid,
                       enum wps_request_type req_type,
                       unsigned int num_req_dev_types,
                       const u8 *req_dev_types);


struct wps_registrar_config {
    int (*new_psk_cb)(void *ctx, const u8 *mac_addr, const u8 *p2p_dev_addr,
              const u8 *psk, size_t psk_len);

    int (*set_ie_cb)(void *ctx, struct wpabuf *beacon_ie,
             struct wpabuf *probe_resp_ie);

    void (*pin_needed_cb)(void *ctx, const u8 *uuid_e,
                  const struct wps_device_data *dev);

    void (*reg_success_cb)(void *ctx, const u8 *mac_addr,
                   const u8 *uuid_e, const u8 *dev_pw,
                   size_t dev_pw_len);

    void (*set_sel_reg_cb)(void *ctx, int sel_reg, u16 dev_passwd_id,
                   u16 sel_reg_config_methods);

    void (*enrollee_seen_cb)(void *ctx, const u8 *addr, const u8 *uuid_e,
                 const u8 *pri_dev_type, u16 config_methods,
                 u16 dev_password_id, u8 request_type,
                 const char *dev_name);

    void *cb_ctx;

    int skip_cred_build;

    const u8 *extra_cred;

    size_t extra_cred_len;

    int disable_auto_conf;

    int static_wep_only;

    int dualband;

    int force_per_enrollee_psk;
};


enum wps_event {
    WPS_EV_M2D,

    WPS_EV_FAIL,

    WPS_EV_SUCCESS,

    WPS_EV_PWD_AUTH_FAIL,

    WPS_EV_PBC_OVERLAP,

    WPS_EV_PBC_TIMEOUT,

    WPS_EV_PBC_ACTIVE,

    WPS_EV_PBC_DISABLE,

    WPS_EV_ER_AP_ADD,

    WPS_EV_ER_AP_REMOVE,

    WPS_EV_ER_ENROLLEE_ADD,

    WPS_EV_ER_ENROLLEE_REMOVE,

    WPS_EV_ER_AP_SETTINGS,

    WPS_EV_ER_SET_SELECTED_REGISTRAR,

    WPS_EV_AP_PIN_SUCCESS
};

union wps_event_data {
    struct wps_event_m2d {
        u16 config_methods;
        const u8 *manufacturer;
        size_t manufacturer_len;
        const u8 *model_name;
        size_t model_name_len;
        const u8 *model_number;
        size_t model_number_len;
        const u8 *serial_number;
        size_t serial_number_len;
        const u8 *dev_name;
        size_t dev_name_len;
        const u8 *primary_dev_type; /* 8 octets */
        u16 config_error;
        u16 dev_password_id;
    } m2d;

    struct wps_event_fail {
        int msg;
        u16 config_error;
        u16 error_indication;
        u8 peer_macaddr[ETH_ALEN];
    } fail;

    struct wps_event_success {
        u8 peer_macaddr[ETH_ALEN];
    } success;

    struct wps_event_pwd_auth_fail {
        int enrollee;
        int part;
        u8 peer_macaddr[ETH_ALEN];
    } pwd_auth_fail;

    struct wps_event_er_ap {
        const u8 *uuid;
        const u8 *mac_addr;
        const char *friendly_name;
        const char *manufacturer;
        const char *manufacturer_url;
        const char *model_description;
        const char *model_name;
        const char *model_number;
        const char *model_url;
        const char *serial_number;
        const char *upc;
        const u8 *pri_dev_type;
        u8 wps_state;
    } ap;

    struct wps_event_er_enrollee {
        const u8 *uuid;
        const u8 *mac_addr;
        int m1_received;
        u16 config_methods;
        u16 dev_passwd_id;
        const u8 *pri_dev_type;
        const char *dev_name;
        const char *manufacturer;
        const char *model_name;
        const char *model_number;
        const char *serial_number;
    } enrollee;

    struct wps_event_er_ap_settings {
        const u8 *uuid;
        const struct wps_credential *cred;
    } ap_settings;

    struct wps_event_er_set_selected_registrar {
        const u8 *uuid;
        int sel_reg;
        u16 dev_passwd_id;
        u16 sel_reg_config_methods;
        enum {
            WPS_ER_SET_SEL_REG_START,
            WPS_ER_SET_SEL_REG_DONE,
            WPS_ER_SET_SEL_REG_FAILED
        } state;
    } set_sel_reg;
};

struct upnp_pending_message {
    struct upnp_pending_message *next;
    u8 addr[ETH_ALEN];
    struct wpabuf *msg;
    enum wps_msg_type type;
};

struct wps_context {
    int ap;

    struct wps_registrar *registrar;

    enum wps_state wps_state;

    int ap_setup_locked;

    u8 uuid[16];

    u8 ssid[SSID_MAX_LEN];

    size_t ssid_len;

    struct wps_device_data dev;

    void *dh_ctx;

    struct wpabuf *dh_privkey;

    struct wpabuf *dh_pubkey;

    u16 config_methods;

    u16 encr_types;

    u16 encr_types_rsn;

    u16 encr_types_wpa;

    u16 auth_types;

    u16 ap_encr_type;

    u16 ap_auth_type;

    u8 *network_key;

    size_t network_key_len;

    u8 psk[32];

    int psk_set;

    u8 *ap_settings;

    size_t ap_settings_len;

    char *friendly_name;

    char *manufacturer_url;

    char *model_description;

    char *model_url;

    char *upc;

    int (*cred_cb)(void *ctx, const struct wps_credential *cred);

    void (*event_cb)(void *ctx, enum wps_event event,
             union wps_event_data *data);

    int (*rf_band_cb)(void *ctx);

    void *cb_ctx;

    struct upnp_wps_device_sm *wps_upnp;

    /* Pending messages from UPnP PutWLANResponse */
    struct upnp_pending_message *upnp_msgs;

    u16 ap_nfc_dev_pw_id;
    struct wpabuf *ap_nfc_dh_pubkey;
    struct wpabuf *ap_nfc_dh_privkey;
    struct wpabuf *ap_nfc_dev_pw;
};

struct wps_registrar *
wps_registrar_init(struct wps_context *wps,
           const struct wps_registrar_config *cfg);
void wps_registrar_deinit(struct wps_registrar *reg);
int wps_registrar_add_pin(struct wps_registrar *reg, const u8 *addr,
              const u8 *uuid, const u8 *pin, size_t pin_len,
              int timeout);
int wps_registrar_invalidate_pin(struct wps_registrar *reg, const u8 *uuid);
int wps_registrar_wps_cancel(struct wps_registrar *reg);
int wps_registrar_unlock_pin(struct wps_registrar *reg, const u8 *uuid);
int wps_registrar_button_pushed(struct wps_registrar *reg,
                const u8 *p2p_dev_addr);
void wps_registrar_complete(struct wps_registrar *registrar, const u8 *uuid_e,
                const u8 *dev_pw, size_t dev_pw_len);
void wps_registrar_probe_req_rx(struct wps_registrar *reg, const u8 *addr,
                const struct wpabuf *wps_data,
                int p2p_wildcard);
int wps_registrar_update_ie(struct wps_registrar *reg);
int wps_registrar_get_info(struct wps_registrar *reg, const u8 *addr,
               char *buf, size_t buflen);
int wps_registrar_config_ap(struct wps_registrar *reg,
                struct wps_credential *cred);
int wps_registrar_add_nfc_pw_token(struct wps_registrar *reg,
                   const u8 *pubkey_hash, u16 pw_id,
                   const u8 *dev_pw, size_t dev_pw_len,
                   int pk_hash_provided_oob);
int wps_registrar_add_nfc_password_token(struct wps_registrar *reg,
                     const u8 *oob_dev_pw,
                     size_t oob_dev_pw_len);
void wps_registrar_flush(struct wps_registrar *reg);

int wps_build_credential_wrap(struct wpabuf *msg,
                  const struct wps_credential *cred);

unsigned int wps_pin_checksum(unsigned int pin);
unsigned int wps_pin_valid(unsigned int pin);
int wps_generate_pin(unsigned int *pin);
int wps_pin_str_valid(const char *pin);
void wps_free_pending_msgs(struct upnp_pending_message *msgs);

struct wpabuf * wps_get_oob_cred(struct wps_context *wps, int rf_band,
                 int channel);
int wps_oob_use_cred(struct wps_context *wps, struct wps_parse_attr *attr);
int wps_attr_text(struct wpabuf *data, char *buf, char *end);
const char * wps_ei_str(enum wps_error_indication ei);

struct wps_er * wps_er_init(struct wps_context *wps, const char *ifname,
                const char *filter);
void wps_er_refresh(struct wps_er *er);
void wps_er_deinit(struct wps_er *er, void (*cb)(void *ctx), void *ctx);
void wps_er_set_sel_reg(struct wps_er *er, int sel_reg, u16 dev_passwd_id,
            u16 sel_reg_config_methods);
int wps_er_pbc(struct wps_er *er, const u8 *uuid, const u8 *addr);
const u8 * wps_er_get_sta_uuid(struct wps_er *er, const u8 *addr);
int wps_er_learn(struct wps_er *er, const u8 *uuid, const u8 *addr,
         const u8 *pin, size_t pin_len);
int wps_er_set_config(struct wps_er *er, const u8 *uuid, const u8 *addr,
              const struct wps_credential *cred);
int wps_er_config(struct wps_er *er, const u8 *uuid, const u8 *addr,
          const u8 *pin, size_t pin_len,
          const struct wps_credential *cred);
struct wpabuf * wps_er_config_token_from_cred(struct wps_context *wps,
                          struct wps_credential *cred);
struct wpabuf * wps_er_nfc_config_token(struct wps_er *er, const u8 *uuid,
                    const u8 *addr);
struct wpabuf * wps_er_nfc_handover_sel(struct wps_er *er,
                    struct wps_context *wps, const u8 *uuid,
                    const u8 *addr, struct wpabuf *pubkey);

int wps_dev_type_str2bin(const char *str, u8 dev_type[WPS_DEV_TYPE_LEN]);
char * wps_dev_type_bin2str(const u8 dev_type[WPS_DEV_TYPE_LEN], char *buf,
                size_t buf_len);
void uuid_gen_mac_addr(const u8 *mac_addr, u8 *uuid);
u16 wps_config_methods_str2bin(const char *str);
struct wpabuf * wps_build_nfc_pw_token(u16 dev_pw_id,
                       const struct wpabuf *pubkey,
                       const struct wpabuf *dev_pw);
struct wpabuf * wps_nfc_token_build(int ndef, int id, struct wpabuf *pubkey,
                    struct wpabuf *dev_pw);
int wps_nfc_gen_dh(struct wpabuf **pubkey, struct wpabuf **privkey);
struct wpabuf * wps_nfc_token_gen(int ndef, int *id, struct wpabuf **pubkey,
                  struct wpabuf **privkey,
                  struct wpabuf **dev_pw);
struct wpabuf * wps_build_nfc_handover_req(struct wps_context *ctx,
                       struct wpabuf *nfc_dh_pubkey);
struct wpabuf * wps_build_nfc_handover_sel(struct wps_context *ctx,
                       struct wpabuf *nfc_dh_pubkey,
                       const u8 *bssid, int freq);
struct wpabuf * wps_build_nfc_handover_req_p2p(struct wps_context *ctx,
                           struct wpabuf *nfc_dh_pubkey);
struct wpabuf * wps_build_nfc_handover_sel_p2p(struct wps_context *ctx,
                           int nfc_dev_pw_id,
                           struct wpabuf *nfc_dh_pubkey,
                           struct wpabuf *nfc_dev_pw);

/* ndef.c */
struct wpabuf * ndef_parse_wifi(const struct wpabuf *buf);
struct wpabuf * ndef_build_wifi(const struct wpabuf *buf);
struct wpabuf * ndef_parse_p2p(const struct wpabuf *buf);
struct wpabuf * ndef_build_p2p(const struct wpabuf *buf);

#ifdef CONFIG_WPS_STRICT
int wps_validate_beacon(const struct wpabuf *wps_ie);
int wps_validate_beacon_probe_resp(const struct wpabuf *wps_ie, int probe,
                   const u8 *addr);
int wps_validate_probe_req(const struct wpabuf *wps_ie, const u8 *addr);
int wps_validate_assoc_req(const struct wpabuf *wps_ie);
int wps_validate_assoc_resp(const struct wpabuf *wps_ie);
int wps_validate_m1(const struct wpabuf *tlvs);
int wps_validate_m2(const struct wpabuf *tlvs);
int wps_validate_m2d(const struct wpabuf *tlvs);
int wps_validate_m3(const struct wpabuf *tlvs);
int wps_validate_m4(const struct wpabuf *tlvs);
int wps_validate_m4_encr(const struct wpabuf *tlvs, int wps2);
int wps_validate_m5(const struct wpabuf *tlvs);
int wps_validate_m5_encr(const struct wpabuf *tlvs, int wps2);
int wps_validate_m6(const struct wpabuf *tlvs);
int wps_validate_m6_encr(const struct wpabuf *tlvs, int wps2);
int wps_validate_m7(const struct wpabuf *tlvs);
int wps_validate_m7_encr(const struct wpabuf *tlvs, int ap, int wps2);
int wps_validate_m8(const struct wpabuf *tlvs);
int wps_validate_m8_encr(const struct wpabuf *tlvs, int ap, int wps2);
int wps_validate_wsc_ack(const struct wpabuf *tlvs);
int wps_validate_wsc_nack(const struct wpabuf *tlvs);
int wps_validate_wsc_done(const struct wpabuf *tlvs);
int wps_validate_upnp_set_selected_registrar(const struct wpabuf *tlvs);
#else /* CONFIG_WPS_STRICT */
static inline int wps_validate_beacon(const struct wpabuf *wps_ie){
    return 0;
}

static inline int wps_validate_beacon_probe_resp(const struct wpabuf *wps_ie,
                         int probe, const u8 *addr)
{
    return 0;
}

static inline int wps_validate_probe_req(const struct wpabuf *wps_ie,
                     const u8 *addr)
{
    return 0;
}

static inline int wps_validate_assoc_req(const struct wpabuf *wps_ie)
{
    return 0;
}

static inline int wps_validate_assoc_resp(const struct wpabuf *wps_ie)
{
    return 0;
}

static inline int wps_validate_m1(const struct wpabuf *tlvs)
{
    return 0;
}

static inline int wps_validate_m2(const struct wpabuf *tlvs)
{
    return 0;
}

static inline int wps_validate_m2d(const struct wpabuf *tlvs)
{
    return 0;
}

static inline int wps_validate_m3(const struct wpabuf *tlvs)
{
    return 0;
}

static inline int wps_validate_m4(const struct wpabuf *tlvs)
{
    return 0;
}

static inline int wps_validate_m4_encr(const struct wpabuf *tlvs, int wps2)
{
    return 0;
}

static inline int wps_validate_m5(const struct wpabuf *tlvs)
{
    return 0;
}

static inline int wps_validate_m5_encr(const struct wpabuf *tlvs, int wps2)
{
    return 0;
}

static inline int wps_validate_m6(const struct wpabuf *tlvs)
{
    return 0;
}

static inline int wps_validate_m6_encr(const struct wpabuf *tlvs, int wps2)
{
    return 0;
}

static inline int wps_validate_m7(const struct wpabuf *tlvs)
{
    return 0;
}

static inline int wps_validate_m7_encr(const struct wpabuf *tlvs, int ap,
                       int wps2)
{
    return 0;
}

static inline int wps_validate_m8(const struct wpabuf *tlvs)
{
    return 0;
}

static inline int wps_validate_m8_encr(const struct wpabuf *tlvs, int ap,
                       int wps2)
{
    return 0;
}

static inline int wps_validate_wsc_ack(const struct wpabuf *tlvs)
{
    return 0;
}

static inline int wps_validate_wsc_nack(const struct wpabuf *tlvs)
{
    return 0;
}

static inline int wps_validate_wsc_done(const struct wpabuf *tlvs)
{
    return 0;
}

static inline int wps_validate_upnp_set_selected_registrar(
    const struct wpabuf *tlvs)
{
    return 0;
}
#endif /* CONFIG_WPS_STRICT */

#endif /* WPS_H */