src/common/wpa_ctrl.h

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