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