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_malloc(sizeof(*ctrl));
100 os_memset(ctrl, 0, sizeof(*ctrl));
102 ctrl->s = socket(PF_UNIX, SOCK_DGRAM, 0);
108 ctrl->local.sun_family = AF_UNIX;
111 ret = os_snprintf(ctrl->local.sun_path, sizeof(ctrl->local.sun_path),
112 CONFIG_CTRL_IFACE_CLIENT_DIR "/"
113 CONFIG_CTRL_IFACE_CLIENT_PREFIX "%d-%d",
114 (int) getpid(), counter);
115 if (ret < 0 || (size_t) ret >= sizeof(ctrl->local.sun_path)) {
121 if (bind(ctrl->s, (struct sockaddr *) &ctrl->local,
122 sizeof(ctrl->local)) < 0) {
123 if (errno == EADDRINUSE && tries < 2) {
125 * getpid() returns unique identifier for this instance
126 * of wpa_ctrl, so the existing socket file must have
127 * been left by unclean termination of an earlier run.
128 * Remove the file and try again.
130 unlink(ctrl->local.sun_path);
139 chmod(ctrl->local.sun_path, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
140 chown(ctrl->local.sun_path, AID_SYSTEM, AID_WIFI);
142 if (os_strncmp(ctrl_path, "@android:", 9) == 0) {
143 if (socket_local_client_connect(
144 ctrl->s, ctrl_path + 9,
145 ANDROID_SOCKET_NAMESPACE_RESERVED,
148 unlink(ctrl->local.sun_path);
156 * If the ctrl_path isn't an absolute pathname, assume that
157 * it's the name of a socket in the Android reserved namespace.
158 * Otherwise, it's a normal UNIX domain socket appearing in the
161 if (*ctrl_path != '/') {
163 os_snprintf(buf, sizeof(buf), "wpa_%s", ctrl_path);
164 if (socket_local_client_connect(
166 ANDROID_SOCKET_NAMESPACE_RESERVED,
169 unlink(ctrl->local.sun_path);
177 ctrl->dest.sun_family = AF_UNIX;
178 if (os_strncmp(ctrl_path, "@abstract:", 10) == 0) {
179 ctrl->dest.sun_path[0] = '\0';
180 os_strlcpy(ctrl->dest.sun_path + 1, ctrl_path + 10,
181 sizeof(ctrl->dest.sun_path) - 1);
183 res = os_strlcpy(ctrl->dest.sun_path, ctrl_path,
184 sizeof(ctrl->dest.sun_path));
185 if (res >= sizeof(ctrl->dest.sun_path)) {
191 if (connect(ctrl->s, (struct sockaddr *) &ctrl->dest,
192 sizeof(ctrl->dest)) < 0) {
194 unlink(ctrl->local.sun_path);
200 * Make socket non-blocking so that we don't hang forever if
201 * target dies unexpectedly.
203 flags = fcntl(ctrl->s, F_GETFL);
206 if (fcntl(ctrl->s, F_SETFL, flags) < 0) {
207 perror("fcntl(ctrl->s, O_NONBLOCK)");
208 /* Not fatal, continue on.*/
216 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
220 unlink(ctrl->local.sun_path);
229 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
230 * may be left over from clients that were previously connected to
231 * wpa_supplicant. This keeps these files from being orphaned in the
232 * event of crashes that prevented them from being removed as part
233 * of the normal orderly shutdown.
235 void wpa_ctrl_cleanup(void)
239 struct dirent *result;
242 char pathname[PATH_MAX];
245 if ((dir = opendir(CONFIG_CTRL_IFACE_CLIENT_DIR)) == NULL)
248 dirnamelen = (size_t) os_snprintf(pathname, sizeof(pathname), "%s/",
249 CONFIG_CTRL_IFACE_CLIENT_DIR);
250 if (dirnamelen >= sizeof(pathname)) {
254 namep = pathname + dirnamelen;
255 maxcopy = PATH_MAX - dirnamelen;
256 while (readdir_r(dir, &entry, &result) == 0 && result != NULL) {
257 if (os_strlcpy(namep, entry.d_name, maxcopy) < maxcopy)
264 #else /* CONFIG_CTRL_IFACE_UNIX */
267 void wpa_ctrl_cleanup(void)
272 #endif /* CONFIG_CTRL_IFACE_UNIX */
275 #ifdef CONFIG_CTRL_IFACE_UDP
277 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
279 struct wpa_ctrl *ctrl;
282 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
284 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
286 ctrl = os_malloc(sizeof(*ctrl));
289 os_memset(ctrl, 0, sizeof(*ctrl));
291 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
292 ctrl->s = socket(PF_INET6, SOCK_DGRAM, 0);
293 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
294 ctrl->s = socket(PF_INET, SOCK_DGRAM, 0);
295 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
302 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
303 ctrl->local.sin6_family = AF_INET6;
304 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
305 ctrl->local.sin6_addr = in6addr_any;
306 #else /* CONFIG_CTRL_IFACE_UDP_REMOTE */
307 inet_pton(AF_INET6, "::1", &ctrl->local.sin6_addr);
308 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
309 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
310 ctrl->local.sin_family = AF_INET;
311 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
312 ctrl->local.sin_addr.s_addr = INADDR_ANY;
313 #else /* CONFIG_CTRL_IFACE_UDP_REMOTE */
314 ctrl->local.sin_addr.s_addr = htonl((127 << 24) | 1);
315 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
316 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
318 if (bind(ctrl->s, (struct sockaddr *) &ctrl->local,
319 sizeof(ctrl->local)) < 0) {
325 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
326 ctrl->dest.sin6_family = AF_INET6;
327 inet_pton(AF_INET6, "::1", &ctrl->dest.sin6_addr);
328 ctrl->dest.sin6_port = htons(WPA_CTRL_IFACE_PORT);
329 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
330 ctrl->dest.sin_family = AF_INET;
331 ctrl->dest.sin_addr.s_addr = htonl((127 << 24) | 1);
332 ctrl->dest.sin_port = htons(WPA_CTRL_IFACE_PORT);
333 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
335 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
339 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
342 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
344 name = os_strdup(ctrl_path);
350 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
351 port = os_strchr(name, ',');
352 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
353 port = os_strchr(name, ':');
354 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
357 port_id = atoi(&port[1]);
360 port_id = WPA_CTRL_IFACE_PORT;
362 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
363 scope = os_strchr(name, '%');
365 scope_id = if_nametoindex(&scope[1]);
368 h = gethostbyname2(name, AF_INET6);
369 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
370 h = gethostbyname(name);
371 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
372 ctrl->remote_ip = os_strdup(name);
375 perror("gethostbyname");
377 os_free(ctrl->remote_ip);
381 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
382 ctrl->dest.sin6_scope_id = scope_id;
383 ctrl->dest.sin6_port = htons(port_id);
384 os_memcpy(&ctrl->dest.sin6_addr, h->h_addr, h->h_length);
385 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
386 ctrl->dest.sin_port = htons(port_id);
387 os_memcpy(&ctrl->dest.sin_addr.s_addr, h->h_addr, h->h_length);
388 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
390 ctrl->remote_ip = os_strdup("localhost");
391 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
393 if (connect(ctrl->s, (struct sockaddr *) &ctrl->dest,
394 sizeof(ctrl->dest)) < 0) {
395 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
396 char addr[INET6_ADDRSTRLEN];
397 wpa_printf(MSG_ERROR, "connect(%s:%d) failed: %s",
398 inet_ntop(AF_INET6, &ctrl->dest.sin6_addr, addr,
400 ntohs(ctrl->dest.sin6_port),
402 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
403 wpa_printf(MSG_ERROR, "connect(%s:%d) failed: %s",
404 inet_ntoa(ctrl->dest.sin_addr),
405 ntohs(ctrl->dest.sin_port),
407 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
409 os_free(ctrl->remote_ip);
414 len = sizeof(buf) - 1;
415 if (wpa_ctrl_request(ctrl, "GET_COOKIE", 10, buf, &len, NULL) == 0) {
417 ctrl->cookie = os_strdup(buf);
420 if (wpa_ctrl_request(ctrl, "IFNAME", 6, buf, &len, NULL) == 0) {
422 ctrl->remote_ifname = os_strdup(buf);
429 char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl)
431 #define WPA_CTRL_MAX_PS_NAME 100
432 static char ps[WPA_CTRL_MAX_PS_NAME] = {};
433 os_snprintf(ps, WPA_CTRL_MAX_PS_NAME, "%s/%s",
434 ctrl->remote_ip, ctrl->remote_ifname);
439 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
442 os_free(ctrl->cookie);
443 os_free(ctrl->remote_ifname);
444 os_free(ctrl->remote_ip);
448 #endif /* CONFIG_CTRL_IFACE_UDP */
451 #ifdef CTRL_IFACE_SOCKET
452 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
453 char *reply, size_t *reply_len,
454 void (*msg_cb)(char *msg, size_t len))
457 struct os_reltime started_at;
461 char *cmd_buf = NULL;
464 #ifdef CONFIG_CTRL_IFACE_UDP
467 _cmd_len = os_strlen(ctrl->cookie) + 1 + cmd_len;
468 cmd_buf = os_malloc(_cmd_len);
473 os_strlcpy(pos, ctrl->cookie, _cmd_len);
474 pos += os_strlen(ctrl->cookie);
476 os_memcpy(pos, cmd, cmd_len);
478 #endif /* CONFIG_CTRL_IFACE_UDP */
488 if (send(ctrl->s, _cmd, _cmd_len, 0) < 0) {
489 if (errno == EAGAIN || errno == EBUSY || errno == EWOULDBLOCK)
492 * Must be a non-blocking socket... Try for a bit
493 * longer before giving up.
495 if (started_at.sec == 0)
496 os_get_reltime(&started_at);
500 /* Try for a few seconds. */
501 if (os_reltime_expired(&n, &started_at, 5))
517 FD_SET(ctrl->s, &rfds);
518 res = select(ctrl->s + 1, &rfds, NULL, NULL, &tv);
521 if (FD_ISSET(ctrl->s, &rfds)) {
522 res = recv(ctrl->s, reply, *reply_len, 0);
525 if (res > 0 && reply[0] == '<') {
526 /* This is an unsolicited message from
527 * wpa_supplicant, not the reply to the
528 * request. Use msg_cb to report this to the
531 /* Make sure the message is nul
533 if ((size_t) res == *reply_len)
534 res = (*reply_len) - 1;
548 #endif /* CTRL_IFACE_SOCKET */
551 static int wpa_ctrl_attach_helper(struct wpa_ctrl *ctrl, int attach)
557 ret = wpa_ctrl_request(ctrl, attach ? "ATTACH" : "DETACH", 6,
561 if (len == 3 && os_memcmp(buf, "OK\n", 3) == 0)
567 int wpa_ctrl_attach(struct wpa_ctrl *ctrl)
569 return wpa_ctrl_attach_helper(ctrl, 1);
573 int wpa_ctrl_detach(struct wpa_ctrl *ctrl)
575 return wpa_ctrl_attach_helper(ctrl, 0);
579 #ifdef CTRL_IFACE_SOCKET
581 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len)
585 res = recv(ctrl->s, reply, *reply_len, 0);
593 int wpa_ctrl_pending(struct wpa_ctrl *ctrl)
600 FD_SET(ctrl->s, &rfds);
601 select(ctrl->s + 1, &rfds, NULL, NULL, &tv);
602 return FD_ISSET(ctrl->s, &rfds);
606 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl)
611 #endif /* CTRL_IFACE_SOCKET */
614 #ifdef CONFIG_CTRL_IFACE_NAMED_PIPE
616 #ifndef WPA_SUPPLICANT_NAMED_PIPE
617 #define WPA_SUPPLICANT_NAMED_PIPE "WpaSupplicant"
619 #define NAMED_PIPE_PREFIX TEXT("\\\\.\\pipe\\") TEXT(WPA_SUPPLICANT_NAMED_PIPE)
621 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
623 struct wpa_ctrl *ctrl;
628 ctrl = os_malloc(sizeof(*ctrl));
631 os_memset(ctrl, 0, sizeof(*ctrl));
634 if (ctrl_path == NULL)
635 ret = _snwprintf(name, 256, NAMED_PIPE_PREFIX);
637 ret = _snwprintf(name, 256, NAMED_PIPE_PREFIX TEXT("-%S"),
640 if (ctrl_path == NULL)
641 ret = os_snprintf(name, 256, NAMED_PIPE_PREFIX);
643 ret = os_snprintf(name, 256, NAMED_PIPE_PREFIX "-%s",
646 if (ret < 0 || ret >= 256) {
651 for (i = 0; i < 10; i++) {
652 ctrl->pipe = CreateFile(name, GENERIC_READ | GENERIC_WRITE, 0,
653 NULL, OPEN_EXISTING, 0, NULL);
655 * Current named pipe server side in wpa_supplicant is
656 * re-opening the pipe for new clients only after the previous
657 * one is taken into use. This leaves a small window for race
658 * conditions when two connections are being opened at almost
659 * the same time. Retry if that was the case.
661 if (ctrl->pipe != INVALID_HANDLE_VALUE ||
662 GetLastError() != ERROR_PIPE_BUSY)
664 WaitNamedPipe(name, 1000);
666 if (ctrl->pipe == INVALID_HANDLE_VALUE) {
671 mode = PIPE_READMODE_MESSAGE;
672 if (!SetNamedPipeHandleState(ctrl->pipe, &mode, NULL, NULL)) {
673 CloseHandle(ctrl->pipe);
682 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
684 CloseHandle(ctrl->pipe);
689 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
690 char *reply, size_t *reply_len,
691 void (*msg_cb)(char *msg, size_t len))
694 DWORD readlen = *reply_len;
696 if (!WriteFile(ctrl->pipe, cmd, cmd_len, &written, NULL))
699 if (!ReadFile(ctrl->pipe, reply, *reply_len, &readlen, NULL))
701 *reply_len = readlen;
707 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len)
709 DWORD len = *reply_len;
710 if (!ReadFile(ctrl->pipe, reply, *reply_len, &len, NULL))
717 int wpa_ctrl_pending(struct wpa_ctrl *ctrl)
721 if (!PeekNamedPipe(ctrl->pipe, NULL, 0, NULL, &left, NULL))
727 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl)
732 #endif /* CONFIG_CTRL_IFACE_NAMED_PIPE */
734 #endif /* CONFIG_CTRL_IFACE */