wpa_supplicant.sgml

一个Linux下无线网卡的设置工具

          Supplicant).</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>-h</term>
	<listitem>
	  <para>Help.  Show a usage message.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>-L</term>
	<listitem>
	  <para>Show license (GPL and BSD).</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>-q</term>
	<listitem>
	  <para>Decrease debugging verbosity (-qq even less).</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>-v</term>
	<listitem>
	  <para>Show version.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>-w</term>
	<listitem>
	  <para>wait for interface to be added, if needed.  normally,
	  <command>wpa_supplicant</command> will exit if the interface
	  is not there yet.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>-N</term>
	<listitem>
	  <para>Start describing new interface.</para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Examples</title>

    <para>In most common cases, <command>wpa_supplicant</command> is
    started with:</para>

<blockquote><programlisting>
wpa_supplicant -Bw -c/etc/wpa_supplicant.conf -iwlan0
</programlisting></blockquote>

    <para>This makes the process fork into background and wait for the wlan0
    interface if it is not available at startup time.</para>

    <para>The easiest way to debug problems, and to get debug log for
    bug reports, is to start <command>wpa_supplicant</command> on
    foreground with debugging enabled:</para>

<blockquote><programlisting>
wpa_supplicant -c/etc/wpa_supplicant.conf -iwlan0 -d
</programlisting></blockquote>

    <para><command>wpa_supplicant</command> can control multiple
    interfaces (radios) either by running one process for each
    interface separately or by running just one process and list of
    options at command line. Each interface is separated with -N
    argument. As an example, following command would start
    wpa_supplicant for two interfaces:</para>

<blockquote><programlisting>
wpa_supplicant \
	-c wpa1.conf -i wlan0 -D hostap -N \
	-c wpa2.conf -i ath0 -D madwifi
