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