wpa_ctrl.h revision 1f69aa52ea2e0a73ac502565df8c666ee49cab6a
18d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* 28d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_supplicant/hostapd control interface library 38d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Copyright (c) 2004-2006, Jouni Malinen <j@w1.fi> 48d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 58d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This program is free software; you can redistribute it and/or modify 68d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * it under the terms of the GNU General Public License version 2 as 78d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * published by the Free Software Foundation. 88d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 98d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Alternatively, this software may be distributed under the terms of BSD 108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * license. 118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * See README and COPYING for more details. 138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#ifndef WPA_CTRL_H 168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_CTRL_H 178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#ifdef __cplusplus 198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtextern "C" { 208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#endif 218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* wpa_supplicant control interface - fixed message prefixes */ 238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** Interactive request for identity/password/pin */ 258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_CTRL_REQ "CTRL-REQ-" 268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** Response to identity/password/pin request */ 288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_CTRL_RSP "CTRL-RSP-" 298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* Event messages with fixed prefix */ 318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** Authentication completed successfully and data connection enabled */ 328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_CONNECTED "CTRL-EVENT-CONNECTED " 338d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** Disconnected, data connection is not available */ 348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_DISCONNECTED "CTRL-EVENT-DISCONNECTED " 358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** Association rejected during connection attempt */ 368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_ASSOC_REJECT "CTRL-EVENT-ASSOC-REJECT " 378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** wpa_supplicant is exiting */ 388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_TERMINATING "CTRL-EVENT-TERMINATING " 398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** Password change was completed successfully */ 408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_PASSWORD_CHANGED "CTRL-EVENT-PASSWORD-CHANGED " 418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** EAP-Request/Notification received */ 428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_EAP_NOTIFICATION "CTRL-EVENT-EAP-NOTIFICATION " 438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** EAP authentication started (EAP-Request/Identity received) */ 448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_EAP_STARTED "CTRL-EVENT-EAP-STARTED " 458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** EAP method proposed by the server */ 468d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_EAP_PROPOSED_METHOD "CTRL-EVENT-EAP-PROPOSED-METHOD " 478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** EAP method selected */ 488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_EAP_METHOD "CTRL-EVENT-EAP-METHOD " 498d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** EAP peer certificate from TLS */ 508d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_EAP_PEER_CERT "CTRL-EVENT-EAP-PEER-CERT " 518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** EAP TLS certificate chain validation error */ 528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_EAP_TLS_CERT_ERROR "CTRL-EVENT-EAP-TLS-CERT-ERROR " 538d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** EAP authentication completed successfully */ 548d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_EAP_SUCCESS "CTRL-EVENT-EAP-SUCCESS " 558d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** EAP authentication failed (EAP-Failure received) */ 568d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_EAP_FAILURE "CTRL-EVENT-EAP-FAILURE " 578d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** New scan results available */ 588d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_SCAN_RESULTS "CTRL-EVENT-SCAN-RESULTS " 598d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** wpa_supplicant state change */ 608d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_STATE_CHANGE "CTRL-EVENT-STATE-CHANGE " 618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** A new BSS entry was added (followed by BSS entry id and BSSID) */ 628d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_BSS_ADDED "CTRL-EVENT-BSS-ADDED " 638d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** A BSS entry was removed (followed by BSS entry id and BSSID) */ 648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_EVENT_BSS_REMOVED "CTRL-EVENT-BSS-REMOVED " 658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 668d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** WPS overlap detected in PBC mode */ 678d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_OVERLAP "WPS-OVERLAP-DETECTED " 688d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** Available WPS AP with active PBC found in scan results */ 698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_AP_AVAILABLE_PBC "WPS-AP-AVAILABLE-PBC " 708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** Available WPS AP with our address as authorized in scan results */ 718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_AP_AVAILABLE_AUTH "WPS-AP-AVAILABLE-AUTH " 728d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** Available WPS AP with recently selected PIN registrar found in scan results 738d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 748d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_AP_AVAILABLE_PIN "WPS-AP-AVAILABLE-PIN " 758d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** Available WPS AP found in scan results */ 768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_AP_AVAILABLE "WPS-AP-AVAILABLE " 778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** A new credential received */ 788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_CRED_RECEIVED "WPS-CRED-RECEIVED " 798d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** M2D received */ 808d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_M2D "WPS-M2D " 818d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** WPS registration failed after M2/M2D */ 828d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_FAIL "WPS-FAIL " 838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** WPS registration completed successfully */ 848d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_SUCCESS "WPS-SUCCESS " 858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** WPS enrollment attempt timed out and was terminated */ 868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_TIMEOUT "WPS-TIMEOUT " 878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_ENROLLEE_SEEN "WPS-ENROLLEE-SEEN " 898d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 908d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_OPEN_NETWORK "WPS-OPEN-NETWORK " 918d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 928d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* WPS ER events */ 938d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_ER_AP_ADD "WPS-ER-AP-ADD " 948d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_ER_AP_REMOVE "WPS-ER-AP-REMOVE " 958d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_ER_ENROLLEE_ADD "WPS-ER-ENROLLEE-ADD " 968d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_ER_ENROLLEE_REMOVE "WPS-ER-ENROLLEE-REMOVE " 978d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_ER_AP_SETTINGS "WPS-ER-AP-SETTINGS " 988d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_ER_SET_SEL_REG "WPS-ER-AP-SET-SEL-REG " 998d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1008d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** P2P device found */ 1018d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_DEVICE_FOUND "P2P-DEVICE-FOUND " 102497c1d5e50162d6b3c1cce5dbd9c5fd9da69aaefDmitry Shmidt 103497c1d5e50162d6b3c1cce5dbd9c5fd9da69aaefDmitry Shmidt/** P2P device lost */ 104497c1d5e50162d6b3c1cce5dbd9c5fd9da69aaefDmitry Shmidt#define P2P_EVENT_DEVICE_LOST "P2P-DEVICE-LOST " 105497c1d5e50162d6b3c1cce5dbd9c5fd9da69aaefDmitry Shmidt 1068d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** A P2P device requested GO negotiation, but we were not ready to start the 1078d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * negotiation */ 1088d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_GO_NEG_REQUEST "P2P-GO-NEG-REQUEST " 1098d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_GO_NEG_SUCCESS "P2P-GO-NEG-SUCCESS " 1108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_GO_NEG_FAILURE "P2P-GO-NEG-FAILURE " 1118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_GROUP_FORMATION_SUCCESS "P2P-GROUP-FORMATION-SUCCESS " 1128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_GROUP_FORMATION_FAILURE "P2P-GROUP-FORMATION-FAILURE " 1138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_GROUP_STARTED "P2P-GROUP-STARTED " 1148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_GROUP_REMOVED "P2P-GROUP-REMOVED " 1158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_CROSS_CONNECT_ENABLE "P2P-CROSS-CONNECT-ENABLE " 1168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_CROSS_CONNECT_DISABLE "P2P-CROSS-CONNECT-DISABLE " 1178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* parameters: <peer address> <PIN> */ 1188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_PROV_DISC_SHOW_PIN "P2P-PROV-DISC-SHOW-PIN " 1198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* parameters: <peer address> */ 1208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_PROV_DISC_ENTER_PIN "P2P-PROV-DISC-ENTER-PIN " 1218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* parameters: <peer address> */ 1228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_PROV_DISC_PBC_REQ "P2P-PROV-DISC-PBC-REQ " 1238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* parameters: <peer address> */ 1248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_PROV_DISC_PBC_RESP "P2P-PROV-DISC-PBC-RESP " 1258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* parameters: <freq> <src addr> <dialog token> <update indicator> <TLVs> */ 1268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_SERV_DISC_REQ "P2P-SERV-DISC-REQ " 1278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* parameters: <src addr> <update indicator> <TLVs> */ 1288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_SERV_DISC_RESP "P2P-SERV-DISC-RESP " 1298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_INVITATION_RECEIVED "P2P-INVITATION-RECEIVED " 1308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define P2P_EVENT_INVITATION_RESULT "P2P-INVITATION-RESULT " 1311f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt#define P2P_EVENT_FIND_STOPPED "P2P-FIND-STOPPED " 1321f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt 1331f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt#define INTERWORKING_AP "INTERWORKING-AP " 1341f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt#define INTERWORKING_NO_MATCH "INTERWORKING-NO-MATCH " 1358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* hostapd control interface - fixed message prefixes */ 1378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_PIN_NEEDED "WPS-PIN-NEEDED " 1388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_NEW_AP_SETTINGS "WPS-NEW-AP-SETTINGS " 1398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_REG_SUCCESS "WPS-REG-SUCCESS " 1408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_AP_SETUP_LOCKED "WPS-AP-SETUP-LOCKED " 1418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_AP_SETUP_UNLOCKED "WPS-AP-SETUP-UNLOCKED " 1428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_AP_PIN_ENABLED "WPS-AP-PIN-ENABLED " 1438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_EVENT_AP_PIN_DISABLED "WPS-AP-PIN-DISABLED " 1448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define AP_STA_CONNECTED "AP-STA-CONNECTED " 1458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define AP_STA_DISCONNECTED "AP-STA-DISCONNECTED " 1468d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* wpa_supplicant/hostapd control interface access */ 1498d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1508d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 1518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_ctrl_open - Open a control interface to wpa_supplicant/hostapd 1528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctrl_path: Path for UNIX domain sockets; ignored if UDP sockets are used. 1538d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Pointer to abstract control interface data or %NULL on failure 1548d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1558d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This function is used to open a control interface to wpa_supplicant/hostapd. 1568d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * ctrl_path is usually /var/run/wpa_supplicant or /var/run/hostapd. This path 1578d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * is configured in wpa_supplicant/hostapd and other programs using the control 1588d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * interface need to use matching path configuration. 1598d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1608d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path); 1618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1628d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1638d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 1648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_ctrl_close - Close a control interface to wpa_supplicant/hostapd 1658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctrl: Control interface data from wpa_ctrl_open() 1668d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1678d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This function is used to close a control interface. 1688d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid wpa_ctrl_close(struct wpa_ctrl *ctrl); 1708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1728d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 1738d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_ctrl_request - Send a command to wpa_supplicant/hostapd 1748d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctrl: Control interface data from wpa_ctrl_open() 1758d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @cmd: Command; usually, ASCII text, e.g., "PING" 1768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @cmd_len: Length of the cmd in bytes 1778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @reply: Buffer for the response 1788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @reply_len: Reply buffer length 1798d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @msg_cb: Callback function for unsolicited messages or %NULL if not used 1808d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on error (send or receive failed), -2 on timeout 1818d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1828d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This function is used to send commands to wpa_supplicant/hostapd. Received 1838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * response will be written to reply and reply_len is set to the actual length 1848d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * of the reply. This function will block for up to two seconds while waiting 1858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * for the reply. If unsolicited messages are received, the blocking time may 1868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * be longer. 1878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * msg_cb can be used to register a callback function that will be called for 1898d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * unsolicited messages received while waiting for the command response. These 1908d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * messages may be received if wpa_ctrl_request() is called at the same time as 1918d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_supplicant/hostapd is sending such a message. This can happen only if 1928d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * the program has used wpa_ctrl_attach() to register itself as a monitor for 1938d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * event messages. Alternatively to msg_cb, programs can register two control 1948d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * interface connections and use one of them for commands and the other one for 1958d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * receiving event messages, in other words, call wpa_ctrl_attach() only for 1968d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * the control interface connection that will be used for event messages. 1978d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1988d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len, 1998d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt char *reply, size_t *reply_len, 2008d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt void (*msg_cb)(char *msg, size_t len)); 2018d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2028d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2038d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2048d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_ctrl_attach - Register as an event monitor for the control interface 2058d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctrl: Control interface data from wpa_ctrl_open() 2068d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on failure, -2 on timeout 2078d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 2088d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This function registers the control interface connection as a monitor for 2098d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_supplicant/hostapd events. After a success wpa_ctrl_attach() call, the 2108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * control interface connection starts receiving event messages that can be 2118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * read with wpa_ctrl_recv(). 2128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint wpa_ctrl_attach(struct wpa_ctrl *ctrl); 2148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_ctrl_detach - Unregister event monitor from the control interface 2188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctrl: Control interface data from wpa_ctrl_open() 2198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on failure, -2 on timeout 2208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 2218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This function unregisters the control interface connection as a monitor for 2228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_supplicant/hostapd events, i.e., cancels the registration done with 2238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_ctrl_attach(). 2248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint wpa_ctrl_detach(struct wpa_ctrl *ctrl); 2268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_ctrl_recv - Receive a pending control interface message 2308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctrl: Control interface data from wpa_ctrl_open() 2318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @reply: Buffer for the message data 2328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @reply_len: Length of the reply buffer 2338d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 0 on success, -1 on failure 2348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 2358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This function will receive a pending control interface message. This 2368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * function will block if no messages are available. The received response will 2378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * be written to reply and reply_len is set to the actual length of the reply. 2388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_ctrl_recv() is only used for event messages, i.e., wpa_ctrl_attach() 2398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * must have been used to register the control interface as an event monitor. 2408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len); 2428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_ctrl_pending - Check whether there are pending event messages 2468d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctrl: Control interface data from wpa_ctrl_open() 2478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: 1 if there are pending messages, 0 if no, or -1 on error 2488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 2498d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This function will check whether there are any pending control interface 2508d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * message available to be received with wpa_ctrl_recv(). wpa_ctrl_pending() is 2518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * only used for event messages, i.e., wpa_ctrl_attach() must have been used to 2528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * register the control interface as an event monitor. 2538d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2548d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint wpa_ctrl_pending(struct wpa_ctrl *ctrl); 2558d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2568d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2578d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2588d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_ctrl_get_fd - Get file descriptor used by the control interface 2598d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctrl: Control interface data from wpa_ctrl_open() 2608d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: File descriptor used for the connection 2618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 2628d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This function can be used to get the file descriptor that is used for the 2638d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * control interface connection. The returned value can be used, e.g., with 2648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * select() while waiting for multiple events. 2658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 2668d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * The returned file descriptor must not be used directly for sending or 2678d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * receiving packets; instead, the library functions wpa_ctrl_request() and 2688d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wpa_ctrl_recv() must be used for this. 2698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint wpa_ctrl_get_fd(struct wpa_ctrl *ctrl); 2718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2721f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt#ifdef ANDROID 2731f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt/** 2741f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that 2751f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt * may be left over from clients that were previously connected to 2761f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt * wpa_supplicant. This keeps these files from being orphaned in the 2771f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt * event of crashes that prevented them from being removed as part 2781f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt * of the normal orderly shutdown. 2791f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt */ 2801f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidtvoid wpa_ctrl_cleanup(void); 2811f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt#endif /* ANDROID */ 2821f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt 2838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#ifdef CONFIG_CTRL_IFACE_UDP 2848d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_CTRL_IFACE_PORT 9877 2858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPA_GLOBAL_CTRL_IFACE_PORT 9878 2868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#endif /* CONFIG_CTRL_IFACE_UDP */ 2878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2898d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#ifdef __cplusplus 2908d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt} 2918d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#endif 2928d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2938d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#endif /* WPA_CTRL_H */ 294