wps_defs.h 9.8 KB

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