src/wps/wps_upnp_i.h

   1 /*
   2  * UPnP for WPS / internal definitions
   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, Jouni Malinen <j@w1.fi>
   7  *
   8  * See wps_upnp.c for more details on licensing and code history.
   9  */
  10
  11 #ifndef WPS_UPNP_I_H
  12 #define WPS_UPNP_I_H
  13
  14 #include "http.h"
  15
  16 #define UPNP_MULTICAST_ADDRESS  "239.255.255.250" /* for UPnP multicasting */
  17 #define UPNP_MULTICAST_PORT 1900 /* UDP port to monitor for UPnP */
  18
  19 /* min subscribe time per UPnP standard */
  20 #define UPNP_SUBSCRIBE_SEC_MIN 1800
  21 /* subscribe time we use */
  22 #define UPNP_SUBSCRIBE_SEC (UPNP_SUBSCRIBE_SEC_MIN + 1)
  23
  24 /* "filenames" used in URLs that we service via our "web server": */
  25 #define UPNP_WPS_DEVICE_XML_FILE "wps_device.xml"
  26 #define UPNP_WPS_SCPD_XML_FILE   "wps_scpd.xml"
  27 #define UPNP_WPS_DEVICE_CONTROL_FILE "wps_control"
  28 #define UPNP_WPS_DEVICE_EVENT_FILE "wps_event"
  29
  30 #define MULTICAST_MAX_READ 1600 /* max bytes we'll read for UPD request */
  31
  32
  33 struct web_connection;
  34 struct subscription;
  35 struct upnp_wps_device_sm;
  36
  37
  38 enum advertisement_type_enum {
  39         ADVERTISE_UP = 0,
  40         ADVERTISE_DOWN = 1,
  41         MSEARCH_REPLY = 2
  42 };
  43
  44 /*
  45  * Advertisements are broadcast via UDP NOTIFYs, and are also the essence of
  46  * the reply to UDP M-SEARCH requests. This struct handles both cases.
  47  *
  48  * A state machine is needed because a number of variant forms must be sent in
  49  * separate packets and spread out in time to avoid congestion.
  50  */
  51 struct advertisement_state_machine {
  52         /* double-linked list */
  53         struct advertisement_state_machine *next;
  54         struct advertisement_state_machine *prev;
  55         struct upnp_wps_device_sm *sm; /* parent */
  56         enum advertisement_type_enum type;
  57         int state;
  58         int nerrors;
  59         struct sockaddr_in client; /* for M-SEARCH replies */
  60 };
  61
  62
  63 /*
  64  * An address of a subscriber (who may have multiple addresses). We are
  65  * supposed to send (via TCP) updates to each subscriber, trying each address
  66  * for a subscriber until we find one that seems to work.
  67  */
  68 struct subscr_addr {
  69         /* double linked list */
  70         struct subscr_addr *next;
  71         struct subscr_addr *prev;
  72         struct subscription *s; /* parent */
  73         char *domain_and_port; /* domain and port part of url */
  74         char *path; /* "filepath" part of url (from "mem") */
  75         struct sockaddr_in saddr; /* address for doing connect */
  76 };
  77
  78
  79 /*
  80  * Subscribers to our events are recorded in this struct. This includes a max
  81  * of one outgoing connection (sending an "event message") per subscriber. We
  82  * also have to age out subscribers unless they renew.
  83  */
  84 struct subscription {
  85         /* double linked list */
  86         struct subscription *next;
  87         struct subscription *prev;
  88         struct upnp_wps_device_sm *sm; /* parent */
  89         time_t timeout_time; /* when to age out the subscription */
  90         unsigned next_subscriber_sequence; /* number our messages */
  91         /*
  92          * This uuid identifies the subscription and is randomly generated by
  93          * us and given to the subscriber when the subscription is accepted;
  94          * and is then included with each event sent to the subscriber.
  95          */
  96         u8 uuid[UUID_LEN];
  97         /* Linked list of address alternatives (rotate through on failure) */
  98         struct subscr_addr *addr_list;
  99         int n_addr; /* Number of addresses in list */
 100         struct wps_event_ *event_queue; /* Queued event messages. */
 101         int n_queue; /* How many events are queued */
 102         struct wps_event_ *current_event; /* non-NULL if being sent (not in q)
 103                                            */
 104 };
 105
 106
 107 /*
 108  * Our instance data corresponding to one WiFi network interface
 109  * (multiple might share the same wired network interface!).
 110  *
 111  * This is known as an opaque struct declaration to users of the WPS UPnP code.
 112  */
 113 struct upnp_wps_device_sm {
 114         struct upnp_wps_device_ctx *ctx; /* callback table */
 115         struct wps_context *wps;
 116         void *priv;
 117         char *root_dir;
 118         char *desc_url;
 119         int started; /* nonzero if we are active */
 120         char *net_if; /* network interface we use */
 121         char *mac_addr_text; /* mac addr of network i.f. we use */
 122         u8 mac_addr[ETH_ALEN]; /* mac addr of network i.f. we use */
 123         char *ip_addr_text; /* IP address of network i.f. we use */
 124         unsigned ip_addr; /* IP address of network i.f. we use (host order) */
 125         int multicast_sd; /* send multicast messages over this socket */
 126         int ssdp_sd; /* receive discovery UPD packets on socket */
 127         int ssdp_sd_registered; /* nonzero if we must unregister */
 128         unsigned advertise_count; /* how many advertisements done */
 129         struct advertisement_state_machine advertisement;
 130         struct advertisement_state_machine *msearch_replies;
 131         int n_msearch_replies; /* no. of pending M-SEARCH replies */
 132         int web_port; /* our port that others get xml files from */
 133         int web_sd; /* socket to listen for web requests */
 134         int web_sd_registered; /* nonzero if we must cancel registration */
 135         struct web_connection *web_connections; /* linked list */
 136         int n_web_connections; /* no. of pending web connections */
 137         /* Note: subscriptions are kept in expiry order */
 138         struct subscription *subscriptions; /* linked list */
 139         int n_subscriptions; /* no of current subscriptions */
 140         int event_send_all_queued; /* if we are scheduled to send events soon
 141                                     */
 142
 143         char *wlanevent; /* the last WLANEvent data */
 144
 145         /* FIX: maintain separate structures for each UPnP peer */
 146         struct upnp_wps_peer peer;
 147 };
 148
 149 /* wps_upnp.c */
 150 void format_date(struct wpabuf *buf);
 151 struct subscription * subscription_start(struct upnp_wps_device_sm *sm,
 152                                          char *callback_urls);
 153 struct subscription * subscription_renew(struct upnp_wps_device_sm *sm,
 154                                          const u8 uuid[UUID_LEN]);
 155 void subscription_unlink(struct subscription *s);
 156 void subscription_destroy(struct subscription *s);
 157 struct subscription * subscription_find(struct upnp_wps_device_sm *sm,
 158                                         const u8 uuid[UUID_LEN]);
 159 int send_wpabuf(int fd, struct wpabuf *buf);
 160 int get_netif_info(const char *net_if, unsigned *ip_addr, char **ip_addr_text,
 161                    u8 mac[ETH_ALEN], char **mac_addr_text);
 162
 163 /* wps_upnp_ssdp.c */
 164 void msearchreply_state_machine_stop(struct advertisement_state_machine *a);
 165 int advertisement_state_machine_start(struct upnp_wps_device_sm *sm);
 166 void advertisement_state_machine_stop(struct upnp_wps_device_sm *sm);
 167 void ssdp_listener_stop(struct upnp_wps_device_sm *sm);
 168 int ssdp_listener_start(struct upnp_wps_device_sm *sm);
 169 int ssdp_listener_open(void);
 170 int add_ssdp_network(const char *net_if);
 171 int ssdp_open_multicast_sock(u32 ip_addr);
 172 int ssdp_open_multicast(struct upnp_wps_device_sm *sm);
 173
 174 /* wps_upnp_web.c */
 175 void web_connection_stop(struct web_connection *c);
 176 int web_listener_start(struct upnp_wps_device_sm *sm);
 177 void web_listener_stop(struct upnp_wps_device_sm *sm);
 178
 179 /* wps_upnp_event.c */
 180 int event_add(struct subscription *s, const struct wpabuf *data);
 181 void event_delete_all(struct subscription *s);
 182 void event_send_all_later(struct upnp_wps_device_sm *sm);
 183 void event_send_stop_all(struct upnp_wps_device_sm *sm);
 184
 185 #endif /* WPS_UPNP_I_H */