sys/net80211/ieee80211_node.h

   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$
  33  */
  34 #ifndef _NET80211_IEEE80211_NODE_H_
  35 #define _NET80211_IEEE80211_NODE_H_
  36
  37 #include <net80211/ieee80211_ioctl.h>           /* for ieee80211_nodestats */
  38
  39 /*
  40  * Each ieee80211com instance has a single timer that fires once a
  41  * second.  This is used to initiate various work depending on the
  42  * state of the instance: scanning (passive or active), ``transition''
  43  * (waiting for a response to a management frame when operating
  44  * as a station), and node inactivity processing (when operating
  45  * as an AP).  For inactivity processing each node has a timeout
  46  * set in it's ni_inact field that is decremented on each timeout
  47  * and the node is reclaimed when the counter goes to zero.  We
  48  * use different inactivity timeout values depending on whether
  49  * the node is associated and authorized (either by 802.1x or
  50  * open/shared key authentication) or associated but yet to be
  51  * authorized.  The latter timeout is shorter to more aggressively
  52  * reclaim nodes that leave part way through the 802.1x exchange.
  53  */
  54 #define IEEE80211_INACT_WAIT    15              /* inactivity interval (secs) */
  55 #define IEEE80211_INACT_INIT    (30/IEEE80211_INACT_WAIT)       /* initial */
  56 #define IEEE80211_INACT_AUTH    (180/IEEE80211_INACT_WAIT)      /* associated but not authorized */
  57 #define IEEE80211_INACT_RUN     (300/IEEE80211_INACT_WAIT)      /* authorized */
  58 #define IEEE80211_INACT_PROBE   (30/IEEE80211_INACT_WAIT)       /* probe */
  59 #define IEEE80211_INACT_SCAN    (300/IEEE80211_INACT_WAIT)      /* scanned */
  60
  61 #define IEEE80211_TRANS_WAIT    5               /* mgt frame tx timer (secs) */
  62
  63 #define IEEE80211_NODE_HASHSIZE 32
  64 /* simple hash is enough for variation of macaddr */
  65 #define IEEE80211_NODE_HASH(addr)       \
  66         (((const u_int8_t *)(addr))[IEEE80211_ADDR_LEN - 1] % \
  67                 IEEE80211_NODE_HASHSIZE)
  68
  69 struct ieee80211_rsnparms {
  70         u_int8_t        rsn_mcastcipher;        /* mcast/group cipher */
  71         u_int8_t        rsn_mcastkeylen;        /* mcast key length */
  72         u_int8_t        rsn_ucastcipherset;     /* unicast cipher set */
  73         u_int8_t        rsn_ucastcipher;        /* selected unicast cipher */
  74         u_int8_t        rsn_ucastkeylen;        /* unicast key length */
  75         u_int8_t        rsn_keymgmtset;         /* key mangement algorithms */
  76         u_int8_t        rsn_keymgmt;            /* selected key mgmt algo */
  77         u_int16_t       rsn_caps;               /* capabilities */
  78 };
  79
  80 struct ieee80211_node_table;
  81 struct ieee80211com;
  82
  83 /*
  84  * Node specific information.  Note that drivers are expected
  85  * to derive from this structure to add device-specific per-node
  86  * state.  This is done by overriding the ic_node_* methods in
  87  * the ieee80211com structure.
  88  */
  89 struct ieee80211_node {
  90         struct ieee80211com     *ni_ic;
  91         struct ieee80211_node_table *ni_table;
  92         TAILQ_ENTRY(ieee80211_node)     ni_list;
  93         LIST_ENTRY(ieee80211_node)      ni_hash;
  94         u_int                   ni_refcnt;
  95         u_int                   ni_scangen;     /* gen# for timeout scan */
  96         u_int8_t                ni_authmode;    /* authentication algorithm */
  97         u_int16_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         u_int16_t               ni_associd;     /* assoc response */
 105         u_int16_t               ni_txpower;     /* current transmit power */
 106         u_int16_t               ni_vlan;        /* vlan tag */
 107         u_int32_t               *ni_challenge;  /* shared-key challenge */
 108         u_int8_t                *ni_wpa_ie;     /* captured WPA/RSN ie */
 109         u_int8_t                *ni_wme_ie;     /* captured WME ie */
 110         u_int16_t               ni_txseqs[17];  /* tx seq per-tid */
 111         u_int16_t               ni_rxseqs[17];  /* rx seq previous per-tid*/
 112         u_int32_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         u_int32_t               ni_rstamp;      /* recv timestamp */
 119         u_int8_t                ni_rssi;        /* recv ssi */
 120
 121         /* header */
 122         u_int8_t                ni_macaddr[IEEE80211_ADDR_LEN];
 123         u_int8_t                ni_bssid[IEEE80211_ADDR_LEN];
 124
 125         /* beacon, probe response */
 126         union {
 127                 u_int8_t        data[8];
 128                 u_int64_t       tsf;
 129         } ni_tstamp;                            /* from last rcv'd beacon */
 130         u_int16_t               ni_intval;      /* beacon interval */
 131         u_int16_t               ni_capinfo;     /* capabilities */
 132         u_int8_t                ni_esslen;
 133         u_int8_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         u_int16_t               ni_fhdwell;     /* FH only */
 137         u_int8_t                ni_fhindex;     /* FH only */
 138         u_int8_t                ni_erp;         /* ERP from beacon/probe resp */
 139         u_int16_t               ni_timoff;      /* byte offset to TIM ie */
 140         u_int8_t                ni_dtim_period; /* DTIM period */
 141         u_int8_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 };
 151 MALLOC_DECLARE(M_80211_NODE);
 152
 153 #define IEEE80211_NODE_AID(ni)  IEEE80211_AID(ni->ni_associd)
 154
 155 #define IEEE80211_NODE_STAT(ni,stat)    (ni->ni_stats.ns_##stat++)
 156 #define IEEE80211_NODE_STAT_ADD(ni,stat,v)      (ni->ni_stats.ns_##stat += v)
 157 #define IEEE80211_NODE_STAT_SET(ni,stat,v)      (ni->ni_stats.ns_##stat = v)
 158
 159 static __inline struct ieee80211_node *
 160 ieee80211_ref_node(struct ieee80211_node *ni)
 161 {
 162         ieee80211_node_incref(ni);
 163         return ni;
 164 }
 165
 166 static __inline void
 167 ieee80211_unref_node(struct ieee80211_node **ni)
 168 {
 169         ieee80211_node_decref(*ni);
 170         *ni = NULL;                     /* guard against use */
 171 }
 172
 173 struct ieee80211com;
 174
 175 void    ieee80211_node_attach(struct ieee80211com *);
 176 void    ieee80211_node_lateattach(struct ieee80211com *);
 177 void    ieee80211_node_detach(struct ieee80211com *);
 178
 179 static __inline int
 180 ieee80211_node_is_authorized(const struct ieee80211_node *ni)
 181 {
 182         return (ni->ni_flags & IEEE80211_NODE_AUTH);
 183 }
 184
 185 void    ieee80211_node_authorize(struct ieee80211_node *);
 186 void    ieee80211_node_unauthorize(struct ieee80211_node *);
 187
 188 void    ieee80211_begin_scan(struct ieee80211com *, int);
 189 int     ieee80211_next_scan(struct ieee80211com *);
 190 void    ieee80211_probe_curchan(struct ieee80211com *, int);
 191 void    ieee80211_create_ibss(struct ieee80211com*, struct ieee80211_channel *);
 192 void    ieee80211_reset_bss(struct ieee80211com *);
 193 void    ieee80211_cancel_scan(struct ieee80211com *);
 194 void    ieee80211_end_scan(struct ieee80211com *);
 195 int     ieee80211_ibss_merge(struct ieee80211_node *);
 196 int     ieee80211_sta_join(struct ieee80211com *, struct ieee80211_node *);
 197 void    ieee80211_sta_leave(struct ieee80211com *, struct ieee80211_node *);
 198
 199 /*
 200  * Table of ieee80211_node instances.  Each ieee80211com
 201  * has at least one for holding the scan candidates.
 202  * When operating as an access point or in ibss mode there
 203  * is a second table for associated stations or neighbors.
 204  */
 205 struct ieee80211_node_table {
 206         struct ieee80211com     *nt_ic;         /* back reference */
 207         ieee80211_node_lock_t   nt_nodelock;    /* on node table */
 208         TAILQ_HEAD(, ieee80211_node) nt_node;   /* information of all nodes */
 209         LIST_HEAD(, ieee80211_node) nt_hash[IEEE80211_NODE_HASHSIZE];
 210         const char              *nt_name;       /* for debugging */
 211         ieee80211_scan_lock_t   nt_scanlock;    /* on nt_scangen */
 212         u_int                   nt_scangen;     /* gen# for timeout scan */
 213         int                     nt_inact_timer; /* inactivity timer */
 214         int                     nt_inact_init;  /* initial node inact setting */
 215         struct ieee80211_node   **nt_keyixmap;  /* key ix -> node map */
 216         int                     nt_keyixmax;    /* keyixmap size */
 217
 218         void                    (*nt_timeout)(struct ieee80211_node_table *);
 219 };
 220 void    ieee80211_node_table_reset(struct ieee80211_node_table *);
 221
 222 struct ieee80211_node *ieee80211_alloc_node(
 223                 struct ieee80211_node_table *, const u_int8_t *);
 224 struct ieee80211_node *ieee80211_tmp_node(struct ieee80211com *,
 225                 const u_int8_t *macaddr);
 226 struct ieee80211_node *ieee80211_dup_bss(struct ieee80211_node_table *,
 227                 const u_int8_t *);
 228 #ifdef IEEE80211_DEBUG_REFCNT
 229 void    ieee80211_free_node_debug(struct ieee80211_node *,
 230                 const char *func, int line);
 231 struct ieee80211_node *ieee80211_find_node_debug(
 232                 struct ieee80211_node_table *, const u_int8_t *,
 233                 const char *func, int line);
 234 struct ieee80211_node * ieee80211_find_rxnode_debug(
 235                 struct ieee80211com *, const struct ieee80211_frame_min *,
 236                 const char *func, int line);
 237 struct ieee80211_node * ieee80211_find_rxnode_withkey_debug(
 238                 struct ieee80211com *,
 239                 const struct ieee80211_frame_min *, u_int16_t keyix,
 240                 const char *func, int line);
 241 struct ieee80211_node *ieee80211_find_txnode_debug(
 242                 struct ieee80211com *, const u_int8_t *,
 243                 const char *func, int line);
 244 struct ieee80211_node *ieee80211_find_node_with_channel_debug(
 245                 struct ieee80211_node_table *, const u_int8_t *macaddr,
 246                 struct ieee80211_channel *, const char *func, int line);
 247 struct ieee80211_node *ieee80211_find_node_with_ssid_debug(
 248                 struct ieee80211_node_table *, const u_int8_t *macaddr,
 249                 u_int ssidlen, const u_int8_t *ssid,
 250                 const char *func, int line);
 251 #define ieee80211_free_node(ni) \
 252         ieee80211_free_node_debug(ni, __func__, __LINE__)
 253 #define ieee80211_find_node(nt, mac) \
 254         ieee80211_find_node_debug(nt, mac, __func__, __LINE__)
 255 #define ieee80211_find_rxnode(nt, wh) \
 256         ieee80211_find_rxnode_debug(nt, wh, __func__, __LINE__)
 257 #define ieee80211_find_rxnode_withkey(nt, wh, keyix) \
 258         ieee80211_find_rxnode_withkey_debug(nt, wh, keyix, __func__, __LINE__)
 259 #define ieee80211_find_txnode(nt, mac) \
 260         ieee80211_find_txnode_debug(nt, mac, __func__, __LINE__)
 261 #define ieee80211_find_node_with_channel(nt, mac, c) \
 262         ieee80211_find_node_with_channel_debug(nt, mac, c, __func__, __LINE__)
 263 #define ieee80211_find_node_with_ssid(nt, mac, sl, ss) \
 264         ieee80211_find_node_with_ssid_debug(nt, mac, sl, ss, __func__, __LINE__)
 265 #else
 266 void    ieee80211_free_node(struct ieee80211_node *);
 267 struct ieee80211_node *ieee80211_find_node(
 268                 struct ieee80211_node_table *, const u_int8_t *);
 269 struct ieee80211_node * ieee80211_find_rxnode(
 270                 struct ieee80211com *, const struct ieee80211_frame_min *);
 271 struct ieee80211_node * ieee80211_find_rxnode_withkey(struct ieee80211com *,
 272                 const struct ieee80211_frame_min *, u_int16_t keyix);
 273 struct ieee80211_node *ieee80211_find_txnode(
 274                 struct ieee80211com *, const u_int8_t *);
 275 struct ieee80211_node *ieee80211_find_node_with_channel(
 276                 struct ieee80211_node_table *, const u_int8_t *macaddr,
 277                 struct ieee80211_channel *);
 278 struct ieee80211_node *ieee80211_find_node_with_ssid(
 279                 struct ieee80211_node_table *, const u_int8_t *macaddr,
 280                 u_int ssidlen, const u_int8_t *ssid);
 281 #endif
 282 int     ieee80211_node_delucastkey(struct ieee80211_node *);
 283
 284 typedef void ieee80211_iter_func(void *, struct ieee80211_node *);
 285 void    ieee80211_iterate_nodes(struct ieee80211_node_table *,
 286                 ieee80211_iter_func *, void *);
 287
 288 void    ieee80211_dump_node(struct ieee80211_node_table *,
 289                 struct ieee80211_node *);
 290 void    ieee80211_dump_nodes(struct ieee80211_node_table *);
 291
 292 struct ieee80211_node *ieee80211_fakeup_adhoc_node(
 293                 struct ieee80211_node_table *, const u_int8_t macaddr[]);
 294 void    ieee80211_node_join(struct ieee80211com *, struct ieee80211_node *,int);
 295 void    ieee80211_node_leave(struct ieee80211com *, struct ieee80211_node *);
 296 u_int8_t ieee80211_getrssi(struct ieee80211com *ic);
 297
 298 /*
 299  * Parameters supplied when adding/updating an entry in a
 300  * scan cache.  Pointer variables should be set to NULL
 301  * if no data is available.  Pointer references can be to
 302  * local data; any information that is saved will be copied.
 303  * All multi-byte values must be in host byte order.
 304  */
 305 struct ieee80211_scanparams {
 306         u_int16_t       capinfo;        /* 802.11 capabilities */
 307         u_int16_t       fhdwell;        /* FHSS dwell interval */
 308         u_int8_t        chan;           /* */
 309         u_int8_t        bchan;
 310         u_int8_t        fhindex;
 311         u_int8_t        erp;
 312         u_int16_t       bintval;
 313         u_int8_t        timoff;
 314         u_int8_t        *tim;
 315         u_int8_t        *tstamp;
 316         u_int8_t        *country;
 317         u_int8_t        *ssid;
 318         u_int8_t        *rates;
 319         u_int8_t        *xrates;
 320         u_int8_t        *wpa;
 321         u_int8_t        *wme;
 322 };
 323
 324 void    ieee80211_add_scan(struct ieee80211com *,
 325                 const struct ieee80211_scanparams *,
 326                 const struct ieee80211_frame *,
 327                 int subtype, int rssi, int rstamp);
 328 void    ieee80211_init_neighbor(struct ieee80211_node *,
 329                 const struct ieee80211_frame *,
 330                 const struct ieee80211_scanparams *);
 331 struct ieee80211_node *ieee80211_add_neighbor(struct ieee80211com *,
 332                 const struct ieee80211_frame *,
 333                 const struct ieee80211_scanparams *);
 334 #endif /* _NET80211_IEEE80211_NODE_H_ */