1 /* 2 * Copyright (c) 2001 Atsushi Onoe 3 * Copyright (c) 2002-2005 Sam Leffler, Errno Consulting 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission. 16 * 17 * Alternatively, this software may be distributed under the terms of the 18 * GNU General Public License ("GPL") version 2 as published by the Free 19 * Software Foundation. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 * 32 * $FreeBSD: src/sys/net80211/ieee80211_node.h,v 1.17.2.5 2006/03/13 03:05:47 sam Exp $ 33 * $DragonFly: src/sys/netproto/802_11/ieee80211_node.h,v 1.5 2008/03/04 13:48:40 sephe Exp $ 34 */ 35 #ifndef _NET80211_IEEE80211_NODE_H_ 36 #define _NET80211_IEEE80211_NODE_H_ 37 38 #include <netproto/802_11/ieee80211_ioctl.h> /* for ieee80211_nodestats */ 39 40 /* 41 * Each ieee80211com instance has a single timer that fires once a 42 * second. This is used to initiate various work depending on the 43 * state of the instance: scanning (passive or active), ``transition'' 44 * (waiting for a response to a management frame when operating 45 * as a station), and node inactivity processing (when operating 46 * as an AP). For inactivity processing each node has a timeout 47 * set in it's ni_inact field that is decremented on each timeout 48 * and the node is reclaimed when the counter goes to zero. We 49 * use different inactivity timeout values depending on whether 50 * the node is associated and authorized (either by 802.1x or 51 * open/shared key authentication) or associated but yet to be 52 * authorized. The latter timeout is shorter to more aggressively 53 * reclaim nodes that leave part way through the 802.1x exchange. 54 */ 55 #define IEEE80211_INACT_WAIT 15 /* inactivity interval (secs) */ 56 #define IEEE80211_INACT_INIT (30/IEEE80211_INACT_WAIT) /* initial */ 57 #define IEEE80211_INACT_AUTH (180/IEEE80211_INACT_WAIT) /* associated but not authorized */ 58 #define IEEE80211_INACT_RUN (300/IEEE80211_INACT_WAIT) /* authorized */ 59 #define IEEE80211_INACT_PROBE (30/IEEE80211_INACT_WAIT) /* probe */ 60 #define IEEE80211_INACT_SCAN (300/IEEE80211_INACT_WAIT) /* scanned */ 61 62 #define IEEE80211_TRANS_WAIT 5 /* mgt frame tx timer (secs) */ 63 64 #define IEEE80211_NODE_HASHSIZE 32 65 /* simple hash is enough for variation of macaddr */ 66 #define IEEE80211_NODE_HASH(addr) \ 67 (((const uint8_t *)(addr))[IEEE80211_ADDR_LEN - 1] % \ 68 IEEE80211_NODE_HASHSIZE) 69 70 struct ieee80211_rsnparms { 71 uint8_t rsn_mcastcipher; /* mcast/group cipher */ 72 uint8_t rsn_mcastkeylen; /* mcast key length */ 73 uint8_t rsn_ucastcipherset; /* unicast cipher set */ 74 uint8_t rsn_ucastcipher; /* selected unicast cipher */ 75 uint8_t rsn_ucastkeylen; /* unicast key length */ 76 uint8_t rsn_keymgmtset; /* key mangement algorithms */ 77 uint8_t rsn_keymgmt; /* selected key mgmt algo */ 78 uint16_t rsn_caps; /* capabilities */ 79 }; 80 81 struct ieee80211_node_table; 82 struct ieee80211com; 83 84 /* 85 * Node specific information. Note that drivers are expected 86 * to derive from this structure to add device-specific per-node 87 * state. This is done by overriding the ic_node_* methods in 88 * the ieee80211com structure. 89 */ 90 struct ieee80211_node { 91 struct ieee80211com *ni_ic; 92 struct ieee80211_node_table *ni_table; 93 TAILQ_ENTRY(ieee80211_node) ni_list; 94 LIST_ENTRY(ieee80211_node) ni_hash; 95 u_int ni_refcnt; 96 uint8_t ni_authmode; /* authentication algorithm */ 97 uint16_t ni_flags; /* special-purpose state */ 98 #define IEEE80211_NODE_AUTH 0x0001 /* authorized for data */ 99 #define IEEE80211_NODE_QOS 0x0002 /* QoS enabled */ 100 #define IEEE80211_NODE_ERP 0x0004 /* ERP enabled */ 101 /* NB: this must have the same value as IEEE80211_FC1_PWR_MGT */ 102 #define IEEE80211_NODE_PWR_MGT 0x0010 /* power save mode enabled */ 103 #define IEEE80211_NODE_AREF 0x0020 /* authentication ref held */ 104 uint16_t ni_associd; /* assoc response */ 105 uint16_t ni_txpower; /* current transmit power */ 106 uint16_t ni_vlan; /* vlan tag */ 107 uint32_t *ni_challenge; /* shared-key challenge */ 108 uint8_t *ni_wpa_ie; /* captured WPA/RSN ie */ 109 uint8_t *ni_wme_ie; /* captured WME ie */ 110 uint16_t ni_txseqs[17]; /* tx seq per-tid */ 111 uint16_t ni_rxseqs[17]; /* rx seq previous per-tid*/ 112 uint32_t ni_rxfragstamp; /* time stamp of last rx frag */ 113 struct mbuf *ni_rxfrag[3]; /* rx frag reassembly */ 114 struct ieee80211_rsnparms ni_rsn; /* RSN/WPA parameters */ 115 struct ieee80211_key ni_ucastkey; /* unicast key */ 116 117 /* hardware */ 118 uint32_t ni_rstamp; /* recv timestamp */ 119 uint8_t ni_rssi; /* recv ssi */ 120 121 /* header */ 122 uint8_t ni_macaddr[IEEE80211_ADDR_LEN]; 123 uint8_t ni_bssid[IEEE80211_ADDR_LEN]; 124 125 /* beacon, probe response */ 126 union { 127 uint8_t data[8]; 128 uint64_t tsf; 129 } ni_tstamp; /* from last rcv'd beacon */ 130 uint16_t ni_intval; /* beacon interval */ 131 uint16_t ni_capinfo; /* capabilities */ 132 uint8_t ni_esslen; 133 uint8_t ni_essid[IEEE80211_NWID_LEN]; 134 struct ieee80211_rateset ni_rates; /* negotiated rate set */ 135 struct ieee80211_channel *ni_chan; /* XXX multiple uses */ 136 uint16_t ni_fhdwell; /* FH only */ 137 uint8_t ni_fhindex; /* FH only */ 138 uint8_t ni_erp; /* ERP from beacon/probe resp */ 139 uint16_t ni_timoff; /* byte offset to TIM ie */ 140 uint8_t ni_dtim_period; /* DTIM period */ 141 uint8_t ni_dtim_count; /* DTIM count for last bcn */ 142 143 /* others */ 144 int ni_fails; /* failure count to associate */ 145 short ni_inact; /* inactivity mark count */ 146 short ni_inact_reload;/* inactivity reload value */ 147 int ni_txrate; /* index to ni_rates[] */ 148 struct ifqueue ni_savedq; /* ps-poll queue */ 149 struct ieee80211_nodestats ni_stats; /* per-node statistics */ 150 void *ni_rate_data; 151 uint32_t ni_pad[8]; /* future expansion */ 152 }; 153 MALLOC_DECLARE(M_80211_NODE); 154 155 #define IEEE80211_NODE_AID(ni) IEEE80211_AID(ni->ni_associd) 156 157 #define IEEE80211_NODE_STAT(ni,stat) (ni->ni_stats.ns_##stat++) 158 #define IEEE80211_NODE_STAT_ADD(ni,stat,v) (ni->ni_stats.ns_##stat += v) 159 #define IEEE80211_NODE_STAT_SET(ni,stat,v) (ni->ni_stats.ns_##stat = v) 160 161 static __inline struct ieee80211_node * 162 ieee80211_ref_node(struct ieee80211_node *ni) 163 { 164 ieee80211_node_incref(ni); 165 return ni; 166 } 167 168 static __inline void 169 ieee80211_unref_node(struct ieee80211_node **ni) 170 { 171 ieee80211_node_decref(*ni); 172 *ni = NULL; /* guard against use */ 173 } 174 175 struct ieee80211com; 176 177 void ieee80211_node_attach(struct ieee80211com *); 178 void ieee80211_node_lateattach(struct ieee80211com *); 179 void ieee80211_node_detach(struct ieee80211com *); 180 181 static __inline int 182 ieee80211_node_is_authorized(const struct ieee80211_node *ni) 183 { 184 return (ni->ni_flags & IEEE80211_NODE_AUTH); 185 } 186 187 void ieee80211_node_authorize(struct ieee80211_node *); 188 void ieee80211_node_unauthorize(struct ieee80211_node *); 189 190 void ieee80211_begin_scan(struct ieee80211com *, int); 191 int ieee80211_next_scan(struct ieee80211com *); 192 void ieee80211_set_scanchan(struct ieee80211com *, 193 struct ieee80211_channel *); 194 void ieee80211_probe_curchan(struct ieee80211com *, int); 195 void ieee80211_create_ibss(struct ieee80211com*, struct ieee80211_channel *); 196 void ieee80211_reset_bss(struct ieee80211com *); 197 void ieee80211_cancel_scan(struct ieee80211com *); 198 void ieee80211_end_scan(struct ieee80211com *); 199 int ieee80211_ibss_merge(struct ieee80211_node *); 200 int ieee80211_sta_join(struct ieee80211com *, struct ieee80211_node *); 201 void ieee80211_sta_leave(struct ieee80211com *, struct ieee80211_node *); 202 void ieee80211_update_shpreamble(struct ieee80211com *, 203 const struct ieee80211_node *); 204 205 /* 206 * Table of ieee80211_node instances. Each ieee80211com 207 * has at least one for holding the scan candidates. 208 * When operating as an access point or in ibss mode there 209 * is a second table for associated stations or neighbors. 210 */ 211 struct ieee80211_node_table { 212 struct ieee80211com *nt_ic; /* back reference */ 213 TAILQ_HEAD(, ieee80211_node) nt_node; /* information of all nodes */ 214 LIST_HEAD(, ieee80211_node) nt_hash[IEEE80211_NODE_HASHSIZE]; 215 const char *nt_name; /* for debugging */ 216 int nt_inact_timer; /* inactivity timer */ 217 int nt_inact_init; /* initial node inact setting */ 218 struct ieee80211_node **nt_keyixmap; /* key ix -> node map */ 219 int nt_keyixmax; /* keyixmap size */ 220 221 void (*nt_timeout)(struct ieee80211_node_table *); 222 }; 223 void ieee80211_node_table_reset(struct ieee80211_node_table *); 224 225 struct ieee80211_node *ieee80211_alloc_node( 226 struct ieee80211_node_table *, const uint8_t *); 227 struct ieee80211_node *ieee80211_tmp_node(struct ieee80211com *, 228 const uint8_t *macaddr); 229 struct ieee80211_node *ieee80211_dup_bss(struct ieee80211_node_table *, 230 const uint8_t *); 231 #ifdef IEEE80211_DEBUG_REFCNT 232 void ieee80211_free_node_debug(struct ieee80211_node *, 233 const char *func, int line); 234 struct ieee80211_node *ieee80211_find_node_debug( 235 struct ieee80211_node_table *, const uint8_t *, 236 const char *func, int line); 237 struct ieee80211_node * ieee80211_find_rxnode_debug( 238 struct ieee80211com *, const struct ieee80211_frame_min *, 239 const char *func, int line); 240 struct ieee80211_node * ieee80211_find_rxnode_withkey_debug( 241 struct ieee80211com *, 242 const struct ieee80211_frame_min *, uint16_t keyix, 243 const char *func, int line); 244 struct ieee80211_node *ieee80211_find_txnode_debug( 245 struct ieee80211com *, const uint8_t *, 246 const char *func, int line); 247 struct ieee80211_node *ieee80211_find_node_with_channel_debug( 248 struct ieee80211_node_table *, const uint8_t *macaddr, 249 struct ieee80211_channel *, const char *func, int line); 250 struct ieee80211_node *ieee80211_find_node_with_ssid_debug( 251 struct ieee80211_node_table *, const uint8_t *macaddr, 252 u_int ssidlen, const uint8_t *ssid, 253 const char *func, int line); 254 #define ieee80211_free_node(ni) \ 255 ieee80211_free_node_debug(ni, __func__, __LINE__) 256 #define ieee80211_find_node(nt, mac) \ 257 ieee80211_find_node_debug(nt, mac, __func__, __LINE__) 258 #define ieee80211_find_rxnode(nt, wh) \ 259 ieee80211_find_rxnode_debug(nt, wh, __func__, __LINE__) 260 #define ieee80211_find_rxnode_withkey(nt, wh, keyix) \ 261 ieee80211_find_rxnode_withkey_debug(nt, wh, keyix, __func__, __LINE__) 262 #define ieee80211_find_txnode(nt, mac) \ 263 ieee80211_find_txnode_debug(nt, mac, __func__, __LINE__) 264 #define ieee80211_find_node_with_channel(nt, mac, c) \ 265 ieee80211_find_node_with_channel_debug(nt, mac, c, __func__, __LINE__) 266 #define ieee80211_find_node_with_ssid(nt, mac, sl, ss) \ 267 ieee80211_find_node_with_ssid_debug(nt, mac, sl, ss, __func__, __LINE__) 268 #else 269 void ieee80211_free_node(struct ieee80211_node *); 270 struct ieee80211_node *ieee80211_find_node( 271 struct ieee80211_node_table *, const uint8_t *); 272 struct ieee80211_node * ieee80211_find_rxnode( 273 struct ieee80211com *, const struct ieee80211_frame_min *); 274 struct ieee80211_node * ieee80211_find_rxnode_withkey(struct ieee80211com *, 275 const struct ieee80211_frame_min *, uint16_t keyix); 276 struct ieee80211_node *ieee80211_find_txnode( 277 struct ieee80211com *, const uint8_t *); 278 struct ieee80211_node *ieee80211_find_node_with_channel( 279 struct ieee80211_node_table *, const uint8_t *macaddr, 280 struct ieee80211_channel *); 281 struct ieee80211_node *ieee80211_find_node_with_ssid( 282 struct ieee80211_node_table *, const uint8_t *macaddr, 283 u_int ssidlen, const uint8_t *ssid); 284 #endif 285 int ieee80211_node_delucastkey(struct ieee80211_node *); 286 287 typedef void ieee80211_iter_func(void *, struct ieee80211_node *); 288 void ieee80211_iterate_nodes(struct ieee80211_node_table *, 289 ieee80211_iter_func *, void *); 290 291 void ieee80211_dump_node(struct ieee80211_node_table *, 292 struct ieee80211_node *); 293 void ieee80211_dump_nodes(struct ieee80211_node_table *); 294 295 struct ieee80211_node *ieee80211_fakeup_adhoc_node( 296 struct ieee80211_node_table *, const uint8_t macaddr[]); 297 void ieee80211_node_join(struct ieee80211com *, struct ieee80211_node *,int); 298 void ieee80211_node_leave(struct ieee80211com *, struct ieee80211_node *); 299 uint8_t ieee80211_getrssi(struct ieee80211com *ic); 300 301 /* 302 * Parameters supplied when adding/updating an entry in a 303 * scan cache. Pointer variables should be set to NULL 304 * if no data is available. Pointer references can be to 305 * local data; any information that is saved will be copied. 306 * All multi-byte values must be in host byte order. 307 */ 308 struct ieee80211_scanparams { 309 uint16_t capinfo; /* 802.11 capabilities */ 310 uint16_t fhdwell; /* FHSS dwell interval */ 311 uint8_t chan; /* */ 312 uint8_t bchan; 313 uint8_t fhindex; 314 uint8_t erp; 315 uint16_t bintval; 316 uint8_t timoff; 317 uint8_t *tim; 318 uint8_t *tstamp; 319 uint8_t *country; 320 uint8_t *ssid; 321 uint8_t *rates; 322 uint8_t *xrates; 323 uint8_t *wpa; 324 uint8_t *wme; 325 }; 326 327 void ieee80211_add_scan(struct ieee80211com *, 328 const struct ieee80211_scanparams *, 329 const struct ieee80211_frame *, 330 int subtype, int rssi, int rstamp); 331 void ieee80211_init_neighbor(struct ieee80211_node *, 332 const struct ieee80211_frame *, 333 const struct ieee80211_scanparams *); 334 struct ieee80211_node *ieee80211_add_neighbor(struct ieee80211com *, 335 const struct ieee80211_frame *, 336 const struct ieee80211_scanparams *); 337 #endif /* _NET80211_IEEE80211_NODE_H_ */ 338