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);
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 = wpa_supplicant_ctrl_iface_process(wpa_s, buf,
185 sendto(sock, reply, reply_len, 0, (struct sockaddr *) &from,
188 } else if (reply_len == 1) {
189 sendto(sock, "FAIL\n", 5, 0, (struct sockaddr *) &from,
191 } else if (reply_len == 2) {
192 sendto(sock, "OK\n", 3, 0, (struct sockaddr *) &from,
197 eapol_sm_notify_ctrl_attached(wpa_s->eapol);
201 static char * wpa_supplicant_ctrl_iface_path(struct wpa_supplicant *wpa_s)
205 char *pbuf, *dir = NULL, *gid_str = NULL;
208 if (wpa_s->conf->ctrl_interface == NULL)
211 pbuf = os_strdup(wpa_s->conf->ctrl_interface);
214 if (os_strncmp(pbuf, "DIR=", 4) == 0) {
216 gid_str = os_strstr(dir, " GROUP=");
224 len = os_strlen(dir) + os_strlen(wpa_s->ifname) + 2;
225 buf = os_malloc(len);
231 res = os_snprintf(buf, len, "%s/%s", dir, wpa_s->ifname);
232 if (res < 0 || (size_t) res >= len) {
239 /* Windows/WinPcap uses interface names that are not suitable
240 * as a file name - convert invalid chars to underscores */
248 #endif /* __CYGWIN__ */
254 static void wpa_supplicant_ctrl_iface_msg_cb(void *ctx, int level, int global,
255 const char *txt, size_t len)
257 struct wpa_supplicant *wpa_s = ctx;
262 if (global != 2 && wpa_s->global->ctrl_iface) {
263 struct ctrl_iface_global_priv *priv = wpa_s->global->ctrl_iface;
264 if (!dl_list_empty(&priv->ctrl_dst)) {
265 wpa_supplicant_ctrl_iface_send(global ? NULL :
273 if (wpa_s->ctrl_iface == NULL)
275 wpa_supplicant_ctrl_iface_send(NULL, wpa_s->ctrl_iface->sock,
276 &wpa_s->ctrl_iface->ctrl_dst,
281 struct ctrl_iface_priv *
282 wpa_supplicant_ctrl_iface_init(struct wpa_supplicant *wpa_s)
284 struct ctrl_iface_priv *priv;
285 struct sockaddr_un addr;
289 char *buf, *dir = NULL, *gid_str = NULL;
294 priv = os_zalloc(sizeof(*priv));
297 dl_list_init(&priv->ctrl_dst);
301 if (wpa_s->conf->ctrl_interface == NULL)
304 buf = os_strdup(wpa_s->conf->ctrl_interface);
308 os_snprintf(addr.sun_path, sizeof(addr.sun_path), "wpa_%s",
309 wpa_s->conf->ctrl_interface);
310 priv->sock = android_get_control_socket(addr.sun_path);
314 if (os_strncmp(buf, "DIR=", 4) == 0) {
316 gid_str = os_strstr(dir, " GROUP=");
323 gid_str = wpa_s->conf->ctrl_interface_group;
326 if (mkdir(dir, S_IRWXU | S_IRWXG) < 0) {
327 if (errno == EEXIST) {
328 wpa_printf(MSG_DEBUG, "Using existing control "
329 "interface directory.");
331 wpa_printf(MSG_ERROR, "mkdir[ctrl_interface=%s]: %s",
332 dir, strerror(errno));
339 * wpa_supplicant is started from /init.*.rc on Android and that seems
340 * to be using umask 0077 which would leave the control interface
341 * directory without group access. This breaks things since Wi-Fi
342 * framework assumes that this directory can be accessed by other
343 * applications in the wifi group. Fix this by adding group access even
344 * if umask value would prevent this.
346 if (chmod(dir, S_IRWXU | S_IRWXG) < 0) {
347 wpa_printf(MSG_ERROR, "CTRL: Could not chmod directory: %s",
349 /* Try to continue anyway */
354 grp = getgrnam(gid_str);
358 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d"
359 " (from group name '%s')",
362 /* Group name not found - try to parse this as gid */
363 gid = strtol(gid_str, &endp, 10);
364 if (*gid_str == '\0' || *endp != '\0') {
365 wpa_printf(MSG_ERROR, "CTRL: Invalid group "
370 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d",
375 if (gid_set && chown(dir, -1, gid) < 0) {
376 wpa_printf(MSG_ERROR, "chown[ctrl_interface=%s,gid=%d]: %s",
377 dir, (int) gid, strerror(errno));
381 /* Make sure the group can enter and read the directory */
383 chmod(dir, S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP) < 0) {
384 wpa_printf(MSG_ERROR, "CTRL: chmod[ctrl_interface]: %s",
389 if (os_strlen(dir) + 1 + os_strlen(wpa_s->ifname) >=
390 sizeof(addr.sun_path)) {
391 wpa_printf(MSG_ERROR, "ctrl_iface path limit exceeded");
395 priv->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
396 if (priv->sock < 0) {
397 wpa_printf(MSG_ERROR, "socket(PF_UNIX): %s", strerror(errno));
401 os_memset(&addr, 0, sizeof(addr));
402 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
403 addr.sun_len = sizeof(addr);
404 #endif /* __FreeBSD__ */
405 addr.sun_family = AF_UNIX;
406 fname = wpa_supplicant_ctrl_iface_path(wpa_s);
409 os_strlcpy(addr.sun_path, fname, sizeof(addr.sun_path));
410 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
411 wpa_printf(MSG_DEBUG, "ctrl_iface bind(PF_UNIX) failed: %s",
413 if (connect(priv->sock, (struct sockaddr *) &addr,
415 wpa_printf(MSG_DEBUG, "ctrl_iface exists, but does not"
416 " allow connections - assuming it was left"
417 "over from forced program termination");
418 if (unlink(fname) < 0) {
419 wpa_printf(MSG_ERROR,
420 "Could not unlink existing ctrl_iface socket '%s': %s",
421 fname, strerror(errno));
424 if (bind(priv->sock, (struct sockaddr *) &addr,
426 wpa_printf(MSG_ERROR, "supp-ctrl-iface-init: bind(PF_UNIX): %s",
430 wpa_printf(MSG_DEBUG, "Successfully replaced leftover "
431 "ctrl_iface socket '%s'", fname);
433 wpa_printf(MSG_INFO, "ctrl_iface exists and seems to "
434 "be in use - cannot override it");
435 wpa_printf(MSG_INFO, "Delete '%s' manually if it is "
436 "not used anymore", fname);
443 if (gid_set && chown(fname, -1, gid) < 0) {
444 wpa_printf(MSG_ERROR, "chown[ctrl_interface=%s,gid=%d]: %s",
445 fname, (int) gid, strerror(errno));
449 if (chmod(fname, S_IRWXU | S_IRWXG) < 0) {
450 wpa_printf(MSG_ERROR, "chmod[ctrl_interface=%s]: %s",
451 fname, strerror(errno));
461 * Make socket non-blocking so that we don't hang forever if
462 * target dies unexpectedly.
464 flags = fcntl(priv->sock, F_GETFL);
467 if (fcntl(priv->sock, F_SETFL, flags) < 0) {
468 wpa_printf(MSG_INFO, "fcntl(ctrl, O_NONBLOCK): %s",
470 /* Not fatal, continue on.*/
474 eloop_register_read_sock(priv->sock, wpa_supplicant_ctrl_iface_receive,
476 wpa_msg_register_cb(wpa_supplicant_ctrl_iface_msg_cb);
494 void wpa_supplicant_ctrl_iface_deinit(struct ctrl_iface_priv *priv)
496 struct wpa_ctrl_dst *dst, *prev;
498 if (priv->sock > -1) {
500 char *buf, *dir = NULL, *gid_str = NULL;
501 eloop_unregister_read_sock(priv->sock);
502 if (!dl_list_empty(&priv->ctrl_dst)) {
504 * Wait before closing the control socket if
505 * there are any attached monitors in order to allow
506 * them to receive any pending messages.
508 wpa_printf(MSG_DEBUG, "CTRL_IFACE wait for attached "
509 "monitors to receive messages");
514 fname = wpa_supplicant_ctrl_iface_path(priv->wpa_s);
520 buf = os_strdup(priv->wpa_s->conf->ctrl_interface);
523 if (os_strncmp(buf, "DIR=", 4) == 0) {
525 gid_str = os_strstr(dir, " GROUP=");
533 if (rmdir(dir) < 0) {
534 if (errno == ENOTEMPTY) {
535 wpa_printf(MSG_DEBUG, "Control interface "
536 "directory not empty - leaving it "
539 wpa_printf(MSG_ERROR,
540 "rmdir[ctrl_interface=%s]: %s",
541 dir, strerror(errno));
548 dl_list_for_each_safe(dst, prev, &priv->ctrl_dst, struct wpa_ctrl_dst,
556 * wpa_supplicant_ctrl_iface_send - Send a control interface packet to monitors
557 * @ifname: Interface name for global control socket or %NULL
558 * @sock: Local socket fd
559 * @ctrl_dst: List of attached listeners
560 * @level: Priority level of the message
562 * @len: Message length
564 * Send a packet to all monitor programs attached to the control interface.
566 static void wpa_supplicant_ctrl_iface_send(const char *ifname, int sock,
567 struct dl_list *ctrl_dst,
568 int level, const char *buf,
571 struct wpa_ctrl_dst *dst, *next;
577 if (sock < 0 || dl_list_empty(ctrl_dst))
580 res = os_snprintf(levelstr, sizeof(levelstr), "<%d>", level);
581 if (res < 0 || (size_t) res >= sizeof(levelstr))
585 io[idx].iov_base = "IFNAME=";
588 io[idx].iov_base = (char *) ifname;
589 io[idx].iov_len = os_strlen(ifname);
591 io[idx].iov_base = " ";
595 io[idx].iov_base = levelstr;
596 io[idx].iov_len = os_strlen(levelstr);
598 io[idx].iov_base = (char *) buf;
599 io[idx].iov_len = len;
601 os_memset(&msg, 0, sizeof(msg));
603 msg.msg_iovlen = idx;
606 dl_list_for_each_safe(dst, next, ctrl_dst, struct wpa_ctrl_dst, list) {
607 if (level >= dst->debug_level) {
608 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor send",
609 (u8 *) dst->addr.sun_path, dst->addrlen -
610 offsetof(struct sockaddr_un, sun_path));
611 msg.msg_name = (void *) &dst->addr;
612 msg.msg_namelen = dst->addrlen;
613 if (sendmsg(sock, &msg, MSG_DONTWAIT) < 0) {
615 wpa_printf(MSG_INFO, "CTRL_IFACE monitor[%d]: "
617 idx, errno, strerror(errno));
619 if (dst->errors > 1000 ||
620 (_errno != ENOBUFS && dst->errors > 10) ||
622 wpa_supplicant_ctrl_iface_detach(
623 ctrl_dst, &dst->addr,
634 void wpa_supplicant_ctrl_iface_wait(struct ctrl_iface_priv *priv)
638 struct sockaddr_un from;
639 socklen_t fromlen = sizeof(from);
642 wpa_printf(MSG_DEBUG, "CTRL_IFACE - %s - wait for monitor to "
643 "attach", priv->wpa_s->ifname);
644 eloop_wait_for_read_sock(priv->sock);
646 res = recvfrom(priv->sock, buf, sizeof(buf) - 1, 0,
647 (struct sockaddr *) &from, &fromlen);
649 wpa_printf(MSG_ERROR, "recvfrom(ctrl_iface): %s",
655 if (os_strcmp(buf, "ATTACH") == 0) {
656 /* handle ATTACH signal of first monitor interface */
657 if (!wpa_supplicant_ctrl_iface_attach(&priv->ctrl_dst,
659 sendto(priv->sock, "OK\n", 3, 0,
660 (struct sockaddr *) &from, fromlen);
664 sendto(priv->sock, "FAIL\n", 5, 0,
665 (struct sockaddr *) &from, fromlen);
668 /* return FAIL for all other signals */
669 sendto(priv->sock, "FAIL\n", 5, 0,
670 (struct sockaddr *) &from, fromlen);
676 /* Global ctrl_iface */
678 static void wpa_supplicant_global_ctrl_iface_receive(int sock, void *eloop_ctx,
681 struct wpa_global *global = eloop_ctx;
682 struct ctrl_iface_global_priv *priv = sock_ctx;
685 struct sockaddr_un from;
686 socklen_t fromlen = sizeof(from);
690 res = recvfrom(sock, buf, sizeof(buf) - 1, 0,
691 (struct sockaddr *) &from, &fromlen);
693 wpa_printf(MSG_ERROR, "recvfrom(ctrl_iface): %s",
699 if (os_strcmp(buf, "ATTACH") == 0) {
700 if (wpa_supplicant_ctrl_iface_attach(&priv->ctrl_dst, &from,
705 } else if (os_strcmp(buf, "DETACH") == 0) {
706 if (wpa_supplicant_ctrl_iface_detach(&priv->ctrl_dst, &from,
712 reply = wpa_supplicant_global_ctrl_iface_process(global, buf,
717 sendto(sock, reply, reply_len, 0, (struct sockaddr *) &from,
720 } else if (reply_len == 1) {
721 sendto(sock, "FAIL\n", 5, 0, (struct sockaddr *) &from,
723 } else if (reply_len == 2) {
724 sendto(sock, "OK\n", 3, 0, (struct sockaddr *) &from, fromlen);
729 struct ctrl_iface_global_priv *
730 wpa_supplicant_global_ctrl_iface_init(struct wpa_global *global)
732 struct ctrl_iface_global_priv *priv;
733 struct sockaddr_un addr;
734 const char *ctrl = global->params.ctrl_interface;
737 priv = os_zalloc(sizeof(*priv));
740 dl_list_init(&priv->ctrl_dst);
741 priv->global = global;
747 wpa_printf(MSG_DEBUG, "Global control interface '%s'", ctrl);
750 if (os_strncmp(ctrl, "@android:", 9) == 0) {
751 priv->sock = android_get_control_socket(ctrl + 9);
752 if (priv->sock < 0) {
753 wpa_printf(MSG_ERROR, "Failed to open Android control "
754 "socket '%s'", ctrl + 9);
757 wpa_printf(MSG_DEBUG, "Using Android control socket '%s'",
762 if (os_strncmp(ctrl, "@abstract:", 10) != 0) {
764 * Backwards compatibility - try to open an Android control
765 * socket and if that fails, assume this was a UNIX domain
768 priv->sock = android_get_control_socket(ctrl);
769 if (priv->sock >= 0) {
770 wpa_printf(MSG_DEBUG,
771 "Using Android control socket '%s'",
778 priv->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
779 if (priv->sock < 0) {
780 wpa_printf(MSG_ERROR, "socket(PF_UNIX): %s", strerror(errno));
784 os_memset(&addr, 0, sizeof(addr));
785 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
786 addr.sun_len = sizeof(addr);
787 #endif /* __FreeBSD__ */
788 addr.sun_family = AF_UNIX;
790 if (os_strncmp(ctrl, "@abstract:", 10) == 0) {
791 addr.sun_path[0] = '\0';
792 os_strlcpy(addr.sun_path + 1, ctrl + 10,
793 sizeof(addr.sun_path) - 1);
794 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) <
796 wpa_printf(MSG_ERROR, "supp-global-ctrl-iface-init: "
797 "bind(PF_UNIX;%s) failed: %s",
798 ctrl, strerror(errno));
801 wpa_printf(MSG_DEBUG, "Using Abstract control socket '%s'",
806 os_strlcpy(addr.sun_path, ctrl, sizeof(addr.sun_path));
807 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
808 wpa_printf(MSG_INFO, "supp-global-ctrl-iface-init(%s) (will try fixup): bind(PF_UNIX): %s",
809 ctrl, strerror(errno));
810 if (connect(priv->sock, (struct sockaddr *) &addr,
812 wpa_printf(MSG_DEBUG, "ctrl_iface exists, but does not"
813 " allow connections - assuming it was left"
814 "over from forced program termination");
815 if (unlink(ctrl) < 0) {
816 wpa_printf(MSG_ERROR,
817 "Could not unlink existing ctrl_iface socket '%s': %s",
818 ctrl, strerror(errno));
821 if (bind(priv->sock, (struct sockaddr *) &addr,
823 wpa_printf(MSG_ERROR, "supp-glb-iface-init: bind(PF_UNIX;%s): %s",
824 ctrl, strerror(errno));
827 wpa_printf(MSG_DEBUG, "Successfully replaced leftover "
828 "ctrl_iface socket '%s'",
831 wpa_printf(MSG_INFO, "ctrl_iface exists and seems to "
832 "be in use - cannot override it");
833 wpa_printf(MSG_INFO, "Delete '%s' manually if it is "
840 wpa_printf(MSG_DEBUG, "Using UNIX control socket '%s'", ctrl);
842 if (global->params.ctrl_interface_group) {
843 char *gid_str = global->params.ctrl_interface_group;
848 grp = getgrnam(gid_str);
851 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d"
852 " (from group name '%s')",
855 /* Group name not found - try to parse this as gid */
856 gid = strtol(gid_str, &endp, 10);
857 if (*gid_str == '\0' || *endp != '\0') {
858 wpa_printf(MSG_ERROR, "CTRL: Invalid group "
862 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d",
865 if (chown(ctrl, -1, gid) < 0) {
866 wpa_printf(MSG_ERROR,
867 "chown[global_ctrl_interface=%s,gid=%d]: %s",
868 ctrl, (int) gid, strerror(errno));
872 if (chmod(ctrl, S_IRWXU | S_IRWXG) < 0) {
873 wpa_printf(MSG_ERROR,
874 "chmod[global_ctrl_interface=%s]: %s",
875 ctrl, strerror(errno));
879 chmod(ctrl, S_IRWXU);
885 * Make socket non-blocking so that we don't hang forever if
886 * target dies unexpectedly.
888 flags = fcntl(priv->sock, F_GETFL);
891 if (fcntl(priv->sock, F_SETFL, flags) < 0) {
892 wpa_printf(MSG_INFO, "fcntl(ctrl, O_NONBLOCK): %s",
894 /* Not fatal, continue on.*/
898 eloop_register_read_sock(priv->sock,
899 wpa_supplicant_global_ctrl_iface_receive,
913 wpa_supplicant_global_ctrl_iface_deinit(struct ctrl_iface_global_priv *priv)
915 struct wpa_ctrl_dst *dst, *prev;
917 if (priv->sock >= 0) {
918 eloop_unregister_read_sock(priv->sock);
921 if (priv->global->params.ctrl_interface)
922 unlink(priv->global->params.ctrl_interface);
923 dl_list_for_each_safe(dst, prev, &priv->ctrl_dst, struct wpa_ctrl_dst,