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 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
  15 #ifndef WPA_CTRL_H
  16 #define WPA_CTRL_H
  17
  18 #ifdef  __cplusplus
  19 extern "C" {
  20 #endif
  21
  22 /* wpa_supplicant control interface - fixed message prefixes */
  23
  24 /** Interactive request for identity/password/pin */
  25 #define WPA_CTRL_REQ "CTRL-REQ-"
  26
  27 /** Response to identity/password/pin request */
  28 #define WPA_CTRL_RSP "CTRL-RSP-"
  29
  30 /* Event messages with fixed prefix */
  31 /** Authentication completed successfully and data connection enabled */
  32 #define WPA_EVENT_CONNECTED "CTRL-EVENT-CONNECTED "
  33 /** Disconnected, data connection is not available */
  34 #define WPA_EVENT_DISCONNECTED "CTRL-EVENT-DISCONNECTED "
  35 /** wpa_supplicant is exiting */
  36 #define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING "
  37 /** Password change was completed successfully */
  38 #define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED "
  39 /** EAP-Request/Notification received */
  40 #define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION "
  41 /** EAP authentication started (EAP-Request/Identity received) */
  42 #define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED "
  43 /** EAP method selected */
  44 #define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD "
  45 /** EAP authentication completed successfully */
  46 #define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS "
  47 /** EAP authentication failed (EAP-Failure received) */
  48 #define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE "
  49 /** New scan results available */
  50 #define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS "
  51 /** A BSS entry was added (followed by BSS entry id and BSSID) */
  52 #define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED "
  53 /** A BSS entry was added (followed by BSS entry id and BSSID) */
  54 #define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED "
  55
  56 /** WPS overlap detected in PBC mode */
  57 #define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED "
  58 /** Available WPS AP with active PBC found in scan results */
  59 #define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC "
  60 /** Available WPS AP with recently selected PIN registrar found in scan results
  61  */
  62 #define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN "
  63 /** Available WPS AP found in scan results */
  64 #define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE "
  65 /** A new credential received */
  66 #define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED "
  67 /** M2D received */
  68 #define WPS_EVENT_M2D "WPS-M2D "
  69 /** WPS registration failed after M2/M2D */
  70 #define WPS_EVENT_FAIL "WPS-FAIL "
  71 /** WPS registration completed successfully */
  72 #define WPS_EVENT_SUCCESS "WPS-SUCCESS "
  73 /** WPS enrollment attempt timed out and was terminated */
  74 #define WPS_EVENT_TIMEOUT "WPS-TIMEOUT "
  75
  76 #define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN "
  77
  78 /* WPS ER events */
  79 #define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD "
  80 #define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE "
  81 #define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD "
  82 #define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE "
  83
  84 /* hostapd control interface - fixed message prefixes */
  85 #define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED "
  86 #define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS "
  87 #define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS "
  88 #define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED "
  89 #define AP_STA_CONNECTED "AP-STA-CONNECTED "
  90 #define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED "
  91
  92
  93 /* wpa_supplicant/hostapd control interface access */
  94
  95 /**
  96  * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd
  97  * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used.
  98  * Returns: Pointer to abstract control interface data or %NULL on failure
  99  *
 100  * This function is used to open a control interface to wpa_supplicant/hostapd.
 101  * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path
 102  * is configured in wpa_supplicant/hostapd and other programs using the control
 103  * interface need to use matching path configuration.
 104  */
 105 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path);
 106
 107
 108 /**
 109  * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd
 110  * @ctrl: Control interface data from wpa_ctrl_open()
 111  *
 112  * This function is used to close a control interface.
 113  */
 114 void wpa_ctrl_close(struct wpa_ctrl *ctrl);
 115
 116
 117 /**
 118  * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd
 119  * @ctrl: Control interface data from wpa_ctrl_open()
 120  * @cmd: Command; usually, ASCII text, e.g., "PING"
 121  * @cmd_len: Length of the cmd in bytes
 122  * @reply: Buffer for the response
 123  * @reply_len: Reply buffer length
 124  * @msg_cb: Callback function for unsolicited messages or %NULL if not used
 125  * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout
 126  *
 127  * This function is used to send commands to wpa_supplicant/hostapd. Received
 128  * response will be written to reply and reply_len is set to the actual length
 129  * of the reply. This function will block for up to two seconds while waiting
 130  * for the reply. If unsolicited messages are received, the blocking time may
 131  * be longer.
 132  *
 133  * msg_cb can be used to register a callback function that will be called for
 134  * unsolicited messages received while waiting for the command response. These
 135  * messages may be received if wpa_ctrl_request() is called at the same time as
 136  * wpa_supplicant/hostapd is sending such a message. This can happen only if
 137  * the program has used wpa_ctrl_attach() to register itself as a monitor for
 138  * event messages. Alternatively to msg_cb, programs can register two control
 139  * interface connections and use one of them for commands and the other one for
 140  * receiving event messages, in other words, call wpa_ctrl_attach() only for
 141  * the control interface connection that will be used for event messages.
 142  */
 143 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
 144                      char *reply, size_t *reply_len,
 145                      void (*msg_cb)(char *msg, size_t len));
 146
 147
 148 /**
 149  * wpa_ctrl_attach - Register as an event monitor for the control interface
 150  * @ctrl: Control interface data from wpa_ctrl_open()
 151  * Returns: 0 on success, -1 on failure, -2 on timeout
 152  *
 153  * This function registers the control interface connection as a monitor for
 154  * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the
 155  * control interface connection starts receiving event messages that can be
 156  * read with wpa_ctrl_recv().
 157  */
 158 int wpa_ctrl_attach(struct wpa_ctrl *ctrl);
 159
 160
 161 /**
 162  * wpa_ctrl_detach - Unregister event monitor from the control interface
 163  * @ctrl: Control interface data from wpa_ctrl_open()
 164  * Returns: 0 on success, -1 on failure, -2 on timeout
 165  *
 166  * This function unregisters the control interface connection as a monitor for
 167  * wpa_supplicant/hostapd events, i.e., cancels the registration done with
 168  * wpa_ctrl_attach().
 169  */
 170 int wpa_ctrl_detach(struct wpa_ctrl *ctrl);
 171
 172
 173 /**
 174  * wpa_ctrl_recv - Receive a pending control interface message
 175  * @ctrl: Control interface data from wpa_ctrl_open()
 176  * @reply: Buffer for the message data
 177  * @reply_len: Length of the reply buffer
 178  * Returns: 0 on success, -1 on failure
 179  *
 180  * This function will receive a pending control interface message. This
 181  * function will block if no messages are available. The received response will
 182  * be written to reply and reply_len is set to the actual length of the reply.
 183  * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach()
 184  * must have been used to register the control interface as an event monitor.
 185  */
 186 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len);
 187
 188
 189 /**
 190  * wpa_ctrl_pending - Check whether there are pending event messages
 191  * @ctrl: Control interface data from wpa_ctrl_open()
 192  * Returns: 1 if there are pending messages, 0 if no, or -1 on error
 193  *
 194  * This function will check whether there are any pending control interface
 195  * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is
 196  * only used for event messages, i.e., wpa_ctrl_attach() must have been used to
 197  * register the control interface as an event monitor.
 198  */
 199 int wpa_ctrl_pending(struct wpa_ctrl *ctrl);
 200
 201
 202 /**
 203  * wpa_ctrl_get_fd - Get file descriptor used by the control interface
 204  * @ctrl: Control interface data from wpa_ctrl_open()
 205  * Returns: File descriptor used for the connection
 206  *
 207  * This function can be used to get the file descriptor that is used for the
 208  * control interface connection. The returned value can be used, e.g., with
 209  * select() while waiting for multiple events.
 210  *
 211  * The returned file descriptor must not be used directly for sending or
 212  * receiving packets; instead, the library functions wpa_ctrl_request() and
 213  * wpa_ctrl_recv() must be used for this.
 214  */
 215 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl);
 216
 217 #ifdef CONFIG_CTRL_IFACE_UDP
 218 #define WPA_CTRL_IFACE_PORT 9877
 219 #define WPA_GLOBAL_CTRL_IFACE_PORT 9878
 220 #endif /* CONFIG_CTRL_IFACE_UDP */
 221
 222
 223 #ifdef  __cplusplus
 224 }
 225 #endif
 226
 227 #endif /* WPA_CTRL_H */