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 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor detached",
98 (u8 *) from->sun_path,
100 offsetof(struct sockaddr_un, sun_path));
101 dl_list_del(&dst->list);
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);
146 char *reply = NULL, *reply_buf = NULL;
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 wpa_printf(MSG_ERROR, "recvfrom(ctrl_iface): %s",
159 if (os_strcmp(buf, "ATTACH") == 0) {
160 if (wpa_supplicant_ctrl_iface_attach(&priv->ctrl_dst, &from,
167 } else if (os_strcmp(buf, "DETACH") == 0) {
168 if (wpa_supplicant_ctrl_iface_detach(&priv->ctrl_dst, &from,
173 } else if (os_strncmp(buf, "LEVEL ", 6) == 0) {
174 if (wpa_supplicant_ctrl_iface_level(priv, &from, fromlen,
180 reply_buf = wpa_supplicant_ctrl_iface_process(wpa_s, buf,
185 if (!reply && reply_len == 1) {
188 } else if (!reply && reply_len == 2) {
194 if (sendto(sock, reply, reply_len, 0, (struct sockaddr *) &from,
196 wpa_dbg(wpa_s, MSG_DEBUG,
197 "ctrl_iface sendto failed: %s",
204 eapol_sm_notify_ctrl_attached(wpa_s->eapol);
208 static char * wpa_supplicant_ctrl_iface_path(struct wpa_supplicant *wpa_s)
212 char *pbuf, *dir = NULL, *gid_str = NULL;
215 if (wpa_s->conf->ctrl_interface == NULL)
218 pbuf = os_strdup(wpa_s->conf->ctrl_interface);
221 if (os_strncmp(pbuf, "DIR=", 4) == 0) {
223 gid_str = os_strstr(dir, " GROUP=");
231 len = os_strlen(dir) + os_strlen(wpa_s->ifname) + 2;
232 buf = os_malloc(len);
238 res = os_snprintf(buf, len, "%s/%s", dir, wpa_s->ifname);
239 if (res < 0 || (size_t) res >= len) {
246 /* Windows/WinPcap uses interface names that are not suitable
247 * as a file name - convert invalid chars to underscores */
255 #endif /* __CYGWIN__ */
261 static void wpa_supplicant_ctrl_iface_msg_cb(void *ctx, int level, int global,
262 const char *txt, size_t len)
264 struct wpa_supplicant *wpa_s = ctx;
269 if (global != 2 && wpa_s->global->ctrl_iface) {
270 struct ctrl_iface_global_priv *priv = wpa_s->global->ctrl_iface;
271 if (!dl_list_empty(&priv->ctrl_dst)) {
272 wpa_supplicant_ctrl_iface_send(global ? NULL :
280 if (wpa_s->ctrl_iface == NULL)
282 wpa_supplicant_ctrl_iface_send(NULL, wpa_s->ctrl_iface->sock,
283 &wpa_s->ctrl_iface->ctrl_dst,
288 struct ctrl_iface_priv *
289 wpa_supplicant_ctrl_iface_init(struct wpa_supplicant *wpa_s)
291 struct ctrl_iface_priv *priv;
292 struct sockaddr_un addr;
296 char *buf, *dir = NULL, *gid_str = NULL;
301 priv = os_zalloc(sizeof(*priv));
304 dl_list_init(&priv->ctrl_dst);
308 if (wpa_s->conf->ctrl_interface == NULL)
311 buf = os_strdup(wpa_s->conf->ctrl_interface);
315 os_snprintf(addr.sun_path, sizeof(addr.sun_path), "wpa_%s",
316 wpa_s->conf->ctrl_interface);
317 priv->sock = android_get_control_socket(addr.sun_path);
321 if (os_strncmp(buf, "DIR=", 4) == 0) {
323 gid_str = os_strstr(dir, " GROUP=");
330 gid_str = wpa_s->conf->ctrl_interface_group;
333 if (mkdir(dir, S_IRWXU | S_IRWXG) < 0) {
334 if (errno == EEXIST) {
335 wpa_printf(MSG_DEBUG, "Using existing control "
336 "interface directory.");
338 wpa_printf(MSG_ERROR, "mkdir[ctrl_interface=%s]: %s",
339 dir, strerror(errno));
346 * wpa_supplicant is started from /init.*.rc on Android and that seems
347 * to be using umask 0077 which would leave the control interface
348 * directory without group access. This breaks things since Wi-Fi
349 * framework assumes that this directory can be accessed by other
350 * applications in the wifi group. Fix this by adding group access even
351 * if umask value would prevent this.
353 if (chmod(dir, S_IRWXU | S_IRWXG) < 0) {
354 wpa_printf(MSG_ERROR, "CTRL: Could not chmod directory: %s",
356 /* Try to continue anyway */
361 grp = getgrnam(gid_str);
365 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d"
366 " (from group name '%s')",
369 /* Group name not found - try to parse this as gid */
370 gid = strtol(gid_str, &endp, 10);
371 if (*gid_str == '\0' || *endp != '\0') {
372 wpa_printf(MSG_ERROR, "CTRL: Invalid group "
377 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d",
382 if (gid_set && chown(dir, -1, gid) < 0) {
383 wpa_printf(MSG_ERROR, "chown[ctrl_interface=%s,gid=%d]: %s",
384 dir, (int) gid, strerror(errno));
388 /* Make sure the group can enter and read the directory */
390 chmod(dir, S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP) < 0) {
391 wpa_printf(MSG_ERROR, "CTRL: chmod[ctrl_interface]: %s",
396 if (os_strlen(dir) + 1 + os_strlen(wpa_s->ifname) >=
397 sizeof(addr.sun_path)) {
398 wpa_printf(MSG_ERROR, "ctrl_iface path limit exceeded");
402 priv->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
403 if (priv->sock < 0) {
404 wpa_printf(MSG_ERROR, "socket(PF_UNIX): %s", strerror(errno));
408 os_memset(&addr, 0, sizeof(addr));
409 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
410 addr.sun_len = sizeof(addr);
411 #endif /* __FreeBSD__ */
412 addr.sun_family = AF_UNIX;
413 fname = wpa_supplicant_ctrl_iface_path(wpa_s);
416 os_strlcpy(addr.sun_path, fname, sizeof(addr.sun_path));
417 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
418 wpa_printf(MSG_DEBUG, "ctrl_iface bind(PF_UNIX) failed: %s",
420 if (connect(priv->sock, (struct sockaddr *) &addr,
422 wpa_printf(MSG_DEBUG, "ctrl_iface exists, but does not"
423 " allow connections - assuming it was left"
424 "over from forced program termination");
425 if (unlink(fname) < 0) {
426 wpa_printf(MSG_ERROR,
427 "Could not unlink existing ctrl_iface socket '%s': %s",
428 fname, strerror(errno));
431 if (bind(priv->sock, (struct sockaddr *) &addr,
433 wpa_printf(MSG_ERROR, "supp-ctrl-iface-init: bind(PF_UNIX): %s",
437 wpa_printf(MSG_DEBUG, "Successfully replaced leftover "
438 "ctrl_iface socket '%s'", fname);
440 wpa_printf(MSG_INFO, "ctrl_iface exists and seems to "
441 "be in use - cannot override it");
442 wpa_printf(MSG_INFO, "Delete '%s' manually if it is "
443 "not used anymore", fname);
450 if (gid_set && chown(fname, -1, gid) < 0) {
451 wpa_printf(MSG_ERROR, "chown[ctrl_interface=%s,gid=%d]: %s",
452 fname, (int) gid, strerror(errno));
456 if (chmod(fname, S_IRWXU | S_IRWXG) < 0) {
457 wpa_printf(MSG_ERROR, "chmod[ctrl_interface=%s]: %s",
458 fname, strerror(errno));
468 * Make socket non-blocking so that we don't hang forever if
469 * target dies unexpectedly.
471 flags = fcntl(priv->sock, F_GETFL);
474 if (fcntl(priv->sock, F_SETFL, flags) < 0) {
475 wpa_printf(MSG_INFO, "fcntl(ctrl, O_NONBLOCK): %s",
477 /* Not fatal, continue on.*/
481 eloop_register_read_sock(priv->sock, wpa_supplicant_ctrl_iface_receive,
483 wpa_msg_register_cb(wpa_supplicant_ctrl_iface_msg_cb);
501 void wpa_supplicant_ctrl_iface_deinit(struct ctrl_iface_priv *priv)
503 struct wpa_ctrl_dst *dst, *prev;
505 if (priv->sock > -1) {
507 char *buf, *dir = NULL, *gid_str = NULL;
508 eloop_unregister_read_sock(priv->sock);
509 if (!dl_list_empty(&priv->ctrl_dst)) {
511 * Wait before closing the control socket if
512 * there are any attached monitors in order to allow
513 * them to receive any pending messages.
515 wpa_printf(MSG_DEBUG, "CTRL_IFACE wait for attached "
516 "monitors to receive messages");
521 fname = wpa_supplicant_ctrl_iface_path(priv->wpa_s);
527 buf = os_strdup(priv->wpa_s->conf->ctrl_interface);
530 if (os_strncmp(buf, "DIR=", 4) == 0) {
532 gid_str = os_strstr(dir, " GROUP=");
540 if (rmdir(dir) < 0) {
541 if (errno == ENOTEMPTY) {
542 wpa_printf(MSG_DEBUG, "Control interface "
543 "directory not empty - leaving it "
546 wpa_printf(MSG_ERROR,
547 "rmdir[ctrl_interface=%s]: %s",
548 dir, strerror(errno));
555 dl_list_for_each_safe(dst, prev, &priv->ctrl_dst, struct wpa_ctrl_dst,
563 * wpa_supplicant_ctrl_iface_send - Send a control interface packet to monitors
564 * @ifname: Interface name for global control socket or %NULL
565 * @sock: Local socket fd
566 * @ctrl_dst: List of attached listeners
567 * @level: Priority level of the message
569 * @len: Message length
571 * Send a packet to all monitor programs attached to the control interface.
573 static void wpa_supplicant_ctrl_iface_send(const char *ifname, int sock,
574 struct dl_list *ctrl_dst,
575 int level, const char *buf,
578 struct wpa_ctrl_dst *dst, *next;
584 if (sock < 0 || dl_list_empty(ctrl_dst))
587 res = os_snprintf(levelstr, sizeof(levelstr), "<%d>", level);
588 if (res < 0 || (size_t) res >= sizeof(levelstr))
592 io[idx].iov_base = "IFNAME=";
595 io[idx].iov_base = (char *) ifname;
596 io[idx].iov_len = os_strlen(ifname);
598 io[idx].iov_base = " ";
602 io[idx].iov_base = levelstr;
603 io[idx].iov_len = os_strlen(levelstr);
605 io[idx].iov_base = (char *) buf;
606 io[idx].iov_len = len;
608 os_memset(&msg, 0, sizeof(msg));
610 msg.msg_iovlen = idx;
613 dl_list_for_each_safe(dst, next, ctrl_dst, struct wpa_ctrl_dst, list) {
614 if (level >= dst->debug_level) {
615 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor send",
616 (u8 *) dst->addr.sun_path, dst->addrlen -
617 offsetof(struct sockaddr_un, sun_path));
618 msg.msg_name = (void *) &dst->addr;
619 msg.msg_namelen = dst->addrlen;
620 if (sendmsg(sock, &msg, MSG_DONTWAIT) < 0) {
622 wpa_printf(MSG_INFO, "CTRL_IFACE monitor[%d]: "
624 idx, errno, strerror(errno));
626 if (dst->errors > 1000 ||
627 (_errno != ENOBUFS && dst->errors > 10) ||
629 wpa_supplicant_ctrl_iface_detach(
630 ctrl_dst, &dst->addr,
641 void wpa_supplicant_ctrl_iface_wait(struct ctrl_iface_priv *priv)
645 struct sockaddr_un from;
646 socklen_t fromlen = sizeof(from);
649 wpa_printf(MSG_DEBUG, "CTRL_IFACE - %s - wait for monitor to "
650 "attach", priv->wpa_s->ifname);
651 eloop_wait_for_read_sock(priv->sock);
653 res = recvfrom(priv->sock, buf, sizeof(buf) - 1, 0,
654 (struct sockaddr *) &from, &fromlen);
656 wpa_printf(MSG_ERROR, "recvfrom(ctrl_iface): %s",
662 if (os_strcmp(buf, "ATTACH") == 0) {
663 /* handle ATTACH signal of first monitor interface */
664 if (!wpa_supplicant_ctrl_iface_attach(&priv->ctrl_dst,
666 if (sendto(priv->sock, "OK\n", 3, 0,
667 (struct sockaddr *) &from, fromlen) <
669 wpa_printf(MSG_DEBUG, "ctrl_iface sendto failed: %s",
675 if (sendto(priv->sock, "FAIL\n", 5, 0,
676 (struct sockaddr *) &from, fromlen) <
678 wpa_printf(MSG_DEBUG, "ctrl_iface sendto failed: %s",
683 /* return FAIL for all other signals */
684 if (sendto(priv->sock, "FAIL\n", 5, 0,
685 (struct sockaddr *) &from, fromlen) < 0) {
686 wpa_printf(MSG_DEBUG,
687 "ctrl_iface sendto failed: %s",
695 /* Global ctrl_iface */
697 static void wpa_supplicant_global_ctrl_iface_receive(int sock, void *eloop_ctx,
700 struct wpa_global *global = eloop_ctx;
701 struct ctrl_iface_global_priv *priv = sock_ctx;
704 struct sockaddr_un from;
705 socklen_t fromlen = sizeof(from);
706 char *reply = NULL, *reply_buf = NULL;
709 res = recvfrom(sock, buf, sizeof(buf) - 1, 0,
710 (struct sockaddr *) &from, &fromlen);
712 wpa_printf(MSG_ERROR, "recvfrom(ctrl_iface): %s",
718 if (os_strcmp(buf, "ATTACH") == 0) {
719 if (wpa_supplicant_ctrl_iface_attach(&priv->ctrl_dst, &from,
724 } else if (os_strcmp(buf, "DETACH") == 0) {
725 if (wpa_supplicant_ctrl_iface_detach(&priv->ctrl_dst, &from,
731 reply_buf = wpa_supplicant_global_ctrl_iface_process(
732 global, buf, &reply_len);
736 if (!reply && reply_len == 1) {
739 } else if (!reply && reply_len == 2) {
745 if (sendto(sock, reply, reply_len, 0, (struct sockaddr *) &from,
747 wpa_printf(MSG_DEBUG, "ctrl_iface sendto failed: %s",
755 struct ctrl_iface_global_priv *
756 wpa_supplicant_global_ctrl_iface_init(struct wpa_global *global)
758 struct ctrl_iface_global_priv *priv;
759 struct sockaddr_un addr;
760 const char *ctrl = global->params.ctrl_interface;
763 priv = os_zalloc(sizeof(*priv));
766 dl_list_init(&priv->ctrl_dst);
767 priv->global = global;
773 wpa_printf(MSG_DEBUG, "Global control interface '%s'", ctrl);
776 if (os_strncmp(ctrl, "@android:", 9) == 0) {
777 priv->sock = android_get_control_socket(ctrl + 9);
778 if (priv->sock < 0) {
779 wpa_printf(MSG_ERROR, "Failed to open Android control "
780 "socket '%s'", ctrl + 9);
783 wpa_printf(MSG_DEBUG, "Using Android control socket '%s'",
788 if (os_strncmp(ctrl, "@abstract:", 10) != 0) {
790 * Backwards compatibility - try to open an Android control
791 * socket and if that fails, assume this was a UNIX domain
794 priv->sock = android_get_control_socket(ctrl);
795 if (priv->sock >= 0) {
796 wpa_printf(MSG_DEBUG,
797 "Using Android control socket '%s'",
804 priv->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
805 if (priv->sock < 0) {
806 wpa_printf(MSG_ERROR, "socket(PF_UNIX): %s", strerror(errno));
810 os_memset(&addr, 0, sizeof(addr));
811 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
812 addr.sun_len = sizeof(addr);
813 #endif /* __FreeBSD__ */
814 addr.sun_family = AF_UNIX;
816 if (os_strncmp(ctrl, "@abstract:", 10) == 0) {
817 addr.sun_path[0] = '\0';
818 os_strlcpy(addr.sun_path + 1, ctrl + 10,
819 sizeof(addr.sun_path) - 1);
820 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) <
822 wpa_printf(MSG_ERROR, "supp-global-ctrl-iface-init: "
823 "bind(PF_UNIX;%s) failed: %s",
824 ctrl, strerror(errno));
827 wpa_printf(MSG_DEBUG, "Using Abstract control socket '%s'",
832 os_strlcpy(addr.sun_path, ctrl, sizeof(addr.sun_path));
833 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
834 wpa_printf(MSG_INFO, "supp-global-ctrl-iface-init(%s) (will try fixup): bind(PF_UNIX): %s",
835 ctrl, strerror(errno));
836 if (connect(priv->sock, (struct sockaddr *) &addr,
838 wpa_printf(MSG_DEBUG, "ctrl_iface exists, but does not"
839 " allow connections - assuming it was left"
840 "over from forced program termination");
841 if (unlink(ctrl) < 0) {
842 wpa_printf(MSG_ERROR,
843 "Could not unlink existing ctrl_iface socket '%s': %s",
844 ctrl, strerror(errno));
847 if (bind(priv->sock, (struct sockaddr *) &addr,
849 wpa_printf(MSG_ERROR, "supp-glb-iface-init: bind(PF_UNIX;%s): %s",
850 ctrl, strerror(errno));
853 wpa_printf(MSG_DEBUG, "Successfully replaced leftover "
854 "ctrl_iface socket '%s'",
857 wpa_printf(MSG_INFO, "ctrl_iface exists and seems to "
858 "be in use - cannot override it");
859 wpa_printf(MSG_INFO, "Delete '%s' manually if it is "
866 wpa_printf(MSG_DEBUG, "Using UNIX control socket '%s'", ctrl);
868 if (global->params.ctrl_interface_group) {
869 char *gid_str = global->params.ctrl_interface_group;
874 grp = getgrnam(gid_str);
877 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d"
878 " (from group name '%s')",
881 /* Group name not found - try to parse this as gid */
882 gid = strtol(gid_str, &endp, 10);
883 if (*gid_str == '\0' || *endp != '\0') {
884 wpa_printf(MSG_ERROR, "CTRL: Invalid group "
888 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d",
891 if (chown(ctrl, -1, gid) < 0) {
892 wpa_printf(MSG_ERROR,
893 "chown[global_ctrl_interface=%s,gid=%d]: %s",
894 ctrl, (int) gid, strerror(errno));
898 if (chmod(ctrl, S_IRWXU | S_IRWXG) < 0) {
899 wpa_printf(MSG_ERROR,
900 "chmod[global_ctrl_interface=%s]: %s",
901 ctrl, strerror(errno));
905 chmod(ctrl, S_IRWXU);
911 * Make socket non-blocking so that we don't hang forever if
912 * target dies unexpectedly.
914 flags = fcntl(priv->sock, F_GETFL);
917 if (fcntl(priv->sock, F_SETFL, flags) < 0) {
918 wpa_printf(MSG_INFO, "fcntl(ctrl, O_NONBLOCK): %s",
920 /* Not fatal, continue on.*/
924 eloop_register_read_sock(priv->sock,
925 wpa_supplicant_global_ctrl_iface_receive,
939 wpa_supplicant_global_ctrl_iface_deinit(struct ctrl_iface_global_priv *priv)
941 struct wpa_ctrl_dst *dst, *prev;
943 if (priv->sock >= 0) {
944 eloop_unregister_read_sock(priv->sock);
947 if (priv->global->params.ctrl_interface)
948 unlink(priv->global->params.ctrl_interface);
949 dl_list_for_each_safe(dst, prev, &priv->ctrl_dst, struct wpa_ctrl_dst,