contrib/hostapd/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 /** wpa_supplicant is exiting */
  32 #define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING "
  33 /** Password change was completed successfully */
  34 #define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED "
  35 /** EAP-Request/Notification received */
  36 #define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION "
  37 /** EAP authentication started (EAP-Request/Identity received) */
  38 #define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED "
  39 /** EAP method proposed by the server */
  40 #define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD "
  41 /** EAP method selected */
  42 #define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD "
  43 /** EAP peer certificate from TLS */
  44 #define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT "
  45 /** EAP TLS certificate chain validation error */
  46 #define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR "
  47 /** EAP status */
  48 #define WPA_EVENT_EAP_STATUS "CTRL-EVENT-EAP-STATUS "
  49 /** EAP authentication completed successfully */
  50 #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS "
  51 /** EAP authentication failed (EAP-Failure received) */
  52 #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE "
  53 /** Network block temporarily disabled (e.g., due to authentication failure) */
  54 #define WPA_EVENT_TEMP_DISABLED "CTRL-EVENT-SSID-TEMP-DISABLED "
  55 /** Temporarily disabled network block re-enabled */
  56 #define WPA_EVENT_REENABLED "CTRL-EVENT-SSID-REENABLED "
  57 /** New scan started */
  58 #define WPA_EVENT_SCAN_STARTED "CTRL-EVENT-SCAN-STARTED "
  59 /** New scan results available */
  60 #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS "
  61 /** wpa_supplicant state change */
  62 #define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE "
  63 /** A new BSS entry was added (followed by BSS entry id and BSSID) */
  64 #define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED "
  65 /** A BSS entry was removed (followed by BSS entry id and BSSID) */
  66 #define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED "
  67
  68 /** RSN IBSS 4-way handshakes completed with specified peer */
  69 #define IBSS_RSN_COMPLETED "IBSS-RSN-COMPLETED "
  70
  71 /** Notification of frequency conflict due to a concurrent operation.
  72  *
  73  * The indicated network is disabled and needs to be re-enabled before it can
  74  * be used again.
  75  */
  76 #define WPA_EVENT_FREQ_CONFLICT "CTRL-EVENT-FREQ-CONFLICT "
  77 /** Frequency ranges that the driver recommends to avoid */
  78 #define WPA_EVENT_AVOID_FREQ "CTRL-EVENT-AVOID-FREQ "
  79 /** WPS overlap detected in PBC mode */
  80 #define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED "
  81 /** Available WPS AP with active PBC found in scan results */
  82 #define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC "
  83 /** Available WPS AP with our address as authorized in scan results */
  84 #define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH "
  85 /** Available WPS AP with recently selected PIN registrar found in scan results
  86  */
  87 #define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN "
  88 /** Available WPS AP found in scan results */
  89 #define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE "
  90 /** A new credential received */
  91 #define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED "
  92 /** M2D received */
  93 #define WPS_EVENT_M2D "WPS-M2D "
  94 /** WPS registration failed after M2/M2D */
  95 #define WPS_EVENT_FAIL "WPS-FAIL "
  96 /** WPS registration completed successfully */
  97 #define WPS_EVENT_SUCCESS "WPS-SUCCESS "
  98 /** WPS enrollment attempt timed out and was terminated */
  99 #define WPS_EVENT_TIMEOUT "WPS-TIMEOUT "
 100 /* PBC mode was activated */
 101 #define WPS_EVENT_ACTIVE "WPS-PBC-ACTIVE "
 102 /* PBC mode was disabled */
 103 #define WPS_EVENT_DISABLE "WPS-PBC-DISABLE "
 104
 105 #define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN "
 106
 107 #define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK "
 108
 109 /* WPS ER events */
 110 #define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD "
 111 #define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE "
 112 #define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD "
 113 #define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE "
 114 #define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS "
 115 #define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG "
 116
 117 /** P2P device found */
 118 #define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND "
 119
 120 /** P2P device lost */
 121 #define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST "
 122
 123 /** A P2P device requested GO negotiation, but we were not ready to start the
 124  * negotiation */
 125 #define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST "
 126 #define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS "
 127 #define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE "
 128 #define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS "
 129 #define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE "
 130 #define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED "
 131 #define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED "
 132 #define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE "
 133 #define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE "
 134 /* parameters: <peer address> <PIN> */
 135 #define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN "
 136 /* parameters: <peer address> */
 137 #define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN "
 138 /* parameters: <peer address> */
 139 #define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ "
 140 /* parameters: <peer address> */
 141 #define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP "
 142 /* parameters: <peer address> <status> */
 143 #define P2P_EVENT_PROV_DISC_FAILURE "P2P-PROV-DISC-FAILURE"
 144 /* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */
 145 #define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ "
 146 /* parameters: <src addr> <update indicator> <TLVs> */
 147 #define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP "
 148 #define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED "
 149 #define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT "
 150 #define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED "
 151 #define P2P_EVENT_PERSISTENT_PSK_FAIL "P2P-PERSISTENT-PSK-FAIL id="
 152 #define P2P_EVENT_PRESENCE_RESPONSE "P2P-PRESENCE-RESPONSE "
 153 #define P2P_EVENT_NFC_BOTH_GO "P2P-NFC-BOTH-GO "
 154 #define P2P_EVENT_NFC_PEER_CLIENT "P2P-NFC-PEER-CLIENT "
 155 #define P2P_EVENT_NFC_WHILE_CLIENT "P2P-NFC-WHILE-CLIENT "
 156
 157 /* parameters: <PMF enabled> <timeout in ms> <Session Information URL> */
 158 #define ESS_DISASSOC_IMMINENT "ESS-DISASSOC-IMMINENT "
 159 #define P2P_EVENT_REMOVE_AND_REFORM_GROUP "P2P-REMOVE-AND-REFORM-GROUP "
 160
 161 #define INTERWORKING_AP "INTERWORKING-AP "
 162 #define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH "
 163 #define INTERWORKING_ALREADY_CONNECTED "INTERWORKING-ALREADY-CONNECTED "
 164
 165 #define GAS_RESPONSE_INFO "GAS-RESPONSE-INFO "
 166 /* parameters: <addr> <dialog_token> <freq> */
 167 #define GAS_QUERY_START "GAS-QUERY-START "
 168 /* parameters: <addr> <dialog_token> <freq> <status_code> <result> */
 169 #define GAS_QUERY_DONE "GAS-QUERY-DONE "
 170
 171 #define EXT_RADIO_WORK_START "EXT-RADIO-WORK-START "
 172 #define EXT_RADIO_WORK_TIMEOUT "EXT-RADIO-WORK-TIMEOUT "
 173
 174 /* hostapd control interface - fixed message prefixes */
 175 #define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED "
 176 #define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS "
 177 #define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS "
 178 #define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED "
 179 #define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED "
 180 #define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED "
 181 #define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED "
 182 #define AP_STA_CONNECTED "AP-STA-CONNECTED "
 183 #define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED "
 184
 185 #define AP_REJECTED_MAX_STA "AP-REJECTED-MAX-STA "
 186 #define AP_REJECTED_BLOCKED_STA "AP-REJECTED-BLOCKED-STA "
 187
 188 #define AP_EVENT_ENABLED "AP-ENABLED "
 189 #define AP_EVENT_DISABLED "AP-DISABLED "
 190
 191 #define ACS_EVENT_STARTED "ACS-STARTED "
 192 #define ACS_EVENT_COMPLETED "ACS-COMPLETED "
 193 #define ACS_EVENT_FAILED "ACS-FAILED "
 194
 195 #define DFS_EVENT_RADAR_DETECTED "DFS-RADAR-DETECTED "
 196 #define DFS_EVENT_NEW_CHANNEL "DFS-NEW-CHANNEL "
 197 #define DFS_EVENT_CAC_START "DFS-CAC-START "
 198 #define DFS_EVENT_CAC_COMPLETED "DFS-CAC-COMPLETED "
 199 #define DFS_EVENT_NOP_FINISHED "DFS-NOP-FINISHED "
 200
 201 #define AP_CSA_FINISHED "AP-CSA-FINISHED "
 202
 203 /* BSS command information masks */
 204
 205 #define WPA_BSS_MASK_ALL                0xFFFDFFFF
 206 #define WPA_BSS_MASK_ID                 BIT(0)
 207 #define WPA_BSS_MASK_BSSID              BIT(1)
 208 #define WPA_BSS_MASK_FREQ               BIT(2)
 209 #define WPA_BSS_MASK_BEACON_INT         BIT(3)
 210 #define WPA_BSS_MASK_CAPABILITIES       BIT(4)
 211 #define WPA_BSS_MASK_QUAL               BIT(5)
 212 #define WPA_BSS_MASK_NOISE              BIT(6)
 213 #define WPA_BSS_MASK_LEVEL              BIT(7)
 214 #define WPA_BSS_MASK_TSF                BIT(8)
 215 #define WPA_BSS_MASK_AGE                BIT(9)
 216 #define WPA_BSS_MASK_IE                 BIT(10)
 217 #define WPA_BSS_MASK_FLAGS              BIT(11)
 218 #define WPA_BSS_MASK_SSID               BIT(12)
 219 #define WPA_BSS_MASK_WPS_SCAN           BIT(13)
 220 #define WPA_BSS_MASK_P2P_SCAN           BIT(14)
 221 #define WPA_BSS_MASK_INTERNETW          BIT(15)
 222 #define WPA_BSS_MASK_WIFI_DISPLAY       BIT(16)
 223 #define WPA_BSS_MASK_DELIM              BIT(17)
 224
 225
 226 /* wpa_supplicant/hostapd control interface access */
 227
 228 /**
 229  * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
 230  * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
 231  * Returns: Pointer to abstract control interface data or %NULL on failure
 232  *
 233  * This function is used to open a control interface to wpa_supplicant/hostapd.
 234  * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
 235  * is configured in wpa_supplicant/hostapd and other programs using the control
 236  * interface need to use matching path configuration.
 237  */
 238 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);
 239
 240
 241 /**
 242  * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
 243  * @ctrl: Control interface data from wpa_ctrl_open()
 244  *
 245  * This function is used to close a control interface.
 246  */
 247 void wpa_ctrl_close(struct wpa_ctrl *ctrl);
 248
 249
 250 /**
 251  * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
 252  * @ctrl: Control interface data from wpa_ctrl_open()
 253  * @cmd: Command; usually, ASCII text, e.g., "PING"
 254  * @cmd_len: Length of the cmd in bytes
 255  * @reply: Buffer for the response
 256  * @reply_len: Reply buffer length
 257  * @msg_cb: Callback function for unsolicited messages or %NULL if not used
 258  * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
 259  *
 260  * This function is used to send commands to wpa_supplicant/hostapd. Received
 261  * response will be written to reply and reply_len is set to the actual length
 262  * of the reply. This function will block for up to two seconds while waiting
 263  * for the reply. If unsolicited messages are received, the blocking time may
 264  * be longer.
 265  *
 266  * msg_cb can be used to register a callback function that will be called for
 267  * unsolicited messages received while waiting for the command response. These
 268  * messages may be received if wpa_ctrl_request() is called at the same time as
 269  * wpa_supplicant/hostapd is sending such a message. This can happen only if
 270  * the program has used wpa_ctrl_attach() to register itself as a monitor for
 271  * event messages. Alternatively to msg_cb, programs can register two control
 272  * interface connections and use one of them for commands and the other one for
 273  * receiving event messages, in other words, call wpa_ctrl_attach() only for
 274  * the control interface connection that will be used for event messages.
 275  */
 276 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
 277                      char *reply, size_t *reply_len,
 278                      void (*msg_cb)(char *msg, size_t len));
 279
 280
 281 /**
 282  * wpa_ctrl_attach - Register as an event monitor for the control interface
 283  * @ctrl: Control interface data from wpa_ctrl_open()
 284  * Returns: 0 on success, -1 on failure, -2 on timeout
 285  *
 286  * This function registers the control interface connection as a monitor for
 287  * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
 288  * control interface connection starts receiving event messages that can be
 289  * read with wpa_ctrl_recv().
 290  */
 291 int wpa_ctrl_attach(struct wpa_ctrl *ctrl);
 292
 293
 294 /**
 295  * wpa_ctrl_detach - Unregister event monitor from the control interface
 296  * @ctrl: Control interface data from wpa_ctrl_open()
 297  * Returns: 0 on success, -1 on failure, -2 on timeout
 298  *
 299  * This function unregisters the control interface connection as a monitor for
 300  * wpa_supplicant/hostapd events, i.e., cancels the registration done with
 301  * wpa_ctrl_attach().
 302  */
 303 int wpa_ctrl_detach(struct wpa_ctrl *ctrl);
 304
 305
 306 /**
 307  * wpa_ctrl_recv - Receive a pending control interface message
 308  * @ctrl: Control interface data from wpa_ctrl_open()
 309  * @reply: Buffer for the message data
 310  * @reply_len: Length of the reply buffer
 311  * Returns: 0 on success, -1 on failure
 312  *
 313  * This function will receive a pending control interface message. This
 314  * function will block if no messages are available. The received response will
 315  * be written to reply and reply_len is set to the actual length of the reply.
 316  * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
 317  * must have been used to register the control interface as an event monitor.
 318  */
 319 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len);
 320
 321
 322 /**
 323  * wpa_ctrl_pending - Check whether there are pending event messages
 324  * @ctrl: Control interface data from wpa_ctrl_open()
 325  * Returns: 1 if there are pending messages, 0 if no, or -1 on error
 326  *
 327  * This function will check whether there are any pending control interface
 328  * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
 329  * only used for event messages, i.e., wpa_ctrl_attach() must have been used to
 330  * register the control interface as an event monitor.
 331  */
 332 int wpa_ctrl_pending(struct wpa_ctrl *ctrl);
 333
 334
 335 /**
 336  * wpa_ctrl_get_fd - Get file descriptor used by the control interface
 337  * @ctrl: Control interface data from wpa_ctrl_open()
 338  * Returns: File descriptor used for the connection
 339  *
 340  * This function can be used to get the file descriptor that is used for the
 341  * control interface connection. The returned value can be used, e.g., with
 342  * select() while waiting for multiple events.
 343  *
 344  * The returned file descriptor must not be used directly for sending or
 345  * receiving packets; instead, the library functions wpa_ctrl_request() and
 346  * wpa_ctrl_recv() must be used for this.
 347  */
 348 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);
 349
 350 char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl);
 351
 352 #ifdef ANDROID
 353 /**
 354  * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
 355  * may be left over from clients that were previously connected to
 356  * wpa_supplicant. This keeps these files from being orphaned in the
 357  * event of crashes that prevented them from being removed as part
 358  * of the normal orderly shutdown.
 359  */
 360 void wpa_ctrl_cleanup(void);
 361 #endif /* ANDROID */
 362
 363 #ifdef CONFIG_CTRL_IFACE_UDP
 364 /* Port range for multiple wpa_supplicant instances and multiple VIFs */
 365 #define WPA_CTRL_IFACE_PORT 9877
 366 #define WPA_CTRL_IFACE_PORT_LIMIT 50 /* decremented from start */
 367 #define WPA_GLOBAL_CTRL_IFACE_PORT 9878
 368 #define WPA_GLOBAL_CTRL_IFACE_PORT_LIMIT 20 /* incremented from start */
 369 #endif /* CONFIG_CTRL_IFACE_UDP */
 370
 371
 372 #ifdef  __cplusplus
 373 }
 374 #endif
 375
 376 #endif /* WPA_CTRL_H */