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