2 * wpa_supplicant/hostapd control interface library
3 * Copyright (c) 2004-2007, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
11 #ifdef CONFIG_CTRL_IFACE
13 #ifdef CONFIG_CTRL_IFACE_UNIX
17 #endif /* CONFIG_CTRL_IFACE_UNIX */
18 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
20 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
24 #include <cutils/sockets.h>
25 #include "private/android_filesystem_config.h"
28 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
30 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
36 #if defined(CONFIG_CTRL_IFACE_UNIX) || defined(CONFIG_CTRL_IFACE_UDP)
37 #define CTRL_IFACE_SOCKET
38 #endif /* CONFIG_CTRL_IFACE_UNIX || CONFIG_CTRL_IFACE_UDP */
42 * struct wpa_ctrl - Internal structure for control interface library
44 * This structure is used by the wpa_supplicant/hostapd control interface
45 * library to store internal data. Programs using the library should not touch
46 * this data directly. They can only use the pointer to the data structure as
47 * an identifier for the control interface connection and use this as one of
48 * the arguments for most of the control interface library functions.
51 #ifdef CONFIG_CTRL_IFACE_UDP
53 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
54 struct sockaddr_in6 local;
55 struct sockaddr_in6 dest;
56 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
57 struct sockaddr_in local;
58 struct sockaddr_in dest;
59 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
63 #endif /* CONFIG_CTRL_IFACE_UDP */
64 #ifdef CONFIG_CTRL_IFACE_UNIX
66 struct sockaddr_un local;
67 struct sockaddr_un dest;
68 #endif /* CONFIG_CTRL_IFACE_UNIX */
69 #ifdef CONFIG_CTRL_IFACE_NAMED_PIPE
71 #endif /* CONFIG_CTRL_IFACE_NAMED_PIPE */
75 #ifdef CONFIG_CTRL_IFACE_UNIX
77 #ifndef CONFIG_CTRL_IFACE_CLIENT_DIR
78 #define CONFIG_CTRL_IFACE_CLIENT_DIR "/tmp"
79 #endif /* CONFIG_CTRL_IFACE_CLIENT_DIR */
80 #ifndef CONFIG_CTRL_IFACE_CLIENT_PREFIX
81 #define CONFIG_CTRL_IFACE_CLIENT_PREFIX "wpa_ctrl_"
82 #endif /* CONFIG_CTRL_IFACE_CLIENT_PREFIX */
85 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
87 struct wpa_ctrl *ctrl;
88 static int counter = 0;
94 if (ctrl_path == NULL)
97 ctrl = os_zalloc(sizeof(*ctrl));
101 ctrl->s = socket(PF_UNIX, SOCK_DGRAM, 0);
107 ctrl->local.sun_family = AF_UNIX;
110 ret = os_snprintf(ctrl->local.sun_path, sizeof(ctrl->local.sun_path),
111 CONFIG_CTRL_IFACE_CLIENT_DIR "/"
112 CONFIG_CTRL_IFACE_CLIENT_PREFIX "%d-%d",
113 (int) getpid(), counter);
114 if (os_snprintf_error(sizeof(ctrl->local.sun_path), ret)) {
120 if (bind(ctrl->s, (struct sockaddr *) &ctrl->local,
121 sizeof(ctrl->local)) < 0) {
122 if (errno == EADDRINUSE && tries < 2) {
124 * getpid() returns unique identifier for this instance
125 * of wpa_ctrl, so the existing socket file must have
126 * been left by unclean termination of an earlier run.
127 * Remove the file and try again.
129 unlink(ctrl->local.sun_path);
138 chmod(ctrl->local.sun_path, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
139 chown(ctrl->local.sun_path, AID_SYSTEM, AID_WIFI);
141 if (os_strncmp(ctrl_path, "@android:", 9) == 0) {
142 if (socket_local_client_connect(
143 ctrl->s, ctrl_path + 9,
144 ANDROID_SOCKET_NAMESPACE_RESERVED,
147 unlink(ctrl->local.sun_path);
155 * If the ctrl_path isn't an absolute pathname, assume that
156 * it's the name of a socket in the Android reserved namespace.
157 * Otherwise, it's a normal UNIX domain socket appearing in the
160 if (*ctrl_path != '/') {
162 os_snprintf(buf, sizeof(buf), "wpa_%s", ctrl_path);
163 if (socket_local_client_connect(
165 ANDROID_SOCKET_NAMESPACE_RESERVED,
168 unlink(ctrl->local.sun_path);
176 ctrl->dest.sun_family = AF_UNIX;
177 if (os_strncmp(ctrl_path, "@abstract:", 10) == 0) {
178 ctrl->dest.sun_path[0] = '\0';
179 os_strlcpy(ctrl->dest.sun_path + 1, ctrl_path + 10,
180 sizeof(ctrl->dest.sun_path) - 1);
182 res = os_strlcpy(ctrl->dest.sun_path, ctrl_path,
183 sizeof(ctrl->dest.sun_path));
184 if (res >= sizeof(ctrl->dest.sun_path)) {
190 if (connect(ctrl->s, (struct sockaddr *) &ctrl->dest,
191 sizeof(ctrl->dest)) < 0) {
193 unlink(ctrl->local.sun_path);
199 * Make socket non-blocking so that we don't hang forever if
200 * target dies unexpectedly.
202 flags = fcntl(ctrl->s, F_GETFL);
205 if (fcntl(ctrl->s, F_SETFL, flags) < 0) {
206 perror("fcntl(ctrl->s, O_NONBLOCK)");
207 /* Not fatal, continue on.*/
215 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
219 unlink(ctrl->local.sun_path);
228 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
229 * may be left over from clients that were previously connected to
230 * wpa_supplicant. This keeps these files from being orphaned in the
231 * event of crashes that prevented them from being removed as part
232 * of the normal orderly shutdown.
234 void wpa_ctrl_cleanup(void)
238 struct dirent *result;
241 char pathname[PATH_MAX];
244 if ((dir = opendir(CONFIG_CTRL_IFACE_CLIENT_DIR)) == NULL)
247 dirnamelen = (size_t) os_snprintf(pathname, sizeof(pathname), "%s/",
248 CONFIG_CTRL_IFACE_CLIENT_DIR);
249 if (dirnamelen >= sizeof(pathname)) {
253 namep = pathname + dirnamelen;
254 maxcopy = PATH_MAX - dirnamelen;
255 while (readdir_r(dir, &entry, &result) == 0 && result != NULL) {
256 if (os_strlcpy(namep, entry.d_name, maxcopy) < maxcopy)
263 #else /* CONFIG_CTRL_IFACE_UNIX */
266 void wpa_ctrl_cleanup(void)
271 #endif /* CONFIG_CTRL_IFACE_UNIX */
274 #ifdef CONFIG_CTRL_IFACE_UDP
276 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
278 struct wpa_ctrl *ctrl;
281 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
283 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
285 ctrl = os_zalloc(sizeof(*ctrl));
289 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
290 ctrl->s = socket(PF_INET6, SOCK_DGRAM, 0);
291 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
292 ctrl->s = socket(PF_INET, SOCK_DGRAM, 0);
293 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
300 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
301 ctrl->local.sin6_family = AF_INET6;
302 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
303 ctrl->local.sin6_addr = in6addr_any;
304 #else /* CONFIG_CTRL_IFACE_UDP_REMOTE */
305 inet_pton(AF_INET6, "::1", &ctrl->local.sin6_addr);
306 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
307 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
308 ctrl->local.sin_family = AF_INET;
309 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
310 ctrl->local.sin_addr.s_addr = INADDR_ANY;
311 #else /* CONFIG_CTRL_IFACE_UDP_REMOTE */
312 ctrl->local.sin_addr.s_addr = htonl((127 << 24) | 1);
313 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
314 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
316 if (bind(ctrl->s, (struct sockaddr *) &ctrl->local,
317 sizeof(ctrl->local)) < 0) {
323 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
324 ctrl->dest.sin6_family = AF_INET6;
325 inet_pton(AF_INET6, "::1", &ctrl->dest.sin6_addr);
326 ctrl->dest.sin6_port = htons(WPA_CTRL_IFACE_PORT);
327 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
328 ctrl->dest.sin_family = AF_INET;
329 ctrl->dest.sin_addr.s_addr = htonl((127 << 24) | 1);
330 ctrl->dest.sin_port = htons(WPA_CTRL_IFACE_PORT);
331 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
333 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
337 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
340 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
342 name = os_strdup(ctrl_path);
348 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
349 port = os_strchr(name, ',');
350 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
351 port = os_strchr(name, ':');
352 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
355 port_id = atoi(&port[1]);
358 port_id = WPA_CTRL_IFACE_PORT;
360 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
361 scope = os_strchr(name, '%');
363 scope_id = if_nametoindex(&scope[1]);
366 h = gethostbyname2(name, AF_INET6);
367 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
368 h = gethostbyname(name);
369 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
370 ctrl->remote_ip = os_strdup(name);
373 perror("gethostbyname");
375 os_free(ctrl->remote_ip);
379 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
380 ctrl->dest.sin6_scope_id = scope_id;
381 ctrl->dest.sin6_port = htons(port_id);
382 os_memcpy(&ctrl->dest.sin6_addr, h->h_addr, h->h_length);
383 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
384 ctrl->dest.sin_port = htons(port_id);
385 os_memcpy(&ctrl->dest.sin_addr.s_addr, h->h_addr, h->h_length);
386 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
388 ctrl->remote_ip = os_strdup("localhost");
389 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
391 if (connect(ctrl->s, (struct sockaddr *) &ctrl->dest,
392 sizeof(ctrl->dest)) < 0) {
393 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
394 char addr[INET6_ADDRSTRLEN];
395 wpa_printf(MSG_ERROR, "connect(%s:%d) failed: %s",
396 inet_ntop(AF_INET6, &ctrl->dest.sin6_addr, addr,
398 ntohs(ctrl->dest.sin6_port),
400 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
401 wpa_printf(MSG_ERROR, "connect(%s:%d) failed: %s",
402 inet_ntoa(ctrl->dest.sin_addr),
403 ntohs(ctrl->dest.sin_port),
405 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
407 os_free(ctrl->remote_ip);
412 len = sizeof(buf) - 1;
413 if (wpa_ctrl_request(ctrl, "GET_COOKIE", 10, buf, &len, NULL) == 0) {
415 ctrl->cookie = os_strdup(buf);
418 if (wpa_ctrl_request(ctrl, "IFNAME", 6, buf, &len, NULL) == 0) {
420 ctrl->remote_ifname = os_strdup(buf);
427 char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl)
429 #define WPA_CTRL_MAX_PS_NAME 100
430 static char ps[WPA_CTRL_MAX_PS_NAME] = {};
431 os_snprintf(ps, WPA_CTRL_MAX_PS_NAME, "%s/%s",
432 ctrl->remote_ip, ctrl->remote_ifname);
437 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
440 os_free(ctrl->cookie);
441 os_free(ctrl->remote_ifname);
442 os_free(ctrl->remote_ip);
446 #endif /* CONFIG_CTRL_IFACE_UDP */
449 #ifdef CTRL_IFACE_SOCKET
450 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
451 char *reply, size_t *reply_len,
452 void (*msg_cb)(char *msg, size_t len))
455 struct os_reltime started_at;
459 char *cmd_buf = NULL;
462 #ifdef CONFIG_CTRL_IFACE_UDP
465 _cmd_len = os_strlen(ctrl->cookie) + 1 + cmd_len;
466 cmd_buf = os_malloc(_cmd_len);
471 os_strlcpy(pos, ctrl->cookie, _cmd_len);
472 pos += os_strlen(ctrl->cookie);
474 os_memcpy(pos, cmd, cmd_len);
476 #endif /* CONFIG_CTRL_IFACE_UDP */
486 if (send(ctrl->s, _cmd, _cmd_len, 0) < 0) {
487 if (errno == EAGAIN || errno == EBUSY || errno == EWOULDBLOCK)
490 * Must be a non-blocking socket... Try for a bit
491 * longer before giving up.
493 if (started_at.sec == 0)
494 os_get_reltime(&started_at);
498 /* Try for a few seconds. */
499 if (os_reltime_expired(&n, &started_at, 5))
515 FD_SET(ctrl->s, &rfds);
516 res = select(ctrl->s + 1, &rfds, NULL, NULL, &tv);
519 if (FD_ISSET(ctrl->s, &rfds)) {
520 res = recv(ctrl->s, reply, *reply_len, 0);
523 if (res > 0 && reply[0] == '<') {
524 /* This is an unsolicited message from
525 * wpa_supplicant, not the reply to the
526 * request. Use msg_cb to report this to the
529 /* Make sure the message is nul
531 if ((size_t) res == *reply_len)
532 res = (*reply_len) - 1;
546 #endif /* CTRL_IFACE_SOCKET */
549 static int wpa_ctrl_attach_helper(struct wpa_ctrl *ctrl, int attach)
555 ret = wpa_ctrl_request(ctrl, attach ? "ATTACH" : "DETACH", 6,
559 if (len == 3 && os_memcmp(buf, "OK\n", 3) == 0)
565 int wpa_ctrl_attach(struct wpa_ctrl *ctrl)
567 return wpa_ctrl_attach_helper(ctrl, 1);
571 int wpa_ctrl_detach(struct wpa_ctrl *ctrl)
573 return wpa_ctrl_attach_helper(ctrl, 0);
577 #ifdef CTRL_IFACE_SOCKET
579 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len)
583 res = recv(ctrl->s, reply, *reply_len, 0);
591 int wpa_ctrl_pending(struct wpa_ctrl *ctrl)
598 FD_SET(ctrl->s, &rfds);
599 select(ctrl->s + 1, &rfds, NULL, NULL, &tv);
600 return FD_ISSET(ctrl->s, &rfds);
604 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl)
609 #endif /* CTRL_IFACE_SOCKET */
612 #ifdef CONFIG_CTRL_IFACE_NAMED_PIPE
614 #ifndef WPA_SUPPLICANT_NAMED_PIPE
615 #define WPA_SUPPLICANT_NAMED_PIPE "WpaSupplicant"
617 #define NAMED_PIPE_PREFIX TEXT("\\\\.\\pipe\\") TEXT(WPA_SUPPLICANT_NAMED_PIPE)
619 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
621 struct wpa_ctrl *ctrl;
626 ctrl = os_malloc(sizeof(*ctrl));
629 os_memset(ctrl, 0, sizeof(*ctrl));
632 if (ctrl_path == NULL)
633 ret = _snwprintf(name, 256, NAMED_PIPE_PREFIX);
635 ret = _snwprintf(name, 256, NAMED_PIPE_PREFIX TEXT("-%S"),
638 if (ctrl_path == NULL)
639 ret = os_snprintf(name, 256, NAMED_PIPE_PREFIX);
641 ret = os_snprintf(name, 256, NAMED_PIPE_PREFIX "-%s",
644 if (os_snprintf_error(256, ret)) {
649 for (i = 0; i < 10; i++) {
650 ctrl->pipe = CreateFile(name, GENERIC_READ | GENERIC_WRITE, 0,
651 NULL, OPEN_EXISTING, 0, NULL);
653 * Current named pipe server side in wpa_supplicant is
654 * re-opening the pipe for new clients only after the previous
655 * one is taken into use. This leaves a small window for race
656 * conditions when two connections are being opened at almost
657 * the same time. Retry if that was the case.
659 if (ctrl->pipe != INVALID_HANDLE_VALUE ||
660 GetLastError() != ERROR_PIPE_BUSY)
662 WaitNamedPipe(name, 1000);
664 if (ctrl->pipe == INVALID_HANDLE_VALUE) {
669 mode = PIPE_READMODE_MESSAGE;
670 if (!SetNamedPipeHandleState(ctrl->pipe, &mode, NULL, NULL)) {
671 CloseHandle(ctrl->pipe);
680 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
682 CloseHandle(ctrl->pipe);
687 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
688 char *reply, size_t *reply_len,
689 void (*msg_cb)(char *msg, size_t len))
692 DWORD readlen = *reply_len;
694 if (!WriteFile(ctrl->pipe, cmd, cmd_len, &written, NULL))
697 if (!ReadFile(ctrl->pipe, reply, *reply_len, &readlen, NULL))
699 *reply_len = readlen;
705 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len)
707 DWORD len = *reply_len;
708 if (!ReadFile(ctrl->pipe, reply, *reply_len, &len, NULL))
715 int wpa_ctrl_pending(struct wpa_ctrl *ctrl)
719 if (!PeekNamedPipe(ctrl->pipe, NULL, 0, NULL, &left, NULL))
725 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl)
730 #endif /* CONFIG_CTRL_IFACE_NAMED_PIPE */
732 #endif /* CONFIG_CTRL_IFACE */