18d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* 28d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * UPnP for WPS / internal definitions 38d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Copyright (c) 2000-2003 Intel Corporation 48d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Copyright (c) 2006-2007 Sony Corporation 58d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Copyright (c) 2008-2009 Atheros Communications 68d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Copyright (c) 2009, Jouni Malinen <j@w1.fi> 78d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 88d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * See wps_upnp.c for more details on licensing and code history. 98d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#ifndef WPS_UPNP_I_H 128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define WPS_UPNP_I_H 138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#include "utils/list.h" 158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#include "http.h" 168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define UPNP_MULTICAST_ADDRESS "239.255.255.250" /* for UPnP multicasting */ 188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define UPNP_MULTICAST_PORT 1900 /* UDP port to monitor for UPnP */ 198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* min subscribe time per UPnP standard */ 218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define UPNP_SUBSCRIBE_SEC_MIN 1800 228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* subscribe time we use */ 238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define UPNP_SUBSCRIBE_SEC (UPNP_SUBSCRIBE_SEC_MIN + 1) 248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* "filenames" used in URLs that we service via our "web server": */ 268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define UPNP_WPS_DEVICE_XML_FILE "wps_device.xml" 278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define UPNP_WPS_SCPD_XML_FILE "wps_scpd.xml" 288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define UPNP_WPS_DEVICE_CONTROL_FILE "wps_control" 298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define UPNP_WPS_DEVICE_EVENT_FILE "wps_event" 308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define MULTICAST_MAX_READ 1600 /* max bytes we'll read for UPD request */ 328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 338d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct upnp_wps_device_sm; 358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct wps_registrar; 368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtenum advertisement_type_enum { 398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt ADVERTISE_UP = 0, 408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt ADVERTISE_DOWN = 1, 418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt MSEARCH_REPLY = 2 428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* 458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Advertisements are broadcast via UDP NOTIFYs, and are also the essence of 468d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * the reply to UDP M-SEARCH requests. This struct handles both cases. 478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * A state machine is needed because a number of variant forms must be sent in 498d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * separate packets and spread out in time to avoid congestion. 508d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct advertisement_state_machine { 528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct dl_list list; 538d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt enum advertisement_type_enum type; 548d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int state; 558d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int nerrors; 568d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct sockaddr_in client; /* for M-SEARCH replies */ 578d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 588d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 598d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 608d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* 618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * An address of a subscriber (who may have multiple addresses). We are 628d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * supposed to send (via TCP) updates to each subscriber, trying each address 638d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * for a subscriber until we find one that seems to work. 648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct subscr_addr { 668d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct dl_list list; 678d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt char *domain_and_port; /* domain and port part of url */ 688d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt char *path; /* "filepath" part of url (from "mem") */ 698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct sockaddr_in saddr; /* address for doing connect */ 708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt unsigned num_failures; 718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 728d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 738d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 748d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* 758d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Subscribers to our events are recorded in this struct. This includes a max 768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * of one outgoing connection (sending an "event message") per subscriber. We 778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * also have to age out subscribers unless they renew. 788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 798d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct subscription { 808d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct dl_list list; 818d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct upnp_wps_device_sm *sm; /* parent */ 828d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt time_t timeout_time; /* when to age out the subscription */ 838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt unsigned next_subscriber_sequence; /* number our messages */ 848d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /* 858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This uuid identifies the subscription and is randomly generated by 868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * us and given to the subscriber when the subscription is accepted; 878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * and is then included with each event sent to the subscriber. 888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 898d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt u8 uuid[UUID_LEN]; 908d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /* Linked list of address alternatives (rotate through on failure) */ 918d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct dl_list addr_list; 928d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct dl_list event_queue; /* Queued event messages. */ 938d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct wps_event_ *current_event; /* non-NULL if being sent (not in q) 948d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 958d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int last_event_failed; /* Whether delivery of last event failed */ 968d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 978d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /* Information from SetSelectedRegistrar action */ 988d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt u8 selected_registrar; 998d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt u16 dev_password_id; 1008d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt u16 config_methods; 1018d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt u8 authorized_macs[WPS_MAX_AUTHORIZED_MACS][ETH_ALEN]; 1028d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct wps_registrar *reg; 1038d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 1048d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1058d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1068d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct upnp_wps_device_interface { 1078d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct dl_list list; 1088d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct upnp_wps_device_ctx *ctx; /* callback table */ 1098d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct wps_context *wps; 1108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt void *priv; 1118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /* FIX: maintain separate structures for each UPnP peer */ 1138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct upnp_wps_peer peer; 1148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 1158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* 1178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Our instance data corresponding to the AP device. Note that there may be 1188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * multiple wireless interfaces sharing the same UPnP device instance. Each 1198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * such interface is stored in the list of struct upnp_wps_device_interface 1208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * instances. 1218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This is known as an opaque struct declaration to users of the WPS UPnP code. 1238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct upnp_wps_device_sm { 1258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct dl_list interfaces; /* struct upnp_wps_device_interface */ 1268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt char *root_dir; 1278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt char *desc_url; 1288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int started; /* nonzero if we are active */ 1298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt u8 mac_addr[ETH_ALEN]; /* mac addr of network i.f. we use */ 1308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt char *ip_addr_text; /* IP address of network i.f. we use */ 1318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt unsigned ip_addr; /* IP address of network i.f. we use (host order) */ 1328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int multicast_sd; /* send multicast messages over this socket */ 1338d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int ssdp_sd; /* receive discovery UPD packets on socket */ 1348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int ssdp_sd_registered; /* nonzero if we must unregister */ 1358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt unsigned advertise_count; /* how many advertisements done */ 1368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct advertisement_state_machine advertisement; 1378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct dl_list msearch_replies; 1388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int web_port; /* our port that others get xml files from */ 1398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct http_server *web_srv; 1408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /* Note: subscriptions are kept in expiry order */ 1418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct dl_list subscriptions; 1428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int event_send_all_queued; /* if we are scheduled to send events soon 1438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt char *wlanevent; /* the last WLANEvent data */ 1468d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt enum upnp_wps_wlanevent_type wlanevent_type; 1478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt os_time_t last_event_sec; 1488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt unsigned int num_events_in_sec; 1498d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 1508d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* wps_upnp.c */ 1528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid format_date(struct wpabuf *buf); 1538d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct subscription * subscription_start(struct upnp_wps_device_sm *sm, 1548d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *callback_urls); 1558d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct subscription * subscription_renew(struct upnp_wps_device_sm *sm, 1568d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const u8 uuid[UUID_LEN]); 1578d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid subscription_destroy(struct subscription *s); 1588d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct subscription * subscription_find(struct upnp_wps_device_sm *sm, 1598d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const u8 uuid[UUID_LEN]); 1608d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid subscr_addr_delete(struct subscr_addr *a); 1618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint send_wpabuf(int fd, struct wpabuf *buf); 1628d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint get_netif_info(const char *net_if, unsigned *ip_addr, char **ip_addr_text, 1638d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt u8 mac[ETH_ALEN]); 1648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* wps_upnp_ssdp.c */ 1668d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid msearchreply_state_machine_stop(struct advertisement_state_machine *a); 1678d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint advertisement_state_machine_start(struct upnp_wps_device_sm *sm); 1688d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid advertisement_state_machine_stop(struct upnp_wps_device_sm *sm, 1698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int send_byebye); 1708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid ssdp_listener_stop(struct upnp_wps_device_sm *sm); 1718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint ssdp_listener_start(struct upnp_wps_device_sm *sm); 1728d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint ssdp_listener_open(void); 1738d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint add_ssdp_network(const char *net_if); 1748d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint ssdp_open_multicast_sock(u32 ip_addr); 1758d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint ssdp_open_multicast(struct upnp_wps_device_sm *sm); 1768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* wps_upnp_web.c */ 1788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint web_listener_start(struct upnp_wps_device_sm *sm); 1798d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid web_listener_stop(struct upnp_wps_device_sm *sm); 1808d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1818d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* wps_upnp_event.c */ 1828d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint event_add(struct subscription *s, const struct wpabuf *data, int probereq); 1838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid event_delete_all(struct subscription *s); 1848d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid event_send_all_later(struct upnp_wps_device_sm *sm); 1858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid event_send_stop_all(struct upnp_wps_device_sm *sm); 1868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* wps_upnp_ap.c */ 1888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint upnp_er_set_selected_registrar(struct wps_registrar *reg, 1898d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct subscription *s, 1908d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const struct wpabuf *msg); 191c5ec7f57ead87efa365800228aa0b09a12d9e6c4Dmitry Shmidtvoid upnp_er_remove_notification(struct wps_registrar *reg, 192c5ec7f57ead87efa365800228aa0b09a12d9e6c4Dmitry Shmidt struct subscription *s); 1938d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1948d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#endif /* WPS_UPNP_I_H */ 195