wpa_ctrl.h 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564
  1. /*
  2. * wpa_supplicant/hostapd control interface library
  3. * Copyright (c) 2004-2017, 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 WPA_CTRL_H
  9. #define WPA_CTRL_H
  10. #ifdef __cplusplus
  11. extern "C" {
  12. #endif
  13. /* wpa_supplicant control interface - fixed message prefixes */
  14. /** Interactive request for identity/password/pin */
  15. #define WPA_CTRL_REQ "CTRL-REQ-"
  16. /** Response to identity/password/pin request */
  17. #define WPA_CTRL_RSP "CTRL-RSP-"
  18. /* Event messages with fixed prefix */
  19. /** Authentication completed successfully and data connection enabled */
  20. #define WPA_EVENT_CONNECTED "CTRL-EVENT-CONNECTED "
  21. /** Disconnected, data connection is not available */
  22. #define WPA_EVENT_DISCONNECTED "CTRL-EVENT-DISCONNECTED "
  23. /** Association rejected during connection attempt */
  24. #define WPA_EVENT_ASSOC_REJECT "CTRL-EVENT-ASSOC-REJECT "
  25. /** Authentication rejected during connection attempt */
  26. #define WPA_EVENT_AUTH_REJECT "CTRL-EVENT-AUTH-REJECT "
  27. /** wpa_supplicant is exiting */
  28. #define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING "
  29. /** Password change was completed successfully */
  30. #define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED "
  31. /** EAP-Request/Notification received */
  32. #define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION "
  33. /** EAP authentication started (EAP-Request/Identity received) */
  34. #define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED "
  35. /** EAP method proposed by the server */
  36. #define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD "
  37. /** EAP method selected */
  38. #define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD "
  39. /** EAP peer certificate from TLS */
  40. #define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT "
  41. /** EAP peer certificate alternative subject name component from TLS */
  42. #define WPA_EVENT_EAP_PEER_ALT "CTRL-EVENT-EAP-PEER-ALT "
  43. /** EAP TLS certificate chain validation error */
  44. #define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR "
  45. /** EAP status */
  46. #define WPA_EVENT_EAP_STATUS "CTRL-EVENT-EAP-STATUS "
  47. /** Retransmit the previous request packet */
  48. #define WPA_EVENT_EAP_RETRANSMIT "CTRL-EVENT-EAP-RETRANSMIT "
  49. #define WPA_EVENT_EAP_RETRANSMIT2 "CTRL-EVENT-EAP-RETRANSMIT2 "
  50. /** EAP authentication completed successfully */
  51. #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS "
  52. #define WPA_EVENT_EAP_SUCCESS2 "CTRL-EVENT-EAP-SUCCESS2 "
  53. /** EAP authentication failed (EAP-Failure received) */
  54. #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE "
  55. #define WPA_EVENT_EAP_FAILURE2 "CTRL-EVENT-EAP-FAILURE2 "
  56. /** EAP authentication failed due to no response received */
  57. #define WPA_EVENT_EAP_TIMEOUT_FAILURE "CTRL-EVENT-EAP-TIMEOUT-FAILURE "
  58. #define WPA_EVENT_EAP_TIMEOUT_FAILURE2 "CTRL-EVENT-EAP-TIMEOUT-FAILURE2 "
  59. /** Network block temporarily disabled (e.g., due to authentication failure) */
  60. #define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED "
  61. /** Temporarily disabled network block re-enabled */
  62. #define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED "
  63. /** New scan started */
  64. #define WPA_EVENT_SCAN_STARTED "CTRL-EVENT-SCAN-STARTED "
  65. /** New scan results available */
  66. #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS "
  67. /** Scan command failed */
  68. #define WPA_EVENT_SCAN_FAILED "CTRL-EVENT-SCAN-FAILED "
  69. /** wpa_supplicant state change */
  70. #define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE "
  71. /** A new BSS entry was added (followed by BSS entry id and BSSID) */
  72. #define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED "
  73. /** A BSS entry was removed (followed by BSS entry id and BSSID) */
  74. #define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED "
  75. /** No suitable network was found */
  76. #define WPA_EVENT_NETWORK_NOT_FOUND "CTRL-EVENT-NETWORK-NOT-FOUND "
  77. /** Change in the signal level was reported by the driver */
  78. #define WPA_EVENT_SIGNAL_CHANGE "CTRL-EVENT-SIGNAL-CHANGE "
  79. /** Beacon loss reported by the driver */
  80. #define WPA_EVENT_BEACON_LOSS "CTRL-EVENT-BEACON-LOSS "
  81. /** Regulatory domain channel */
  82. #define WPA_EVENT_REGDOM_CHANGE "CTRL-EVENT-REGDOM-CHANGE "
  83. /** Channel switch (followed by freq=<MHz> and other channel parameters) */
  84. #define WPA_EVENT_CHANNEL_SWITCH "CTRL-EVENT-CHANNEL-SWITCH "
  85. /** IP subnet status change notification
  86. *
  87. * When using an offloaded roaming mechanism where driver/firmware takes care
  88. * of roaming and IP subnet validation checks post-roaming, this event can
  89. * indicate whether IP subnet has changed.
  90. *
  91. * The event has a status=<0/1/2> parameter where
  92. * 0 = unknown
  93. * 1 = IP subnet unchanged (can continue to use the old IP address)
  94. * 2 = IP subnet changed (need to get a new IP address)
  95. */
  96. #define WPA_EVENT_SUBNET_STATUS_UPDATE "CTRL-EVENT-SUBNET-STATUS-UPDATE "
  97. /** RSN IBSS 4-way handshakes completed with specified peer */
  98. #define IBSS_RSN_COMPLETED "IBSS-RSN-COMPLETED "
  99. /** Notification of frequency conflict due to a concurrent operation.
  100. *
  101. * The indicated network is disabled and needs to be re-enabled before it can
  102. * be used again.
  103. */
  104. #define WPA_EVENT_FREQ_CONFLICT "CTRL-EVENT-FREQ-CONFLICT "
  105. /** Frequency ranges that the driver recommends to avoid */
  106. #define WPA_EVENT_AVOID_FREQ "CTRL-EVENT-AVOID-FREQ "
  107. /** WPS overlap detected in PBC mode */
  108. #define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED "
  109. /** Available WPS AP with active PBC found in scan results */
  110. #define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC "
  111. /** Available WPS AP with our address as authorized in scan results */
  112. #define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH "
  113. /** Available WPS AP with recently selected PIN registrar found in scan results
  114. */
  115. #define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN "
  116. /** Available WPS AP found in scan results */
  117. #define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE "
  118. /** A new credential received */
  119. #define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED "
  120. /** M2D received */
  121. #define WPS_EVENT_M2D "WPS-M2D "
  122. /** WPS registration failed after M2/M2D */
  123. #define WPS_EVENT_FAIL "WPS-FAIL "
  124. /** WPS registration completed successfully */
  125. #define WPS_EVENT_SUCCESS "WPS-SUCCESS "
  126. /** WPS enrollment attempt timed out and was terminated */
  127. #define WPS_EVENT_TIMEOUT "WPS-TIMEOUT "
  128. /* PBC mode was activated */
  129. #define WPS_EVENT_ACTIVE "WPS-PBC-ACTIVE "
  130. /* PBC mode was disabled */
  131. #define WPS_EVENT_DISABLE "WPS-PBC-DISABLE "
  132. #define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN "
  133. #define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK "
  134. /* WPS ER events */
  135. #define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD "
  136. #define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE "
  137. #define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD "
  138. #define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE "
  139. #define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS "
  140. #define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG "
  141. /* DPP events */
  142. #define DPP_EVENT_AUTH_SUCCESS "DPP-AUTH-SUCCESS "
  143. #define DPP_EVENT_AUTH_INIT_FAILED "DPP-AUTH-INIT-FAILED "
  144. #define DPP_EVENT_NOT_COMPATIBLE "DPP-NOT-COMPATIBLE "
  145. #define DPP_EVENT_RESPONSE_PENDING "DPP-RESPONSE-PENDING "
  146. #define DPP_EVENT_SCAN_PEER_QR_CODE "DPP-SCAN-PEER-QR-CODE "
  147. #define DPP_EVENT_AUTH_DIRECTION "DPP-AUTH-DIRECTION "
  148. #define DPP_EVENT_CONF_RECEIVED "DPP-CONF-RECEIVED "
  149. #define DPP_EVENT_CONF_SENT "DPP-CONF-SENT "
  150. #define DPP_EVENT_CONF_FAILED "DPP-CONF-FAILED "
  151. #define DPP_EVENT_CONFOBJ_AKM "DPP-CONFOBJ-AKM "
  152. #define DPP_EVENT_CONFOBJ_SSID "DPP-CONFOBJ-SSID "
  153. #define DPP_EVENT_CONFOBJ_PASS "DPP-CONFOBJ-PASS "
  154. #define DPP_EVENT_CONFOBJ_PSK "DPP-CONFOBJ-PSK "
  155. #define DPP_EVENT_CONNECTOR "DPP-CONNECTOR "
  156. #define DPP_EVENT_C_SIGN_KEY "DPP-C-SIGN-KEY "
  157. #define DPP_EVENT_NET_ACCESS_KEY "DPP-NET-ACCESS-KEY "
  158. #define DPP_EVENT_MISSING_CONNECTOR "DPP-MISSING-CONNECTOR "
  159. #define DPP_EVENT_NETWORK_ID "DPP-NETWORK-ID "
  160. #define DPP_EVENT_RX "DPP-RX "
  161. #define DPP_EVENT_TX "DPP-TX "
  162. #define DPP_EVENT_TX_STATUS "DPP-TX-STATUS "
  163. #define DPP_EVENT_FAIL "DPP-FAIL "
  164. #define DPP_EVENT_PKEX_T_LIMIT "DPP-PKEX-T-LIMIT "
  165. #define DPP_EVENT_INTRO "DPP-INTRO "
  166. #define DPP_EVENT_CONF_REQ_RX "DPP-CONF-REQ-RX "
  167. /* MESH events */
  168. #define MESH_GROUP_STARTED "MESH-GROUP-STARTED "
  169. #define MESH_GROUP_REMOVED "MESH-GROUP-REMOVED "
  170. #define MESH_PEER_CONNECTED "MESH-PEER-CONNECTED "
  171. #define MESH_PEER_DISCONNECTED "MESH-PEER-DISCONNECTED "
  172. /** Mesh SAE authentication failure. Wrong password suspected. */
  173. #define MESH_SAE_AUTH_FAILURE "MESH-SAE-AUTH-FAILURE "
  174. #define MESH_SAE_AUTH_BLOCKED "MESH-SAE-AUTH-BLOCKED "
  175. /* WMM AC events */
  176. #define WMM_AC_EVENT_TSPEC_ADDED "TSPEC-ADDED "
  177. #define WMM_AC_EVENT_TSPEC_REMOVED "TSPEC-REMOVED "
  178. #define WMM_AC_EVENT_TSPEC_REQ_FAILED "TSPEC-REQ-FAILED "
  179. /** P2P device found */
  180. #define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND "
  181. /** P2P device lost */
  182. #define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST "
  183. /** A P2P device requested GO negotiation, but we were not ready to start the
  184. * negotiation */
  185. #define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST "
  186. #define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS "
  187. #define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE "
  188. #define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS "
  189. #define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE "
  190. #define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED "
  191. #define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED "
  192. #define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE "
  193. #define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE "
  194. /* parameters: <peer address> <PIN> */
  195. #define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN "
  196. /* parameters: <peer address> */
  197. #define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN "
  198. /* parameters: <peer address> */
  199. #define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ "
  200. /* parameters: <peer address> */
  201. #define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP "
  202. /* parameters: <peer address> <status> */
  203. #define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE"
  204. /* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */
  205. #define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ "
  206. /* parameters: <src addr> <update indicator> <TLVs> */
  207. #define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP "
  208. #define P2P_EVENT_SERV_ASP_RESP "P2P-SERV-ASP-RESP "
  209. #define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED "
  210. #define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT "
  211. #define P2P_EVENT_INVITATION_ACCEPTED "P2P-INVITATION-ACCEPTED "
  212. #define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED "
  213. #define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id="
  214. #define P2P_EVENT_PRESENCE_RESPONSE "P2P-PRESENCE-RESPONSE "
  215. #define P2P_EVENT_NFC_BOTH_GO "P2P-NFC-BOTH-GO "
  216. #define P2P_EVENT_NFC_PEER_CLIENT "P2P-NFC-PEER-CLIENT "
  217. #define P2P_EVENT_NFC_WHILE_CLIENT "P2P-NFC-WHILE-CLIENT "
  218. #define P2P_EVENT_FALLBACK_TO_GO_NEG "P2P-FALLBACK-TO-GO-NEG "
  219. #define P2P_EVENT_FALLBACK_TO_GO_NEG_ENABLED "P2P-FALLBACK-TO-GO-NEG-ENABLED "
  220. /* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */
  221. #define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT "
  222. #define P2P_EVENT_REMOVE_AND_REFORM_GROUP "P2P-REMOVE-AND-REFORM-GROUP "
  223. #define P2P_EVENT_P2PS_PROVISION_START "P2PS-PROV-START "
  224. #define P2P_EVENT_P2PS_PROVISION_DONE "P2PS-PROV-DONE "
  225. #define INTERWORKING_AP "INTERWORKING-AP "
  226. #define INTERWORKING_BLACKLISTED "INTERWORKING-BLACKLISTED "
  227. #define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH "
  228. #define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED "
  229. #define INTERWORKING_SELECTED "INTERWORKING-SELECTED "
  230. /* Credential block added; parameters: <id> */
  231. #define CRED_ADDED "CRED-ADDED "
  232. /* Credential block modified; parameters: <id> <field> */
  233. #define CRED_MODIFIED "CRED-MODIFIED "
  234. /* Credential block removed; parameters: <id> */
  235. #define CRED_REMOVED "CRED-REMOVED "
  236. #define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO "
  237. /* parameters: <addr> <dialog_token> <freq> */
  238. #define GAS_QUERY_START "GAS-QUERY-START "
  239. /* parameters: <addr> <dialog_token> <freq> <status_code> <result> */
  240. #define GAS_QUERY_DONE "GAS-QUERY-DONE "
  241. /* parameters: <addr> <result> */
  242. #define ANQP_QUERY_DONE "ANQP-QUERY-DONE "
  243. #define RX_ANQP "RX-ANQP "
  244. #define RX_HS20_ANQP "RX-HS20-ANQP "
  245. #define RX_HS20_ANQP_ICON "RX-HS20-ANQP-ICON "
  246. #define RX_HS20_ICON "RX-HS20-ICON "
  247. #define RX_MBO_ANQP "RX-MBO-ANQP "
  248. #define HS20_SUBSCRIPTION_REMEDIATION "HS20-SUBSCRIPTION-REMEDIATION "
  249. #define HS20_DEAUTH_IMMINENT_NOTICE "HS20-DEAUTH-IMMINENT-NOTICE "
  250. #define EXT_RADIO_WORK_START "EXT-RADIO-WORK-START "
  251. #define EXT_RADIO_WORK_TIMEOUT "EXT-RADIO-WORK-TIMEOUT "
  252. #define RRM_EVENT_NEIGHBOR_REP_RXED "RRM-NEIGHBOR-REP-RECEIVED "
  253. #define RRM_EVENT_NEIGHBOR_REP_FAILED "RRM-NEIGHBOR-REP-REQUEST-FAILED "
  254. /* hostapd control interface - fixed message prefixes */
  255. #define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED "
  256. #define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS "
  257. #define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS "
  258. #define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED "
  259. #define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED "
  260. #define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED "
  261. #define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED "
  262. #define AP_STA_CONNECTED "AP-STA-CONNECTED "
  263. #define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED "
  264. #define AP_STA_POSSIBLE_PSK_MISMATCH "AP-STA-POSSIBLE-PSK-MISMATCH "
  265. #define AP_STA_POLL_OK "AP-STA-POLL-OK "
  266. #define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA "
  267. #define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA "
  268. #define AP_EVENT_ENABLED "AP-ENABLED "
  269. #define AP_EVENT_DISABLED "AP-DISABLED "
  270. #define INTERFACE_ENABLED "INTERFACE-ENABLED "
  271. #define INTERFACE_DISABLED "INTERFACE-DISABLED "
  272. #define ACS_EVENT_STARTED "ACS-STARTED "
  273. #define ACS_EVENT_COMPLETED "ACS-COMPLETED "
  274. #define ACS_EVENT_FAILED "ACS-FAILED "
  275. #define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED "
  276. #define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL "
  277. #define DFS_EVENT_CAC_START "DFS-CAC-START "
  278. #define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED "
  279. #define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED "
  280. #define DFS_EVENT_PRE_CAC_EXPIRED "DFS-PRE-CAC-EXPIRED "
  281. #define AP_CSA_FINISHED "AP-CSA-FINISHED "
  282. #define P2P_EVENT_LISTEN_OFFLOAD_STOP "P2P-LISTEN-OFFLOAD-STOPPED "
  283. #define P2P_LISTEN_OFFLOAD_STOP_REASON "P2P-LISTEN-OFFLOAD-STOP-REASON "
  284. /* BSS Transition Management Response frame received */
  285. #define BSS_TM_RESP "BSS-TM-RESP "
  286. /* MBO IE with cellular data connection preference received */
  287. #define MBO_CELL_PREFERENCE "MBO-CELL-PREFERENCE "
  288. /* BSS Transition Management Request received with MBO transition reason */
  289. #define MBO_TRANSITION_REASON "MBO-TRANSITION-REASON "
  290. /* parameters: <STA address> <dialog token> <ack=0/1> */
  291. #define BEACON_REQ_TX_STATUS "BEACON-REQ-TX-STATUS "
  292. /* parameters: <STA address> <dialog token> <report mode> <beacon report> */
  293. #define BEACON_RESP_RX "BEACON-RESP-RX "
  294. /* PMKSA cache entry added; parameters: <BSSID> <network_id> */
  295. #define PMKSA_CACHE_ADDED "PMKSA-CACHE-ADDED "
  296. /* PMKSA cache entry removed; parameters: <BSSID> <network_id> */
  297. #define PMKSA_CACHE_REMOVED "PMKSA-CACHE-REMOVED "
  298. /* FILS HLP Container receive; parameters: dst=<addr> src=<addr> frame=<hexdump>
  299. */
  300. #define FILS_HLP_RX "FILS-HLP-RX "
  301. /* Event to indicate Probe Request frame;
  302. * parameters: sa=<STA MAC address> signal=<signal> */
  303. #define RX_PROBE_REQUEST "RX-PROBE-REQUEST "
  304. /* BSS command information masks */
  305. #define WPA_BSS_MASK_ALL 0xFFFDFFFF
  306. #define WPA_BSS_MASK_ID BIT(0)
  307. #define WPA_BSS_MASK_BSSID BIT(1)
  308. #define WPA_BSS_MASK_FREQ BIT(2)
  309. #define WPA_BSS_MASK_BEACON_INT BIT(3)
  310. #define WPA_BSS_MASK_CAPABILITIES BIT(4)
  311. #define WPA_BSS_MASK_QUAL BIT(5)
  312. #define WPA_BSS_MASK_NOISE BIT(6)
  313. #define WPA_BSS_MASK_LEVEL BIT(7)
  314. #define WPA_BSS_MASK_TSF BIT(8)
  315. #define WPA_BSS_MASK_AGE BIT(9)
  316. #define WPA_BSS_MASK_IE BIT(10)
  317. #define WPA_BSS_MASK_FLAGS BIT(11)
  318. #define WPA_BSS_MASK_SSID BIT(12)
  319. #define WPA_BSS_MASK_WPS_SCAN BIT(13)
  320. #define WPA_BSS_MASK_P2P_SCAN BIT(14)
  321. #define WPA_BSS_MASK_INTERNETW BIT(15)
  322. #define WPA_BSS_MASK_WIFI_DISPLAY BIT(16)
  323. #define WPA_BSS_MASK_DELIM BIT(17)
  324. #define WPA_BSS_MASK_MESH_SCAN BIT(18)
  325. #define WPA_BSS_MASK_SNR BIT(19)
  326. #define WPA_BSS_MASK_EST_THROUGHPUT BIT(20)
  327. #define WPA_BSS_MASK_FST BIT(21)
  328. #define WPA_BSS_MASK_UPDATE_IDX BIT(22)
  329. #define WPA_BSS_MASK_BEACON_IE BIT(23)
  330. #define WPA_BSS_MASK_FILS_INDICATION BIT(24)
  331. /* VENDOR_ELEM_* frame id values */
  332. enum wpa_vendor_elem_frame {
  333. VENDOR_ELEM_PROBE_REQ_P2P = 0,
  334. VENDOR_ELEM_PROBE_RESP_P2P = 1,
  335. VENDOR_ELEM_PROBE_RESP_P2P_GO = 2,
  336. VENDOR_ELEM_BEACON_P2P_GO = 3,
  337. VENDOR_ELEM_P2P_PD_REQ = 4,
  338. VENDOR_ELEM_P2P_PD_RESP = 5,
  339. VENDOR_ELEM_P2P_GO_NEG_REQ = 6,
  340. VENDOR_ELEM_P2P_GO_NEG_RESP = 7,
  341. VENDOR_ELEM_P2P_GO_NEG_CONF = 8,
  342. VENDOR_ELEM_P2P_INV_REQ = 9,
  343. VENDOR_ELEM_P2P_INV_RESP = 10,
  344. VENDOR_ELEM_P2P_ASSOC_REQ = 11,
  345. VENDOR_ELEM_P2P_ASSOC_RESP = 12,
  346. VENDOR_ELEM_ASSOC_REQ = 13,
  347. VENDOR_ELEM_PROBE_REQ = 14,
  348. NUM_VENDOR_ELEM_FRAMES
  349. };
  350. /* wpa_supplicant/hostapd control interface access */
  351. /**
  352. * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
  353. * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
  354. * Returns: Pointer to abstract control interface data or %NULL on failure
  355. *
  356. * This function is used to open a control interface to wpa_supplicant/hostapd.
  357. * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
  358. * is configured in wpa_supplicant/hostapd and other programs using the control
  359. * interface need to use matching path configuration.
  360. */
  361. struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);
  362. /**
  363. * wpa_ctrl_open2 - Open a control interface to wpa_supplicant/hostapd
  364. * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
  365. * @cli_path: Path for client UNIX domain sockets; ignored if UDP socket
  366. * is used.
  367. * Returns: Pointer to abstract control interface data or %NULL on failure
  368. *
  369. * This function is used to open a control interface to wpa_supplicant/hostapd
  370. * when the socket path for client need to be specified explicitly. Default
  371. * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd and client
  372. * socket path is /tmp.
  373. */
  374. struct wpa_ctrl * wpa_ctrl_open2(const char *ctrl_path, const char *cli_path);
  375. /**
  376. * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
  377. * @ctrl: Control interface data from wpa_ctrl_open()
  378. *
  379. * This function is used to close a control interface.
  380. */
  381. void wpa_ctrl_close(struct wpa_ctrl *ctrl);
  382. /**
  383. * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
  384. * @ctrl: Control interface data from wpa_ctrl_open()
  385. * @cmd: Command; usually, ASCII text, e.g., "PING"
  386. * @cmd_len: Length of the cmd in bytes
  387. * @reply: Buffer for the response
  388. * @reply_len: Reply buffer length
  389. * @msg_cb: Callback function for unsolicited messages or %NULL if not used
  390. * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
  391. *
  392. * This function is used to send commands to wpa_supplicant/hostapd. Received
  393. * response will be written to reply and reply_len is set to the actual length
  394. * of the reply. This function will block for up to 10 seconds while waiting
  395. * for the reply. If unsolicited messages are received, the blocking time may
  396. * be longer.
  397. *
  398. * msg_cb can be used to register a callback function that will be called for
  399. * unsolicited messages received while waiting for the command response. These
  400. * messages may be received if wpa_ctrl_request() is called at the same time as
  401. * wpa_supplicant/hostapd is sending such a message. This can happen only if
  402. * the program has used wpa_ctrl_attach() to register itself as a monitor for
  403. * event messages. Alternatively to msg_cb, programs can register two control
  404. * interface connections and use one of them for commands and the other one for
  405. * receiving event messages, in other words, call wpa_ctrl_attach() only for
  406. * the control interface connection that will be used for event messages.
  407. */
  408. int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
  409. char *reply, size_t *reply_len,
  410. void (*msg_cb)(char *msg, size_t len));
  411. /**
  412. * wpa_ctrl_attach - Register as an event monitor for the control interface
  413. * @ctrl: Control interface data from wpa_ctrl_open()
  414. * Returns: 0 on success, -1 on failure, -2 on timeout
  415. *
  416. * This function registers the control interface connection as a monitor for
  417. * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
  418. * control interface connection starts receiving event messages that can be
  419. * read with wpa_ctrl_recv().
  420. */
  421. int wpa_ctrl_attach(struct wpa_ctrl *ctrl);
  422. /**
  423. * wpa_ctrl_detach - Unregister event monitor from the control interface
  424. * @ctrl: Control interface data from wpa_ctrl_open()
  425. * Returns: 0 on success, -1 on failure, -2 on timeout
  426. *
  427. * This function unregisters the control interface connection as a monitor for
  428. * wpa_supplicant/hostapd events, i.e., cancels the registration done with
  429. * wpa_ctrl_attach().
  430. */
  431. int wpa_ctrl_detach(struct wpa_ctrl *ctrl);
  432. /**
  433. * wpa_ctrl_recv - Receive a pending control interface message
  434. * @ctrl: Control interface data from wpa_ctrl_open()
  435. * @reply: Buffer for the message data
  436. * @reply_len: Length of the reply buffer
  437. * Returns: 0 on success, -1 on failure
  438. *
  439. * This function will receive a pending control interface message. The received
  440. * response will be written to reply and reply_len is set to the actual length
  441. * of the reply.
  442. * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
  443. * must have been used to register the control interface as an event monitor.
  444. */
  445. int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len);
  446. /**
  447. * wpa_ctrl_pending - Check whether there are pending event messages
  448. * @ctrl: Control interface data from wpa_ctrl_open()
  449. * Returns: 1 if there are pending messages, 0 if no, or -1 on error
  450. *
  451. * This function will check whether there are any pending control interface
  452. * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
  453. * only used for event messages, i.e., wpa_ctrl_attach() must have been used to
  454. * register the control interface as an event monitor.
  455. */
  456. int wpa_ctrl_pending(struct wpa_ctrl *ctrl);
  457. /**
  458. * wpa_ctrl_get_fd - Get file descriptor used by the control interface
  459. * @ctrl: Control interface data from wpa_ctrl_open()
  460. * Returns: File descriptor used for the connection
  461. *
  462. * This function can be used to get the file descriptor that is used for the
  463. * control interface connection. The returned value can be used, e.g., with
  464. * select() while waiting for multiple events.
  465. *
  466. * The returned file descriptor must not be used directly for sending or
  467. * receiving packets; instead, the library functions wpa_ctrl_request() and
  468. * wpa_ctrl_recv() must be used for this.
  469. */
  470. int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);
  471. #ifdef ANDROID
  472. /**
  473. * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
  474. * may be left over from clients that were previously connected to
  475. * wpa_supplicant. This keeps these files from being orphaned in the
  476. * event of crashes that prevented them from being removed as part
  477. * of the normal orderly shutdown.
  478. */
  479. void wpa_ctrl_cleanup(void);
  480. #endif /* ANDROID */
  481. #ifdef CONFIG_CTRL_IFACE_UDP
  482. /* Port range for multiple wpa_supplicant instances and multiple VIFs */
  483. #define WPA_CTRL_IFACE_PORT 9877
  484. #define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */
  485. #define WPA_GLOBAL_CTRL_IFACE_PORT 9878
  486. #define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */
  487. char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl);
  488. #endif /* CONFIG_CTRL_IFACE_UDP */
  489. #ifdef __cplusplus
  490. }
  491. #endif
  492. #endif /* WPA_CTRL_H */