wpa_supplicant.sgml 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818
  1. <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
  2. <refentry>
  3. <refmeta>
  4. <refentrytitle>wpa_supplicant</refentrytitle>
  5. <manvolnum>8</manvolnum>
  6. </refmeta>
  7. <refnamediv>
  8. <refname>wpa_supplicant</refname>
  9. <refpurpose>Wi-Fi Protected Access client and IEEE 802.1X supplicant</refpurpose>
  10. </refnamediv>
  11. <refsynopsisdiv>
  12. <cmdsynopsis>
  13. <command>wpa_supplicant</command>
  14. <arg>-BddfhKLqqtuvW</arg>
  15. <arg>-i<replaceable>ifname</replaceable></arg>
  16. <arg>-c<replaceable>config file</replaceable></arg>
  17. <arg>-D<replaceable>driver</replaceable></arg>
  18. <arg>-P<replaceable>PID_file</replaceable></arg>
  19. <arg>-f<replaceable>output file</replaceable></arg>
  20. </cmdsynopsis>
  21. </refsynopsisdiv>
  22. <refsect1>
  23. <title>Overview</title>
  24. <para>
  25. Wireless networks do not require physical access to the network equipment
  26. in the same way as wired networks. This makes it easier for unauthorized
  27. users to passively monitor a network and capture all transmitted frames.
  28. In addition, unauthorized use of the network is much easier. In many cases,
  29. this can happen even without user's explicit knowledge since the wireless
  30. LAN adapter may have been configured to automatically join any available
  31. network.
  32. </para>
  33. <para>
  34. Link-layer encryption can be used to provide a layer of security for
  35. wireless networks. The original wireless LAN standard, IEEE 802.11,
  36. included a simple encryption mechanism, WEP. However, that proved to
  37. be flawed in many areas and network protected with WEP cannot be consider
  38. secure. IEEE 802.1X authentication and frequently changed dynamic WEP keys
  39. can be used to improve the network security, but even that has inherited
  40. security issues due to the use of WEP for encryption. Wi-Fi Protected
  41. Access and IEEE 802.11i amendment to the wireless LAN standard introduce
  42. a much improvement mechanism for securing wireless networks. IEEE 802.11i
  43. enabled networks that are using CCMP (encryption mechanism based on strong
  44. cryptographic algorithm AES) can finally be called secure used for
  45. applications which require efficient protection against unauthorized
  46. access.
  47. </para>
  48. <para><command>wpa_supplicant</command> is an implementation of
  49. the WPA Supplicant component, i.e., the part that runs in the
  50. client stations. It implements WPA key negotiation with a WPA
  51. Authenticator and EAP authentication with Authentication
  52. Server. In addition, it controls the roaming and IEEE 802.11
  53. authentication/association of the wireless LAN driver.</para>
  54. <para><command>wpa_supplicant</command> is designed to be a
  55. "daemon" program that runs in the background and acts as the
  56. backend component controlling the wireless
  57. connection. <command>wpa_supplicant</command> supports separate
  58. frontend programs and an example text-based frontend,
  59. <command>wpa_cli</command>, is included with
  60. wpa_supplicant.</para>
  61. <para>Before wpa_supplicant can do its work, the network interface
  62. must be available. That means that the physical device must be
  63. present and enabled, and the driver for the device must have be
  64. loaded. The daemon will exit immediately if the device is not already
  65. available.</para>
  66. <para>After <command>wpa_supplicant</command> has configured the
  67. network device, higher level configuration such as DHCP may
  68. proceed. There are a variety of ways to integrate wpa_supplicant
  69. into a machine's networking scripts, a few of which are described
  70. in sections below.</para>
  71. <para>The following steps are used when associating with an AP
  72. using WPA:</para>
  73. <itemizedlist>
  74. <listitem>
  75. <para><command>wpa_supplicant</command> requests the kernel
  76. driver to scan neighboring BSSes</para>
  77. </listitem>
  78. <listitem>
  79. <para><command>wpa_supplicant</command> selects a BSS based on
  80. its configuration</para>
  81. </listitem>
  82. <listitem>
  83. <para><command>wpa_supplicant</command> requests the kernel
  84. driver to associate with the chosen BSS</para>
  85. </listitem>
  86. <listitem>
  87. <para>If WPA-EAP: integrated IEEE 802.1X Supplicant
  88. completes EAP authentication with the
  89. authentication server (proxied by the Authenticator in the
  90. AP)</para>
  91. </listitem>
  92. <listitem>
  93. <para>If WPA-EAP: master key is received from the IEEE 802.1X
  94. Supplicant</para>
  95. </listitem>
  96. <listitem>
  97. <para>If WPA-PSK: <command>wpa_supplicant</command> uses PSK
  98. as the master session key</para>
  99. </listitem>
  100. <listitem>
  101. <para><command>wpa_supplicant</command> completes WPA 4-Way
  102. Handshake and Group Key Handshake with the Authenticator
  103. (AP)</para>
  104. </listitem>
  105. <listitem>
  106. <para><command>wpa_supplicant</command> configures encryption
  107. keys for unicast and broadcast</para>
  108. </listitem>
  109. <listitem>
  110. <para>normal data packets can be transmitted and received</para>
  111. </listitem>
  112. </itemizedlist>
  113. </refsect1>
  114. <refsect1>
  115. <title>Supported Features</title>
  116. <para>Supported WPA/IEEE 802.11i features:</para>
  117. <itemizedlist>
  118. <listitem>
  119. <para>WPA-PSK ("WPA-Personal")</para>
  120. </listitem>
  121. <listitem>
  122. <para>WPA with EAP (e.g., with RADIUS authentication server)
  123. ("WPA-Enterprise") Following authentication methods are
  124. supported with an integrate IEEE 802.1X Supplicant:</para>
  125. <itemizedlist>
  126. <listitem>
  127. <para>EAP-TLS</para>
  128. </listitem>
  129. </itemizedlist>
  130. <itemizedlist>
  131. <listitem>
  132. <para>EAP-PEAP/MSCHAPv2 (both PEAPv0 and PEAPv1)</para>
  133. </listitem>
  134. <listitem>
  135. <para>EAP-PEAP/TLS (both PEAPv0 and PEAPv1)</para>
  136. </listitem>
  137. <listitem>
  138. <para>EAP-PEAP/GTC (both PEAPv0 and PEAPv1)</para>
  139. </listitem>
  140. <listitem>
  141. <para>EAP-PEAP/OTP (both PEAPv0 and PEAPv1)</para>
  142. </listitem>
  143. <listitem>
  144. <para>EAP-PEAP/MD5-Challenge (both PEAPv0 and PEAPv1)</para>
  145. </listitem>
  146. <listitem>
  147. <para>EAP-TTLS/EAP-MD5-Challenge</para>
  148. </listitem>
  149. <listitem>
  150. <para>EAP-TTLS/EAP-GTC</para>
  151. </listitem>
  152. <listitem><para>EAP-TTLS/EAP-OTP</para></listitem>
  153. <listitem><para>EAP-TTLS/EAP-MSCHAPv2</para></listitem>
  154. <listitem><para>EAP-TTLS/EAP-TLS</para></listitem>
  155. <listitem><para>EAP-TTLS/MSCHAPv2</para></listitem>
  156. <listitem><para>EAP-TTLS/MSCHAP</para></listitem>
  157. <listitem><para>EAP-TTLS/PAP</para></listitem>
  158. <listitem><para>EAP-TTLS/CHAP</para></listitem>
  159. <listitem><para>EAP-SIM</para></listitem>
  160. <listitem><para>EAP-AKA</para></listitem>
  161. <listitem><para>EAP-PSK</para></listitem>
  162. <listitem><para>EAP-PAX</para></listitem>
  163. <listitem><para>LEAP (note: requires special support from
  164. the driver for IEEE 802.11 authentication)</para></listitem>
  165. <listitem><para>(following methods are supported, but since
  166. they do not generate keying material, they cannot be used
  167. with WPA or IEEE 802.1X WEP keying)</para></listitem>
  168. <listitem><para>EAP-MD5-Challenge </para></listitem>
  169. <listitem><para>EAP-MSCHAPv2</para></listitem>
  170. <listitem><para>EAP-GTC</para></listitem>
  171. <listitem><para>EAP-OTP</para></listitem>
  172. </itemizedlist>
  173. </listitem>
  174. <listitem>
  175. <para>key management for CCMP, TKIP, WEP104, WEP40</para>
  176. </listitem>
  177. <listitem>
  178. <para>RSN/WPA2 (IEEE 802.11i)</para>
  179. <itemizedlist>
  180. <listitem>
  181. <para>pre-authentication</para>
  182. </listitem>
  183. <listitem>
  184. <para>PMKSA caching</para>
  185. </listitem>
  186. </itemizedlist>
  187. </listitem>
  188. </itemizedlist>
  189. </refsect1>
  190. <refsect1>
  191. <title>Available Drivers</title>
  192. <para>A summary of available driver backends is below. Support for each
  193. of the driver backends is chosen at wpa_supplicant compile time. For a
  194. list of supported driver backends that may be used with the -D option on
  195. your system, refer to the help output of wpa_supplicant
  196. (<emphasis>wpa_supplicant -h</emphasis>).</para>
  197. <variablelist>
  198. <varlistentry>
  199. <term>hostap</term>
  200. <listitem>
  201. <para>(default) Host AP driver (Intersil Prism2/2.5/3).
  202. (this can also be used with Linuxant DriverLoader).</para>
  203. </listitem>
  204. </varlistentry>
  205. <varlistentry>
  206. <term>hermes</term>
  207. <listitem>
  208. <para>Agere Systems Inc. driver (Hermes-I/Hermes-II).</para>
  209. </listitem>
  210. </varlistentry>
  211. <varlistentry>
  212. <term>madwifi</term>
  213. <listitem>
  214. <para>MADWIFI 802.11 support (Atheros, etc.).</para>
  215. </listitem>
  216. </varlistentry>
  217. <varlistentry>
  218. <term>atmel</term>
  219. <listitem>
  220. <para>ATMEL AT76C5XXx (USB, PCMCIA).</para>
  221. </listitem>
  222. </varlistentry>
  223. <varlistentry>
  224. <term>wext</term>
  225. <listitem>
  226. <para>Linux wireless extensions (generic).</para>
  227. </listitem>
  228. </varlistentry>
  229. <varlistentry>
  230. <term>ndiswrapper</term>
  231. <listitem>
  232. <para>Linux ndiswrapper.</para>
  233. </listitem>
  234. </varlistentry>
  235. <varlistentry>
  236. <term>broadcom</term>
  237. <listitem>
  238. <para>Broadcom wl.o driver.</para>
  239. </listitem>
  240. </varlistentry>
  241. <varlistentry>
  242. <term>ipw</term>
  243. <listitem>
  244. <para>Intel ipw2100/2200 driver.</para>
  245. </listitem>
  246. </varlistentry>
  247. <varlistentry>
  248. <term>wired</term>
  249. <listitem>
  250. <para>wpa_supplicant wired Ethernet driver</para>
  251. </listitem>
  252. </varlistentry>
  253. <varlistentry>
  254. <term>roboswitch</term>
  255. <listitem>
  256. <para>wpa_supplicant Broadcom switch driver</para>
  257. </listitem>
  258. </varlistentry>
  259. <varlistentry>
  260. <term>bsd</term>
  261. <listitem>
  262. <para>BSD 802.11 support (Atheros, etc.).</para>
  263. </listitem>
  264. </varlistentry>
  265. <varlistentry>
  266. <term>ndis</term>
  267. <listitem>
  268. <para>Windows NDIS driver.</para>
  269. </listitem>
  270. </varlistentry>
  271. </variablelist>
  272. </refsect1>
  273. <refsect1>
  274. <title>Command Line Options</title>
  275. <para>Most command line options have global scope. Some are given per
  276. interface, and are only valid if at least one <option>-i</option> option
  277. is specified, otherwise they're ignored. Option groups for different
  278. interfaces must be separated by <option>-N</option> option.</para>
  279. <variablelist>
  280. <varlistentry>
  281. <term>-b br_ifname</term>
  282. <listitem>
  283. <para>Optional bridge interface name. (Per interface)</para>
  284. </listitem>
  285. </varlistentry>
  286. <varlistentry>
  287. <term>-B</term>
  288. <listitem>
  289. <para>Run daemon in the background.</para>
  290. </listitem>
  291. </varlistentry>
  292. <varlistentry>
  293. <term>-c filename</term>
  294. <listitem>
  295. <para>Path to configuration file. (Per interface)</para>
  296. </listitem>
  297. </varlistentry>
  298. <varlistentry>
  299. <term>-C ctrl_interface</term>
  300. <listitem>
  301. <para>Path to ctrl_interface socket (Per interface. Only used if
  302. <option>-c</option> is not).</para>
  303. </listitem>
  304. </varlistentry>
  305. <varlistentry>
  306. <term>-i ifname</term>
  307. <listitem>
  308. <para>Interface to listen on. Multiple instances of this option can
  309. be present, one per interface, separated by <option>-N</option>
  310. option (see below).</para>
  311. </listitem>
  312. </varlistentry>
  313. <varlistentry>
  314. <term>-d</term>
  315. <listitem>
  316. <para>Increase debugging verbosity (<option>-dd</option> even
  317. more).</para>
  318. </listitem>
  319. </varlistentry>
  320. <varlistentry>
  321. <term>-D driver</term>
  322. <listitem>
  323. <para>Driver to use. (Per interface, see the available options
  324. below.)</para>
  325. </listitem>
  326. </varlistentry>
  327. <varlistentry>
  328. <term>-f output file</term>
  329. <listitem>
  330. <para>Log output to specified file instead of stdout.</para>
  331. </listitem>
  332. </varlistentry>
  333. <varlistentry>
  334. <term>-g global ctrl_interface</term>
  335. <listitem>
  336. <para>Path to global ctrl_interface socket. If specified, interface
  337. definitions may be omitted.</para>
  338. </listitem>
  339. </varlistentry>
  340. <varlistentry>
  341. <term>-K</term>
  342. <listitem>
  343. <para>Include keys (passwords, etc.) in debug output.</para>
  344. </listitem>
  345. </varlistentry>
  346. <varlistentry>
  347. <term>-t</term>
  348. <listitem>
  349. <para>Include timestamp in debug messages.</para>
  350. </listitem>
  351. </varlistentry>
  352. <varlistentry>
  353. <term>-h</term>
  354. <listitem>
  355. <para>Help. Show a usage message.</para>
  356. </listitem>
  357. </varlistentry>
  358. <varlistentry>
  359. <term>-L</term>
  360. <listitem>
  361. <para>Show license (GPL and BSD).</para>
  362. </listitem>
  363. </varlistentry>
  364. <varlistentry>
  365. <term>-p</term>
  366. <listitem>
  367. <para>Driver parameters. (Per interface)</para>
  368. </listitem>
  369. </varlistentry>
  370. <varlistentry>
  371. <term>-P PID_file</term>
  372. <listitem>
  373. <para>Path to PID file.</para>
  374. </listitem>
  375. </varlistentry>
  376. <varlistentry>
  377. <term>-q</term>
  378. <listitem>
  379. <para>Decrease debugging verbosity (<option>-qq</option> even
  380. less).</para>
  381. </listitem>
  382. </varlistentry>
  383. <varlistentry>
  384. <term>-u</term>
  385. <listitem>
  386. <para>Enabled DBus control interface. If enabled, interface
  387. definitions may be omitted.</para>
  388. </listitem>
  389. </varlistentry>
  390. <varlistentry>
  391. <term>-v</term>
  392. <listitem>
  393. <para>Show version.</para>
  394. </listitem>
  395. </varlistentry>
  396. <varlistentry>
  397. <term>-W</term>
  398. <listitem>
  399. <para>Wait for a control interface monitor before starting.</para>
  400. </listitem>
  401. </varlistentry>
  402. <varlistentry>
  403. <term>-N</term>
  404. <listitem>
  405. <para>Start describing new interface.</para>
  406. </listitem>
  407. </varlistentry>
  408. </variablelist>
  409. </refsect1>
  410. <refsect1>
  411. <title>Examples</title>
  412. <para>In most common cases, <command>wpa_supplicant</command> is
  413. started with:</para>
  414. <blockquote><programlisting>
  415. wpa_supplicant -B -c/etc/wpa_supplicant.conf -iwlan0
  416. </programlisting></blockquote>
  417. <para>This makes the process fork into background.</para>
  418. <para>The easiest way to debug problems, and to get debug log for
  419. bug reports, is to start <command>wpa_supplicant</command> on
  420. foreground with debugging enabled:</para>
  421. <blockquote><programlisting>
  422. wpa_supplicant -c/etc/wpa_supplicant.conf -iwlan0 -d
  423. </programlisting></blockquote>
  424. <para><command>wpa_supplicant</command> can control multiple
  425. interfaces (radios) either by running one process for each
  426. interface separately or by running just one process and list of
  427. options at command line. Each interface is separated with -N
  428. argument. As an example, following command would start
  429. wpa_supplicant for two interfaces:</para>
  430. <blockquote><programlisting>
  431. wpa_supplicant \
  432. -c wpa1.conf -i wlan0 -D hostap -N \
  433. -c wpa2.conf -i ath0 -D madwifi
  434. </programlisting></blockquote>
  435. </refsect1>
  436. <refsect1>
  437. <title>OS Requirements</title>
  438. <para>Current hardware/software requirements:</para>
  439. <itemizedlist>
  440. <listitem>
  441. <para>Linux kernel 2.4.x or 2.6.x with Linux Wireless
  442. Extensions v15 or newer</para>
  443. </listitem>
  444. <listitem>
  445. <para>FreeBSD 6-CURRENT</para>
  446. </listitem>
  447. <listitem>
  448. <para>Microsoft Windows with WinPcap (at least WinXP, may work
  449. with other versions)</para>
  450. </listitem>
  451. </itemizedlist>
  452. </refsect1>
  453. <refsect1>
  454. <title>Supported Drivers</title>
  455. <variablelist>
  456. <varlistentry>
  457. <term>Host AP driver for Prism2/2.5/3 (development
  458. snapshot/v0.2.x)</term>
  459. <listitem>
  460. <para> (http://hostap.epitest.fi/) Driver needs to be set in
  461. Managed mode (<emphasis>iwconfig wlan0 mode managed</emphasis>).
  462. Please note that station firmware version needs to be 1.7.0 or
  463. newer to work in WPA mode.</para>
  464. </listitem>
  465. </varlistentry>
  466. <varlistentry>
  467. <term>Linuxant DriverLoader</term>
  468. <listitem>
  469. <para>(http://www.linuxant.com/driverloader/)
  470. with Windows NDIS driver for your wlan card supporting WPA.</para>
  471. </listitem>
  472. </varlistentry>
  473. <varlistentry>
  474. <term>Agere Systems Inc. Linux Driver</term>
  475. <listitem>
  476. <para> (http://www.agere.com/support/drivers/) Please note
  477. that the driver interface file (driver_hermes.c) and hardware
  478. specific include files are not included in the wpa_supplicant
  479. distribution. You will need to copy these from the source
  480. package of the Agere driver.</para>
  481. </listitem>
  482. </varlistentry>
  483. <varlistentry>
  484. <term>madwifi driver for cards based on Atheros chip set (ar521x)</term>
  485. <listitem>
  486. <para> (http://sourceforge.net/projects/madwifi/) Please
  487. note that you will need to modify the wpa_supplicant .config
  488. file to use the correct path for the madwifi driver root
  489. directory (CFLAGS += -I../madwifi/wpa line in example
  490. defconfig).</para>
  491. </listitem>
  492. </varlistentry>
  493. <varlistentry>
  494. <term>ATMEL AT76C5XXx driver for USB and PCMCIA cards</term>
  495. <listitem>
  496. <para> (http://atmelwlandriver.sourceforge.net/).</para>
  497. </listitem>
  498. </varlistentry>
  499. <varlistentry>
  500. <term>Linux ndiswrapper</term>
  501. <listitem>
  502. <para> (http://ndiswrapper.sourceforge.net/) with Windows
  503. NDIS driver.</para>
  504. </listitem>
  505. </varlistentry>
  506. <varlistentry>
  507. <term>Broadcom wl.o driver</term>
  508. <listitem>
  509. <para> This is a generic Linux driver for Broadcom IEEE
  510. 802.11a/g cards. However, it is proprietary driver that is
  511. not publicly available except for couple of exceptions, mainly
  512. Broadcom-based APs/wireless routers that use Linux. The driver
  513. binary can be downloaded, e.g., from Linksys support site
  514. (http://www.linksys.com/support/gpl.asp) for Linksys
  515. WRT54G. The GPL tarball includes cross-compiler and the needed
  516. header file, wlioctl.h, for compiling wpa_supplicant. This
  517. driver support in wpa_supplicant is expected to work also with
  518. other devices based on Broadcom driver (assuming the driver
  519. includes client mode support).</para>
  520. </listitem>
  521. </varlistentry>
  522. <varlistentry>
  523. <term> Intel ipw2100 driver</term>
  524. <listitem>
  525. <para> (http://sourceforge.net/projects/ipw2100/)</para>
  526. </listitem>
  527. </varlistentry>
  528. <varlistentry>
  529. <term>Intel ipw2200 driver</term>
  530. <listitem>
  531. <para> (http://sourceforge.net/projects/ipw2200/)</para>
  532. </listitem>
  533. </varlistentry>
  534. <varlistentry>
  535. <term>Linux wireless extensions</term>
  536. <listitem>
  537. <para>In theory, any driver that supports Linux wireless
  538. extensions can be used with IEEE 802.1X (i.e., not WPA) when
  539. using ap_scan=0 option in configuration file.</para>
  540. </listitem>
  541. </varlistentry>
  542. <varlistentry>
  543. <term>Wired Ethernet drivers</term>
  544. <listitem>
  545. <para>Use ap_scan=0.</para>
  546. </listitem>
  547. </varlistentry>
  548. <varlistentry>
  549. <term>BSD net80211 layer (e.g., Atheros driver)</term>
  550. <listitem>
  551. <para>At the moment, this is for FreeBSD 6-CURRENT branch.</para>
  552. </listitem>
  553. </varlistentry>
  554. <varlistentry>
  555. <term>Windows NDIS</term>
  556. <listitem>
  557. <para>The current Windows port requires WinPcap
  558. (http://winpcap.polito.it/). See README-Windows.txt for more
  559. information.</para>
  560. </listitem>
  561. </varlistentry>
  562. </variablelist>
  563. <para>wpa_supplicant was designed to be portable for different
  564. drivers and operating systems. Hopefully, support for more wlan
  565. cards and OSes will be added in the future. See developer.txt for
  566. more information about the design of wpa_supplicant and porting to
  567. other drivers. One main goal is to add full WPA/WPA2 support to
  568. Linux wireless extensions to allow new drivers to be supported
  569. without having to implement new driver-specific interface code in
  570. wpa_supplicant.</para>
  571. </refsect1>
  572. <refsect1>
  573. <title>Architecture</title> <para>The
  574. <command>wpa_supplicant</command> system consists of the following
  575. components:</para>
  576. <variablelist>
  577. <varlistentry>
  578. <term><filename>wpa_supplicant.conf</filename> </term>
  579. <listitem>
  580. <para>the configuration file describing all networks that the
  581. user wants the computer to connect to. </para>
  582. </listitem>
  583. </varlistentry>
  584. <varlistentry>
  585. <term><command>wpa_supplicant</command></term>
  586. <listitem><para>the program that directly interacts with the
  587. network interface. </para></listitem>
  588. </varlistentry>
  589. <varlistentry>
  590. <term><command>wpa_cli</command></term> <listitem><para> the
  591. client program that provides a high-level interface to the
  592. functionality of the daemon. </para></listitem>
  593. </varlistentry>
  594. <varlistentry>
  595. <term><command>wpa_passphrase</command></term>
  596. <listitem><para>a utility needed to construct
  597. <filename>wpa_supplicant.conf</filename> files that include
  598. encrypted passwords.</para></listitem>
  599. </varlistentry>
  600. </variablelist>
  601. </refsect1>
  602. <refsect1>
  603. <title>Quick Start</title>
  604. <para>First, make a configuration file, e.g.
  605. <filename>/etc/wpa_supplicant.conf</filename>, that describes the networks
  606. you are interested in. See <citerefentry>
  607. <refentrytitle>wpa_supplicant.conf</refentrytitle>
  608. <manvolnum>5</manvolnum>
  609. </citerefentry>
  610. for details.</para>
  611. <para>Once the configuration is ready, you can test whether the
  612. configuration works by running <command>wpa_supplicant</command>
  613. with following command to start it on foreground with debugging
  614. enabled:</para>
  615. <blockquote><programlisting>
  616. wpa_supplicant -iwlan0 -c/etc/wpa_supplicant.conf -d
  617. </programlisting></blockquote>
  618. <para>Assuming everything goes fine, you can start using following
  619. command to start <command>wpa_supplicant</command> on background
  620. without debugging:</para>
  621. <blockquote><programlisting>
  622. wpa_supplicant -iwlan0 -c/etc/wpa_supplicant.conf -B
  623. </programlisting></blockquote>
  624. <para>Please note that if you included more than one driver
  625. interface in the build time configuration (.config), you may need
  626. to specify which interface to use by including -D&lt;driver
  627. name&gt; option on the command line.</para>
  628. <!-- XXX at this point, the page could include a little script
  629. based on wpa_cli to wait for a connection and then run
  630. dhclient -->
  631. </refsect1>
  632. <refsect1>
  633. <title>Interface to pcmcia-cs/cardmrg</title>
  634. <para>For example, following small changes to pcmcia-cs scripts
  635. can be used to enable WPA support:</para>
  636. <para>Add MODE="Managed" and WPA="y" to the network scheme in
  637. <filename>/etc/pcmcia/wireless.opts</filename>.</para>
  638. <para>Add the following block to the end of <emphasis>start</emphasis>
  639. action handler in <filename>/etc/pcmcia/wireless</filename>:</para>
  640. <blockquote><programlisting>
  641. if [ "$WPA" = "y" -a -x /usr/local/bin/wpa_supplicant ]; then
  642. /usr/local/bin/wpa_supplicant -B -c/etc/wpa_supplicant.conf -i$DEVICE
  643. fi
  644. </programlisting></blockquote>
  645. <para>Add the following block to the end of <emphasis>stop</emphasis>
  646. action handler (may need to be separated from other actions) in
  647. <filename>/etc/pcmcia/wireless</filename>:</para>
  648. <blockquote><programlisting>
  649. if [ "$WPA" = "y" -a -x /usr/local/bin/wpa_supplicant ]; then
  650. killall wpa_supplicant
  651. fi
  652. </programlisting></blockquote>
  653. <para>This will make <command>cardmgr</command> start
  654. <command>wpa_supplicant</command> when the card is plugged
  655. in.</para>
  656. </refsect1>
  657. <refsect1>
  658. <title>See Also</title>
  659. <para>
  660. <citerefentry>
  661. <refentrytitle>wpa_background</refentrytitle>
  662. <manvolnum>8</manvolnum>
  663. </citerefentry>
  664. <citerefentry>
  665. <refentrytitle>wpa_supplicant.conf</refentrytitle>
  666. <manvolnum>5</manvolnum>
  667. </citerefentry>
  668. <citerefentry>
  669. <refentrytitle>wpa_cli</refentrytitle>
  670. <manvolnum>8</manvolnum>
  671. </citerefentry>
  672. <citerefentry>
  673. <refentrytitle>wpa_passphrase</refentrytitle>
  674. <manvolnum>8</manvolnum>
  675. </citerefentry>
  676. </para>
  677. </refsect1>
  678. <refsect1>
  679. <title>Legal</title>
  680. <para>wpa_supplicant is copyright (c) 2003-2007,
  681. Jouni Malinen <email>j@w1.fi</email> and
  682. contributors.
  683. All Rights Reserved.</para>
  684. <para>This program is dual-licensed under both the GPL version 2
  685. and BSD license. Either license may be used at your option.</para>
  686. </refsect1>
  687. </refentry>