wps.h

Go to the documentation of this file.

/*
 * Wi-Fi Protected Setup
 * Copyright (c) 2007-2009, Jouni Malinen <j@w1.fi>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * Alternatively, this software may be distributed under the terms of BSD
 * license.
 *
 * See README and COPYING for more details.
 */

#ifndef WPS_H
#define WPS_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_credential {
        u8 ssid[32];
        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

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];
        u32 os_version;
        u8 rf_bands;
};

struct oob_conf_data {
        enum {
                OOB_METHOD_UNKNOWN = 0,
                OOB_METHOD_DEV_PWD_E,
                OOB_METHOD_DEV_PWD_R,
                OOB_METHOD_CRED,
        } oob_method;
        struct wpabuf *dev_password;
        struct wpabuf *pubkey_hash;
};

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;
};

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);
const u8 * wps_get_uuid_e(const struct wpabuf *msg);

struct wpabuf * wps_build_assoc_req_ie(enum wps_request_type req_type);
struct wpabuf * wps_build_probe_req_ie(int pbc, struct wps_device_data *dev,
                                       const u8 *uuid,
                                       enum wps_request_type req_type);


struct wps_registrar_config {
        int (*new_psk_cb)(void *ctx, const u8 *mac_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);

        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;
};


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_ER_AP_ADD,

        WPS_EV_ER_AP_REMOVE,

        WPS_EV_ER_ENROLLEE_ADD,

        WPS_EV_ER_ENROLLEE_REMOVE
};

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;
        } fail;

        struct wps_event_pwd_auth_fail {
                int enrollee;
                int part;
        } 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 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[32];

        size_t ssid_len;

        struct wps_device_data dev;

        struct oob_conf_data oob_conf;

        u16 oob_dev_pw_id;

        void *dh_ctx;

        struct wpabuf *dh_privkey;

        struct wpabuf *dh_pubkey;

        u16 config_methods;

        u16 encr_types;

        u16 auth_types;

        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);

        void *cb_ctx;

        struct upnp_wps_device_sm *wps_upnp;

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

struct oob_device_data {
        char *device_name;
        char *device_path;
        void * (*init_func)(struct wps_context *, struct oob_device_data *,
                            int);
        struct wpabuf * (*read_func)(void *);
        int (*write_func)(void *, struct wpabuf *);
        void (*deinit_func)(void *);
};

struct oob_nfc_device_data {
        int (*init_func)(char *);
        void * (*read_func)(size_t *);
        int (*write_func)(void *, size_t);
        void (*deinit_func)(void);
};

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 *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_unlock_pin(struct wps_registrar *reg, const u8 *uuid);
int wps_registrar_button_pushed(struct wps_registrar *reg);
void wps_registrar_probe_req_rx(struct wps_registrar *reg, const u8 *addr,
                                const struct wpabuf *wps_data);
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);

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

struct oob_device_data * wps_get_oob_device(char *device_type);
struct oob_nfc_device_data * wps_get_oob_nfc_device(char *device_name);
int wps_get_oob_method(char *method);
int wps_process_oob(struct wps_context *wps, struct oob_device_data *oob_dev,
                    int registrar);
int wps_attr_text(struct wpabuf *data, char *buf, char *end);

struct wps_er * wps_er_init(struct wps_context *wps, const char *ifname);
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);
int wps_er_learn(struct wps_er *er, const u8 *uuid, const u8 *pin,
                 size_t pin_len);

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);

#endif /* WPS_H */