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 authentication completed successfully */
  48 #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS "
  49 /** EAP authentication failed (EAP-Failure received) */
  50 #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE "
  51 /** New scan results available */
  52 #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS "
  53 /** wpa_supplicant state change */
  54 #define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE "
  55 /** A new BSS entry was added (followed by BSS entry id and BSSID) */
  56 #define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED "
  57 /** A BSS entry was removed (followed by BSS entry id and BSSID) */
  58 #define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED "
  59
  60 /** WPS overlap detected in PBC mode */
  61 #define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED "
  62 /** Available WPS AP with active PBC found in scan results */
  63 #define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC "
  64 /** Available WPS AP with our address as authorized in scan results */
  65 #define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH "
  66 /** Available WPS AP with recently selected PIN registrar found in scan results
  67  */
  68 #define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN "
  69 /** Available WPS AP found in scan results */
  70 #define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE "
  71 /** A new credential received */
  72 #define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED "
  73 /** M2D received */
  74 #define WPS_EVENT_M2D "WPS-M2D "
  75 /** WPS registration failed after M2/M2D */
  76 #define WPS_EVENT_FAIL "WPS-FAIL "
  77 /** WPS registration completed successfully */
  78 #define WPS_EVENT_SUCCESS "WPS-SUCCESS "
  79 /** WPS enrollment attempt timed out and was terminated */
  80 #define WPS_EVENT_TIMEOUT "WPS-TIMEOUT "
  81
  82 #define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN "
  83
  84 #define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK "
  85
  86 /* WPS ER events */
  87 #define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD "
  88 #define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE "
  89 #define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD "
  90 #define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE "
  91 #define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS "
  92 #define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG "
  93
  94 /** P2P device found */
  95 #define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND "
  96
  97 /** P2P device lost */
  98 #define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST "
  99
 100 /** A P2P device requested GO negotiation, but we were not ready to start the
 101  * negotiation */
 102 #define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST "
 103 #define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS "
 104 #define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE "
 105 #define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS "
 106 #define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE "
 107 #define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED "
 108 #define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED "
 109 #define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE "
 110 #define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE "
 111 /* parameters: <peer address> <PIN> */
 112 #define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN "
 113 /* parameters: <peer address> */
 114 #define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN "
 115 /* parameters: <peer address> */
 116 #define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ "
 117 /* parameters: <peer address> */
 118 #define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP "
 119 /* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */
 120 #define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ "
 121 /* parameters: <src addr> <update indicator> <TLVs> */
 122 #define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP "
 123 #define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED "
 124 #define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT "
 125 #define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED "
 126
 127 #define INTERWORKING_AP "INTERWORKING-AP "
 128 #define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH "
 129
 130 /* hostapd control interface - fixed message prefixes */
 131 #define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED "
 132 #define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS "
 133 #define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS "
 134 #define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED "
 135 #define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED "
 136 #define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED "
 137 #define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED "
 138 #define AP_STA_CONNECTED "AP-STA-CONNECTED "
 139 #define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED "
 140
 141
 142 /* wpa_supplicant/hostapd control interface access */
 143
 144 /**
 145  * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
 146  * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
 147  * Returns: Pointer to abstract control interface data or %NULL on failure
 148  *
 149  * This function is used to open a control interface to wpa_supplicant/hostapd.
 150  * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
 151  * is configured in wpa_supplicant/hostapd and other programs using the control
 152  * interface need to use matching path configuration.
 153  */
 154 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);
 155
 156
 157 /**
 158  * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
 159  * @ctrl: Control interface data from wpa_ctrl_open()
 160  *
 161  * This function is used to close a control interface.
 162  */
 163 void wpa_ctrl_close(struct wpa_ctrl *ctrl);
 164
 165
 166 /**
 167  * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
 168  * @ctrl: Control interface data from wpa_ctrl_open()
 169  * @cmd: Command; usually, ASCII text, e.g., "PING"
 170  * @cmd_len: Length of the cmd in bytes
 171  * @reply: Buffer for the response
 172  * @reply_len: Reply buffer length
 173  * @msg_cb: Callback function for unsolicited messages or %NULL if not used
 174  * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
 175  *
 176  * This function is used to send commands to wpa_supplicant/hostapd. Received
 177  * response will be written to reply and reply_len is set to the actual length
 178  * of the reply. This function will block for up to two seconds while waiting
 179  * for the reply. If unsolicited messages are received, the blocking time may
 180  * be longer.
 181  *
 182  * msg_cb can be used to register a callback function that will be called for
 183  * unsolicited messages received while waiting for the command response. These
 184  * messages may be received if wpa_ctrl_request() is called at the same time as
 185  * wpa_supplicant/hostapd is sending such a message. This can happen only if
 186  * the program has used wpa_ctrl_attach() to register itself as a monitor for
 187  * event messages. Alternatively to msg_cb, programs can register two control
 188  * interface connections and use one of them for commands and the other one for
 189  * receiving event messages, in other words, call wpa_ctrl_attach() only for
 190  * the control interface connection that will be used for event messages.
 191  */
 192 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
 193                      char *reply, size_t *reply_len,
 194                      void (*msg_cb)(char *msg, size_t len));
 195
 196
 197 /**
 198  * wpa_ctrl_attach - Register as an event monitor for the control interface
 199  * @ctrl: Control interface data from wpa_ctrl_open()
 200  * Returns: 0 on success, -1 on failure, -2 on timeout
 201  *
 202  * This function registers the control interface connection as a monitor for
 203  * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
 204  * control interface connection starts receiving event messages that can be
 205  * read with wpa_ctrl_recv().
 206  */
 207 int wpa_ctrl_attach(struct wpa_ctrl *ctrl);
 208
 209
 210 /**
 211  * wpa_ctrl_detach - Unregister event monitor from the control interface
 212  * @ctrl: Control interface data from wpa_ctrl_open()
 213  * Returns: 0 on success, -1 on failure, -2 on timeout
 214  *
 215  * This function unregisters the control interface connection as a monitor for
 216  * wpa_supplicant/hostapd events, i.e., cancels the registration done with
 217  * wpa_ctrl_attach().
 218  */
 219 int wpa_ctrl_detach(struct wpa_ctrl *ctrl);
 220
 221
 222 /**
 223  * wpa_ctrl_recv - Receive a pending control interface message
 224  * @ctrl: Control interface data from wpa_ctrl_open()
 225  * @reply: Buffer for the message data
 226  * @reply_len: Length of the reply buffer
 227  * Returns: 0 on success, -1 on failure
 228  *
 229  * This function will receive a pending control interface message. This
 230  * function will block if no messages are available. The received response will
 231  * be written to reply and reply_len is set to the actual length of the reply.
 232  * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
 233  * must have been used to register the control interface as an event monitor.
 234  */
 235 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len);
 236
 237
 238 /**
 239  * wpa_ctrl_pending - Check whether there are pending event messages
 240  * @ctrl: Control interface data from wpa_ctrl_open()
 241  * Returns: 1 if there are pending messages, 0 if no, or -1 on error
 242  *
 243  * This function will check whether there are any pending control interface
 244  * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
 245  * only used for event messages, i.e., wpa_ctrl_attach() must have been used to
 246  * register the control interface as an event monitor.
 247  */
 248 int wpa_ctrl_pending(struct wpa_ctrl *ctrl);
 249
 250
 251 /**
 252  * wpa_ctrl_get_fd - Get file descriptor used by the control interface
 253  * @ctrl: Control interface data from wpa_ctrl_open()
 254  * Returns: File descriptor used for the connection
 255  *
 256  * This function can be used to get the file descriptor that is used for the
 257  * control interface connection. The returned value can be used, e.g., with
 258  * select() while waiting for multiple events.
 259  *
 260  * The returned file descriptor must not be used directly for sending or
 261  * receiving packets; instead, the library functions wpa_ctrl_request() and
 262  * wpa_ctrl_recv() must be used for this.
 263  */
 264 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);
 265
 266 #ifdef ANDROID
 267 /**
 268  * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
 269  * may be left over from clients that were previously connected to
 270  * wpa_supplicant. This keeps these files from being orphaned in the
 271  * event of crashes that prevented them from being removed as part
 272  * of the normal orderly shutdown.
 273  */
 274 void wpa_ctrl_cleanup(void);
 275 #endif /* ANDROID */
 276
 277 #ifdef CONFIG_CTRL_IFACE_UDP
 278 #define WPA_CTRL_IFACE_PORT 9877
 279 #define WPA_GLOBAL_CTRL_IFACE_PORT 9878
 280 #endif /* CONFIG_CTRL_IFACE_UDP */
 281
 282
 283 #ifdef  __cplusplus
 284 }
 285 #endif
 286
 287 #endif /* WPA_CTRL_H */