2 * WPA Supplicant / UNIX domain socket -based control interface
3 * Copyright (c) 2004-2013, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
17 #include <cutils/sockets.h>
20 #include "utils/common.h"
21 #include "utils/eloop.h"
22 #include "utils/list.h"
23 #include "eapol_supp/eapol_supp_sm.h"
25 #include "wpa_supplicant_i.h"
26 #include "ctrl_iface.h"
28 /* Per-interface ctrl_iface */
31 * struct wpa_ctrl_dst - Internal data structure of control interface monitors
33 * This structure is used to store information about registered control
34 * interface monitors into struct wpa_supplicant. This data is private to
35 * ctrl_iface_unix.c and should not be touched directly from other files.
39 struct sockaddr_un addr;
46 struct ctrl_iface_priv {
47 struct wpa_supplicant *wpa_s;
49 struct dl_list ctrl_dst;
53 struct ctrl_iface_global_priv {
54 struct wpa_global *global;
56 struct dl_list ctrl_dst;
60 static void wpa_supplicant_ctrl_iface_send(const char *ifname, int sock,
61 struct dl_list *ctrl_dst,
62 int level, const char *buf,
66 static int wpa_supplicant_ctrl_iface_attach(struct dl_list *ctrl_dst,
67 struct sockaddr_un *from,
70 struct wpa_ctrl_dst *dst;
72 dst = os_zalloc(sizeof(*dst));
75 os_memcpy(&dst->addr, from, sizeof(struct sockaddr_un));
76 dst->addrlen = fromlen;
77 dst->debug_level = MSG_INFO;
78 dl_list_add(ctrl_dst, &dst->list);
79 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor attached",
80 (u8 *) from->sun_path,
81 fromlen - offsetof(struct sockaddr_un, sun_path));
86 static int wpa_supplicant_ctrl_iface_detach(struct dl_list *ctrl_dst,
87 struct sockaddr_un *from,
90 struct wpa_ctrl_dst *dst;
92 dl_list_for_each(dst, ctrl_dst, struct wpa_ctrl_dst, list) {
93 if (fromlen == dst->addrlen &&
94 os_memcmp(from->sun_path, dst->addr.sun_path,
95 fromlen - offsetof(struct sockaddr_un, sun_path))
97 dl_list_del(&dst->list);
99 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor detached",
100 (u8 *) from->sun_path,
102 offsetof(struct sockaddr_un, sun_path));
110 static int wpa_supplicant_ctrl_iface_level(struct ctrl_iface_priv *priv,
111 struct sockaddr_un *from,
115 struct wpa_ctrl_dst *dst;
117 wpa_printf(MSG_DEBUG, "CTRL_IFACE LEVEL %s", level);
119 dl_list_for_each(dst, &priv->ctrl_dst, struct wpa_ctrl_dst, list) {
120 if (fromlen == dst->addrlen &&
121 os_memcmp(from->sun_path, dst->addr.sun_path,
122 fromlen - offsetof(struct sockaddr_un, sun_path))
124 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE changed monitor "
125 "level", (u8 *) from->sun_path,
127 offsetof(struct sockaddr_un, sun_path));
128 dst->debug_level = atoi(level);
137 static void wpa_supplicant_ctrl_iface_receive(int sock, void *eloop_ctx,
140 struct wpa_supplicant *wpa_s = eloop_ctx;
141 struct ctrl_iface_priv *priv = sock_ctx;
144 struct sockaddr_un from;
145 socklen_t fromlen = sizeof(from);
147 size_t reply_len = 0;
148 int new_attached = 0;
150 res = recvfrom(sock, buf, sizeof(buf) - 1, 0,
151 (struct sockaddr *) &from, &fromlen);
153 perror("recvfrom(ctrl_iface)");
158 if (os_strcmp(buf, "ATTACH") == 0) {
159 if (wpa_supplicant_ctrl_iface_attach(&priv->ctrl_dst, &from,
166 } else if (os_strcmp(buf, "DETACH") == 0) {
167 if (wpa_supplicant_ctrl_iface_detach(&priv->ctrl_dst, &from,
172 } else if (os_strncmp(buf, "LEVEL ", 6) == 0) {
173 if (wpa_supplicant_ctrl_iface_level(priv, &from, fromlen,
179 reply = wpa_supplicant_ctrl_iface_process(wpa_s, buf,
184 sendto(sock, reply, reply_len, 0, (struct sockaddr *) &from,
187 } else if (reply_len == 1) {
188 sendto(sock, "FAIL\n", 5, 0, (struct sockaddr *) &from,
190 } else if (reply_len == 2) {
191 sendto(sock, "OK\n", 3, 0, (struct sockaddr *) &from,
196 eapol_sm_notify_ctrl_attached(wpa_s->eapol);
200 static char * wpa_supplicant_ctrl_iface_path(struct wpa_supplicant *wpa_s)
204 char *pbuf, *dir = NULL, *gid_str = NULL;
207 if (wpa_s->conf->ctrl_interface == NULL)
210 pbuf = os_strdup(wpa_s->conf->ctrl_interface);
213 if (os_strncmp(pbuf, "DIR=", 4) == 0) {
215 gid_str = os_strstr(dir, " GROUP=");
223 len = os_strlen(dir) + os_strlen(wpa_s->ifname) + 2;
224 buf = os_malloc(len);
230 res = os_snprintf(buf, len, "%s/%s", dir, wpa_s->ifname);
231 if (res < 0 || (size_t) res >= len) {
238 /* Windows/WinPcap uses interface names that are not suitable
239 * as a file name - convert invalid chars to underscores */
247 #endif /* __CYGWIN__ */
253 static void wpa_supplicant_ctrl_iface_msg_cb(void *ctx, int level, int global,
254 const char *txt, size_t len)
256 struct wpa_supplicant *wpa_s = ctx;
261 if (global != 2 && wpa_s->global->ctrl_iface) {
262 struct ctrl_iface_global_priv *priv = wpa_s->global->ctrl_iface;
263 if (!dl_list_empty(&priv->ctrl_dst)) {
264 wpa_supplicant_ctrl_iface_send(global ? NULL :
272 if (wpa_s->ctrl_iface == NULL)
274 wpa_supplicant_ctrl_iface_send(NULL, wpa_s->ctrl_iface->sock,
275 &wpa_s->ctrl_iface->ctrl_dst,
280 struct ctrl_iface_priv *
281 wpa_supplicant_ctrl_iface_init(struct wpa_supplicant *wpa_s)
283 struct ctrl_iface_priv *priv;
284 struct sockaddr_un addr;
288 char *buf, *dir = NULL, *gid_str = NULL;
293 priv = os_zalloc(sizeof(*priv));
296 dl_list_init(&priv->ctrl_dst);
300 if (wpa_s->conf->ctrl_interface == NULL)
303 buf = os_strdup(wpa_s->conf->ctrl_interface);
307 os_snprintf(addr.sun_path, sizeof(addr.sun_path), "wpa_%s",
308 wpa_s->conf->ctrl_interface);
309 priv->sock = android_get_control_socket(addr.sun_path);
313 if (os_strncmp(buf, "DIR=", 4) == 0) {
315 gid_str = os_strstr(dir, " GROUP=");
322 gid_str = wpa_s->conf->ctrl_interface_group;
325 if (mkdir(dir, S_IRWXU | S_IRWXG) < 0) {
326 if (errno == EEXIST) {
327 wpa_printf(MSG_DEBUG, "Using existing control "
328 "interface directory.");
330 perror("mkdir[ctrl_interface]");
337 * wpa_supplicant is started from /init.*.rc on Android and that seems
338 * to be using umask 0077 which would leave the control interface
339 * directory without group access. This breaks things since Wi-Fi
340 * framework assumes that this directory can be accessed by other
341 * applications in the wifi group. Fix this by adding group access even
342 * if umask value would prevent this.
344 if (chmod(dir, S_IRWXU | S_IRWXG) < 0) {
345 wpa_printf(MSG_ERROR, "CTRL: Could not chmod directory: %s",
347 /* Try to continue anyway */
352 grp = getgrnam(gid_str);
356 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d"
357 " (from group name '%s')",
360 /* Group name not found - try to parse this as gid */
361 gid = strtol(gid_str, &endp, 10);
362 if (*gid_str == '\0' || *endp != '\0') {
363 wpa_printf(MSG_ERROR, "CTRL: Invalid group "
368 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d",
373 if (gid_set && chown(dir, -1, gid) < 0) {
374 perror("chown[ctrl_interface]");
378 /* Make sure the group can enter and read the directory */
380 chmod(dir, S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP) < 0) {
381 wpa_printf(MSG_ERROR, "CTRL: chmod[ctrl_interface]: %s",
386 if (os_strlen(dir) + 1 + os_strlen(wpa_s->ifname) >=
387 sizeof(addr.sun_path)) {
388 wpa_printf(MSG_ERROR, "ctrl_iface path limit exceeded");
392 priv->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
393 if (priv->sock < 0) {
394 perror("socket(PF_UNIX)");
398 os_memset(&addr, 0, sizeof(addr));
399 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
400 addr.sun_len = sizeof(addr);
401 #endif /* __FreeBSD__ */
402 addr.sun_family = AF_UNIX;
403 fname = wpa_supplicant_ctrl_iface_path(wpa_s);
406 os_strlcpy(addr.sun_path, fname, sizeof(addr.sun_path));
407 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
408 wpa_printf(MSG_DEBUG, "ctrl_iface bind(PF_UNIX) failed: %s",
410 if (connect(priv->sock, (struct sockaddr *) &addr,
412 wpa_printf(MSG_DEBUG, "ctrl_iface exists, but does not"
413 " allow connections - assuming it was left"
414 "over from forced program termination");
415 if (unlink(fname) < 0) {
416 perror("unlink[ctrl_iface]");
417 wpa_printf(MSG_ERROR, "Could not unlink "
418 "existing ctrl_iface socket '%s'",
422 if (bind(priv->sock, (struct sockaddr *) &addr,
424 perror("supp-ctrl-iface-init: bind(PF_UNIX)");
427 wpa_printf(MSG_DEBUG, "Successfully replaced leftover "
428 "ctrl_iface socket '%s'", fname);
430 wpa_printf(MSG_INFO, "ctrl_iface exists and seems to "
431 "be in use - cannot override it");
432 wpa_printf(MSG_INFO, "Delete '%s' manually if it is "
433 "not used anymore", fname);
440 if (gid_set && chown(fname, -1, gid) < 0) {
441 perror("chown[ctrl_interface/ifname]");
445 if (chmod(fname, S_IRWXU | S_IRWXG) < 0) {
446 perror("chmod[ctrl_interface/ifname]");
456 * Make socket non-blocking so that we don't hang forever if
457 * target dies unexpectedly.
459 flags = fcntl(priv->sock, F_GETFL);
462 if (fcntl(priv->sock, F_SETFL, flags) < 0) {
463 perror("fcntl(ctrl, O_NONBLOCK)");
464 /* Not fatal, continue on.*/
468 eloop_register_read_sock(priv->sock, wpa_supplicant_ctrl_iface_receive,
470 wpa_msg_register_cb(wpa_supplicant_ctrl_iface_msg_cb);
488 void wpa_supplicant_ctrl_iface_deinit(struct ctrl_iface_priv *priv)
490 struct wpa_ctrl_dst *dst, *prev;
492 if (priv->sock > -1) {
494 char *buf, *dir = NULL, *gid_str = NULL;
495 eloop_unregister_read_sock(priv->sock);
496 if (!dl_list_empty(&priv->ctrl_dst)) {
498 * Wait a second before closing the control socket if
499 * there are any attached monitors in order to allow
500 * them to receive any pending messages.
502 wpa_printf(MSG_DEBUG, "CTRL_IFACE wait for attached "
503 "monitors to receive messages");
508 fname = wpa_supplicant_ctrl_iface_path(priv->wpa_s);
514 buf = os_strdup(priv->wpa_s->conf->ctrl_interface);
517 if (os_strncmp(buf, "DIR=", 4) == 0) {
519 gid_str = os_strstr(dir, " GROUP=");
527 if (rmdir(dir) < 0) {
528 if (errno == ENOTEMPTY) {
529 wpa_printf(MSG_DEBUG, "Control interface "
530 "directory not empty - leaving it "
533 perror("rmdir[ctrl_interface]");
540 dl_list_for_each_safe(dst, prev, &priv->ctrl_dst, struct wpa_ctrl_dst,
548 * wpa_supplicant_ctrl_iface_send - Send a control interface packet to monitors
549 * @ifname: Interface name for global control socket or %NULL
550 * @sock: Local socket fd
551 * @ctrl_dst: List of attached listeners
552 * @level: Priority level of the message
554 * @len: Message length
556 * Send a packet to all monitor programs attached to the control interface.
558 static void wpa_supplicant_ctrl_iface_send(const char *ifname, int sock,
559 struct dl_list *ctrl_dst,
560 int level, const char *buf,
563 struct wpa_ctrl_dst *dst, *next;
569 if (sock < 0 || dl_list_empty(ctrl_dst))
572 res = os_snprintf(levelstr, sizeof(levelstr), "<%d>", level);
573 if (res < 0 || (size_t) res >= sizeof(levelstr))
577 io[idx].iov_base = "IFNAME=";
580 io[idx].iov_base = (char *) ifname;
581 io[idx].iov_len = os_strlen(ifname);
583 io[idx].iov_base = " ";
587 io[idx].iov_base = levelstr;
588 io[idx].iov_len = os_strlen(levelstr);
590 io[idx].iov_base = (char *) buf;
591 io[idx].iov_len = len;
593 os_memset(&msg, 0, sizeof(msg));
595 msg.msg_iovlen = idx;
598 dl_list_for_each_safe(dst, next, ctrl_dst, struct wpa_ctrl_dst, list) {
599 if (level >= dst->debug_level) {
600 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor send",
601 (u8 *) dst->addr.sun_path, dst->addrlen -
602 offsetof(struct sockaddr_un, sun_path));
603 msg.msg_name = (void *) &dst->addr;
604 msg.msg_namelen = dst->addrlen;
605 if (sendmsg(sock, &msg, MSG_DONTWAIT) < 0) {
607 wpa_printf(MSG_INFO, "CTRL_IFACE monitor[%d]: "
609 idx, errno, strerror(errno));
611 if (dst->errors > 1000 ||
612 (_errno != ENOBUFS && dst->errors > 10) ||
614 wpa_supplicant_ctrl_iface_detach(
615 ctrl_dst, &dst->addr,
626 void wpa_supplicant_ctrl_iface_wait(struct ctrl_iface_priv *priv)
630 struct sockaddr_un from;
631 socklen_t fromlen = sizeof(from);
634 wpa_printf(MSG_DEBUG, "CTRL_IFACE - %s - wait for monitor to "
635 "attach", priv->wpa_s->ifname);
636 eloop_wait_for_read_sock(priv->sock);
638 res = recvfrom(priv->sock, buf, sizeof(buf) - 1, 0,
639 (struct sockaddr *) &from, &fromlen);
641 perror("recvfrom(ctrl_iface)");
646 if (os_strcmp(buf, "ATTACH") == 0) {
647 /* handle ATTACH signal of first monitor interface */
648 if (!wpa_supplicant_ctrl_iface_attach(&priv->ctrl_dst,
650 sendto(priv->sock, "OK\n", 3, 0,
651 (struct sockaddr *) &from, fromlen);
655 sendto(priv->sock, "FAIL\n", 5, 0,
656 (struct sockaddr *) &from, fromlen);
659 /* return FAIL for all other signals */
660 sendto(priv->sock, "FAIL\n", 5, 0,
661 (struct sockaddr *) &from, fromlen);
667 /* Global ctrl_iface */
669 static void wpa_supplicant_global_ctrl_iface_receive(int sock, void *eloop_ctx,
672 struct wpa_global *global = eloop_ctx;
673 struct ctrl_iface_global_priv *priv = sock_ctx;
676 struct sockaddr_un from;
677 socklen_t fromlen = sizeof(from);
681 res = recvfrom(sock, buf, sizeof(buf) - 1, 0,
682 (struct sockaddr *) &from, &fromlen);
684 perror("recvfrom(ctrl_iface)");
689 if (os_strcmp(buf, "ATTACH") == 0) {
690 if (wpa_supplicant_ctrl_iface_attach(&priv->ctrl_dst, &from,
695 } else if (os_strcmp(buf, "DETACH") == 0) {
696 if (wpa_supplicant_ctrl_iface_detach(&priv->ctrl_dst, &from,
702 reply = wpa_supplicant_global_ctrl_iface_process(global, buf,
707 sendto(sock, reply, reply_len, 0, (struct sockaddr *) &from,
710 } else if (reply_len == 1) {
711 sendto(sock, "FAIL\n", 5, 0, (struct sockaddr *) &from,
713 } else if (reply_len == 2) {
714 sendto(sock, "OK\n", 3, 0, (struct sockaddr *) &from, fromlen);
719 struct ctrl_iface_global_priv *
720 wpa_supplicant_global_ctrl_iface_init(struct wpa_global *global)
722 struct ctrl_iface_global_priv *priv;
723 struct sockaddr_un addr;
724 const char *ctrl = global->params.ctrl_interface;
726 priv = os_zalloc(sizeof(*priv));
729 dl_list_init(&priv->ctrl_dst);
730 priv->global = global;
736 wpa_printf(MSG_DEBUG, "Global control interface '%s'", ctrl);
739 if (os_strncmp(ctrl, "@android:", 9) == 0) {
740 priv->sock = android_get_control_socket(ctrl + 9);
741 if (priv->sock < 0) {
742 wpa_printf(MSG_ERROR, "Failed to open Android control "
743 "socket '%s'", ctrl + 9);
746 wpa_printf(MSG_DEBUG, "Using Android control socket '%s'",
751 if (os_strncmp(ctrl, "@abstract:", 10) != 0) {
753 * Backwards compatibility - try to open an Android control
754 * socket and if that fails, assume this was a UNIX domain
757 priv->sock = android_get_control_socket(ctrl);
758 if (priv->sock >= 0) {
759 wpa_printf(MSG_DEBUG,
760 "Using Android control socket '%s'",
767 priv->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
768 if (priv->sock < 0) {
769 perror("socket(PF_UNIX)");
773 os_memset(&addr, 0, sizeof(addr));
774 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
775 addr.sun_len = sizeof(addr);
776 #endif /* __FreeBSD__ */
777 addr.sun_family = AF_UNIX;
779 if (os_strncmp(ctrl, "@abstract:", 10) == 0) {
780 addr.sun_path[0] = '\0';
781 os_strlcpy(addr.sun_path + 1, ctrl + 10,
782 sizeof(addr.sun_path) - 1);
783 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) <
785 wpa_printf(MSG_ERROR, "supp-global-ctrl-iface-init: "
786 "bind(PF_UNIX) failed: %s", strerror(errno));
789 wpa_printf(MSG_DEBUG, "Using Abstract control socket '%s'",
794 os_strlcpy(addr.sun_path, ctrl, sizeof(addr.sun_path));
795 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
796 perror("supp-global-ctrl-iface-init (will try fixup): "
798 if (connect(priv->sock, (struct sockaddr *) &addr,
800 wpa_printf(MSG_DEBUG, "ctrl_iface exists, but does not"
801 " allow connections - assuming it was left"
802 "over from forced program termination");
803 if (unlink(ctrl) < 0) {
804 perror("unlink[ctrl_iface]");
805 wpa_printf(MSG_ERROR, "Could not unlink "
806 "existing ctrl_iface socket '%s'",
810 if (bind(priv->sock, (struct sockaddr *) &addr,
812 perror("supp-glb-iface-init: bind(PF_UNIX)");
815 wpa_printf(MSG_DEBUG, "Successfully replaced leftover "
816 "ctrl_iface socket '%s'",
819 wpa_printf(MSG_INFO, "ctrl_iface exists and seems to "
820 "be in use - cannot override it");
821 wpa_printf(MSG_INFO, "Delete '%s' manually if it is "
828 wpa_printf(MSG_DEBUG, "Using UNIX control socket '%s'", ctrl);
830 if (global->params.ctrl_interface_group) {
831 char *gid_str = global->params.ctrl_interface_group;
836 grp = getgrnam(gid_str);
839 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d"
840 " (from group name '%s')",
843 /* Group name not found - try to parse this as gid */
844 gid = strtol(gid_str, &endp, 10);
845 if (*gid_str == '\0' || *endp != '\0') {
846 wpa_printf(MSG_ERROR, "CTRL: Invalid group "
850 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d",
853 if (chown(ctrl, -1, gid) < 0) {
854 perror("chown[global_ctrl_interface/ifname]");
858 if (chmod(ctrl, S_IRWXU | S_IRWXG) < 0) {
859 perror("chmod[global_ctrl_interface/ifname]");
863 chmod(ctrl, S_IRWXU);
867 eloop_register_read_sock(priv->sock,
868 wpa_supplicant_global_ctrl_iface_receive,
882 wpa_supplicant_global_ctrl_iface_deinit(struct ctrl_iface_global_priv *priv)
884 struct wpa_ctrl_dst *dst, *prev;
886 if (priv->sock >= 0) {
887 eloop_unregister_read_sock(priv->sock);
890 if (priv->global->params.ctrl_interface)
891 unlink(priv->global->params.ctrl_interface);
892 dl_list_for_each_safe(dst, prev, &priv->ctrl_dst, struct wpa_ctrl_dst,