Disconnect hostapd from building in base
[dragonfly.git] / contrib / hostapd / src / wps / wps_upnp_i.h
CommitLineData
a875087d
JL
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
4781064b
JM
14#include "utils/list.h"
15#include "http.h"
16
a875087d
JL
17#define UPNP_MULTICAST_ADDRESS "239.255.255.250" /* for UPnP multicasting */
18#define UPNP_MULTICAST_PORT 1900 /* UDP port to monitor for UPnP */
19
20/* min subscribe time per UPnP standard */
21#define UPNP_SUBSCRIBE_SEC_MIN 1800
22/* subscribe time we use */
23#define UPNP_SUBSCRIBE_SEC (UPNP_SUBSCRIBE_SEC_MIN + 1)
24
25/* "filenames" used in URLs that we service via our "web server": */
26#define UPNP_WPS_DEVICE_XML_FILE "wps_device.xml"
27#define UPNP_WPS_SCPD_XML_FILE "wps_scpd.xml"
28#define UPNP_WPS_DEVICE_CONTROL_FILE "wps_control"
29#define UPNP_WPS_DEVICE_EVENT_FILE "wps_event"
30
4781064b 31#define MULTICAST_MAX_READ 1600 /* max bytes we'll read for UPD request */
a875087d
JL
32
33
4781064b
JM
34struct upnp_wps_device_sm;
35struct wps_registrar;
a875087d
JL
36
37
38enum 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 */
51struct advertisement_state_machine {
4781064b 52 struct dl_list list;
a875087d
JL
53 enum advertisement_type_enum type;
54 int state;
55 int nerrors;
56 struct sockaddr_in client; /* for M-SEARCH replies */
57};
58
59
60/*
61 * An address of a subscriber (who may have multiple addresses). We are
62 * supposed to send (via TCP) updates to each subscriber, trying each address
63 * for a subscriber until we find one that seems to work.
64 */
65struct subscr_addr {
4781064b 66 struct dl_list list;
a875087d
JL
67 char *domain_and_port; /* domain and port part of url */
68 char *path; /* "filepath" part of url (from "mem") */
69 struct sockaddr_in saddr; /* address for doing connect */
4781064b 70 unsigned num_failures;
a875087d
JL
71};
72
73
74/*
75 * Subscribers to our events are recorded in this struct. This includes a max
76 * of one outgoing connection (sending an "event message") per subscriber. We
77 * also have to age out subscribers unless they renew.
78 */
79struct subscription {
4781064b 80 struct dl_list list;
a875087d
JL
81 struct upnp_wps_device_sm *sm; /* parent */
82 time_t timeout_time; /* when to age out the subscription */
83 unsigned next_subscriber_sequence; /* number our messages */
84 /*
85 * This uuid identifies the subscription and is randomly generated by
86 * us and given to the subscriber when the subscription is accepted;
87 * and is then included with each event sent to the subscriber.
88 */
89 u8 uuid[UUID_LEN];
90 /* Linked list of address alternatives (rotate through on failure) */
4781064b
JM
91 struct dl_list addr_list;
92 struct dl_list event_queue; /* Queued event messages. */
a875087d
JL
93 struct wps_event_ *current_event; /* non-NULL if being sent (not in q)
94 */
4781064b
JM
95 int last_event_failed; /* Whether delivery of last event failed */
96
97 /* Information from SetSelectedRegistrar action */
98 u8 selected_registrar;
99 u16 dev_password_id;
100 u16 config_methods;
101 u8 authorized_macs[WPS_MAX_AUTHORIZED_MACS][ETH_ALEN];
102 struct wps_registrar *reg;
a875087d
JL
103};
104
105
4781064b
JM
106struct upnp_wps_device_interface {
107 struct dl_list list;
108 struct upnp_wps_device_ctx *ctx; /* callback table */
109 struct wps_context *wps;
110 void *priv;
111
112 /* FIX: maintain separate structures for each UPnP peer */
113 struct upnp_wps_peer peer;
114};
115
a875087d 116/*
4781064b
JM
117 * Our instance data corresponding to the AP device. Note that there may be
118 * multiple wireless interfaces sharing the same UPnP device instance. Each
119 * such interface is stored in the list of struct upnp_wps_device_interface
120 * instances.
a875087d
JL
121 *
122 * This is known as an opaque struct declaration to users of the WPS UPnP code.
123 */
124struct upnp_wps_device_sm {
4781064b 125 struct dl_list interfaces; /* struct upnp_wps_device_interface */
a875087d
JL
126 char *root_dir;
127 char *desc_url;
128 int started; /* nonzero if we are active */
a875087d
JL
129 u8 mac_addr[ETH_ALEN]; /* mac addr of network i.f. we use */
130 char *ip_addr_text; /* IP address of network i.f. we use */
131 unsigned ip_addr; /* IP address of network i.f. we use (host order) */
132 int multicast_sd; /* send multicast messages over this socket */
133 int ssdp_sd; /* receive discovery UPD packets on socket */
134 int ssdp_sd_registered; /* nonzero if we must unregister */
135 unsigned advertise_count; /* how many advertisements done */
136 struct advertisement_state_machine advertisement;
4781064b 137 struct dl_list msearch_replies;
a875087d 138 int web_port; /* our port that others get xml files from */
4781064b 139 struct http_server *web_srv;
a875087d 140 /* Note: subscriptions are kept in expiry order */
4781064b 141 struct dl_list subscriptions;
a875087d
JL
142 int event_send_all_queued; /* if we are scheduled to send events soon
143 */
144
145 char *wlanevent; /* the last WLANEvent data */
4781064b
JM
146 enum upnp_wps_wlanevent_type wlanevent_type;
147 os_time_t last_event_sec;
148 unsigned int num_events_in_sec;
a875087d
JL
149};
150
151/* wps_upnp.c */
152void format_date(struct wpabuf *buf);
153struct subscription * subscription_start(struct upnp_wps_device_sm *sm,
154 const char *callback_urls);
155struct subscription * subscription_renew(struct upnp_wps_device_sm *sm,
156 const u8 uuid[UUID_LEN]);
a875087d
JL
157void subscription_destroy(struct subscription *s);
158struct subscription * subscription_find(struct upnp_wps_device_sm *sm,
159 const u8 uuid[UUID_LEN]);
4781064b
JM
160void subscr_addr_delete(struct subscr_addr *a);
161int get_netif_info(const char *net_if, unsigned *ip_addr, char **ip_addr_text,
162 u8 mac[ETH_ALEN]);
a875087d
JL
163
164/* wps_upnp_ssdp.c */
165void msearchreply_state_machine_stop(struct advertisement_state_machine *a);
166int advertisement_state_machine_start(struct upnp_wps_device_sm *sm);
167void advertisement_state_machine_stop(struct upnp_wps_device_sm *sm,
168 int send_byebye);
169void ssdp_listener_stop(struct upnp_wps_device_sm *sm);
170int ssdp_listener_start(struct upnp_wps_device_sm *sm);
4781064b
JM
171int ssdp_listener_open(void);
172int add_ssdp_network(const char *net_if);
173int ssdp_open_multicast_sock(u32 ip_addr, const char *forced_ifname);
a875087d
JL
174int ssdp_open_multicast(struct upnp_wps_device_sm *sm);
175
176/* wps_upnp_web.c */
a875087d
JL
177int web_listener_start(struct upnp_wps_device_sm *sm);
178void web_listener_stop(struct upnp_wps_device_sm *sm);
179
180/* wps_upnp_event.c */
4781064b 181int event_add(struct subscription *s, const struct wpabuf *data, int probereq);
a875087d
JL
182void event_delete_all(struct subscription *s);
183void event_send_all_later(struct upnp_wps_device_sm *sm);
184void event_send_stop_all(struct upnp_wps_device_sm *sm);
185
4781064b
JM
186/* wps_upnp_ap.c */
187int upnp_er_set_selected_registrar(struct wps_registrar *reg,
188 struct subscription *s,
189 const struct wpabuf *msg);
190void upnp_er_remove_notification(struct wps_registrar *reg,
191 struct subscription *s);
192
a875087d 193#endif /* WPS_UPNP_I_H */