</programlisting></blockquote>
  </refsect1>

  <refsect1>
    <title>OS Requirements</title>
    <para>Current hardware/software requirements:</para>

    <itemizedlist>
      <listitem>
	<para>Linux kernel 2.4.x or 2.6.x with Linux Wireless
	Extensions v15 or newer</para>
      </listitem>


      <listitem>
	<para>FreeBSD 6-CURRENT</para>
      </listitem>

      <listitem>
	<para>Microsoft Windows with WinPcap (at least WinXP, may work
	with other versions)</para>
      </listitem>
    </itemizedlist>
  </refsect1>

  <refsect1>
    <title>Supported Drivers</title>
    <variablelist>
      <varlistentry>
	<term>Host AP driver for Prism2/2.5/3 (development
	snapshot/v0.2.x)</term>
	<listitem>
	  <para> (http://hostap.epitest.fi/) Driver needs to be set in
	Managed mode ('iwconfig wlan0 mode managed').  Please note
	that station firmware version needs to be 1.7.0 or newer to
	work in WPA mode.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>Linuxant DriverLoader</term>
	<listitem>
	  <para>(http://www.linuxant.com/driverloader/)
	with Windows NDIS driver for your wlan card supporting WPA.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>Agere Systems Inc. Linux Driver</term>
	<listitem>
	  <para> (http://www.agere.com/support/drivers/) Please note
	that the driver interface file (driver_hermes.c) and hardware
	specific include files are not included in the wpa_supplicant
	distribution. You will need to copy these from the source
	package of the Agere driver.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>madwifi driver for cards based on Atheros chip set (ar521x)</term>
	<listitem>
	  <para> (http://sourceforge.net/projects/madwifi/) Please
	note that you will need to modify the wpa_supplicant .config
	file to use the correct path for the madwifi driver root
	directory (CFLAGS += -I../madwifi/wpa line in example
	defconfig).</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>ATMEL AT76C5XXx driver for USB and PCMCIA cards</term>
	<listitem>
	  <para> (http://atmelwlandriver.sourceforge.net/).</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>Linux ndiswrapper</term>
	<listitem>
	  <para> (http://ndiswrapper.sourceforge.net/) with Windows
	NDIS driver.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>Broadcom wl.o driver</term>
	<listitem>
	  <para> This is a generic Linux driver for Broadcom IEEE
	802.11a/g cards.  However, it is proprietary driver that is
	not publicly available except for couple of exceptions, mainly
	Broadcom-based APs/wireless routers that use Linux. The driver
	binary can be downloaded, e.g., from Linksys support site
	(http://www.linksys.com/support/gpl.asp) for Linksys
	WRT54G. The GPL tarball includes cross-compiler and the needed
	header file, wlioctl.h, for compiling wpa_supplicant.  This
	driver support in wpa_supplicant is expected to work also with
	other devices based on Broadcom driver (assuming the driver
	includes client mode support).</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term> Intel ipw2100 driver</term>
	<listitem>
	  <para> (http://sourceforge.net/projects/ipw2100/)</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>Intel ipw2200 driver</term>
	<listitem>
	  <para> (http://sourceforge.net/projects/ipw2200/)</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>Linux wireless extensions</term>
	<listitem>
	  <para>In theory, any driver that supports Linux wireless
	extensions can be used with IEEE 802.1X (i.e., not WPA) when
	using ap_scan=0 option in configuration file.</para>
	</listitem>
      </varlistentry>
      
      <varlistentry>
	<term>Wired Ethernet drivers</term>
	<listitem>
	  <para>Use ap_scan=0.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>BSD net80211 layer (e.g., Atheros driver)</term>
	<listitem>
	  <para>At the moment, this is for FreeBSD 6-CURRENT branch.</para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term>Windows NDIS</term>
	<listitem>
	  <para>The current Windows port requires WinPcap
	(http://winpcap.polito.it/).  See README-Windows.txt for more
	information.</para>
	</listitem>
      </varlistentry>
    </variablelist>

	
    <para>wpa_supplicant was designed to be portable for different
    drivers and operating systems. Hopefully, support for more wlan
    cards and OSes will be added in the future. See developer.txt for
    more information about the design of wpa_supplicant and porting to
    other drivers. One main goal is to add full WPA/WPA2 support to
    Linux wireless extensions to allow new drivers to be supported
    without having to implement new driver-specific interface code in
    wpa_supplicant.</para>
  </refsect1>

  <refsect1>
    <title>Architecture</title> <para>The
    <command>wpa_supplicant</command> system consists of the following
    components:</para>

    <variablelist>
      <varlistentry>
	<term><filename>wpa_supplicant.conf</filename> </term>
	<listitem>
        <para>the configuration file describing all networks that the
        user wants the computer to connect to.  </para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><command>wpa_supplicant</command></term>
        <listitem><para>the program that directly interacts with the
        network interface.  </para></listitem>
      </varlistentry>
      <varlistentry>
	<term><command>wpa_cli</command></term> <listitem><para> the
	client program that provides a high-level interface to the
	functionality of the daemon.  </para></listitem>
      </varlistentry>
      <varlistentry>
	<term><command>wpa_passphrase</command></term>
        <listitem><para>a utility needed to construct
        <filename>wpa_supplicant.conf</filename> files that include
        encrypted passwords.</para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Quick Start</title>

    <para>First, make a configuration file, e.g.
    <filename>/etc/wpa_supplicant.conf</filename>, that describes the networks
    you are interested in.  See <citerefentry>
	<refentrytitle>wpa_supplicant</refentrytitle>
	<manvolnum>5</manvolnum>
      </citerefentry>
    for details.</para>

    <para>Once the configuration is ready, you can test whether the
    configuration works by running <command>wpa_supplicant</command>
    with following command to start it on foreground with debugging
    enabled:</para>

    <blockquote><programlisting>
wpa_supplicant -iwlan0 -c/etc/wpa_supplicant.conf -d
    </programlisting></blockquote>

    <para>Assuming everything goes fine, you can start using following
    command to start <command>wpa_supplicant</command> on background
    without debugging:</para>

    <blockquote><programlisting>
wpa_supplicant -iwlan0 -c/etc/wpa_supplicant.conf -B
    </programlisting></blockquote>

    <para>Please note that if you included more than one driver
    interface in the build time configuration (.config), you may need
    to specify which interface to use by including -D&lt;driver
    name&gt; option on the command line.</para>

    <!-- XXX at this point, the page could include a little script
         based on wpa_cli to wait for a connection and then run
         dhclient -->

  </refsect1>

  <refsect1>
    <title>Interface to pcmcia-cs/cardmrg</title>

    <para>For example, following small changes to pcmcia-cs scripts
    can be used to enable WPA support:</para>

    <para>Add MODE="Managed" and WPA="y" to the network scheme in
    <filename>/etc/pcmcia/wireless.opts</filename>.</para>

    <para>Add the following block to the end of 'start' action handler
    in <filename>/etc/pcmcia/wireless</filename>:</para>

    <blockquote><programlisting>
if [ "$WPA" = "y" -a -x /usr/local/bin/wpa_supplicant ]; then
    /usr/local/bin/wpa_supplicant -Bw -c/etc/wpa_supplicant.conf -i$DEVICE
fi
    </programlisting></blockquote>


    <para>Add the following block to the end of 'stop' action handler
    (may need to be separated from other actions) in
    <filename>/etc/pcmcia/wireless</filename>:</para>

    <blockquote><programlisting>
if [ "$WPA" = "y" -a -x /usr/local/bin/wpa_supplicant ]; then
    killall wpa_supplicant
fi
    </programlisting></blockquote>

    <para>This will make <command>cardmgr</command> start
    <command>wpa_supplicant</command> when the card is plugged
    in. <command>wpa_supplicant</command> will wait until the
    interface is set up--either when a static IP address is configured
    or when DHCP client is started--and will then negotiate keys with
    the AP.</para>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry>
	<refentrytitle>wpa_background</refentrytitle>
	<manvolnum>8</manvolnum>
      </citerefentry>
      <citerefentry>
	<refentrytitle>wpa_supplicant.conf</refentrytitle>
	<manvolnum>5</manvolnum>
      </citerefentry>
      <citerefentry>
	<refentrytitle>wpa_cli</refentrytitle>
	<manvolnum>8</manvolnum>
      </citerefentry>
      <citerefentry>
	<refentrytitle>wpa_passphrase</refentrytitle>
	<manvolnum>8</manvolnum>
      </citerefentry>
    </para>
  </refsect1>
  <refsect1>
    <title>Legal</title>
    <para>wpa_supplicant is copyright (c) 2003-2005,
    Jouni Malinen <email>[e-mail]</email> and
    contributors.
    All Rights Reserved.</para>

    <para>This program is dual-licensed under both the GPL version 2
    and BSD license. Either license may be used at your option.</para>
  </refsect1>
</refentry>