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