2 * WPA Supplicant / UNIX domain socket -based control interface
3 * Copyright (c) 2004-2005, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
21 #include <cutils/sockets.h>
27 #include "eapol_supp/eapol_supp_sm.h"
28 #include "wpa_supplicant_i.h"
29 #include "ctrl_iface.h"
31 /* Per-interface ctrl_iface */
34 * struct wpa_ctrl_dst - Internal data structure of control interface monitors
36 * This structure is used to store information about registered control
37 * interface monitors into struct wpa_supplicant. This data is private to
38 * ctrl_iface_unix.c and should not be touched directly from other files.
41 struct wpa_ctrl_dst *next;
42 struct sockaddr_un addr;
49 struct ctrl_iface_priv {
50 struct wpa_supplicant *wpa_s;
52 struct wpa_ctrl_dst *ctrl_dst;
56 static void wpa_supplicant_ctrl_iface_send(struct ctrl_iface_priv *priv,
57 int level, const char *buf,
61 static int wpa_supplicant_ctrl_iface_attach(struct ctrl_iface_priv *priv,
62 struct sockaddr_un *from,
65 struct wpa_ctrl_dst *dst;
67 dst = os_zalloc(sizeof(*dst));
70 os_memcpy(&dst->addr, from, sizeof(struct sockaddr_un));
71 dst->addrlen = fromlen;
72 dst->debug_level = MSG_INFO;
73 dst->next = priv->ctrl_dst;
75 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor attached",
76 (u8 *) from->sun_path,
77 fromlen - offsetof(struct sockaddr_un, sun_path));
82 static int wpa_supplicant_ctrl_iface_detach(struct ctrl_iface_priv *priv,
83 struct sockaddr_un *from,
86 struct wpa_ctrl_dst *dst, *prev = NULL;
90 if (fromlen == dst->addrlen &&
91 os_memcmp(from->sun_path, dst->addr.sun_path,
92 fromlen - offsetof(struct sockaddr_un, sun_path))
95 priv->ctrl_dst = dst->next;
97 prev->next = dst->next;
99 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor detached",
100 (u8 *) from->sun_path,
102 offsetof(struct sockaddr_un, sun_path));
112 static int wpa_supplicant_ctrl_iface_level(struct ctrl_iface_priv *priv,
113 struct sockaddr_un *from,
117 struct wpa_ctrl_dst *dst;
119 wpa_printf(MSG_DEBUG, "CTRL_IFACE LEVEL %s", level);
121 dst = priv->ctrl_dst;
123 if (fromlen == dst->addrlen &&
124 os_memcmp(from->sun_path, dst->addr.sun_path,
125 fromlen - offsetof(struct sockaddr_un, sun_path))
127 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE changed monitor "
128 "level", (u8 *) from->sun_path,
130 offsetof(struct sockaddr_un, sun_path));
131 dst->debug_level = atoi(level);
141 static void wpa_supplicant_ctrl_iface_receive(int sock, void *eloop_ctx,
144 struct wpa_supplicant *wpa_s = eloop_ctx;
145 struct ctrl_iface_priv *priv = sock_ctx;
148 struct sockaddr_un from;
149 socklen_t fromlen = sizeof(from);
151 size_t reply_len = 0;
152 int new_attached = 0;
154 res = recvfrom(sock, buf, sizeof(buf) - 1, 0,
155 (struct sockaddr *) &from, &fromlen);
157 perror("recvfrom(ctrl_iface)");
162 if (os_strcmp(buf, "ATTACH") == 0) {
163 if (wpa_supplicant_ctrl_iface_attach(priv, &from, fromlen))
169 } else if (os_strcmp(buf, "DETACH") == 0) {
170 if (wpa_supplicant_ctrl_iface_detach(priv, &from, fromlen))
174 } else if (os_strncmp(buf, "LEVEL ", 6) == 0) {
175 if (wpa_supplicant_ctrl_iface_level(priv, &from, fromlen,
181 reply = wpa_supplicant_ctrl_iface_process(wpa_s, buf,
186 sendto(sock, reply, reply_len, 0, (struct sockaddr *) &from,
189 } else if (reply_len == 1) {
190 sendto(sock, "FAIL\n", 5, 0, (struct sockaddr *) &from,
192 } else if (reply_len == 2) {
193 sendto(sock, "OK\n", 3, 0, (struct sockaddr *) &from,
198 eapol_sm_notify_ctrl_attached(wpa_s->eapol);
202 static char * wpa_supplicant_ctrl_iface_path(struct wpa_supplicant *wpa_s)
206 char *pbuf, *dir = NULL, *gid_str = NULL;
209 if (wpa_s->conf->ctrl_interface == NULL)
212 pbuf = os_strdup(wpa_s->conf->ctrl_interface);
215 if (os_strncmp(pbuf, "DIR=", 4) == 0) {
217 gid_str = os_strstr(dir, " GROUP=");
225 len = os_strlen(dir) + os_strlen(wpa_s->ifname) + 2;
226 buf = os_malloc(len);
232 res = os_snprintf(buf, len, "%s/%s", dir, wpa_s->ifname);
233 if (res < 0 || (size_t) res >= len) {
240 /* Windows/WinPcap uses interface names that are not suitable
241 * as a file name - convert invalid chars to underscores */
249 #endif /* __CYGWIN__ */
255 static void wpa_supplicant_ctrl_iface_msg_cb(void *ctx, int level,
256 const char *txt, size_t len)
258 struct wpa_supplicant *wpa_s = ctx;
259 if (wpa_s == NULL || wpa_s->ctrl_iface == NULL)
261 wpa_supplicant_ctrl_iface_send(wpa_s->ctrl_iface, level, txt, len);
265 struct ctrl_iface_priv *
266 wpa_supplicant_ctrl_iface_init(struct wpa_supplicant *wpa_s)
268 struct ctrl_iface_priv *priv;
269 struct sockaddr_un addr;
273 char *buf, *dir = NULL, *gid_str = NULL;
277 priv = os_zalloc(sizeof(*priv));
283 if (wpa_s->conf->ctrl_interface == NULL)
286 buf = os_strdup(wpa_s->conf->ctrl_interface);
290 os_snprintf(addr.sun_path, sizeof(addr.sun_path), "wpa_%s",
291 wpa_s->conf->ctrl_interface);
292 priv->sock = android_get_control_socket(addr.sun_path);
296 if (os_strncmp(buf, "DIR=", 4) == 0) {
298 gid_str = os_strstr(dir, " GROUP=");
305 gid_str = wpa_s->conf->ctrl_interface_group;
308 if (mkdir(dir, S_IRWXU | S_IRWXG) < 0) {
309 if (errno == EEXIST) {
310 wpa_printf(MSG_DEBUG, "Using existing control "
311 "interface directory.");
313 perror("mkdir[ctrl_interface]");
319 grp = getgrnam(gid_str);
323 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d"
324 " (from group name '%s')",
327 /* Group name not found - try to parse this as gid */
328 gid = strtol(gid_str, &endp, 10);
329 if (*gid_str == '\0' || *endp != '\0') {
330 wpa_printf(MSG_ERROR, "CTRL: Invalid group "
335 wpa_printf(MSG_DEBUG, "ctrl_interface_group=%d",
340 if (gid_set && chown(dir, -1, gid) < 0) {
341 perror("chown[ctrl_interface]");
345 if (os_strlen(dir) + 1 + os_strlen(wpa_s->ifname) >=
346 sizeof(addr.sun_path)) {
347 wpa_printf(MSG_ERROR, "ctrl_iface path limit exceeded");
351 priv->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
352 if (priv->sock < 0) {
353 perror("socket(PF_UNIX)");
357 os_memset(&addr, 0, sizeof(addr));
359 addr.sun_len = sizeof(addr);
360 #endif /* __FreeBSD__ */
361 addr.sun_family = AF_UNIX;
362 fname = wpa_supplicant_ctrl_iface_path(wpa_s);
365 os_strlcpy(addr.sun_path, fname, sizeof(addr.sun_path));
366 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
367 wpa_printf(MSG_DEBUG, "ctrl_iface bind(PF_UNIX) failed: %s",
369 if (connect(priv->sock, (struct sockaddr *) &addr,
371 wpa_printf(MSG_DEBUG, "ctrl_iface exists, but does not"
372 " allow connections - assuming it was left"
373 "over from forced program termination");
374 if (unlink(fname) < 0) {
375 perror("unlink[ctrl_iface]");
376 wpa_printf(MSG_ERROR, "Could not unlink "
377 "existing ctrl_iface socket '%s'",
381 if (bind(priv->sock, (struct sockaddr *) &addr,
383 perror("bind(PF_UNIX)");
386 wpa_printf(MSG_DEBUG, "Successfully replaced leftover "
387 "ctrl_iface socket '%s'", fname);
389 wpa_printf(MSG_INFO, "ctrl_iface exists and seems to "
390 "be in use - cannot override it");
391 wpa_printf(MSG_INFO, "Delete '%s' manually if it is "
392 "not used anymore", fname);
399 if (gid_set && chown(fname, -1, gid) < 0) {
400 perror("chown[ctrl_interface/ifname]");
404 if (chmod(fname, S_IRWXU | S_IRWXG) < 0) {
405 perror("chmod[ctrl_interface/ifname]");
411 eloop_register_read_sock(priv->sock, wpa_supplicant_ctrl_iface_receive,
413 wpa_msg_register_cb(wpa_supplicant_ctrl_iface_msg_cb);
431 void wpa_supplicant_ctrl_iface_deinit(struct ctrl_iface_priv *priv)
433 struct wpa_ctrl_dst *dst, *prev;
435 if (priv->sock > -1) {
437 char *buf, *dir = NULL, *gid_str = NULL;
438 eloop_unregister_read_sock(priv->sock);
439 if (priv->ctrl_dst) {
441 * Wait a second before closing the control socket if
442 * there are any attached monitors in order to allow
443 * them to receive any pending messages.
445 wpa_printf(MSG_DEBUG, "CTRL_IFACE wait for attached "
446 "monitors to receive messages");
451 fname = wpa_supplicant_ctrl_iface_path(priv->wpa_s);
457 buf = os_strdup(priv->wpa_s->conf->ctrl_interface);
460 if (os_strncmp(buf, "DIR=", 4) == 0) {
462 gid_str = os_strstr(dir, " GROUP=");
470 if (rmdir(dir) < 0) {
471 if (errno == ENOTEMPTY) {
472 wpa_printf(MSG_DEBUG, "Control interface "
473 "directory not empty - leaving it "
476 perror("rmdir[ctrl_interface]");
483 dst = priv->ctrl_dst;
494 * wpa_supplicant_ctrl_iface_send - Send a control interface packet to monitors
495 * @priv: Pointer to private data from wpa_supplicant_ctrl_iface_init()
496 * @level: Priority level of the message
498 * @len: Message length
500 * Send a packet to all monitor programs attached to the control interface.
502 static void wpa_supplicant_ctrl_iface_send(struct ctrl_iface_priv *priv,
503 int level, const char *buf,
506 struct wpa_ctrl_dst *dst, *next;
512 dst = priv->ctrl_dst;
513 if (priv->sock < 0 || dst == NULL)
516 res = os_snprintf(levelstr, sizeof(levelstr), "<%d>", level);
517 if (res < 0 || (size_t) res >= sizeof(levelstr))
519 io[0].iov_base = levelstr;
520 io[0].iov_len = os_strlen(levelstr);
521 io[1].iov_base = (char *) buf;
523 os_memset(&msg, 0, sizeof(msg));
530 if (level >= dst->debug_level) {
531 wpa_hexdump(MSG_DEBUG, "CTRL_IFACE monitor send",
532 (u8 *) dst->addr.sun_path, dst->addrlen -
533 offsetof(struct sockaddr_un, sun_path));
534 msg.msg_name = (void *) &dst->addr;
535 msg.msg_namelen = dst->addrlen;
536 if (sendmsg(priv->sock, &msg, 0) < 0) {
538 wpa_printf(MSG_INFO, "CTRL_IFACE monitor[%d]: "
540 idx, errno, strerror(errno));
542 if (dst->errors > 10 || _errno == ENOENT) {
543 wpa_supplicant_ctrl_iface_detach(
556 void wpa_supplicant_ctrl_iface_wait(struct ctrl_iface_priv *priv)
560 struct sockaddr_un from;
561 socklen_t fromlen = sizeof(from);
564 wpa_printf(MSG_DEBUG, "CTRL_IFACE - %s - wait for monitor to "
565 "attach", priv->wpa_s->ifname);
566 eloop_wait_for_read_sock(priv->sock);
568 res = recvfrom(priv->sock, buf, sizeof(buf) - 1, 0,
569 (struct sockaddr *) &from, &fromlen);
571 perror("recvfrom(ctrl_iface)");
576 if (os_strcmp(buf, "ATTACH") == 0) {
577 /* handle ATTACH signal of first monitor interface */
578 if (!wpa_supplicant_ctrl_iface_attach(priv, &from,
580 sendto(priv->sock, "OK\n", 3, 0,
581 (struct sockaddr *) &from, fromlen);
585 sendto(priv->sock, "FAIL\n", 5, 0,
586 (struct sockaddr *) &from, fromlen);
589 /* return FAIL for all other signals */
590 sendto(priv->sock, "FAIL\n", 5, 0,
591 (struct sockaddr *) &from, fromlen);
597 /* Global ctrl_iface */
599 struct ctrl_iface_global_priv {
600 struct wpa_global *global;
605 static void wpa_supplicant_global_ctrl_iface_receive(int sock, void *eloop_ctx,
608 struct wpa_global *global = eloop_ctx;
611 struct sockaddr_un from;
612 socklen_t fromlen = sizeof(from);
616 res = recvfrom(sock, buf, sizeof(buf) - 1, 0,
617 (struct sockaddr *) &from, &fromlen);
619 perror("recvfrom(ctrl_iface)");
624 reply = wpa_supplicant_global_ctrl_iface_process(global, buf,
628 sendto(sock, reply, reply_len, 0, (struct sockaddr *) &from,
631 } else if (reply_len) {
632 sendto(sock, "FAIL\n", 5, 0, (struct sockaddr *) &from,
638 struct ctrl_iface_global_priv *
639 wpa_supplicant_global_ctrl_iface_init(struct wpa_global *global)
641 struct ctrl_iface_global_priv *priv;
642 struct sockaddr_un addr;
644 priv = os_zalloc(sizeof(*priv));
647 priv->global = global;
650 if (global->params.ctrl_interface == NULL)
654 priv->sock = android_get_control_socket(global->params.ctrl_interface);
659 wpa_printf(MSG_DEBUG, "Global control interface '%s'",
660 global->params.ctrl_interface);
662 priv->sock = socket(PF_UNIX, SOCK_DGRAM, 0);
663 if (priv->sock < 0) {
664 perror("socket(PF_UNIX)");
668 os_memset(&addr, 0, sizeof(addr));
670 addr.sun_len = sizeof(addr);
671 #endif /* __FreeBSD__ */
672 addr.sun_family = AF_UNIX;
673 os_strlcpy(addr.sun_path, global->params.ctrl_interface,
674 sizeof(addr.sun_path));
675 if (bind(priv->sock, (struct sockaddr *) &addr, sizeof(addr)) < 0) {
676 perror("bind(PF_UNIX)");
677 if (connect(priv->sock, (struct sockaddr *) &addr,
679 wpa_printf(MSG_DEBUG, "ctrl_iface exists, but does not"
680 " allow connections - assuming it was left"
681 "over from forced program termination");
682 if (unlink(global->params.ctrl_interface) < 0) {
683 perror("unlink[ctrl_iface]");
684 wpa_printf(MSG_ERROR, "Could not unlink "
685 "existing ctrl_iface socket '%s'",
686 global->params.ctrl_interface);
689 if (bind(priv->sock, (struct sockaddr *) &addr,
691 perror("bind(PF_UNIX)");
694 wpa_printf(MSG_DEBUG, "Successfully replaced leftover "
695 "ctrl_iface socket '%s'",
696 global->params.ctrl_interface);
698 wpa_printf(MSG_INFO, "ctrl_iface exists and seems to "
699 "be in use - cannot override it");
700 wpa_printf(MSG_INFO, "Delete '%s' manually if it is "
702 global->params.ctrl_interface);
708 eloop_register_read_sock(priv->sock,
709 wpa_supplicant_global_ctrl_iface_receive,
723 wpa_supplicant_global_ctrl_iface_deinit(struct ctrl_iface_global_priv *priv)
725 if (priv->sock >= 0) {
726 eloop_unregister_read_sock(priv->sock);
729 if (priv->global->params.ctrl_interface)
730 unlink(priv->global->params.ctrl_interface);