wps_defs.h 7.4 KB

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