diff options
-rw-r--r-- | usr.sbin/ancontrol/ancontrol.8 | 299 |
1 files changed, 168 insertions, 131 deletions
diff --git a/usr.sbin/ancontrol/ancontrol.8 b/usr.sbin/ancontrol/ancontrol.8 index f88baa8..ab2c084 100644 --- a/usr.sbin/ancontrol/ancontrol.8 +++ b/usr.sbin/ancontrol/ancontrol.8 @@ -50,53 +50,53 @@ .Nm .Fl i Ar iface Fl C .Nm -.Fl i Ar iface Fl t Ar 0|1|2|3|4 +.Fl i Ar iface Fl t Cm 0 | 1 | 2 | 3 | 4 .Nm -.Fl i Ar iface Fl s Ar 0|1|2|3 +.Fl i Ar iface Fl s Cm 0 | 1 | 2 | 3 .Nm .Fl i Ar iface -.Op Fl v Ar 1|2|3|4 +.Op Fl v Cm 1 | 2 | 3 | 4 .Fl a Ar AP .Nm -.Fl i Ar iface Fl b Ar beacon period +.Fl i Ar iface Fl b Ar beacon_period .Nm .Fl i Ar iface -.Op Fl v Ar 0|1 -.Fl d Ar 0|1|2|3 +.Op Fl v Cm 0 | 1 +.Fl d Cm 0 | 1 | 2 | 3 .Nm -.Fl i Ar iface Fl e Ar 0|1|2|4 +.Fl i Ar iface Fl e Cm 0 | 1 | 2 | 3 .Nm .Fl i Ar iface -.Op Fl v Ar 0|1|2|3|4|5|6|7 +.Op Fl v Cm 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 .Fl k Ar key .Nm .Fl i Ar iface -.Fl K Ar mode +.Fl K Cm 0 | 1 | 2 .Nm .Fl i Ar iface -.Fl W Ar mode +.Fl W Cm 0 | 1 | 2 .Nm -.Fl i Ar iface Fl j Ar netjoin timeout +.Fl i Ar iface Fl j Ar netjoin_timeout .Nm -.Fl i Ar iface Fl l Ar station name +.Fl i Ar iface Fl l Ar station_name .Nm -.Fl i Ar iface Fl m Ar mac address +.Fl i Ar iface Fl m Ar mac_address .Nm .Fl i Ar iface -.Op Fl v Ar 1|2|3 +.Op Fl v Cm 1 | 2 | 3 .Fl n Ar SSID .Nm -.Fl i Ar iface Fl o Ar 0|1 +.Fl i Ar iface Fl o Cm 0 | 1 .Nm -.Fl i Ar iface Fl p Ar tx power +.Fl i Ar iface Fl p Ar tx_power .Nm -.Fl i Ar iface Fl c Ar channel number +.Fl i Ar iface Fl c Ar frequency .Nm -.Fl i Ar iface Fl f Ar fragmentation threshold +.Fl i Ar iface Fl f Ar fragmentation_threshold .Nm -.Fl i Ar iface Fl r Ar RTS threshold +.Fl i Ar iface Fl r Ar RTS_threshold .Nm -.Fl i Ar iface Fl M Ar 0-15 (set monitor mode) +.Fl i Ar iface Fl M Cm 0 Ns - Ns Cm 15 .Nm .Fl h .Sh DESCRIPTION @@ -122,8 +122,12 @@ The argument given to .Nm should be the logical interface name associated with the Aironet -device (an0, an1, etc...). -If one isn't specified the device an0 will be assumed. +device +.Li ( an0 , an1 , +etc.). +If one isn't specified the device +.Dq Li an0 +will be assumed. .Pp The .Nm @@ -134,6 +138,7 @@ lines in a single invocation, and such combinations are not recommended. .Sh OPTIONS The options are as follows: +.\" XXX .Bl -tag -width Fl .It Fl i Ar iface Fl A Display the preferred access point list. @@ -149,7 +154,7 @@ be modified with the option. .It Fl i Ar iface Fl N Display the SSID list. -This is a list of service set IDs (i.e. network names) +This is a list of service set IDs (i.e., network names) with which the station wishes to associate. There may be up to three SSIDs in the list: the station will go through the list in ascending order and @@ -161,9 +166,14 @@ status, current BSSID, SSID, channel, beacon period and currently associated access point. The operating mode indicates the state of the NIC, MAC status and receiver status. -When the "synced" keyword +When the +.Qq Li synced +keyword appears, it means the NIC has successfully associated with an access -point, associated with an ad-hoc "master" station, or become a "master" +point, associated with an ad-hoc +.Dq master +station, or become a +.Dq master itself. The beacon period can be anything between 20 and 976 milliseconds. The default is 100. @@ -178,38 +188,34 @@ Display current NIC configuration. This shows the current operation mode, receive mode, MAC address, power save settings, various timing settings, channel selection, diversity, transmit power and transmit speed. -.It Fl i Ar iface Fl t Ar 0|1|2|3|4 +.It Fl i Ar iface Fl t Cm 0 | 1 | 2 | 3 | 4 Select transmit speed. The available settings are as follows: -.Bl -column "TX rate " "NIC speed " -offset indent +.Bl -column ".Em TX rate" -offset indent .Em "TX rate NIC speed" -0 Auto -- NIC selects optimal speed -1 1Mbps fixed -2 2Mbps fixed -3 5.5Mbps fixed -4 11Mbps fixed +.It Cm 0 Ta "Auto -- NIC selects optimal speed" +.It Cm 1 Ta "1Mbps fixed" +.It Cm 2 Ta "2Mbps fixed" +.It Cm 3 Ta "5.5Mbps fixed" +.It Cm 4 Ta "11Mbps fixed" .El .Pp Note that the 5.5 and 11Mbps settings are only supported on the 4800 series adapters: the 4500 series adapters have a maximum speed of 2Mbps. -.It Fl i Ar iface Fl s Ar 0|1|2|3 +.It Fl i Ar iface Fl s Cm 0 | 1 | 2 | 3 Set power save mode. Valid selections are as follows: -.Bl -column "Selection " "Power save mode " -offset indent +.Bl -column ".Em Selection" -offset indent .Em "Selection Power save mode" -0 None - power save disabled -1 Constantly awake mode (CAM) -2 Power Save Polling (PSP) -3 Fast Power Save Polling (PSP-CAM) +.It Cm 0 Ta "None - power save disabled" +.It Cm 1 Ta "Constantly awake mode (CAM)" +.It Cm 2 Ta "Power Save Polling (PSP)" +.It Cm 3 Ta "Fast Power Save Polling (PSP-CAM)" .El .Pp Note that for IBSS (ad-hoc) mode, only PSP mode is supported, and only if the ATIM window is non-zero. -.It Xo -.Fl i Ar iface -.Op Fl v Ar 1|2|3|4 -.Fl a Ar AP -.Xc +.It Fl i Ar iface Oo Fl v Cm 1 | 2 | 3 | 4 Oc Fl a Ar AP Set preferred access point. The .Ar AP @@ -225,27 +231,24 @@ modified. If the .Fl v flag is not used, the first AP list entry will be changed. -.It Fl i Ar iface Fl b Ar beacon period +.It Fl i Ar iface Fl b Ar beacon_period Set the ad-hoc mode beacon period. -The becon period is specified in -milliseconds. +The +.Ar beacon_period +is specified in milliseconds. The default is 100ms. -.It Xo -.Fl i Ar iface -.Op Fl v Ar 0|1 -.Fl d Ar 0|1|2|3 -.Xc +.It Fl i Ar iface Oo Fl v Cm 0 | 1 Oc Fl d Cm 0 | 1 | 2 | 3 Select the antenna diversity. Aironet devices can be configured with up to two antennas, and transmit and receive diversity can be configured accordingly. Valid selections are as follows: -.Bl -column "Selection " "Diversity " -offset indent +.Bl -column ".Em Selection" -offset indent .Em "Selection Diversity" -0 Select factory default diversity -1 Antenna 1 only -2 Antenna 2 only -3 Antenna 1 and 2 +.It Cm 0 Ta "Select factory default diversity" +.It Cm 1 Ta "Antenna 1 only" +.It Cm 2 Ta "Antenna 2 only" +.It Cm 3 Ta "Antenna 1 and 2" .El .Pp The receive and transmit diversity can be set independently. @@ -253,70 +256,95 @@ The user must specify which diversity setting is to be modified by using the .Fl v option: selection -.Ar 0 +.Cm 0 sets the receive diversity and -.Ar 1 +.Cm 1 sets the transmit diversity. -.It Fl i Ar iface Fl e Ar 0|1|2|3 +.It Fl i Ar iface Fl e Cm 0 | 1 | 2 | 3 Set the transmit WEP key to use. Note that until this command is issued, the device will use the -last key programmed. The transmit key is stored in NVRAM. Currently -set transmit key can be checked via "-C" option. -.It Xo -.Fl i Ar iface -.Op Fl v Ar 0|1|2|3|4|5|6|7 -.Fl k Ar key -.Xc +last key programmed. +The transmit key is stored in NVRAM. +Currently +set transmit key can be checked via +.Fl C +option. +.It Fl i Ar iface Oo Fl v Cm 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 Oc Fl k Ar key Set a WEP key. For 40 bit prefix 10 hex character with 0x. For 128 bit prefix 26 hex character with 0x. -Use "" as the key to erase the key. +Use +.Qq +as the key to erase the key. Supports 4 keys; even numbers are for permanent keys and odd number are for temporary keys. -For example, "-v 1" sets the first temporary key. -(A "permanent" key is stored in NVRAM; a "temporary" key is not.) +For example, +.Fl v Cm 1 +sets the first temporary key. +(A +.Dq permanent +key is stored in NVRAM; a +.Dq temporary +key is not.) Note that the device will use the most recently-programmed key by default. -Currently set keys can be checked via "-C" option, only the sizes of the +Currently set keys can be checked via +.Fl C +option, only the sizes of the keys are returned. -.It Fl i Ar iface Fl K Ar 0|1|2 +.It Fl i Ar iface Fl K Cm 0 | 1 | 2 Set authorization type. -Use 0 for none, 1 for "Open", 2 for "Shared Key". -.It Fl i Ar iface Fl W Ar 0|1|2 +Use +.Cm 0 +for none, +.Cm 1 +for +.Dq Open , +.Cm 2 +for +.Dq "Shared Key" . +.It Fl i Ar iface Fl W Cm 0 | 1 | 2 Enable WEP. -Use 0 for no WEP, 1 to enable full WEP, 2 for mixed cell. -.It Fl i Ar iface Fl j Ar netjoin timeout +Use +.Cm 0 +for no WEP, +.Cm 1 +to enable full WEP, +.Cm 2 +for mixed cell. +.It Fl i Ar iface Fl j Ar netjoin_timeout Set the ad-hoc network join timeout. When a station is first activated -in ad-hoc mode, it will search out a 'master' station with the desired +in ad-hoc mode, it will search out a +.Dq master +station with the desired SSID and associate with it. If the station is unable to locate another station with the same SSID after a suitable timeout, it sets itself up -as the 'master' so that other stations may associate with it. +as the +.Dq master +so that other stations may associate with it. This timeout defaults to 10000 milliseconds (10 seconds) but may be changed with this option. The timeout should be specified in milliseconds. -.It i Ar iface Fl l Ar station name +.It Fl i Ar iface Fl l Ar station_name Set the station name used internally by the NIC. The -.Ar station name +.Ar station_name can be any text string up to 16 characters in length. The default name is set by the driver to .Dq Li FreeBSD . -.It Fl i Ar iface Fl m Ar mac address +.It Fl i Ar iface Fl m Ar mac_address Set the station address for the specified interface. The -.Ar mac address +.Ar mac_address is specified as a series of six hexadecimal values separated by colons, -e.g.: 00:60:1d:12:34:56. +e.g.: +.Li 00:60:1d:12:34:56 . This programs the new address into the card and updates the interface as well. -.It Xo -.Fl i Ar iface -.Op Fl v Ar 1|2|3 -.Fl n Ar SSID -.Xc +.It Fl i Ar iface Oo Fl v Cm 1 | 2 | 3 Oc Fl n Ar SSID Set the desired SSID (network name). There are three SSIDs which allows the NIC to work with access points at several locations without needing @@ -329,16 +357,16 @@ modifier option. If the .Fl v flag isn't used, the first SSID in the list is set. -.It Fl i Ar iface Fl o Ar 0|1 +.It Fl i Ar iface Fl o Cm 0 | 1 Set the operating mode of the Aironet interface. Valid selections are -.Ar 0 +.Cm 0 for ad-hoc mode and -.Ar 1 +.Cm 1 for infrastructure mode. The default driver setting is for infrastructure mode. -.It Fl i Ar iface Fl p Ar tx power +.It Fl i Ar iface Fl p Ar tx_power Set the transmit power level in milliwatts. Valid power settings vary depending on the actual NIC and can be viewed by dumping the @@ -348,7 +376,7 @@ flag. Typical values are 1, 5, 20, 50 and 100mW. Selecting 0 sets the factory default. -.It Fl i Ar iface Fl c Ar channel +.It Fl i Ar iface Fl c Ar frequency Set the radio frequency of a given interface. The .Ar frequency @@ -360,22 +388,22 @@ Recognized regulatory authorities include the FCC (United States), ETSI (Europe), France and Japan. Frequencies in the table are specified in Mhz. -.Bl -column "Channel ID " "FCC " "ETSI " "France " "Japan " -offset indent +.Bl -column ".Em Channel ID" ".Em FCC" ".Em ETSI" ".Em France" ".Em Japan" -offset indent .Em "Channel ID FCC ETSI France Japan" -1 2412 2412 - - -2 2417 2417 - - -3 2422 2422 - - -4 2427 2427 - - -5 2432 2432 - - -6 2437 2437 - - -7 2442 2442 - - -8 2447 2447 - - -9 2452 2452 - - -10 2457 2457 2457 - -11 2462 2462 2462 - -12 - 2467 2467 - -13 - 2472 2472 - -14 - - - 2484 +.It Cm 1 Ta 2412 Ta 2412 Ta - Ta - +.It Cm 2 Ta 2417 Ta 2417 Ta - Ta - +.It Cm 3 Ta 2422 Ta 2422 Ta - Ta - +.It Cm 4 Ta 2427 Ta 2427 Ta - Ta - +.It Cm 5 Ta 2432 Ta 2432 Ta - Ta - +.It Cm 6 Ta 2437 Ta 2437 Ta - Ta - +.It Cm 7 Ta 2442 Ta 2442 Ta - Ta - +.It Cm 8 Ta 2447 Ta 2447 Ta - Ta - +.It Cm 9 Ta 2452 Ta 2452 Ta - Ta - +.It Cm 10 Ta 2457 Ta 2457 Ta 2457 Ta - +.It Cm 11 Ta 2462 Ta 2462 Ta 2462 Ta - +.It Cm 12 Ta - Ta 2467 Ta 2467 Ta - +.It Cm 13 Ta - Ta 2472 Ta 2472 Ta - +.It Cm 14 Ta - Ta - Ta - Ta 2484 .El .Pp If an illegal channel is specified, the @@ -387,7 +415,7 @@ channel is 11. For NICs sold in Japan, the only available channel is 14. Note that two stations must be set to the same channel in order to communicate. -.It Fl i Ar iface Fl f Ar fragmentation threshold +.It Fl i Ar iface Fl f Ar fragmentation_threshold Set the fragmentation threshold in bytes. This threshold controls the point at which outgoing packets will be split into multiple fragments. @@ -396,35 +424,39 @@ need to be retransmitted instead of the whole packet. The fragmentation threshold can be anything from 64 to 2312 bytes. The default is 2312. -.It Fl i Ar iface Fl M Ar 0-15 -Set monitor mode via bit mask, meaning: -.Bl -tag -offset indent -compact -width 0x000000 -.Em "Bit Mask Meaning" -.It 0 -to not dump 802.11 packet. -.It 1 -to enable 802.11 monitor. -.It 2 -to monitor any SSID. -.It 4 -to not skip beacons, monitor beacons produces a high system load. -.It 8 -to enable full Aironet header returned via BPF. -Note it appears that a SSID must be set. -.El -.It Fl i Ar iface Fl r Ar RTS threshold +.It Fl i Ar iface Fl r Ar RTS_threshold Set the RTS/CTS threshold for a given interface. This controls the number of bytes used for the RTS/CTS handhake boundary. The -.Ar RTS threshold +.Ar RTS_threshold can be any value between 0 and 2312. The default is 2312. +.It Fl i Ar iface Fl M Cm 0 Ns - Ns Cm 15 +Set monitor mode via bit mask, meaning: +.Pp +.Bl -tag -width indent -offset indent -compact +.It Em Bit +.Em Meaning +.It 0 +to not dump 802.11 packet. +.It 1 +to enable 802.11 monitor. +.It 2 +to monitor any SSID. +.It 4 +to not skip beacons, monitor beacons produces a high system load. +.It 8 +to enable full Aironet header returned via BPF. +Note it appears that a SSID must be set. +.El .It Fl h -Prints a list of available options and sample usage. +Print a list of available options and sample usage. .El .Sh SECURITY NOTES -WEP ("wired equivalent privacy") is based on the RC4 algorithm, +WEP +.Pq Dq "wired equivalent privacy" +is based on the RC4 algorithm, using a 24 bit initialization vector. .Pp RC4 is supposedly vunerable to certain known plaintext attacks, @@ -432,9 +464,12 @@ especially with 40 bit keys. So the security of WEP in part depends on how much known plaintext is transmitted. .Pp -Because of this, although counter-intuitive, using "shared key" +Because of this, although counter-intuitive, using +.Dq "shared key" authentication (which involves sending known plaintext) is less -secure than using "open" authentication when WEP is enabled. +secure than using +.Dq open +authentication when WEP is enabled. .Pp Devices may alternate among all of the configured WEP keys when tranmitting packets. @@ -447,7 +482,9 @@ ancontrol -i an0 -W 1 ancontrol -i an0 -e 0 .Ed .Pp -Sets a WEP key 0, enables "Shared Key" authentication, enables full WEP +Sets a WEP key 0, enables +.Dq "Shared Key" +authentication, enables full WEP and uses transmit key 0. .Sh SEE ALSO .Xr an 4 , |