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 */
25 #include <cutils/sockets.h>
26 #include "private/android_filesystem_config.h"
29 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
31 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
37 #if defined(CONFIG_CTRL_IFACE_UNIX) || defined(CONFIG_CTRL_IFACE_UDP)
38 #define CTRL_IFACE_SOCKET
39 #endif /* CONFIG_CTRL_IFACE_UNIX || CONFIG_CTRL_IFACE_UDP */
43 * struct wpa_ctrl - Internal structure for control interface library
45 * This structure is used by the wpa_supplicant/hostapd control interface
46 * library to store internal data. Programs using the library should not touch
47 * this data directly. They can only use the pointer to the data structure as
48 * an identifier for the control interface connection and use this as one of
49 * the arguments for most of the control interface library functions.
52 #ifdef CONFIG_CTRL_IFACE_UDP
54 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
55 struct sockaddr_in6 local;
56 struct sockaddr_in6 dest;
57 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
58 struct sockaddr_in local;
59 struct sockaddr_in dest;
60 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
64 #endif /* CONFIG_CTRL_IFACE_UDP */
65 #ifdef CONFIG_CTRL_IFACE_UNIX
67 struct sockaddr_un local;
68 struct sockaddr_un dest;
69 #endif /* CONFIG_CTRL_IFACE_UNIX */
70 #ifdef CONFIG_CTRL_IFACE_NAMED_PIPE
72 #endif /* CONFIG_CTRL_IFACE_NAMED_PIPE */
76 #ifdef CONFIG_CTRL_IFACE_UNIX
78 #ifndef CONFIG_CTRL_IFACE_CLIENT_DIR
79 #define CONFIG_CTRL_IFACE_CLIENT_DIR "/tmp"
80 #endif /* CONFIG_CTRL_IFACE_CLIENT_DIR */
81 #ifndef CONFIG_CTRL_IFACE_CLIENT_PREFIX
82 #define CONFIG_CTRL_IFACE_CLIENT_PREFIX "wpa_ctrl_"
83 #endif /* CONFIG_CTRL_IFACE_CLIENT_PREFIX */
86 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
88 return wpa_ctrl_open2(ctrl_path, NULL);
92 struct wpa_ctrl * wpa_ctrl_open2(const char *ctrl_path,
95 struct wpa_ctrl *ctrl;
96 static int counter = 0;
102 if (ctrl_path == NULL)
105 ctrl = os_zalloc(sizeof(*ctrl));
109 ctrl->s = socket(PF_UNIX, SOCK_DGRAM, 0);
115 ctrl->local.sun_family = AF_UNIX;
118 if (cli_path && cli_path[0] == '/') {
119 ret = os_snprintf(ctrl->local.sun_path,
120 sizeof(ctrl->local.sun_path),
121 "%s/" CONFIG_CTRL_IFACE_CLIENT_PREFIX "%d-%d",
122 cli_path, (int) getpid(), counter);
124 ret = os_snprintf(ctrl->local.sun_path,
125 sizeof(ctrl->local.sun_path),
126 CONFIG_CTRL_IFACE_CLIENT_DIR "/"
127 CONFIG_CTRL_IFACE_CLIENT_PREFIX "%d-%d",
128 (int) getpid(), counter);
130 if (os_snprintf_error(sizeof(ctrl->local.sun_path), ret)) {
136 if (bind(ctrl->s, (struct sockaddr *) &ctrl->local,
137 sizeof(ctrl->local)) < 0) {
138 if (errno == EADDRINUSE && tries < 2) {
140 * getpid() returns unique identifier for this instance
141 * of wpa_ctrl, so the existing socket file must have
142 * been left by unclean termination of an earlier run.
143 * Remove the file and try again.
145 unlink(ctrl->local.sun_path);
154 chmod(ctrl->local.sun_path, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
155 chown(ctrl->local.sun_path, AID_SYSTEM, AID_WIFI);
157 if (os_strncmp(ctrl_path, "@android:", 9) == 0) {
158 if (socket_local_client_connect(
159 ctrl->s, ctrl_path + 9,
160 ANDROID_SOCKET_NAMESPACE_RESERVED,
163 unlink(ctrl->local.sun_path);
171 * If the ctrl_path isn't an absolute pathname, assume that
172 * it's the name of a socket in the Android reserved namespace.
173 * Otherwise, it's a normal UNIX domain socket appearing in the
176 if (*ctrl_path != '/') {
178 os_snprintf(buf, sizeof(buf), "wpa_%s", ctrl_path);
179 if (socket_local_client_connect(
181 ANDROID_SOCKET_NAMESPACE_RESERVED,
184 unlink(ctrl->local.sun_path);
192 ctrl->dest.sun_family = AF_UNIX;
193 if (os_strncmp(ctrl_path, "@abstract:", 10) == 0) {
194 ctrl->dest.sun_path[0] = '\0';
195 os_strlcpy(ctrl->dest.sun_path + 1, ctrl_path + 10,
196 sizeof(ctrl->dest.sun_path) - 1);
198 res = os_strlcpy(ctrl->dest.sun_path, ctrl_path,
199 sizeof(ctrl->dest.sun_path));
200 if (res >= sizeof(ctrl->dest.sun_path)) {
206 if (connect(ctrl->s, (struct sockaddr *) &ctrl->dest,
207 sizeof(ctrl->dest)) < 0) {
209 unlink(ctrl->local.sun_path);
215 * Make socket non-blocking so that we don't hang forever if
216 * target dies unexpectedly.
218 flags = fcntl(ctrl->s, F_GETFL);
221 if (fcntl(ctrl->s, F_SETFL, flags) < 0) {
222 perror("fcntl(ctrl->s, O_NONBLOCK)");
223 /* Not fatal, continue on.*/
231 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
235 unlink(ctrl->local.sun_path);
244 * wpa_ctrl_cleanup() - Delete any local UNIX domain socket files that
245 * may be left over from clients that were previously connected to
246 * wpa_supplicant. This keeps these files from being orphaned in the
247 * event of crashes that prevented them from being removed as part
248 * of the normal orderly shutdown.
250 void wpa_ctrl_cleanup(void)
254 struct dirent *result;
257 char pathname[PATH_MAX];
260 if ((dir = opendir(CONFIG_CTRL_IFACE_CLIENT_DIR)) == NULL)
263 dirnamelen = (size_t) os_snprintf(pathname, sizeof(pathname), "%s/",
264 CONFIG_CTRL_IFACE_CLIENT_DIR);
265 if (dirnamelen >= sizeof(pathname)) {
269 namep = pathname + dirnamelen;
270 maxcopy = PATH_MAX - dirnamelen;
271 while (readdir_r(dir, &entry, &result) == 0 && result != NULL) {
272 if (os_strlcpy(namep, entry.d_name, maxcopy) < maxcopy)
279 #else /* CONFIG_CTRL_IFACE_UNIX */
282 void wpa_ctrl_cleanup(void)
287 #endif /* CONFIG_CTRL_IFACE_UNIX */
290 #ifdef CONFIG_CTRL_IFACE_UDP
292 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
294 struct wpa_ctrl *ctrl;
297 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
299 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
301 ctrl = os_zalloc(sizeof(*ctrl));
305 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
306 ctrl->s = socket(PF_INET6, SOCK_DGRAM, 0);
307 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
308 ctrl->s = socket(PF_INET, SOCK_DGRAM, 0);
309 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
316 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
317 ctrl->local.sin6_family = AF_INET6;
318 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
319 ctrl->local.sin6_addr = in6addr_any;
320 #else /* CONFIG_CTRL_IFACE_UDP_REMOTE */
321 inet_pton(AF_INET6, "::1", &ctrl->local.sin6_addr);
322 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
323 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
324 ctrl->local.sin_family = AF_INET;
325 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
326 ctrl->local.sin_addr.s_addr = INADDR_ANY;
327 #else /* CONFIG_CTRL_IFACE_UDP_REMOTE */
328 ctrl->local.sin_addr.s_addr = htonl((127 << 24) | 1);
329 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
330 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
332 if (bind(ctrl->s, (struct sockaddr *) &ctrl->local,
333 sizeof(ctrl->local)) < 0) {
339 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
340 ctrl->dest.sin6_family = AF_INET6;
341 inet_pton(AF_INET6, "::1", &ctrl->dest.sin6_addr);
342 ctrl->dest.sin6_port = htons(WPA_CTRL_IFACE_PORT);
343 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
344 ctrl->dest.sin_family = AF_INET;
345 ctrl->dest.sin_addr.s_addr = htonl((127 << 24) | 1);
346 ctrl->dest.sin_port = htons(WPA_CTRL_IFACE_PORT);
347 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
349 #ifdef CONFIG_CTRL_IFACE_UDP_REMOTE
353 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
356 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
358 name = os_strdup(ctrl_path);
364 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
365 port = os_strchr(name, ',');
366 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
367 port = os_strchr(name, ':');
368 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
371 port_id = atoi(&port[1]);
374 port_id = WPA_CTRL_IFACE_PORT;
376 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
377 scope = os_strchr(name, '%');
379 scope_id = if_nametoindex(&scope[1]);
382 h = gethostbyname2(name, AF_INET6);
383 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
384 h = gethostbyname(name);
385 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
386 ctrl->remote_ip = os_strdup(name);
389 perror("gethostbyname");
391 os_free(ctrl->remote_ip);
395 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
396 ctrl->dest.sin6_scope_id = scope_id;
397 ctrl->dest.sin6_port = htons(port_id);
398 os_memcpy(&ctrl->dest.sin6_addr, h->h_addr, h->h_length);
399 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
400 ctrl->dest.sin_port = htons(port_id);
401 os_memcpy(&ctrl->dest.sin_addr.s_addr, h->h_addr, h->h_length);
402 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
404 ctrl->remote_ip = os_strdup("localhost");
405 #endif /* CONFIG_CTRL_IFACE_UDP_REMOTE */
407 if (connect(ctrl->s, (struct sockaddr *) &ctrl->dest,
408 sizeof(ctrl->dest)) < 0) {
409 #ifdef CONFIG_CTRL_IFACE_UDP_IPV6
410 char addr[INET6_ADDRSTRLEN];
411 wpa_printf(MSG_ERROR, "connect(%s:%d) failed: %s",
412 inet_ntop(AF_INET6, &ctrl->dest.sin6_addr, addr,
414 ntohs(ctrl->dest.sin6_port),
416 #else /* CONFIG_CTRL_IFACE_UDP_IPV6 */
417 wpa_printf(MSG_ERROR, "connect(%s:%d) failed: %s",
418 inet_ntoa(ctrl->dest.sin_addr),
419 ntohs(ctrl->dest.sin_port),
421 #endif /* CONFIG_CTRL_IFACE_UDP_IPV6 */
423 os_free(ctrl->remote_ip);
428 len = sizeof(buf) - 1;
429 if (wpa_ctrl_request(ctrl, "GET_COOKIE", 10, buf, &len, NULL) == 0) {
431 ctrl->cookie = os_strdup(buf);
434 if (wpa_ctrl_request(ctrl, "IFNAME", 6, buf, &len, NULL) == 0) {
436 ctrl->remote_ifname = os_strdup(buf);
443 char * wpa_ctrl_get_remote_ifname(struct wpa_ctrl *ctrl)
445 #define WPA_CTRL_MAX_PS_NAME 100
446 static char ps[WPA_CTRL_MAX_PS_NAME] = {};
447 os_snprintf(ps, WPA_CTRL_MAX_PS_NAME, "%s/%s",
448 ctrl->remote_ip, ctrl->remote_ifname);
453 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
456 os_free(ctrl->cookie);
457 os_free(ctrl->remote_ifname);
458 os_free(ctrl->remote_ip);
462 #endif /* CONFIG_CTRL_IFACE_UDP */
465 #ifdef CTRL_IFACE_SOCKET
466 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
467 char *reply, size_t *reply_len,
468 void (*msg_cb)(char *msg, size_t len))
471 struct os_reltime started_at;
475 char *cmd_buf = NULL;
478 #ifdef CONFIG_CTRL_IFACE_UDP
481 _cmd_len = os_strlen(ctrl->cookie) + 1 + cmd_len;
482 cmd_buf = os_malloc(_cmd_len);
487 os_strlcpy(pos, ctrl->cookie, _cmd_len);
488 pos += os_strlen(ctrl->cookie);
490 os_memcpy(pos, cmd, cmd_len);
492 #endif /* CONFIG_CTRL_IFACE_UDP */
502 if (send(ctrl->s, _cmd, _cmd_len, 0) < 0) {
503 if (errno == EAGAIN || errno == EBUSY || errno == EWOULDBLOCK)
506 * Must be a non-blocking socket... Try for a bit
507 * longer before giving up.
509 if (started_at.sec == 0)
510 os_get_reltime(&started_at);
514 /* Try for a few seconds. */
515 if (os_reltime_expired(&n, &started_at, 5))
531 FD_SET(ctrl->s, &rfds);
532 res = select(ctrl->s + 1, &rfds, NULL, NULL, &tv);
535 if (FD_ISSET(ctrl->s, &rfds)) {
536 res = recv(ctrl->s, reply, *reply_len, 0);
539 if (res > 0 && reply[0] == '<') {
540 /* This is an unsolicited message from
541 * wpa_supplicant, not the reply to the
542 * request. Use msg_cb to report this to the
545 /* Make sure the message is nul
547 if ((size_t) res == *reply_len)
548 res = (*reply_len) - 1;
562 #endif /* CTRL_IFACE_SOCKET */
565 static int wpa_ctrl_attach_helper(struct wpa_ctrl *ctrl, int attach)
571 ret = wpa_ctrl_request(ctrl, attach ? "ATTACH" : "DETACH", 6,
575 if (len == 3 && os_memcmp(buf, "OK\n", 3) == 0)
581 int wpa_ctrl_attach(struct wpa_ctrl *ctrl)
583 return wpa_ctrl_attach_helper(ctrl, 1);
587 int wpa_ctrl_detach(struct wpa_ctrl *ctrl)
589 return wpa_ctrl_attach_helper(ctrl, 0);
593 #ifdef CTRL_IFACE_SOCKET
595 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len)
599 res = recv(ctrl->s, reply, *reply_len, 0);
607 int wpa_ctrl_pending(struct wpa_ctrl *ctrl)
614 FD_SET(ctrl->s, &rfds);
615 select(ctrl->s + 1, &rfds, NULL, NULL, &tv);
616 return FD_ISSET(ctrl->s, &rfds);
620 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl)
625 #endif /* CTRL_IFACE_SOCKET */
628 #ifdef CONFIG_CTRL_IFACE_NAMED_PIPE
630 #ifndef WPA_SUPPLICANT_NAMED_PIPE
631 #define WPA_SUPPLICANT_NAMED_PIPE "WpaSupplicant"
633 #define NAMED_PIPE_PREFIX TEXT("\\\\.\\pipe\\") TEXT(WPA_SUPPLICANT_NAMED_PIPE)
635 struct wpa_ctrl * wpa_ctrl_open(const char *ctrl_path)
637 struct wpa_ctrl *ctrl;
642 ctrl = os_malloc(sizeof(*ctrl));
645 os_memset(ctrl, 0, sizeof(*ctrl));
648 if (ctrl_path == NULL)
649 ret = _snwprintf(name, 256, NAMED_PIPE_PREFIX);
651 ret = _snwprintf(name, 256, NAMED_PIPE_PREFIX TEXT("-%S"),
654 if (ctrl_path == NULL)
655 ret = os_snprintf(name, 256, NAMED_PIPE_PREFIX);
657 ret = os_snprintf(name, 256, NAMED_PIPE_PREFIX "-%s",
660 if (os_snprintf_error(256, ret)) {
665 for (i = 0; i < 10; i++) {
666 ctrl->pipe = CreateFile(name, GENERIC_READ | GENERIC_WRITE, 0,
667 NULL, OPEN_EXISTING, 0, NULL);
669 * Current named pipe server side in wpa_supplicant is
670 * re-opening the pipe for new clients only after the previous
671 * one is taken into use. This leaves a small window for race
672 * conditions when two connections are being opened at almost
673 * the same time. Retry if that was the case.
675 if (ctrl->pipe != INVALID_HANDLE_VALUE ||
676 GetLastError() != ERROR_PIPE_BUSY)
678 WaitNamedPipe(name, 1000);
680 if (ctrl->pipe == INVALID_HANDLE_VALUE) {
685 mode = PIPE_READMODE_MESSAGE;
686 if (!SetNamedPipeHandleState(ctrl->pipe, &mode, NULL, NULL)) {
687 CloseHandle(ctrl->pipe);
696 void wpa_ctrl_close(struct wpa_ctrl *ctrl)
698 CloseHandle(ctrl->pipe);
703 int wpa_ctrl_request(struct wpa_ctrl *ctrl, const char *cmd, size_t cmd_len,
704 char *reply, size_t *reply_len,
705 void (*msg_cb)(char *msg, size_t len))
708 DWORD readlen = *reply_len;
710 if (!WriteFile(ctrl->pipe, cmd, cmd_len, &written, NULL))
713 if (!ReadFile(ctrl->pipe, reply, *reply_len, &readlen, NULL))
715 *reply_len = readlen;
721 int wpa_ctrl_recv(struct wpa_ctrl *ctrl, char *reply, size_t *reply_len)
723 DWORD len = *reply_len;
724 if (!ReadFile(ctrl->pipe, reply, *reply_len, &len, NULL))
731 int wpa_ctrl_pending(struct wpa_ctrl *ctrl)
735 if (!PeekNamedPipe(ctrl->pipe, NULL, 0, NULL, &left, NULL))
741 int wpa_ctrl_get_fd(struct wpa_ctrl *ctrl)
746 #endif /* CONFIG_CTRL_IFACE_NAMED_PIPE */
748 #endif /* CONFIG_CTRL_IFACE */