src/wps/wps_upnp_event.c

   1 /*
   2  * UPnP WPS Device - Event processing
   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@w1.fi>
   7  *
   8  * See wps_upnp.c for more details on licensing and code history.
   9  */
  10
  11 #include "includes.h"
  12 #include <assert.h>
  13
  14 #include "common.h"
  15 #include "eloop.h"
  16 #include "uuid.h"
  17 #include "http_client.h"
  18 #include "wps_defs.h"
  19 #include "wps_upnp.h"
  20 #include "wps_upnp_i.h"
  21
  22 /*
  23  * Event message generation (to subscribers)
  24  *
  25  * We make a separate copy for each message for each subscriber. This memory
  26  * wasted could be limited (adding code complexity) by sharing copies, keeping
  27  * a usage count and freeing when zero.
  28  *
  29  * Sending a message requires using a HTTP over TCP NOTIFY
  30  * (like a PUT) which requires a number of states..
  31  */
  32
  33 #define MAX_EVENTS_QUEUED 20   /* How far behind queued events */
  34 #define MAX_FAILURES 10 /* Drop subscription after this many failures */
  35
  36 /* How long to wait before sending event */
  37 #define EVENT_DELAY_SECONDS 0
  38 #define EVENT_DELAY_MSEC 0
  39
  40 /*
  41  * Event information that we send to each subscriber is remembered in this
  42  * struct. The event cannot be sent by simple UDP; it has to be sent by a HTTP
  43  * over TCP transaction which requires various states.. It may also need to be
  44  * retried at a different address (if more than one is available).
  45  *
  46  * TODO: As an optimization we could share data between subscribers.
  47  */
  48 struct wps_event_ {
  49         struct dl_list list;
  50         struct subscription *s;         /* parent */
  51         unsigned subscriber_sequence;   /* which event for this subscription*/
  52         unsigned int retry;             /* which retry */
  53         struct subscr_addr *addr;       /* address to connect to */
  54         struct wpabuf *data;            /* event data to send */
  55         struct http_client *http_event;
  56 };
  57
  58
  59 /* event_clean -- clean sockets etc. of event
  60  * Leaves data, retry count etc. alone.
  61  */
  62 static void event_clean(struct wps_event_ *e)
  63 {
  64         if (e->s->current_event == e)
  65                 e->s->current_event = NULL;
  66         http_client_free(e->http_event);
  67         e->http_event = NULL;
  68 }
  69
  70
  71 /* event_delete -- delete single unqueued event
  72  * (be sure to dequeue first if need be)
  73  */
  74 static void event_delete(struct wps_event_ *e)
  75 {
  76         wpa_printf(MSG_DEBUG, "WPS UPnP: Delete event %p", e);
  77         event_clean(e);
  78         wpabuf_free(e->data);
  79         os_free(e);
  80 }
  81
  82
  83 /* event_dequeue -- get next event from the queue
  84  * Returns NULL if empty.
  85  */
  86 static struct wps_event_ *event_dequeue(struct subscription *s)
  87 {
  88         struct wps_event_ *e;
  89         e = dl_list_first(&s->event_queue, struct wps_event_, list);
  90         if (e) {
  91                 wpa_printf(MSG_DEBUG, "WPS UPnP: Dequeue event %p for "
  92                            "subscription %p", e, s);
  93                 dl_list_del(&e->list);
  94         }
  95         return e;
  96 }
  97
  98
  99 /* event_delete_all -- delete entire event queue and current event */
 100 void event_delete_all(struct subscription *s)
 101 {
 102         struct wps_event_ *e;
 103         while ((e = event_dequeue(s)) != NULL)
 104                 event_delete(e);
 105         if (s->current_event) {
 106                 event_delete(s->current_event);
 107                 /* will set: s->current_event = NULL;  */
 108         }
 109 }
 110
 111
 112 /**
 113  * event_retry - Called when we had a failure delivering event msg
 114  * @e: Event
 115  * @do_next_address: skip address e.g. on connect fail
 116  */
 117 static void event_retry(struct wps_event_ *e, int do_next_address)
 118 {
 119         struct subscription *s = e->s;
 120         struct upnp_wps_device_sm *sm = s->sm;
 121
 122         wpa_printf(MSG_DEBUG, "WPS UPnP: Retry event %p for subscription %p",
 123                    e, s);
 124         event_clean(e);
 125         /* will set: s->current_event = NULL; */
 126
 127         if (do_next_address) {
 128                 e->retry++;
 129                 wpa_printf(MSG_DEBUG, "WPS UPnP: Try address %d", e->retry);
 130         }
 131         if (e->retry >= dl_list_len(&s->addr_list)) {
 132                 wpa_printf(MSG_DEBUG, "WPS UPnP: Giving up on sending event "
 133                            "for %s", e->addr->domain_and_port);
 134                 event_delete(e);
 135                 if (!dl_list_empty(&s->event_queue))
 136                         event_send_all_later(s->sm);
 137                 return;
 138         }
 139         dl_list_add(&s->event_queue, &e->list);
 140         event_send_all_later(sm);
 141 }
 142
 143
 144 static struct wpabuf * event_build_message(struct wps_event_ *e)
 145 {
 146         struct wpabuf *buf;
 147         char *b;
 148
 149         buf = wpabuf_alloc(1000 + wpabuf_len(e->data));
 150         if (buf == NULL)
 151                 return NULL;
 152         wpabuf_printf(buf, "NOTIFY %s HTTP/1.1\r\n", e->addr->path);
 153         wpabuf_put_str(buf, "SERVER: Unspecified, UPnP/1.0, Unspecified\r\n");
 154         wpabuf_printf(buf, "HOST: %s\r\n", e->addr->domain_and_port);
 155         wpabuf_put_str(buf, "CONTENT-TYPE: text/xml; charset=\"utf-8\"\r\n"
 156                        "NT: upnp:event\r\n"
 157                        "NTS: upnp:propchange\r\n");
 158         wpabuf_put_str(buf, "SID: uuid:");
 159         b = wpabuf_put(buf, 0);
 160         uuid_bin2str(e->s->uuid, b, 80);
 161         wpabuf_put(buf, os_strlen(b));
 162         wpabuf_put_str(buf, "\r\n");
 163         wpabuf_printf(buf, "SEQ: %u\r\n", e->subscriber_sequence);
 164         wpabuf_printf(buf, "CONTENT-LENGTH: %d\r\n",
 165                       (int) wpabuf_len(e->data));
 166         wpabuf_put_str(buf, "\r\n"); /* terminating empty line */
 167         wpabuf_put_buf(buf, e->data);
 168         return buf;
 169 }
 170
 171
 172 static void event_addr_failure(struct wps_event_ *e)
 173 {
 174         struct subscription *s = e->s;
 175
 176         e->addr->num_failures++;
 177         wpa_printf(MSG_DEBUG, "WPS UPnP: Failed to send event %p to %s "
 178                    "(num_failures=%u)",
 179                    e, e->addr->domain_and_port, e->addr->num_failures);
 180
 181         if (e->addr->num_failures < MAX_FAILURES) {
 182                 /* Try other addresses, if available */
 183                 event_retry(e, 1);
 184                 return;
 185         }
 186
 187         /*
 188          * If other side doesn't like what we say, forget about them.
 189          * (There is no way to tell other side that we are dropping them...).
 190          */
 191         wpa_printf(MSG_DEBUG, "WPS UPnP: Deleting subscription %p "
 192                    "address %s due to errors", s, e->addr->domain_and_port);
 193         dl_list_del(&e->addr->list);
 194         subscr_addr_delete(e->addr);
 195         e->addr = NULL;
 196
 197         if (dl_list_empty(&s->addr_list)) {
 198                 /* if we've given up on all addresses */
 199                 wpa_printf(MSG_DEBUG, "WPS UPnP: Removing subscription %p "
 200                            "with no addresses", s);
 201                 dl_list_del(&s->list);
 202                 subscription_destroy(s);
 203                 return;
 204         }
 205
 206         /* Try other addresses, if available */
 207         event_retry(e, 0);
 208 }
 209
 210
 211 static void event_http_cb(void *ctx, struct http_client *c,
 212                           enum http_client_event event)
 213 {
 214         struct wps_event_ *e = ctx;
 215         struct subscription *s = e->s;
 216
 217         wpa_printf(MSG_DEBUG, "WPS UPnP: HTTP client callback: e=%p c=%p "
 218                    "event=%d", e, c, event);
 219         switch (event) {
 220         case HTTP_CLIENT_OK:
 221                 wpa_printf(MSG_DEBUG,
 222                            "WPS UPnP: Got event %p reply OK from %s",
 223                            e, e->addr->domain_and_port);
 224                 e->addr->num_failures = 0;
 225                 event_delete(e);
 226
 227                 /* Schedule sending more if there is more to send */
 228                 if (!dl_list_empty(&s->event_queue))
 229                         event_send_all_later(s->sm);
 230                 break;
 231         case HTTP_CLIENT_FAILED:
 232                 wpa_printf(MSG_DEBUG, "WPS UPnP: Event send failure");
 233                 event_addr_failure(e);
 234                 break;
 235         case HTTP_CLIENT_INVALID_REPLY:
 236                 wpa_printf(MSG_DEBUG, "WPS UPnP: Invalid reply");
 237                 event_addr_failure(e);
 238                 break;
 239         case HTTP_CLIENT_TIMEOUT:
 240                 wpa_printf(MSG_DEBUG, "WPS UPnP: Event send timeout");
 241                 event_addr_failure(e);
 242                 break;
 243         }
 244 }
 245
 246
 247 /* event_send_start -- prepare to send a event message to subscriber
 248  *
 249  * This gets complicated because:
 250  * -- The message is sent via TCP and we have to keep the stream open
 251  *      for 30 seconds to get a response... then close it.
 252  * -- But we might have other event happen in the meantime...
 253  *      we have to queue them, if we lose them then the subscriber will
 254  *      be forced to unsubscribe and subscribe again.
 255  * -- If multiple URLs are provided then we are supposed to try successive
 256  *      ones after 30 second timeout.
 257  * -- The URLs might use domain names instead of dotted decimal addresses,
 258  *      and resolution of those may cause unwanted sleeping.
 259  * -- Doing the initial TCP connect can take a while, so we have to come
 260  *      back after connection and then send the data.
 261  *
 262  * Returns nonzero on error;
 263  *
 264  * Prerequisite: No current event send (s->current_event == NULL)
 265  *      and non-empty queue.
 266  */
 267 static int event_send_start(struct subscription *s)
 268 {
 269         struct wps_event_ *e;
 270         unsigned int itry;
 271         struct wpabuf *buf;
 272
 273         /*
 274          * Assume we are called ONLY with no current event and ONLY with
 275          * nonempty event queue and ONLY with at least one address to send to.
 276          */
 277         if (dl_list_empty(&s->addr_list))
 278                 return -1;
 279         if (s->current_event)
 280                 return -1;
 281         if (dl_list_empty(&s->event_queue))
 282                 return -1;
 283
 284         s->current_event = e = event_dequeue(s);
 285
 286         /* Use address according to number of retries */
 287         itry = 0;
 288         dl_list_for_each(e->addr, &s->addr_list, struct subscr_addr, list)
 289                 if (itry++ == e->retry)
 290                         break;
 291         if (itry < e->retry)
 292                 return -1;
 293
 294         buf = event_build_message(e);
 295         if (buf == NULL) {
 296                 event_retry(e, 0);
 297                 return -1;
 298         }
 299
 300         e->http_event = http_client_addr(&e->addr->saddr, buf, 0,
 301                                          event_http_cb, e);
 302         if (e->http_event == NULL) {
 303                 wpabuf_free(buf);
 304                 event_retry(e, 0);
 305                 return -1;
 306         }
 307
 308         return 0;
 309 }
 310
 311
 312 /* event_send_all_later_handler -- actually send events as needed */
 313 static void event_send_all_later_handler(void *eloop_data, void *user_ctx)
 314 {
 315         struct upnp_wps_device_sm *sm = user_ctx;
 316         struct subscription *s, *tmp;
 317         int nerrors = 0;
 318
 319         sm->event_send_all_queued = 0;
 320         dl_list_for_each_safe(s, tmp, &sm->subscriptions, struct subscription,
 321                               list) {
 322                 if (s->current_event == NULL /* not busy */ &&
 323                     !dl_list_empty(&s->event_queue) /* more to do */) {
 324                         if (event_send_start(s))
 325                                 nerrors++;
 326                 }
 327         }
 328
 329         if (nerrors) {
 330                 /* Try again later */
 331                 event_send_all_later(sm);
 332         }
 333 }
 334
 335
 336 /* event_send_all_later -- schedule sending events to all subscribers
 337  * that need it.
 338  * This avoids two problems:
 339  * -- After getting a subscription, we should not send the first event
 340  *      until after our reply is fully queued to be sent back,
 341  * -- Possible stack depth or infinite recursion issues.
 342  */
 343 void event_send_all_later(struct upnp_wps_device_sm *sm)
 344 {
 345         /*
 346          * The exact time in the future isn't too important. Waiting a bit
 347          * might let us do several together.
 348          */
 349         if (sm->event_send_all_queued)
 350                 return;
 351         sm->event_send_all_queued = 1;
 352         eloop_register_timeout(EVENT_DELAY_SECONDS, EVENT_DELAY_MSEC,
 353                                event_send_all_later_handler, NULL, sm);
 354 }
 355
 356
 357 /* event_send_stop_all -- cleanup */
 358 void event_send_stop_all(struct upnp_wps_device_sm *sm)
 359 {
 360         if (sm->event_send_all_queued)
 361                 eloop_cancel_timeout(event_send_all_later_handler, NULL, sm);
 362         sm->event_send_all_queued = 0;
 363 }
 364
 365
 366 /**
 367  * event_add - Add a new event to a queue
 368  * @s: Subscription
 369  * @data: Event data (is copied; caller retains ownership)
 370  * Returns: 0 on success, -1 on error, 1 on max event queue limit reached
 371  */
 372 int event_add(struct subscription *s, const struct wpabuf *data)
 373 {
 374         struct wps_event_ *e;
 375         unsigned int len;
 376
 377         len = dl_list_len(&s->event_queue);
 378         if (len >= MAX_EVENTS_QUEUED) {
 379                 wpa_printf(MSG_DEBUG, "WPS UPnP: Too many events queued for "
 380                            "subscriber %p", s);
 381                 return 1;
 382         }
 383
 384         e = os_zalloc(sizeof(*e));
 385         if (e == NULL)
 386                 return -1;
 387         dl_list_init(&e->list);
 388         e->s = s;
 389         e->data = wpabuf_dup(data);
 390         if (e->data == NULL) {
 391                 os_free(e);
 392                 return -1;
 393         }
 394         e->subscriber_sequence = s->next_subscriber_sequence++;
 395         if (s->next_subscriber_sequence == 0)
 396                 s->next_subscriber_sequence++;
 397         wpa_printf(MSG_DEBUG, "WPS UPnP: Queue event %p for subscriber %p "
 398                    "(queue len %u)", e, s, len + 1);
 399         dl_list_add_tail(&s->event_queue, &e->list);
 400         event_send_all_later(s->sm);
 401         return 0;
 402 }