1 /* 2 * UPnP WPS Device 3 * Copyright (c) 2000-2003 Intel Corporation 4 * Copyright (c) 2006-2007 Sony Corporation 5 * Copyright (c) 2008-2009 Atheros Communications 6 * Copyright (c) 2009-2010, Jouni Malinen <j (at) w1.fi> 7 * 8 * See below for more details on licensing and code history. 9 */ 10 11 /* 12 * This has been greatly stripped down from the original file 13 * (upnp_wps_device.c) by Ted Merrill, Atheros Communications 14 * in order to eliminate use of the bulky libupnp library etc. 15 * 16 * History: 17 * upnp_wps_device.c is/was a shim layer between wps_opt_upnp.c and 18 * the libupnp library. 19 * The layering (by Sony) was well done; only a very minor modification 20 * to API of upnp_wps_device.c was required. 21 * libupnp was found to be undesirable because: 22 * -- It consumed too much code and data space 23 * -- It uses multiple threads, making debugging more difficult 24 * and possibly reducing reliability. 25 * -- It uses static variables and only supports one instance. 26 * The shim and libupnp are here replaced by special code written 27 * specifically for the needs of hostapd. 28 * Various shortcuts can and are taken to keep the code size small. 29 * Generally, execution time is not as crucial. 30 * 31 * BUGS: 32 * -- UPnP requires that we be able to resolve domain names. 33 * While uncommon, if we have to do it then it will stall the entire 34 * hostapd program, which is bad. 35 * This is because we use the standard linux getaddrinfo() function 36 * which is syncronous. 37 * An asyncronous solution would be to use the free "ares" library. 38 * -- Does not have a robust output buffering scheme. Uses a single 39 * fixed size output buffer per TCP/HTTP connection, with possible (although 40 * unlikely) possibility of overflow and likely excessive use of RAM. 41 * A better solution would be to write the HTTP output as a buffered stream, 42 * using chunking: (handle header specially, then) generate data with 43 * a printf-like function into a buffer, catching buffer full condition, 44 * then send it out surrounded by http chunking. 45 * -- There is some code that could be separated out into the common 46 * library to be shared with wpa_supplicant. 47 * -- Needs renaming with module prefix to avoid polluting the debugger 48 * namespace and causing possible collisions with other static fncs 49 * and structure declarations when using the debugger. 50 * -- The http error code generation is pretty bogus, hopefully noone cares. 51 * 52 * Author: Ted Merrill, Atheros Communications, based upon earlier work 53 * as explained above and below. 54 * 55 * Copyright: 56 * Copyright 2008 Atheros Communications. 57 * 58 * The original header (of upnp_wps_device.c) reads: 59 * 60 * Copyright (c) 2006-2007 Sony Corporation. All Rights Reserved. 61 * 62 * File Name: upnp_wps_device.c 63 * Description: EAP-WPS UPnP device source 64 * 65 * Redistribution and use in source and binary forms, with or without 66 * modification, are permitted provided that the following conditions 67 * are met: 68 * 69 * * Redistributions of source code must retain the above copyright 70 * notice, this list of conditions and the following disclaimer. 71 * * Redistributions in binary form must reproduce the above copyright 72 * notice, this list of conditions and the following disclaimer in 73 * the documentation and/or other materials provided with the 74 * distribution. 75 * * Neither the name of Sony Corporation nor the names of its 76 * contributors may be used to endorse or promote products derived 77 * from this software without specific prior written permission. 78 * 79 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 80 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 81 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 82 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 83 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 84 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 85 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 86 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 87 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 88 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 89 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 90 * 91 * Portions from Intel libupnp files, e.g. genlib/net/http/httpreadwrite.c 92 * typical header: 93 * 94 * Copyright (c) 2000-2003 Intel Corporation 95 * All rights reserved. 96 * 97 * Redistribution and use in source and binary forms, with or without 98 * modification, are permitted provided that the following conditions are met: 99 * 100 * * Redistributions of source code must retain the above copyright notice, 101 * this list of conditions and the following disclaimer. 102 * * Redistributions in binary form must reproduce the above copyright notice, 103 * this list of conditions and the following disclaimer in the documentation 104 * and/or other materials provided with the distribution. 105 * * Neither name of Intel Corporation nor the names of its contributors 106 * may be used to endorse or promote products derived from this software 107 * without specific prior written permission. 108 * 109 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 110 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 111 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 112 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR 113 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 114 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 115 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 116 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 117 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 118 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 119 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 120 */ 121 122 /* 123 * Overview of WPS over UPnP: 124 * 125 * UPnP is a protocol that allows devices to discover each other and control 126 * each other. In UPnP terminology, a device is either a "device" (a server 127 * that provides information about itself and allows itself to be controlled) 128 * or a "control point" (a client that controls "devices") or possibly both. 129 * This file implements a UPnP "device". 130 * 131 * For us, we use mostly basic UPnP discovery, but the control part of interest 132 * is WPS carried via UPnP messages. There is quite a bit of basic UPnP 133 * discovery to do before we can get to WPS, however. 134 * 135 * UPnP discovery begins with "devices" send out multicast UDP packets to a 136 * certain fixed multicast IP address and port, and "control points" sending 137 * out other such UDP packets. 138 * 139 * The packets sent by devices are NOTIFY packets (not to be confused with TCP 140 * NOTIFY packets that are used later) and those sent by control points are 141 * M-SEARCH packets. These packets contain a simple HTTP style header. The 142 * packets are sent redundantly to get around packet loss. Devices respond to 143 * M-SEARCH packets with HTTP-like UDP packets containing HTTP/1.1 200 OK 144 * messages, which give similar information as the UDP NOTIFY packets. 145 * 146 * The above UDP packets advertise the (arbitrary) TCP ports that the 147 * respective parties will listen to. The control point can then do a HTTP 148 * SUBSCRIBE (something like an HTTP PUT) after which the device can do a 149 * separate HTTP NOTIFY (also like an HTTP PUT) to do event messaging. 150 * 151 * The control point will also do HTTP GET of the "device file" listed in the 152 * original UDP information from the device (see UPNP_WPS_DEVICE_XML_FILE 153 * data), and based on this will do additional GETs... HTTP POSTs are done to 154 * cause an action. 155 * 156 * Beyond some basic information in HTTP headers, additional information is in 157 * the HTTP bodies, in a format set by the SOAP and XML standards, a markup 158 * language related to HTML used for web pages. This language is intended to 159 * provide the ultimate in self-documentation by providing a universal 160 * namespace based on pseudo-URLs called URIs. Note that although a URI looks 161 * like a URL (a web address), they are never accessed as such but are used 162 * only as identifiers. 163 * 164 * The POST of a GetDeviceInfo gets information similar to what might be 165 * obtained from a probe request or response on Wi-Fi. WPS messages M1-M8 166 * are passed via a POST of a PutMessage; the M1-M8 WPS messages are converted 167 * to a bin64 ascii representation for encapsulation. When proxying messages, 168 * WLANEvent and PutWLANResponse are used. 169 * 170 * This of course glosses over a lot of details. 171 */ 172 173 #include "includes.h" 174 175 #include <assert.h> 176 #include <net/if.h> 177 #include <netdb.h> 178 #include <sys/ioctl.h> 179 180 #include "common.h" 181 #include "uuid.h" 182 #include "base64.h" 183 #include "wps.h" 184 #include "wps_i.h" 185 #include "wps_upnp.h" 186 #include "wps_upnp_i.h" 187 188 189 /* 190 * UPnP allows a client ("control point") to send a server like us ("device") 191 * a domain name for registration, and we are supposed to resolve it. This is 192 * bad because, using the standard Linux library, we will stall the entire 193 * hostapd waiting for resolution. 194 * 195 * The "correct" solution would be to use an event driven library for domain 196 * name resolution such as "ares". However, this would increase code size 197 * further. Since it is unlikely that we'll actually see such domain names, we 198 * can just refuse to accept them. 199 */ 200 #define NO_DOMAIN_NAME_RESOLUTION 1 /* 1 to allow only dotted ip addresses */ 201 202 203 /* 204 * UPnP does not scale well. If we were in a room with thousands of control 205 * points then potentially we could be expected to handle subscriptions for 206 * each of them, which would exhaust our memory. So we must set a limit. In 207 * practice we are unlikely to see more than one or two. 208 */ 209 #define MAX_SUBSCRIPTIONS 4 /* how many subscribing clients we handle */ 210 #define MAX_ADDR_PER_SUBSCRIPTION 8 211 212 /* Maximum number of Probe Request events per second */ 213 #define MAX_EVENTS_PER_SEC 5 214 215 216 static struct upnp_wps_device_sm *shared_upnp_device = NULL; 217 218 219 /* Write the current date/time per RFC */ 220 void format_date(struct wpabuf *buf) 221 { 222 const char *weekday_str = "Sun\0Mon\0Tue\0Wed\0Thu\0Fri\0Sat"; 223 const char *month_str = "Jan\0Feb\0Mar\0Apr\0May\0Jun\0" 224 "Jul\0Aug\0Sep\0Oct\0Nov\0Dec"; 225 struct tm *date; 226 time_t t; 227 228 t = time(NULL); 229 date = gmtime(&t); 230 wpabuf_printf(buf, "%s, %02d %s %d %02d:%02d:%02d GMT", 231 &weekday_str[date->tm_wday * 4], date->tm_mday, 232 &month_str[date->tm_mon * 4], date->tm_year + 1900, 233 date->tm_hour, date->tm_min, date->tm_sec); 234 } 235 236 237 /*************************************************************************** 238 * UUIDs (unique identifiers) 239 * 240 * These are supposed to be unique in all the world. 241 * Sometimes permanent ones are used, sometimes temporary ones 242 * based on random numbers... there are different rules for valid content 243 * of different types. 244 * Each uuid is 16 bytes long. 245 **************************************************************************/ 246 247 /* uuid_make -- construct a random UUID 248 * The UPnP documents don't seem to offer any guidelines as to which method to 249 * use for constructing UUIDs for subscriptions. Presumably any method from 250 * rfc4122 is good enough; I've chosen random number method. 251 */ 252 static void uuid_make(u8 uuid[UUID_LEN]) 253 { 254 os_get_random(uuid, UUID_LEN); 255 256 /* Replace certain bits as specified in rfc4122 or X.667 */ 257 uuid[6] &= 0x0f; uuid[6] |= (4 << 4); /* version 4 == random gen */ 258 uuid[8] &= 0x3f; uuid[8] |= 0x80; 259 } 260 261 262 /* 263 * Subscriber address handling. 264 * Since a subscriber may have an arbitrary number of addresses, we have to 265 * add a bunch of code to handle them. 266 * 267 * Addresses are passed in text, and MAY be domain names instead of the (usual 268 * and expected) dotted IP addresses. Resolving domain names consumes a lot of 269 * resources. Worse, we are currently using the standard Linux getaddrinfo() 270 * which will block the entire program until complete or timeout! The proper 271 * solution would be to use the "ares" library or similar with more state 272 * machine steps etc. or just disable domain name resolution by setting 273 * NO_DOMAIN_NAME_RESOLUTION to 1 at top of this file. 274 */ 275 276 /* subscr_addr_delete -- delete single unlinked subscriber address 277 * (be sure to unlink first if need be) 278 */ 279 void subscr_addr_delete(struct subscr_addr *a) 280 { 281 /* 282 * Note: do NOT free domain_and_port or path because they point to 283 * memory within the allocation of "a". 284 */ 285 os_free(a); 286 } 287 288 289 /* subscr_addr_free_all -- unlink and delete list of subscriber addresses. */ 290 static void subscr_addr_free_all(struct subscription *s) 291 { 292 struct subscr_addr *a, *tmp; 293 dl_list_for_each_safe(a, tmp, &s->addr_list, struct subscr_addr, list) 294 { 295 dl_list_del(&a->list); 296 subscr_addr_delete(a); 297 } 298 } 299 300 301 /* subscr_addr_add_url -- add address(es) for one url to subscription */ 302 static void subscr_addr_add_url(struct subscription *s, const char *url, 303 size_t url_len) 304 { 305 int alloc_len; 306 char *scratch_mem = NULL; 307 char *mem; 308 char *domain_and_port; 309 char *delim; 310 char *path; 311 char *domain; 312 int port = 80; /* port to send to (default is port 80) */ 313 struct addrinfo hints; 314 struct addrinfo *result = NULL; 315 struct addrinfo *rp; 316 int rerr; 317 318 /* url MUST begin with http: */ 319 if (url_len < 7 || os_strncasecmp(url, "http://", 7)) 320 goto fail; 321 url += 7; 322 url_len -= 7; 323 324 /* allocate memory for the extra stuff we need */ 325 alloc_len = 2 * (url_len + 1); 326 scratch_mem = os_zalloc(alloc_len); 327 if (scratch_mem == NULL) 328 goto fail; 329 mem = scratch_mem; 330 os_strncpy(mem, url, url_len); 331 wpa_printf(MSG_DEBUG, "WPS UPnP: Adding URL '%s'", mem); 332 domain_and_port = mem; 333 mem += 1 + os_strlen(mem); 334 delim = os_strchr(domain_and_port, '/'); 335 if (delim) { 336 *delim++ = 0; /* null terminate domain and port */ 337 path = delim; 338 } else { 339 path = domain_and_port + os_strlen(domain_and_port); 340 } 341 domain = mem; 342 strcpy(domain, domain_and_port); 343 delim = os_strchr(domain, ':'); 344 if (delim) { 345 *delim++ = 0; /* null terminate domain */ 346 if (isdigit(*delim)) 347 port = atol(delim); 348 } 349 350 /* 351 * getaddrinfo does the right thing with dotted decimal notations, or 352 * will resolve domain names. Resolving domain names will unfortunately 353 * hang the entire program until it is resolved or it times out 354 * internal to getaddrinfo; fortunately we think that the use of actual 355 * domain names (vs. dotted decimal notations) should be uncommon. 356 */ 357 os_memset(&hints, 0, sizeof(struct addrinfo)); 358 hints.ai_family = AF_INET; /* IPv4 */ 359 hints.ai_socktype = SOCK_STREAM; 360 #if NO_DOMAIN_NAME_RESOLUTION 361 /* Suppress domain name resolutions that would halt 362 * the program for periods of time 363 */ 364 hints.ai_flags = AI_NUMERICHOST; 365 #else 366 /* Allow domain name resolution. */ 367 hints.ai_flags = 0; 368 #endif 369 hints.ai_protocol = 0; /* Any protocol? */ 370 rerr = getaddrinfo(domain, NULL /* fill in port ourselves */, 371 &hints, &result); 372 if (rerr) { 373 wpa_printf(MSG_INFO, "WPS UPnP: Resolve error %d (%s) on: %s", 374 rerr, gai_strerror(rerr), domain); 375 goto fail; 376 } 377 for (rp = result; rp; rp = rp->ai_next) { 378 struct subscr_addr *a; 379 380 /* Limit no. of address to avoid denial of service attack */ 381 if (dl_list_len(&s->addr_list) >= MAX_ADDR_PER_SUBSCRIPTION) { 382 wpa_printf(MSG_INFO, "WPS UPnP: subscr_addr_add_url: " 383 "Ignoring excessive addresses"); 384 break; 385 } 386 387 a = os_zalloc(sizeof(*a) + alloc_len); 388 if (a == NULL) 389 continue; 390 mem = (void *) (a + 1); 391 a->domain_and_port = mem; 392 strcpy(mem, domain_and_port); 393 mem += 1 + strlen(mem); 394 a->path = mem; 395 if (path[0] != '/') 396 *mem++ = '/'; 397 strcpy(mem, path); 398 mem += 1 + os_strlen(mem); 399 os_memcpy(&a->saddr, rp->ai_addr, sizeof(a->saddr)); 400 a->saddr.sin_port = htons(port); 401 402 dl_list_add(&s->addr_list, &a->list); 403 } 404 405 fail: 406 if (result) 407 freeaddrinfo(result); 408 os_free(scratch_mem); 409 } 410 411 412 /* subscr_addr_list_create -- create list from urls in string. 413 * Each url is enclosed by angle brackets. 414 */ 415 static void subscr_addr_list_create(struct subscription *s, 416 const char *url_list) 417 { 418 const char *end; 419 wpa_printf(MSG_DEBUG, "WPS UPnP: Parsing URL list '%s'", url_list); 420 for (;;) { 421 while (*url_list == ' ' || *url_list == '\t') 422 url_list++; 423 if (*url_list != '<') 424 break; 425 url_list++; 426 end = os_strchr(url_list, '>'); 427 if (end == NULL) 428 break; 429 subscr_addr_add_url(s, url_list, end - url_list); 430 url_list = end + 1; 431 } 432 } 433 434 435 int send_wpabuf(int fd, struct wpabuf *buf) 436 { 437 wpa_printf(MSG_DEBUG, "WPS UPnP: Send %lu byte message", 438 (unsigned long) wpabuf_len(buf)); 439 errno = 0; 440 if (write(fd, wpabuf_head(buf), wpabuf_len(buf)) != 441 (int) wpabuf_len(buf)) { 442 wpa_printf(MSG_ERROR, "WPS UPnP: Failed to send buffer: " 443 "errno=%d (%s)", 444 errno, strerror(errno)); 445 return -1; 446 } 447 448 return 0; 449 } 450 451 452 static void wpabuf_put_property(struct wpabuf *buf, const char *name, 453 const char *value) 454 { 455 wpabuf_put_str(buf, "<e:property>"); 456 wpabuf_printf(buf, "<%s>", name); 457 if (value) 458 wpabuf_put_str(buf, value); 459 wpabuf_printf(buf, "</%s>", name); 460 wpabuf_put_str(buf, "</e:property>\n"); 461 } 462 463 464 /** 465 * upnp_wps_device_send_event - Queue event messages for subscribers 466 * @sm: WPS UPnP state machine from upnp_wps_device_init() 467 * 468 * This function queues the last WLANEvent to be sent for all currently 469 * subscribed UPnP control points. sm->wlanevent must have been set with the 470 * encoded data before calling this function. 471 */ 472 static void upnp_wps_device_send_event(struct upnp_wps_device_sm *sm) 473 { 474 /* Enqueue event message for all subscribers */ 475 struct wpabuf *buf; /* holds event message */ 476 int buf_size = 0; 477 struct subscription *s, *tmp; 478 /* Actually, utf-8 is the default, but it doesn't hurt to specify it */ 479 const char *format_head = 480 "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n" 481 "<e:propertyset xmlns:e=\"urn:schemas-upnp-org:event-1-0\">\n"; 482 const char *format_tail = "</e:propertyset>\n"; 483 struct os_time now; 484 485 if (dl_list_empty(&sm->subscriptions)) { 486 /* optimize */ 487 return; 488 } 489 490 if (os_get_time(&now) == 0) { 491 if (now.sec != sm->last_event_sec) { 492 sm->last_event_sec = now.sec; 493 sm->num_events_in_sec = 1; 494 } else { 495 sm->num_events_in_sec++; 496 /* 497 * In theory, this should apply to all WLANEvent 498 * notifications, but EAP messages are of much higher 499 * priority and Probe Request notifications should not 500 * be allowed to drop EAP messages, so only throttle 501 * Probe Request notifications. 502 */ 503 if (sm->num_events_in_sec > MAX_EVENTS_PER_SEC && 504 sm->wlanevent_type == 505 UPNP_WPS_WLANEVENT_TYPE_PROBE) { 506 wpa_printf(MSG_DEBUG, "WPS UPnP: Throttle " 507 "event notifications (%u seen " 508 "during one second)", 509 sm->num_events_in_sec); 510 return; 511 } 512 } 513 } 514 515 /* Determine buffer size needed first */ 516 buf_size += os_strlen(format_head); 517 buf_size += 50 + 2 * os_strlen("WLANEvent"); 518 if (sm->wlanevent) 519 buf_size += os_strlen(sm->wlanevent); 520 buf_size += os_strlen(format_tail); 521 522 buf = wpabuf_alloc(buf_size); 523 if (buf == NULL) 524 return; 525 wpabuf_put_str(buf, format_head); 526 wpabuf_put_property(buf, "WLANEvent", sm->wlanevent); 527 wpabuf_put_str(buf, format_tail); 528 529 wpa_printf(MSG_MSGDUMP, "WPS UPnP: WLANEvent message:\n%s", 530 (char *) wpabuf_head(buf)); 531 532 dl_list_for_each_safe(s, tmp, &sm->subscriptions, struct subscription, 533 list) { 534 event_add(s, buf, 535 sm->wlanevent_type == UPNP_WPS_WLANEVENT_TYPE_PROBE); 536 } 537 538 wpabuf_free(buf); 539 } 540 541 542 /* 543 * Event subscription (subscriber machines register with us to receive event 544 * messages). 545 * This is the result of an incoming HTTP over TCP SUBSCRIBE request. 546 */ 547 548 /* subscription_destroy -- destroy an unlinked subscription 549 * Be sure to unlink first if necessary. 550 */ 551 void subscription_destroy(struct subscription *s) 552 { 553 wpa_printf(MSG_DEBUG, "WPS UPnP: Destroy subscription %p", s); 554 subscr_addr_free_all(s); 555 event_delete_all(s); 556 upnp_er_remove_notification(s); 557 os_free(s); 558 } 559 560 561 /* subscription_list_age -- remove expired subscriptions */ 562 static void subscription_list_age(struct upnp_wps_device_sm *sm, time_t now) 563 { 564 struct subscription *s, *tmp; 565 dl_list_for_each_safe(s, tmp, &sm->subscriptions, 566 struct subscription, list) { 567 if (s->timeout_time > now) 568 break; 569 wpa_printf(MSG_DEBUG, "WPS UPnP: Removing aged subscription"); 570 dl_list_del(&s->list); 571 subscription_destroy(s); 572 } 573 } 574 575 576 /* subscription_find -- return existing subscription matching uuid, if any 577 * returns NULL if not found 578 */ 579 struct subscription * subscription_find(struct upnp_wps_device_sm *sm, 580 const u8 uuid[UUID_LEN]) 581 { 582 struct subscription *s; 583 dl_list_for_each(s, &sm->subscriptions, struct subscription, list) { 584 if (os_memcmp(s->uuid, uuid, UUID_LEN) == 0) 585 return s; /* Found match */ 586 } 587 return NULL; 588 } 589 590 591 static struct wpabuf * build_fake_wsc_ack(void) 592 { 593 struct wpabuf *msg = wpabuf_alloc(100); 594 if (msg == NULL) 595 return NULL; 596 wpabuf_put_u8(msg, UPNP_WPS_WLANEVENT_TYPE_EAP); 597 wpabuf_put_str(msg, "00:00:00:00:00:00"); 598 if (wps_build_version(msg) || 599 wps_build_msg_type(msg, WPS_WSC_ACK)) { 600 wpabuf_free(msg); 601 return NULL; 602 } 603 /* Enrollee Nonce */ 604 wpabuf_put_be16(msg, ATTR_ENROLLEE_NONCE); 605 wpabuf_put_be16(msg, WPS_NONCE_LEN); 606 wpabuf_put(msg, WPS_NONCE_LEN); 607 /* Registrar Nonce */ 608 wpabuf_put_be16(msg, ATTR_REGISTRAR_NONCE); 609 wpabuf_put_be16(msg, WPS_NONCE_LEN); 610 wpabuf_put(msg, WPS_NONCE_LEN); 611 wps_build_wfa_ext(msg, 0, NULL, 0); 612 return msg; 613 } 614 615 616 /* subscription_first_event -- send format/queue event that is automatically 617 * sent on a new subscription. 618 */ 619 static int subscription_first_event(struct subscription *s) 620 { 621 /* 622 * Actually, utf-8 is the default, but it doesn't hurt to specify it. 623 * 624 * APStatus is apparently a bit set, 625 * 0x1 = configuration change (but is always set?) 626 * 0x10 = ap is locked 627 * 628 * Per UPnP spec, we send out the last value of each variable, even 629 * for WLANEvent, whatever it was. 630 */ 631 char *wlan_event; 632 struct wpabuf *buf; 633 int ap_status = 1; /* TODO: add 0x10 if access point is locked */ 634 const char *head = 635 "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n" 636 "<e:propertyset xmlns:e=\"urn:schemas-upnp-org:event-1-0\">\n"; 637 const char *tail = "</e:propertyset>\n"; 638 char txt[10]; 639 int ret; 640 641 if (s->sm->wlanevent == NULL) { 642 /* 643 * There has been no events before the subscription. However, 644 * UPnP device architecture specification requires all the 645 * evented variables to be included, so generate a dummy event 646 * for this particular case using a WSC_ACK and all-zeros 647 * nonces. The ER (UPnP control point) will ignore this, but at 648 * least it will learn that WLANEvent variable will be used in 649 * event notifications in the future. 650 */ 651 struct wpabuf *msg; 652 wpa_printf(MSG_DEBUG, "WPS UPnP: Use a fake WSC_ACK as the " 653 "initial WLANEvent"); 654 msg = build_fake_wsc_ack(); 655 if (msg) { 656 s->sm->wlanevent = (char *) 657 base64_encode(wpabuf_head(msg), 658 wpabuf_len(msg), NULL); 659 wpabuf_free(msg); 660 } 661 } 662 663 wlan_event = s->sm->wlanevent; 664 if (wlan_event == NULL || *wlan_event == '\0') { 665 wpa_printf(MSG_DEBUG, "WPS UPnP: WLANEvent not known for " 666 "initial event message"); 667 wlan_event = ""; 668 } 669 buf = wpabuf_alloc(500 + os_strlen(wlan_event)); 670 if (buf == NULL) 671 return -1; 672 673 wpabuf_put_str(buf, head); 674 wpabuf_put_property(buf, "STAStatus", "1"); 675 os_snprintf(txt, sizeof(txt), "%d", ap_status); 676 wpabuf_put_property(buf, "APStatus", txt); 677 if (*wlan_event) 678 wpabuf_put_property(buf, "WLANEvent", wlan_event); 679 wpabuf_put_str(buf, tail); 680 681 ret = event_add(s, buf, 0); 682 if (ret) { 683 wpabuf_free(buf); 684 return ret; 685 } 686 wpabuf_free(buf); 687 688 return 0; 689 } 690 691 692 /** 693 * subscription_start - Remember a UPnP control point to send events to. 694 * @sm: WPS UPnP state machine from upnp_wps_device_init() 695 * @callback_urls: Callback URLs 696 * Returns: %NULL on error, or pointer to new subscription structure. 697 */ 698 struct subscription * subscription_start(struct upnp_wps_device_sm *sm, 699 const char *callback_urls) 700 { 701 struct subscription *s; 702 time_t now = time(NULL); 703 time_t expire = now + UPNP_SUBSCRIBE_SEC; 704 705 /* Get rid of expired subscriptions so we have room */ 706 subscription_list_age(sm, now); 707 708 /* If too many subscriptions, remove oldest */ 709 if (dl_list_len(&sm->subscriptions) >= MAX_SUBSCRIPTIONS) { 710 s = dl_list_first(&sm->subscriptions, struct subscription, 711 list); 712 wpa_printf(MSG_INFO, "WPS UPnP: Too many subscriptions, " 713 "trashing oldest"); 714 dl_list_del(&s->list); 715 subscription_destroy(s); 716 } 717 718 s = os_zalloc(sizeof(*s)); 719 if (s == NULL) 720 return NULL; 721 dl_list_init(&s->addr_list); 722 dl_list_init(&s->event_queue); 723 724 s->sm = sm; 725 s->timeout_time = expire; 726 uuid_make(s->uuid); 727 subscr_addr_list_create(s, callback_urls); 728 if (dl_list_empty(&s->addr_list)) { 729 wpa_printf(MSG_DEBUG, "WPS UPnP: No valid callback URLs in " 730 "'%s' - drop subscription", callback_urls); 731 subscription_destroy(s); 732 return NULL; 733 } 734 735 /* Add to end of list, since it has the highest expiration time */ 736 dl_list_add_tail(&sm->subscriptions, &s->list); 737 /* Queue up immediate event message (our last event) 738 * as required by UPnP spec. 739 */ 740 if (subscription_first_event(s)) { 741 wpa_printf(MSG_INFO, "WPS UPnP: Dropping subscriber due to " 742 "event backlog"); 743 dl_list_del(&s->list); 744 subscription_destroy(s); 745 return NULL; 746 } 747 wpa_printf(MSG_DEBUG, "WPS UPnP: Subscription %p started with %s", 748 s, callback_urls); 749 /* Schedule sending this */ 750 event_send_all_later(sm); 751 return s; 752 } 753 754 755 /* subscription_renew -- find subscription and reset timeout */ 756 struct subscription * subscription_renew(struct upnp_wps_device_sm *sm, 757 const u8 uuid[UUID_LEN]) 758 { 759 time_t now = time(NULL); 760 time_t expire = now + UPNP_SUBSCRIBE_SEC; 761 struct subscription *s = subscription_find(sm, uuid); 762 if (s == NULL) 763 return NULL; 764 wpa_printf(MSG_DEBUG, "WPS UPnP: Subscription renewed"); 765 dl_list_del(&s->list); 766 s->timeout_time = expire; 767 /* add back to end of list, since it now has highest expiry */ 768 dl_list_add_tail(&sm->subscriptions, &s->list); 769 return s; 770 } 771 772 773 /** 774 * upnp_wps_device_send_wlan_event - Event notification 775 * @sm: WPS UPnP state machine from upnp_wps_device_init() 776 * @from_mac_addr: Source (Enrollee) MAC address for the event 777 * @ev_type: Event type 778 * @msg: Event data 779 * Returns: 0 on success, -1 on failure 780 * 781 * Tell external Registrars (UPnP control points) that something happened. In 782 * particular, events include WPS messages from clients that are proxied to 783 * external Registrars. 784 */ 785 int upnp_wps_device_send_wlan_event(struct upnp_wps_device_sm *sm, 786 const u8 from_mac_addr[ETH_ALEN], 787 enum upnp_wps_wlanevent_type ev_type, 788 const struct wpabuf *msg) 789 { 790 int ret = -1; 791 char type[2]; 792 const u8 *mac = from_mac_addr; 793 char mac_text[18]; 794 u8 *raw = NULL; 795 size_t raw_len; 796 char *val; 797 size_t val_len; 798 int pos = 0; 799 800 if (!sm) 801 goto fail; 802 803 os_snprintf(type, sizeof(type), "%1u", ev_type); 804 805 raw_len = 1 + 17 + (msg ? wpabuf_len(msg) : 0); 806 raw = os_zalloc(raw_len); 807 if (!raw) 808 goto fail; 809 810 *(raw + pos) = (u8) ev_type; 811 pos += 1; 812 os_snprintf(mac_text, sizeof(mac_text), MACSTR, MAC2STR(mac)); 813 wpa_printf(MSG_DEBUG, "WPS UPnP: Proxying WLANEvent from %s", 814 mac_text); 815 os_memcpy(raw + pos, mac_text, 17); 816 pos += 17; 817 if (msg) { 818 os_memcpy(raw + pos, wpabuf_head(msg), wpabuf_len(msg)); 819 pos += wpabuf_len(msg); 820 } 821 raw_len = pos; 822 823 val = (char *) base64_encode(raw, raw_len, &val_len); 824 if (val == NULL) 825 goto fail; 826 827 os_free(sm->wlanevent); 828 sm->wlanevent = val; 829 sm->wlanevent_type = ev_type; 830 upnp_wps_device_send_event(sm); 831 832 ret = 0; 833 834 fail: 835 os_free(raw); 836 837 return ret; 838 } 839 840 841 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) 842 #include <sys/sysctl.h> 843 #include <net/route.h> 844 #include <net/if_dl.h> 845 846 static int eth_get(const char *device, u8 ea[ETH_ALEN]) 847 { 848 struct if_msghdr *ifm; 849 struct sockaddr_dl *sdl; 850 u_char *p, *buf; 851 size_t len; 852 int mib[] = { CTL_NET, AF_ROUTE, 0, AF_LINK, NET_RT_IFLIST, 0 }; 853 854 if (sysctl(mib, 6, NULL, &len, NULL, 0) < 0) 855 return -1; 856 if ((buf = os_malloc(len)) == NULL) 857 return -1; 858 if (sysctl(mib, 6, buf, &len, NULL, 0) < 0) { 859 os_free(buf); 860 return -1; 861 } 862 for (p = buf; p < buf + len; p += ifm->ifm_msglen) { 863 ifm = (struct if_msghdr *)p; 864 sdl = (struct sockaddr_dl *)(ifm + 1); 865 if (ifm->ifm_type != RTM_IFINFO || 866 (ifm->ifm_addrs & RTA_IFP) == 0) 867 continue; 868 if (sdl->sdl_family != AF_LINK || sdl->sdl_nlen == 0 || 869 os_memcmp(sdl->sdl_data, device, sdl->sdl_nlen) != 0) 870 continue; 871 os_memcpy(ea, LLADDR(sdl), sdl->sdl_alen); 872 break; 873 } 874 os_free(buf); 875 876 if (p >= buf + len) { 877 errno = ESRCH; 878 return -1; 879 } 880 return 0; 881 } 882 #endif /* __FreeBSD__ */ 883 884 885 /** 886 * get_netif_info - Get hw and IP addresses for network device 887 * @net_if: Selected network interface name 888 * @ip_addr: Buffer for returning IP address in network byte order 889 * @ip_addr_text: Buffer for returning a pointer to allocated IP address text 890 * @mac: Buffer for returning MAC address 891 * Returns: 0 on success, -1 on failure 892 */ 893 int get_netif_info(const char *net_if, unsigned *ip_addr, char **ip_addr_text, 894 u8 mac[ETH_ALEN]) 895 { 896 struct ifreq req; 897 int sock = -1; 898 struct sockaddr_in *addr; 899 struct in_addr in_addr; 900 901 *ip_addr_text = os_zalloc(16); 902 if (*ip_addr_text == NULL) 903 goto fail; 904 905 sock = socket(AF_INET, SOCK_DGRAM, 0); 906 if (sock < 0) 907 goto fail; 908 909 os_strlcpy(req.ifr_name, net_if, sizeof(req.ifr_name)); 910 if (ioctl(sock, SIOCGIFADDR, &req) < 0) { 911 wpa_printf(MSG_ERROR, "WPS UPnP: SIOCGIFADDR failed: %d (%s)", 912 errno, strerror(errno)); 913 goto fail; 914 } 915 addr = (void *) &req.ifr_addr; 916 *ip_addr = addr->sin_addr.s_addr; 917 in_addr.s_addr = *ip_addr; 918 os_snprintf(*ip_addr_text, 16, "%s", inet_ntoa(in_addr)); 919 920 #ifdef __linux__ 921 os_strlcpy(req.ifr_name, net_if, sizeof(req.ifr_name)); 922 if (ioctl(sock, SIOCGIFHWADDR, &req) < 0) { 923 wpa_printf(MSG_ERROR, "WPS UPnP: SIOCGIFHWADDR failed: " 924 "%d (%s)", errno, strerror(errno)); 925 goto fail; 926 } 927 os_memcpy(mac, req.ifr_addr.sa_data, 6); 928 #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__) 929 if (eth_get(net_if, mac) < 0) { 930 wpa_printf(MSG_ERROR, "WPS UPnP: Failed to get MAC address"); 931 goto fail; 932 } 933 #else 934 #error MAC address fetch not implemented 935 #endif 936 937 close(sock); 938 return 0; 939 940 fail: 941 if (sock >= 0) 942 close(sock); 943 os_free(*ip_addr_text); 944 *ip_addr_text = NULL; 945 return -1; 946 } 947 948 949 static void upnp_wps_free_msearchreply(struct dl_list *head) 950 { 951 struct advertisement_state_machine *a, *tmp; 952 dl_list_for_each_safe(a, tmp, head, struct advertisement_state_machine, 953 list) 954 msearchreply_state_machine_stop(a); 955 } 956 957 958 static void upnp_wps_free_subscriptions(struct dl_list *head, 959 struct wps_registrar *reg) 960 { 961 struct subscription *s, *tmp; 962 dl_list_for_each_safe(s, tmp, head, struct subscription, list) { 963 if (reg && s->reg != reg) 964 continue; 965 dl_list_del(&s->list); 966 subscription_destroy(s); 967 } 968 } 969 970 971 /** 972 * upnp_wps_device_stop - Stop WPS UPnP operations on an interface 973 * @sm: WPS UPnP state machine from upnp_wps_device_init() 974 */ 975 static void upnp_wps_device_stop(struct upnp_wps_device_sm *sm) 976 { 977 if (!sm || !sm->started) 978 return; 979 980 wpa_printf(MSG_DEBUG, "WPS UPnP: Stop device"); 981 web_listener_stop(sm); 982 upnp_wps_free_msearchreply(&sm->msearch_replies); 983 upnp_wps_free_subscriptions(&sm->subscriptions, NULL); 984 985 advertisement_state_machine_stop(sm, 1); 986 987 event_send_stop_all(sm); 988 os_free(sm->wlanevent); 989 sm->wlanevent = NULL; 990 os_free(sm->ip_addr_text); 991 sm->ip_addr_text = NULL; 992 if (sm->multicast_sd >= 0) 993 close(sm->multicast_sd); 994 sm->multicast_sd = -1; 995 ssdp_listener_stop(sm); 996 997 sm->started = 0; 998 } 999 1000 1001 /** 1002 * upnp_wps_device_start - Start WPS UPnP operations on an interface 1003 * @sm: WPS UPnP state machine from upnp_wps_device_init() 1004 * @net_if: Selected network interface name 1005 * Returns: 0 on success, -1 on failure 1006 */ 1007 static int upnp_wps_device_start(struct upnp_wps_device_sm *sm, char *net_if) 1008 { 1009 if (!sm || !net_if) 1010 return -1; 1011 1012 if (sm->started) 1013 upnp_wps_device_stop(sm); 1014 1015 sm->multicast_sd = -1; 1016 sm->ssdp_sd = -1; 1017 sm->started = 1; 1018 sm->advertise_count = 0; 1019 1020 /* Fix up linux multicast handling */ 1021 if (add_ssdp_network(net_if)) 1022 goto fail; 1023 1024 /* Determine which IP and mac address we're using */ 1025 if (get_netif_info(net_if, &sm->ip_addr, &sm->ip_addr_text, 1026 sm->mac_addr)) { 1027 wpa_printf(MSG_INFO, "WPS UPnP: Could not get IP/MAC address " 1028 "for %s. Does it have IP address?", net_if); 1029 goto fail; 1030 } 1031 1032 /* Listen for incoming TCP connections so that others 1033 * can fetch our "xml files" from us. 1034 */ 1035 if (web_listener_start(sm)) 1036 goto fail; 1037 1038 /* Set up for receiving discovery (UDP) packets */ 1039 if (ssdp_listener_start(sm)) 1040 goto fail; 1041 1042 /* Set up for sending multicast */ 1043 if (ssdp_open_multicast(sm) < 0) 1044 goto fail; 1045 1046 /* 1047 * Broadcast NOTIFY messages to let the world know we exist. 1048 * This is done via a state machine since the messages should not be 1049 * all sent out at once. 1050 */ 1051 if (advertisement_state_machine_start(sm)) 1052 goto fail; 1053 1054 return 0; 1055 1056 fail: 1057 upnp_wps_device_stop(sm); 1058 return -1; 1059 } 1060 1061 1062 static struct upnp_wps_device_interface * 1063 upnp_wps_get_iface(struct upnp_wps_device_sm *sm, void *priv) 1064 { 1065 struct upnp_wps_device_interface *iface; 1066 dl_list_for_each(iface, &sm->interfaces, 1067 struct upnp_wps_device_interface, list) { 1068 if (iface->priv == priv) 1069 return iface; 1070 } 1071 return NULL; 1072 } 1073 1074 1075 /** 1076 * upnp_wps_device_deinit - Deinitialize WPS UPnP 1077 * @sm: WPS UPnP state machine from upnp_wps_device_init() 1078 * @priv: External context data that was used in upnp_wps_device_init() call 1079 */ 1080 void upnp_wps_device_deinit(struct upnp_wps_device_sm *sm, void *priv) 1081 { 1082 struct upnp_wps_device_interface *iface; 1083 1084 if (!sm) 1085 return; 1086 1087 iface = upnp_wps_get_iface(sm, priv); 1088 if (iface == NULL) { 1089 wpa_printf(MSG_ERROR, "WPS UPnP: Could not find the interface " 1090 "instance to deinit"); 1091 return; 1092 } 1093 wpa_printf(MSG_DEBUG, "WPS UPnP: Deinit interface instance %p", iface); 1094 if (dl_list_len(&sm->interfaces) == 1) { 1095 wpa_printf(MSG_DEBUG, "WPS UPnP: Deinitializing last instance " 1096 "- free global device instance"); 1097 upnp_wps_device_stop(sm); 1098 } else 1099 upnp_wps_free_subscriptions(&sm->subscriptions, 1100 iface->wps->registrar); 1101 dl_list_del(&iface->list); 1102 1103 if (iface->peer.wps) 1104 wps_deinit(iface->peer.wps); 1105 os_free(iface->ctx->ap_pin); 1106 os_free(iface->ctx); 1107 os_free(iface); 1108 1109 if (dl_list_empty(&sm->interfaces)) { 1110 os_free(sm->root_dir); 1111 os_free(sm->desc_url); 1112 os_free(sm); 1113 shared_upnp_device = NULL; 1114 } 1115 } 1116 1117 1118 /** 1119 * upnp_wps_device_init - Initialize WPS UPnP 1120 * @ctx: callback table; we must eventually free it 1121 * @wps: Pointer to longterm WPS context 1122 * @priv: External context data that will be used in callbacks 1123 * @net_if: Selected network interface name 1124 * Returns: WPS UPnP state or %NULL on failure 1125 */ 1126 struct upnp_wps_device_sm * 1127 upnp_wps_device_init(struct upnp_wps_device_ctx *ctx, struct wps_context *wps, 1128 void *priv, char *net_if) 1129 { 1130 struct upnp_wps_device_sm *sm; 1131 struct upnp_wps_device_interface *iface; 1132 int start = 0; 1133 1134 iface = os_zalloc(sizeof(*iface)); 1135 if (iface == NULL) { 1136 os_free(ctx->ap_pin); 1137 os_free(ctx); 1138 return NULL; 1139 } 1140 wpa_printf(MSG_DEBUG, "WPS UPnP: Init interface instance %p", iface); 1141 1142 iface->ctx = ctx; 1143 iface->wps = wps; 1144 iface->priv = priv; 1145 1146 if (shared_upnp_device) { 1147 wpa_printf(MSG_DEBUG, "WPS UPnP: Share existing device " 1148 "context"); 1149 sm = shared_upnp_device; 1150 } else { 1151 wpa_printf(MSG_DEBUG, "WPS UPnP: Initialize device context"); 1152 sm = os_zalloc(sizeof(*sm)); 1153 if (!sm) { 1154 wpa_printf(MSG_ERROR, "WPS UPnP: upnp_wps_device_init " 1155 "failed"); 1156 os_free(iface); 1157 os_free(ctx->ap_pin); 1158 os_free(ctx); 1159 return NULL; 1160 } 1161 shared_upnp_device = sm; 1162 1163 dl_list_init(&sm->msearch_replies); 1164 dl_list_init(&sm->subscriptions); 1165 dl_list_init(&sm->interfaces); 1166 start = 1; 1167 } 1168 1169 dl_list_add(&sm->interfaces, &iface->list); 1170 1171 if (start && upnp_wps_device_start(sm, net_if)) { 1172 upnp_wps_device_deinit(sm, priv); 1173 return NULL; 1174 } 1175 1176 1177 return sm; 1178 } 1179 1180 1181 /** 1182 * upnp_wps_subscribers - Check whether there are any event subscribers 1183 * @sm: WPS UPnP state machine from upnp_wps_device_init() 1184 * Returns: 0 if no subscribers, 1 if subscribers 1185 */ 1186 int upnp_wps_subscribers(struct upnp_wps_device_sm *sm) 1187 { 1188 return !dl_list_empty(&sm->subscriptions); 1189 } 1190 1191 1192 int upnp_wps_set_ap_pin(struct upnp_wps_device_sm *sm, const char *ap_pin) 1193 { 1194 struct upnp_wps_device_interface *iface; 1195 if (sm == NULL) 1196 return 0; 1197 1198 dl_list_for_each(iface, &sm->interfaces, 1199 struct upnp_wps_device_interface, list) { 1200 os_free(iface->ctx->ap_pin); 1201 if (ap_pin) { 1202 iface->ctx->ap_pin = os_strdup(ap_pin); 1203 if (iface->ctx->ap_pin == NULL) 1204 return -1; 1205 } else 1206 iface->ctx->ap_pin = NULL; 1207 } 1208 1209 return 0; 1210 } 1211
