usr.sbin/wicontrol/wicontrol.8

   1 .\" Copyright (c) 1997, 1998, 1999
   2 .\"     Bill Paul <wpaul@ctr.columbia.edu> All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Bill Paul.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"   without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29 .\" THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd April 21, 1999
  34 .Dt WICONTROL 8
  35 .Os
  36 .Sh NAME
  37 .Nm wicontrol
  38 .Nd configure WaveLAN/IEEE devices
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl i
  42 .Ar iface Op Fl oa
  43 .Nm
  44 .Op Fl i
  45 .Ar iface Fl t Ar tx rate
  46 .Nm
  47 .Op Fl i
  48 .Ar iface Fl n Ar network name
  49 .Nm
  50 .Op Fl i
  51 .Ar iface Fl s Ar station name
  52 .Nm
  53 .Op Fl i
  54 .Ar iface Fl c Ar 0|1
  55 .Nm
  56 .Op Fl i
  57 .Ar iface Fl q Ar SSID
  58 .Nm
  59 .Op Fl i
  60 .Ar iface Fl p Ar port type
  61 .Nm
  62 .Op Fl i
  63 .Ar iface Fl a Ar access point density
  64 .Nm
  65 .Op Fl i
  66 .Ar iface Fl m Ar mac address
  67 .Nm
  68 .Op Fl i
  69 .Ar iface Fl d Ar max data length
  70 .Nm
  71 .Op Fl i
  72 .Ar iface Fl e Ar 0|1
  73 .Nm
  74 .Op Fl i
  75 .Ar iface Fl k Ar key
  76 .Op Fl v Ar 1|2|3|4
  77 .Nm
  78 .Op Fl i
  79 .Ar iface Fl T Ar 1|2|3|4
  80 .Nm
  81 .Op Fl i
  82 .Ar iface Fl r Ar RTS threshold
  83 .Nm
  84 .Op Fl i
  85 .Ar iface Fl f Ar frequency
  86 .Nm
  87 .Op Fl i
  88 .Ar iface Fl P Ar 0|1
  89 .Nm
  90 .Op Fl i
  91 .Ar iface Fl S Ar max_sleep_duration
  92 .Nm
  93 .Op Fl i
  94 .Ar iface Fl Z
  95 (zero signal cache)
  96 .Nm
  97 .Op Fl i
  98 .Ar iface Fl C
  99 (display signal cache)
 100 .Sh DESCRIPTION
 101 The
 102 .Nm
 103 command controls the operation of WaveLAN/IEEE wireless networking
 104 devices via the
 105 .Xr wi 4
 106 driver.
 107 Most of the parameters that can be changed relate to the
 108 IEEE 802.11 protocol which the WaveLAN implements.
 109 This includes
 110 the station name, whether the station is operating in ad-hoc (point
 111 to point) or BSS (service set) mode, and the network name of a service
 112 set to join (IBSS) if BSS mode is enabled.
 113 The
 114 .Nm
 115 command can also be used to view the current settings of these parameters
 116 and to dump out the values of the card's statistics counters.
 117 .Pp
 118 The
 119 .Ar iface
 120 argument given to
 121 .Nm
 122 should be the logical interface name associated with the WaveLAN/IEEE
 123 device (wi0, wi1, etc...). If none is specified then wi0 is used
 124 as default.
 125 .Sh OPTIONS
 126 The options are as follows:
 127 .Bl -tag -width Fl
 128 .It Fl i Ar iface Op Fl o
 129 Display the current settings of the specified WaveLAN/IEEE interface.
 130 This retrieves the current card settings from the driver and prints them
 131 out.
 132 Using the additional
 133 .Fl o
 134 flag will cause
 135 .Nm
 136 to print out the statistics counters instead of the card settings.
 137 Encryption keys are only displayed if wicontrol is run as root.
 138 .It Fl i Ar iface Fl t Ar tx rate
 139 Set the transmit rate of the specified interface.
 140 The legal values
 141 for the transmit rate vary depending on whether the interface is a
 142 standard WaveLAN/IEEE or a WaveLAN/IEEE Turbo adapter.
 143 The standard
 144 NICs support a maximum transmit rate of 2Mbps while the turbo NICs
 145 support a maximum speed of 6Mbps.
 146 The following table shows the
 147 legal transmit rate settings and the corresponding transmit speeds:
 148 .Bl -column "TX rate " "NIC speed " -offset indent
 149 .Em "TX rate    NIC speed"
 150 1       Fixed Low (1Mbps)
 151 2       Fixed Standard (2Mbps)
 152 3       Auto Rate Select (High)
 153 4       Fixed Medium (4Mbps)
 154 5       Fixed High (6Mbps)
 155 6       Auto Rate Select (Standard)
 156 7       Auto Rate Select (Medium)
 157 .El
 158 .Pp
 159 The standard NICs support only settings 1 through 3. Turbo NICs support
 160 all the above listed speed settings.
 161 The default driver setting is 3 (auto rate select).
 162 .It Fl i Ar iface Fl n Ar network name
 163 Set the name of the service set (IBSS) that this station wishes to
 164 join.
 165 The
 166 .Ar network name
 167 can be any text string up to 30 characters in length.
 168 The default name
 169 is the string "ANY" which should allow the station to connect to the first
 170 available access point.
 171 The interface should be set for BSS mode using
 172 the
 173 .Fl p
 174 flag in order for this to work.
 175 .Pp
 176 Note: the WaveLAN manual indicates that an empty string will allow the
 177 host to connect to any access point, however I have also seen a reference
 178 in another driver which indicates that the "ANY" string works as well.
 179 .It Fl i Ar iface Fl s Ar station name
 180 Sets the
 181 .Ar station name
 182 for the specified interface.
 183 The
 184 .Ar station name
 185 is used for diagnostic purposes.
 186 The Lucent WaveMANAGER software can
 187 poll the names of remote hosts.
 188 .It Fl i Ar iface Fl c Ar 0|1
 189 Allow the station to create a service set (IBSS). Permitted values
 190 are 0 (don't create IBSS) and 1 (enable creation of IBSS). The default
 191 is 0.
 192 .Pp
 193 Note: this option is provided for experimental purposes only: enabling
 194 the creation of an IBSS on a host system doesn't appear to actually work.
 195 .It Fl i Ar iface Fl q Ar SSID
 196 Specify the name of an IBSS (SSID) to create on a given interface.
 197 The
 198 .Ar SSID
 199 can be any text string up to 30 characters long.
 200 .Pp
 201 Note: this option is provided for experimental purposes only: enabling
 202 the creation of an IBSS on a host system doesn't appear to actually work.
 203 .It Fl i Ar iface Fl p Ar port type
 204 Set the
 205 .Ar port type
 206 for a specified interface.
 207 The legal values for
 208 .Ar port type
 209 are 1 (BSS mode) and 3 (ad-hoc) mode.
 210 In ad-hoc mode, the station can
 211 communicate directly with any other stations within direct radio range
 212 (provided that they are also operating in ad-hoc mode). In BSS mode,
 213 hosts must associate with a service set controlled by an access point,
 214 which relays traffic between end stations.
 215 The default setting is 3
 216 (ad-hoc mode).
 217 .It Fl i Ar iface Fl a Ar access_point_density
 218 Specify the
 219 .Ar access point density
 220 for a given interface.
 221 Legal values are 1 (low), 2 (medium) and 3 (high).
 222 This setting influences some of the radio modem threshold settings.
 223 .It Fl i Ar iface Fl m Ar mac address
 224 Set the station address for the specified interface.
 225 The
 226 .Ar mac address
 227 is specified as a series of six hexadecimal values separated by colons,
 228 e.g.: 00:60:1d:12:34:56.
 229 This programs the new address into the card
 230 and updates the interface as well.
 231 .It Fl i Ar iface Fl d Ar max_data_length
 232 Set the maximum receive and transmit frame size for a specified interface.
 233 The
 234 .Ar max data length
 235 can be any number from 350 to 2304.
 236 The default is 2304.
 237 .It Fl i Ar iface Fl e Ar 0|1
 238 Enable or disable WEP encryption.
 239 Permitted values are
 240 .Ar 0
 241 (encryption disabled) or
 242 .Ar 1
 243 (encryption enabled).
 244 Encryption is off by default.
 245 .Pp
 246 Both 128-bit and 64-bit WEP have been broken.
 247 See the BUGS section for details.
 248 .It Fl i Ar iface Fl k Ar key "[-v 1|2|3|4]"
 249 Set WEP encryption keys.
 250 There are four default encryption keys
 251 that can be programmed.
 252 A specific key can be set using
 253 the
 254 .Fl v
 255 flag.
 256 If the
 257 .Fl v
 258 flag is not specified, the first key will be set.
 259 Encryption keys
 260 can either be normal text (i.e. "hello") or a series of hexadecimal
 261 digits (i.e. "0x1234512345"). For
 262 WaveLAN Turbo Silver cards, the key is restricted to 40 bits, hence
 263 the key can be either a 5 character text string or 10 hex digits.
 264 For WaveLAN Turbo Gold cards, the key can also be 104 bits,
 265 which means the key can be specified as either a 13 character text
 266 string or 26 hex digits in addition to the formats supported by the
 267 Silver cards.
 268 .Pp
 269 Both 128-bit and 64-bit WEP have been broken.
 270 See the BUGS section for details.
 271 .It Fl i Ar iface Fl T Ar 1|2|3|4
 272 Specify which of the four WEP encryption keys will be used to
 273 encrypt transmitted packets.
 274 .Pp
 275 Both 128-bit and 64-bit WEP have been broken.
 276 See the BUGS section for details.
 277 .It Fl i Ar iface Fl r Ar RTS threshold
 278 Set the RTS/CTS threshold for a given interface.
 279 This controls the
 280 number of bytes used for the RTS/CTS handshake boundary.
 281 The
 282 .Ar RTS threshold
 283 can be any value between 0 and 2047.
 284 The default is 2347.
 285 .It Fl i Ar iface Fl f Ar frequency
 286 Set the radio frequency of a given interface.
 287 The
 288 .Ar frequency
 289 should be specified as a channel ID as shown in the table below.
 290 The
 291 list of available frequencies is dependent on radio regulations specified
 292 by regional authorities.
 293 Recognized regulatory authorities include
 294 the FCC (United States), ETSI (Europe), France and Japan.
 295 Frequencies
 296 in the table are specified in Mhz.
 297 .Bl -column "Channel ID " "FCC " "ETSI " "France " "Japan " -offset indent
 298 .Em "Channel ID FCC     ETSI    France  Japan"
 299 1       2412    2412    -       2412
 300 2       2417    2417    -       2417
 301 3       2422    2422    -       2422
 302 4       2427    2427    -       2427
 303 5       2432    2432    -       2432
 304 6       2437    2437    -       2437
 305 7       2442    2442    -       2442
 306 8       2447    2447    -       2447
 307 9       2452    2452    -       2452
 308 10      2457    2457    2457    2457
 309 11      2462    2462    2462    2462
 310 12      -       2467    2467    2467
 311 13      -       2472    2472    2472
 312 14      -       -       -       2484
 313 .El
 314 .Pp
 315 If an illegal channel is specified, the
 316 NIC will revert to its default channel.
 317 For NICs sold in the United States
 318 and Europe, the default channel is 3. For NICs sold in France, the default
 319 channel is 11.
 320 For NICs sold in Japan, the default channel is 14,
 321 and it is the only available channel for pre-11Mbps NICs.
 322 Note that two stations must be set to the same channel in order to
 323 communicate.
 324 .It Fl i Ar iface Fl P Ar 0|1
 325 Enable or disable power management on a given interface.
 326 Enabling
 327 power management uses an alternating sleep/wake protocol to help
 328 conserve power on mobile stations, at the cost of some increased
 329 receive latency.
 330 Power management is off by default.
 331 Note that power
 332 management requires the cooperation of an access point in order to
 333 function; it is not functional in ad-hoc mode.
 334 Also, power management
 335 is only implemented in Lucent WavePOINT firmware version 2.03 or
 336 later, and in WaveLAN PCMCIA adapter firmware 2.00 or later.
 337 Older
 338 revisions will silently ignore the power management setting.
 339 Legal
 340 values for this parameter are 0 (off) and 1 (on).
 341 .It Fl i Ar iface Fl S Ar max_sleep_interval
 342 Specify the sleep interval to use when power management is enabled.
 343 The
 344 .Ar max_sleep_interval
 345 is specified in milliseconds.
 346 The default is 100.
 347 .It Fl i Ar iface Fl Z
 348 Clear the signal strength cache maintained internally by the
 349 .Nm wi
 350 driver.
 351 .It Fl i Ar iface Fl C
 352 Display the cached signal strength information maintained by the
 353 .Nm wi
 354 driver.
 355 The driver retains information about signal strength and
 356 noise level for packets received from different hosts.
 357 The signal
 358 strength and noise level values are displayed in units of dBms.
 359 The signal quality values is produced by subtracting the noise level
 360 from the signal strength (i.e. less noise and better signal yields
 361 better signal quality).
 362 .El
 363 .Sh SEE ALSO
 364 .Xr ipsec 4 ,
 365 .Xr wi 4 ,
 366 .Xr ifconfig 8
 367 .Sh BUGS
 368 WEP has been broken.
 369 Do not use it.
 370 Use IPSEC instead.
 371 Do not trust access points.
 372 .Pp
 373 The attack on WEP is a passive attack, requiring only the ability to
 374 sniff packets on the network.
 375 The passive attack can be launched at a distance larger, up to many
 376 miles, than one might otherwise expect given a specialized antenna
 377 used in point to point applications.
 378 The attacker can recover the keys from a 128-bit WEP network after
 379 at most 5,000,000 or 6,000,000 packets.
 380 While this may sound like a large number of packets, emperical
 381 evidence suggests that this amount of traffic is generated in a few
 382 hours on a partially loaded network.
 383 .Pp
 384 See http://www.cs.rice.edu/~astubble/wep/wep_attack.html for details
 385 of the attack.
 386 .Sh HISTORY
 387 The
 388 .Nm
 389 command first appeared in
 390 .Fx 3.0 .
 391 .Sh AUTHORS
 392 The
 393 .Nm
 394 command was written by
 395 .An Bill Paul Aq wpaul@ctr.columbia.edu .