contrib/hostapd/src/wps/wps_defs.h

   1 /*
   2  * Wi-Fi Protected Setup - message definitions
   3  * Copyright (c) 2008, 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_DEFS_H
  10 #define WPS_DEFS_H
  11
  12 #ifdef CONFIG_WPS_TESTING
  13
  14 extern int wps_version_number;
  15 extern int wps_testing_dummy_cred;
  16 extern int wps_corrupt_pkhash;
  17 #define WPS_VERSION wps_version_number
  18
  19 #else /* CONFIG_WPS_TESTING */
  20
  21 #ifdef CONFIG_WPS2
  22 #define WPS_VERSION 0x20
  23 #else /* CONFIG_WPS2 */
  24 #define WPS_VERSION 0x10
  25 #endif /* CONFIG_WPS2 */
  26
  27 #endif /* CONFIG_WPS_TESTING */
  28
  29 /* Diffie-Hellman 1536-bit MODP Group; RFC 3526, Group 5 */
  30 #define WPS_DH_GROUP 5
  31
  32 #define WPS_UUID_LEN 16
  33 #define WPS_NONCE_LEN 16
  34 #define WPS_AUTHENTICATOR_LEN 8
  35 #define WPS_AUTHKEY_LEN 32
  36 #define WPS_KEYWRAPKEY_LEN 16
  37 #define WPS_EMSK_LEN 32
  38 #define WPS_PSK_LEN 16
  39 #define WPS_SECRET_NONCE_LEN 16
  40 #define WPS_HASH_LEN 32
  41 #define WPS_KWA_LEN 8
  42 #define WPS_MGMTAUTHKEY_LEN 32
  43 #define WPS_MGMTENCKEY_LEN 16
  44 #define WPS_MGMT_KEY_ID_LEN 16
  45 #define WPS_OOB_DEVICE_PASSWORD_MIN_LEN 16
  46 #define WPS_OOB_DEVICE_PASSWORD_LEN 32
  47 #define WPS_OOB_PUBKEY_HASH_LEN 20
  48
  49 /* Attribute Types */
  50 enum wps_attribute {
  51         ATTR_AP_CHANNEL = 0x1001,
  52         ATTR_ASSOC_STATE = 0x1002,
  53         ATTR_AUTH_TYPE = 0x1003,
  54         ATTR_AUTH_TYPE_FLAGS = 0x1004,
  55         ATTR_AUTHENTICATOR = 0x1005,
  56         ATTR_CONFIG_METHODS = 0x1008,
  57         ATTR_CONFIG_ERROR = 0x1009,
  58         ATTR_CONFIRM_URL4 = 0x100a,
  59         ATTR_CONFIRM_URL6 = 0x100b,
  60         ATTR_CONN_TYPE = 0x100c,
  61         ATTR_CONN_TYPE_FLAGS = 0x100d,
  62         ATTR_CRED = 0x100e,
  63         ATTR_ENCR_TYPE = 0x100f,
  64         ATTR_ENCR_TYPE_FLAGS = 0x1010,
  65         ATTR_DEV_NAME = 0x1011,
  66         ATTR_DEV_PASSWORD_ID = 0x1012,
  67         ATTR_E_HASH1 = 0x1014,
  68         ATTR_E_HASH2 = 0x1015,
  69         ATTR_E_SNONCE1 = 0x1016,
  70         ATTR_E_SNONCE2 = 0x1017,
  71         ATTR_ENCR_SETTINGS = 0x1018,
  72         ATTR_ENROLLEE_NONCE = 0x101a,
  73         ATTR_FEATURE_ID = 0x101b,
  74         ATTR_IDENTITY = 0x101c,
  75         ATTR_IDENTITY_PROOF = 0x101d,
  76         ATTR_KEY_WRAP_AUTH = 0x101e,
  77         ATTR_KEY_ID = 0x101f,
  78         ATTR_MAC_ADDR = 0x1020,
  79         ATTR_MANUFACTURER = 0x1021,
  80         ATTR_MSG_TYPE = 0x1022,
  81         ATTR_MODEL_NAME = 0x1023,
  82         ATTR_MODEL_NUMBER = 0x1024,
  83         ATTR_NETWORK_INDEX = 0x1026,
  84         ATTR_NETWORK_KEY = 0x1027,
  85         ATTR_NETWORK_KEY_INDEX = 0x1028,
  86         ATTR_NEW_DEVICE_NAME = 0x1029,
  87         ATTR_NEW_PASSWORD = 0x102a,
  88         ATTR_OOB_DEVICE_PASSWORD = 0x102c,
  89         ATTR_OS_VERSION = 0x102d,
  90         ATTR_POWER_LEVEL = 0x102f,
  91         ATTR_PSK_CURRENT = 0x1030,
  92         ATTR_PSK_MAX = 0x1031,
  93         ATTR_PUBLIC_KEY = 0x1032,
  94         ATTR_RADIO_ENABLE = 0x1033,
  95         ATTR_REBOOT = 0x1034,
  96         ATTR_REGISTRAR_CURRENT = 0x1035,
  97         ATTR_REGISTRAR_ESTABLISHED = 0x1036,
  98         ATTR_REGISTRAR_LIST = 0x1037,
  99         ATTR_REGISTRAR_MAX = 0x1038,
 100         ATTR_REGISTRAR_NONCE = 0x1039,
 101         ATTR_REQUEST_TYPE = 0x103a,
 102         ATTR_RESPONSE_TYPE = 0x103b,
 103         ATTR_RF_BANDS = 0x103c,
 104         ATTR_R_HASH1 = 0x103d,
 105         ATTR_R_HASH2 = 0x103e,
 106         ATTR_R_SNONCE1 = 0x103f,
 107         ATTR_R_SNONCE2 = 0x1040,
 108         ATTR_SELECTED_REGISTRAR = 0x1041,
 109         ATTR_SERIAL_NUMBER = 0x1042,
 110         ATTR_WPS_STATE = 0x1044,
 111         ATTR_SSID = 0x1045,
 112         ATTR_TOTAL_NETWORKS = 0x1046,
 113         ATTR_UUID_E = 0x1047,
 114         ATTR_UUID_R = 0x1048,
 115         ATTR_VENDOR_EXT = 0x1049,
 116         ATTR_VERSION = 0x104a,
 117         ATTR_X509_CERT_REQ = 0x104b,
 118         ATTR_X509_CERT = 0x104c,
 119         ATTR_EAP_IDENTITY = 0x104d,
 120         ATTR_MSG_COUNTER = 0x104e,
 121         ATTR_PUBKEY_HASH = 0x104f,
 122         ATTR_REKEY_KEY = 0x1050,
 123         ATTR_KEY_LIFETIME = 0x1051,
 124         ATTR_PERMITTED_CFG_METHODS = 0x1052,
 125         ATTR_SELECTED_REGISTRAR_CONFIG_METHODS = 0x1053,
 126         ATTR_PRIMARY_DEV_TYPE = 0x1054,
 127         ATTR_SECONDARY_DEV_TYPE_LIST = 0x1055,
 128         ATTR_PORTABLE_DEV = 0x1056,
 129         ATTR_AP_SETUP_LOCKED = 0x1057,
 130         ATTR_APPLICATION_EXT = 0x1058,
 131         ATTR_EAP_TYPE = 0x1059,
 132         ATTR_IV = 0x1060,
 133         ATTR_KEY_PROVIDED_AUTO = 0x1061,
 134         ATTR_802_1X_ENABLED = 0x1062,
 135         ATTR_APPSESSIONKEY = 0x1063,
 136         ATTR_WEPTRANSMITKEY = 0x1064,
 137         ATTR_REQUESTED_DEV_TYPE = 0x106a,
 138         ATTR_EXTENSIBILITY_TEST = 0x10fa /* _NOT_ defined in the spec */
 139 };
 140
 141 #define WPS_VENDOR_ID_WFA 14122
 142
 143 /* WFA Vendor Extension subelements */
 144 enum {
 145         WFA_ELEM_VERSION2 = 0x00,
 146         WFA_ELEM_AUTHORIZEDMACS = 0x01,
 147         WFA_ELEM_NETWORK_KEY_SHAREABLE = 0x02,
 148         WFA_ELEM_REQUEST_TO_ENROLL = 0x03,
 149         WFA_ELEM_SETTINGS_DELAY_TIME = 0x04
 150 };
 151
 152 /* Device Password ID */
 153 enum wps_dev_password_id {
 154         DEV_PW_DEFAULT = 0x0000,
 155         DEV_PW_USER_SPECIFIED = 0x0001,
 156         DEV_PW_MACHINE_SPECIFIED = 0x0002,
 157         DEV_PW_REKEY = 0x0003,
 158         DEV_PW_PUSHBUTTON = 0x0004,
 159         DEV_PW_REGISTRAR_SPECIFIED = 0x0005,
 160         DEV_PW_NFC_CONNECTION_HANDOVER = 0x0007
 161 };
 162
 163 /* Message Type */
 164 enum wps_msg_type {
 165         WPS_Beacon = 0x01,
 166         WPS_ProbeRequest = 0x02,
 167         WPS_ProbeResponse = 0x03,
 168         WPS_M1 = 0x04,
 169         WPS_M2 = 0x05,
 170         WPS_M2D = 0x06,
 171         WPS_M3 = 0x07,
 172         WPS_M4 = 0x08,
 173         WPS_M5 = 0x09,
 174         WPS_M6 = 0x0a,
 175         WPS_M7 = 0x0b,
 176         WPS_M8 = 0x0c,
 177         WPS_WSC_ACK = 0x0d,
 178         WPS_WSC_NACK = 0x0e,
 179         WPS_WSC_DONE = 0x0f
 180 };
 181
 182 /* Authentication Type Flags */
 183 #define WPS_AUTH_OPEN 0x0001
 184 #define WPS_AUTH_WPAPSK 0x0002
 185 #define WPS_AUTH_SHARED 0x0004
 186 #define WPS_AUTH_WPA 0x0008
 187 #define WPS_AUTH_WPA2 0x0010
 188 #define WPS_AUTH_WPA2PSK 0x0020
 189 #define WPS_AUTH_TYPES (WPS_AUTH_OPEN | WPS_AUTH_WPAPSK | WPS_AUTH_SHARED | \
 190                         WPS_AUTH_WPA | WPS_AUTH_WPA2 | WPS_AUTH_WPA2PSK)
 191
 192 /* Encryption Type Flags */
 193 #define WPS_ENCR_NONE 0x0001
 194 #define WPS_ENCR_WEP 0x0002
 195 #define WPS_ENCR_TKIP 0x0004
 196 #define WPS_ENCR_AES 0x0008
 197 #define WPS_ENCR_TYPES (WPS_ENCR_NONE | WPS_ENCR_WEP | WPS_ENCR_TKIP | \
 198                         WPS_ENCR_AES)
 199
 200 /* Configuration Error */
 201 enum wps_config_error {
 202         WPS_CFG_NO_ERROR = 0,
 203         WPS_CFG_OOB_IFACE_READ_ERROR = 1,
 204         WPS_CFG_DECRYPTION_CRC_FAILURE = 2,
 205         WPS_CFG_24_CHAN_NOT_SUPPORTED = 3,
 206         WPS_CFG_50_CHAN_NOT_SUPPORTED = 4,
 207         WPS_CFG_SIGNAL_TOO_WEAK = 5,
 208         WPS_CFG_NETWORK_AUTH_FAILURE = 6,
 209         WPS_CFG_NETWORK_ASSOC_FAILURE = 7,
 210         WPS_CFG_NO_DHCP_RESPONSE = 8,
 211         WPS_CFG_FAILED_DHCP_CONFIG = 9,
 212         WPS_CFG_IP_ADDR_CONFLICT = 10,
 213         WPS_CFG_NO_CONN_TO_REGISTRAR = 11,
 214         WPS_CFG_MULTIPLE_PBC_DETECTED = 12,
 215         WPS_CFG_ROGUE_SUSPECTED = 13,
 216         WPS_CFG_DEVICE_BUSY = 14,
 217         WPS_CFG_SETUP_LOCKED = 15,
 218         WPS_CFG_MSG_TIMEOUT = 16,
 219         WPS_CFG_REG_SESS_TIMEOUT = 17,
 220         WPS_CFG_DEV_PASSWORD_AUTH_FAILURE = 18,
 221         WPS_CFG_60G_CHAN_NOT_SUPPORTED = 19,
 222         WPS_CFG_PUBLIC_KEY_HASH_MISMATCH = 20
 223 };
 224
 225 /* Vendor specific Error Indication for WPS event messages */
 226 enum wps_error_indication {
 227         WPS_EI_NO_ERROR,
 228         WPS_EI_SECURITY_TKIP_ONLY_PROHIBITED,
 229         WPS_EI_SECURITY_WEP_PROHIBITED,
 230         WPS_EI_AUTH_FAILURE,
 231         NUM_WPS_EI_VALUES
 232 };
 233
 234 /* RF Bands */
 235 #define WPS_RF_24GHZ 0x01
 236 #define WPS_RF_50GHZ 0x02
 237
 238 /* Config Methods */
 239 #define WPS_CONFIG_USBA 0x0001
 240 #define WPS_CONFIG_ETHERNET 0x0002
 241 #define WPS_CONFIG_LABEL 0x0004
 242 #define WPS_CONFIG_DISPLAY 0x0008
 243 #define WPS_CONFIG_EXT_NFC_TOKEN 0x0010
 244 #define WPS_CONFIG_INT_NFC_TOKEN 0x0020
 245 #define WPS_CONFIG_NFC_INTERFACE 0x0040
 246 #define WPS_CONFIG_PUSHBUTTON 0x0080
 247 #define WPS_CONFIG_KEYPAD 0x0100
 248 #ifdef CONFIG_WPS2
 249 #define WPS_CONFIG_VIRT_PUSHBUTTON 0x0280
 250 #define WPS_CONFIG_PHY_PUSHBUTTON 0x0480
 251 #define WPS_CONFIG_VIRT_DISPLAY 0x2008
 252 #define WPS_CONFIG_PHY_DISPLAY 0x4008
 253 #endif /* CONFIG_WPS2 */
 254
 255 /* Connection Type Flags */
 256 #define WPS_CONN_ESS 0x01
 257 #define WPS_CONN_IBSS 0x02
 258
 259 /* Wi-Fi Protected Setup State */
 260 enum wps_state {
 261         WPS_STATE_NOT_CONFIGURED = 1,
 262         WPS_STATE_CONFIGURED = 2
 263 };
 264
 265 /* Association State */
 266 enum wps_assoc_state {
 267         WPS_ASSOC_NOT_ASSOC = 0,
 268         WPS_ASSOC_CONN_SUCCESS = 1,
 269         WPS_ASSOC_CFG_FAILURE = 2,
 270         WPS_ASSOC_FAILURE = 3,
 271         WPS_ASSOC_IP_FAILURE = 4
 272 };
 273
 274
 275 #define WPS_DEV_OUI_WFA 0x0050f204
 276
 277 enum wps_dev_categ {
 278         WPS_DEV_COMPUTER = 1,
 279         WPS_DEV_INPUT = 2,
 280         WPS_DEV_PRINTER = 3,
 281         WPS_DEV_CAMERA = 4,
 282         WPS_DEV_STORAGE = 5,
 283         WPS_DEV_NETWORK_INFRA = 6,
 284         WPS_DEV_DISPLAY = 7,
 285         WPS_DEV_MULTIMEDIA = 8,
 286         WPS_DEV_GAMING = 9,
 287         WPS_DEV_PHONE = 10
 288 };
 289
 290 enum wps_dev_subcateg {
 291         WPS_DEV_COMPUTER_PC = 1,
 292         WPS_DEV_COMPUTER_SERVER = 2,
 293         WPS_DEV_COMPUTER_MEDIA_CENTER = 3,
 294         WPS_DEV_PRINTER_PRINTER = 1,
 295         WPS_DEV_PRINTER_SCANNER = 2,
 296         WPS_DEV_CAMERA_DIGITAL_STILL_CAMERA = 1,
 297         WPS_DEV_STORAGE_NAS = 1,
 298         WPS_DEV_NETWORK_INFRA_AP = 1,
 299         WPS_DEV_NETWORK_INFRA_ROUTER = 2,
 300         WPS_DEV_NETWORK_INFRA_SWITCH = 3,
 301         WPS_DEV_DISPLAY_TV = 1,
 302         WPS_DEV_DISPLAY_PICTURE_FRAME = 2,
 303         WPS_DEV_DISPLAY_PROJECTOR = 3,
 304         WPS_DEV_MULTIMEDIA_DAR = 1,
 305         WPS_DEV_MULTIMEDIA_PVR = 2,
 306         WPS_DEV_MULTIMEDIA_MCX = 3,
 307         WPS_DEV_GAMING_XBOX = 1,
 308         WPS_DEV_GAMING_XBOX360 = 2,
 309         WPS_DEV_GAMING_PLAYSTATION = 3,
 310         WPS_DEV_PHONE_WINDOWS_MOBILE = 1
 311 };
 312
 313
 314 /* Request Type */
 315 enum wps_request_type {
 316         WPS_REQ_ENROLLEE_INFO = 0,
 317         WPS_REQ_ENROLLEE = 1,
 318         WPS_REQ_REGISTRAR = 2,
 319         WPS_REQ_WLAN_MANAGER_REGISTRAR = 3
 320 };
 321
 322 /* Response Type */
 323 enum wps_response_type {
 324         WPS_RESP_ENROLLEE_INFO = 0,
 325         WPS_RESP_ENROLLEE = 1,
 326         WPS_RESP_REGISTRAR = 2,
 327         WPS_RESP_AP = 3
 328 };
 329
 330 /* Walk Time for push button configuration (in seconds) */
 331 #define WPS_PBC_WALK_TIME 120
 332
 333 #define WPS_MAX_AUTHORIZED_MACS 5
 334
 335 #endif /* WPS_DEFS_H */