source: networking/netprogs/wpa_supplicant.xml@ 130e7e1

systemd-13485
Last change on this file since 130e7e1 was 130e7e1, checked in by Douglas R. Reno <renodr@…>, 8 years ago

(systemd) LFS79 Tags
(systemd) GCC6 tags

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@17405 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 16.0 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY wpa_supplicant-download-http
8 "http://hostap.epitest.fi/releases/wpa_supplicant-&wpa_supplicant-version;.tar.gz">
9 <!ENTITY wpa_supplicant-download-ftp " ">
10 <!ENTITY wpa_supplicant-md5sum "96ff75c3a514f1f324560a2376f13110">
11 <!ENTITY wpa_supplicant-size "2.5 MB">
12 <!ENTITY wpa_supplicant-buildsize "31 MB">
13 <!ENTITY wpa_supplicant-time "0.4 SBU (includes optional gui)">
14]>
15
16<sect1 id="wpa_supplicant" xreflabel="wpa_supplicant-&wpa_supplicant-version;">
17 <?dbhtml filename="wpa_supplicant.html"?>
18
19 <sect1info>
20 <othername>$LastChangedBy$</othername>
21 <date>$Date$</date>
22 </sect1info>
23
24 <title>wpa_supplicant-&wpa_supplicant-version;</title>
25
26 <indexterm zone="wpa_supplicant">
27 <primary sortas="a-wpa_supplicant">wpa_supplicant</primary>
28 </indexterm>
29
30 <sect2 role="package">
31 <title>Introduction to WPA Supplicant</title>
32
33 <para>
34 <application>WPA Supplicant</application> is a Wi-Fi Protected Access
35 (WPA) client and IEEE 802.1X supplicant. It implements WPA key negotiation
36 with a WPA Authenticator and Extensible Authentication Protocol (EAP)
37 authentication with an Authentication Server. In addition, it controls the
38 roaming and IEEE 802.11 authentication/association of the wireless LAN
39 driver. This is useful for connecting to a password protected wireless
40 access point.
41 </para>
42
43 &lfs79_checked;&gcc6_checked;
44
45 <bridgehead renderas="sect3">Package Information</bridgehead>
46 <itemizedlist spacing="compact">
47 <listitem>
48 <para>
49 Download (HTTP): <ulink url="&wpa_supplicant-download-http;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download (FTP): <ulink url="&wpa_supplicant-download-ftp;"/>
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download MD5 sum: &wpa_supplicant-md5sum;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Download size: &wpa_supplicant-size;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated disk space required: &wpa_supplicant-buildsize;
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 Estimated build time: &wpa_supplicant-time;
75 </para>
76 </listitem>
77 </itemizedlist>
78
79 <bridgehead renderas="sect3">WPA Supplicant Dependencies</bridgehead>
80
81 <bridgehead renderas="sect4">Recommended</bridgehead>
82 <para role="recommended">
83 <xref linkend="libnl"/> and
84 <xref linkend="openssl"/>
85 </para>
86
87 <bridgehead renderas="sect4">Optional</bridgehead>
88 <para role="optional">
89 <xref linkend="dbus"/>,
90 <xref linkend="libxml2"/>, and
91 <xref linkend="qt5"/>
92 </para>
93
94 <para condition="html" role="usernotes">User Notes:
95 <ulink url="&blfs-wiki;/wpa_supplicant"/>
96 </para>
97
98 </sect2>
99
100 <sect2 role="kernel" id="wpa_supplicant-kernel">
101 <title>Kernel Configuration</title>
102
103 <para>
104 Enable the following options in the kernel configuration as well as
105 specific device drivers for your hardware and recompile the kernel if
106 necessary:
107 </para>
108
109<screen><literal>[*] Networking support ---&gt; [CONFIG_NET]
110 [*] Wireless ---&gt; [CONFIG_WIRELESS]
111 &lt;*/M&gt; cfg80211 - wireless configuration API [CONFIG_CFG80211]
112 [*] cfg80211 wireless extensions compatibility [CONFIG_CFG80211_WEXT]
113 &lt;*/M&gt; Generic IEEE 802.11 Networking Stack (mac80211) [CONFIG_MAC80211]
114Device Drivers ---&gt;
115 [*] Network device support ---&gt; [CONFIG_NETDEVICES]
116 [*] Wireless LAN ---&gt; [CONFIG_WLAN]</literal></screen>
117
118 <para>
119 Open the submenu and select the options that support your hardware:
120 <command>lspci</command> from <xref linkend="pciutils"/> can be used to
121 view your hardware configuration.
122 </para>
123
124 <indexterm zone="wpa_supplicant wpa_supplicant-kernel">
125 <primary sortas="d-wpa_supplicant">wpa_supplicant</primary>
126 </indexterm>
127 </sect2>
128
129 <sect2 role="installation">
130 <title>Installation of WPA Supplicant</title>
131
132 <para>
133 First you will need to create an initial configuration file for the
134 build process. You can read <filename>wpa_supplicant/README</filename>
135 and <filename>wpa_supplicant/defconfig</filename> for the explanation
136 of the following options as well as other options that can be used.
137 Create a build configuration file that should work for standard WiFi
138 setups by running the following command:
139 </para>
140
141<screen><userinput>cat &gt; wpa_supplicant/.config &lt;&lt; "EOF"
142<literal>CONFIG_BACKEND=file
143CONFIG_CTRL_IFACE=y
144CONFIG_DEBUG_FILE=y
145CONFIG_DEBUG_SYSLOG=y
146CONFIG_DEBUG_SYSLOG_FACILITY=LOG_DAEMON
147CONFIG_DRIVER_NL80211=y
148CONFIG_DRIVER_WEXT=y
149CONFIG_DRIVER_WIRED=y
150CONFIG_EAP_GTC=y
151CONFIG_EAP_LEAP=y
152CONFIG_EAP_MD5=y
153CONFIG_EAP_MSCHAPV2=y
154CONFIG_EAP_OTP=y
155CONFIG_EAP_PEAP=y
156CONFIG_EAP_TLS=y
157CONFIG_EAP_TTLS=y
158CONFIG_IEEE8021X_EAPOL=y
159CONFIG_IPV6=y
160CONFIG_LIBNL32=y
161CONFIG_PEERKEY=y
162CONFIG_PKCS12=y
163CONFIG_READLINE=y
164CONFIG_SMARTCARD=y
165CONFIG_WPS=y
166CFLAGS += -I/usr/include/libnl3</literal>
167EOF</userinput></screen>
168
169 <para>
170 If you wish to use <application>WPA Supplicant</application> with
171 <xref linkend="NetworkManager"/>, add the required options to
172 the <application>WPA Supplicant</application> build configuration
173 file by running the following command:
174 </para>
175
176<screen><userinput>cat &gt;&gt; wpa_supplicant/.config &lt;&lt; "EOF"
177<literal>CONFIG_CTRL_IFACE_DBUS=y
178CONFIG_CTRL_IFACE_DBUS_NEW=y
179CONFIG_CTRL_IFACE_DBUS_INTRO=y</literal>
180EOF</userinput></screen>
181
182 <para>
183 Install <application>WPA Supplicant</application> by running the
184 following commands:
185 </para>
186
187<screen><userinput>cd wpa_supplicant &amp;&amp;
188make BINDIR=/sbin LIBDIR=/lib</userinput></screen>
189
190 <para>
191 If you have installed <xref linkend="qt4"/> and wish to build
192 the <application>WPA Supplicant</application> GUI program, run
193 the following commands:
194 </para>
195
196<screen><userinput>pushd wpa_gui-qt4 &amp;&amp;
197qmake wpa_gui.pro &amp;&amp;
198make &amp;&amp;
199popd</userinput></screen>
200
201 <para>
202 This package does not come with a test suite.
203 </para>
204
205 <para>
206 Now, as the <systemitem class="username">root</systemitem> user:
207 </para>
208
209<screen role="root"><userinput>install -v -m755 wpa_{cli,passphrase,supplicant} /sbin/ &amp;&amp;
210install -v -m644 doc/docbook/wpa_supplicant.conf.5 /usr/share/man/man5/ &amp;&amp;
211install -v -m644 doc/docbook/wpa_{cli,passphrase,supplicant}.8 /usr/share/man/man8/</userinput></screen>
212
213 <para>
214 Install the <application>systemd</application> support files by
215 running the following command as the <systemitem
216 class="username">root</systemitem> user:
217 </para>
218
219<screen role="root"><userinput>install -v -m644 systemd/*.service /lib/systemd/system/</userinput></screen>
220
221 <para>
222 If you have built <application>WPA Supplicant</application> with
223 <application>D-Bus</application> support, you will need to install
224 <application>D-Bus</application> configuration files. Install them
225 by running the following commands as the
226 <systemitem class="username">root</systemitem> user:
227 </para>
228
229<screen role="root"><userinput>install -v -m644 dbus/fi.{epitest.hostap.WPASupplicant,w1.wpa_supplicant1}.service \
230 /usr/share/dbus-1/system-services/ &amp;&amp;
231install -v -m644 dbus/dbus-wpa_supplicant.conf \
232 /etc/dbus-1/system.d/wpa_supplicant.conf</userinput></screen>
233
234 <para>
235 Additionally, enable the <filename>wpa_supplicant.service</filename> so that
236 <application>systemd</application> can properly activate the
237 <application>D-Bus</application> service. Note that the
238 per-connection service and the D-Bus service cannot be enabled
239 at the same time. Run the following command as the
240 <systemitem class="username">root</systemitem> user:
241 </para>
242
243<screen role="root"><userinput>systemctl enable wpa_supplicant</userinput></screen>
244
245 <para>
246 If you have built the <application>WPA Supplicant</application> GUI
247 program, install it by running the following commands as the
248 <systemitem class="username">root</systemitem> user:
249 </para>
250
251<screen role="root"><userinput>install -v -m755 wpa_gui-qt4/wpa_gui /usr/bin/ &amp;&amp;
252install -v -m644 doc/docbook/wpa_gui.8 /usr/share/man/man8/ &amp;&amp;
253install -v -m644 wpa_gui-qt4/wpa_gui.desktop /usr/share/applications/ &amp;&amp;
254install -v -m644 wpa_gui-qt4/icons/wpa_gui.svg /usr/share/pixmaps/</userinput></screen>
255
256 <note>
257 <para>
258 You will need to restart the system <application>D-Bus</application> daemon
259 before you can use the <application>WPA Supplicant</application>
260 <application>D-Bus</application> interface.
261 </para>
262 </note>
263
264 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
265 href="../../xincludes/update-desktop-database.xml"/>
266
267 </sect2>
268
269 <sect2 role="configuration">
270 <title>Configuring wpa_supplicant</title>
271
272 <sect3 id="wpa_supplicant-config">
273 <title>Config File</title>
274
275 <para>
276 <filename>/etc/wpa_supplicant/wpa_supplicant-*.conf</filename>
277 </para>
278
279 <indexterm zone="wpa_supplicant wpa_supplicant-config">
280 <primary
281 sortas="e-etc-wpa_supplicant-wpa_supplicant-star.conf">/etc/wpa_supplicant/wpa_supplicant-*.conf</primary>
282 </indexterm>
283
284 </sect3>
285
286 <sect3>
287 <title>Configuration Information</title>
288
289 <warning>
290 <para>
291 You need to replace <replaceable>wlan0</replaceable> with
292 the correct wireless interface name in the commands below.
293 </para>
294 </warning>
295
296 <para>
297 To connect to an access point that uses a password, you need to put
298 the pre-shared key in <filename>
299 /etc/wpa_supplicant/wpa_supplicant-<replaceable>wlan0</replaceable>.conf</filename>.
300 SSID is the string that the access point/router transmits to
301 identify itself. Run the following command as the
302 <systemitem class="username">root</systemitem> user:
303 </para>
304
305<screen role="root"><userinput>install -v -dm755 /etc/wpa_supplicant &amp;&amp;
306wpa_passphrase <replaceable>SSID</replaceable> <replaceable>SECRET_PASSWORD</replaceable> &gt; /etc/wpa_supplicant/wpa_supplicant-<replaceable>wlan0</replaceable>.conf</userinput></screen>
307
308 <para>
309 <filename>/etc/wpa_supplicant/wpa_supplicant-<replaceable>wlan0</replaceable>.conf
310 </filename> can hold the details of several access points. When
311 <command>wpa_supplicant</command> is started, it will scan for the
312 SSIDs it can see and choose the appropriate password to connect.
313 </para>
314
315 <para>
316 If you want to connect to an access point that isn't password
317 protected, put an entry like this in <filename>
318 /etc/wpa_supplicant/wpa_supplicant-<replaceable>wlan0</replaceable>.conf</filename>.
319 Replace "Some-SSID" with the SSID of the access point/router.
320 </para>
321
322<screen>network={
323 ssid="<replaceable>Some-SSID</replaceable>"
324 key_mgmt=NONE
325}</screen>
326
327 <para>
328 There are many options that you could use to tweak how you connect
329 to each access point. They are described in some detail in the
330 <filename>wpa_supplicant/wpa_supplicant.conf</filename> file in the
331 source tree.
332 </para>
333
334 </sect3>
335
336 <sect3>
337 <title>Connecting to an Access Point</title>
338
339 <para>
340 There are 3 types of <application>systemd</application> units
341 that were installed:
342 </para>
343
344 <itemizedlist spacing="compact">
345 <listitem>
346 <para>
347 wpa_supplicant@.service
348 </para>
349 </listitem>
350 <listitem>
351 <para>
352 wpa_supplicant-nl80211@.service
353 </para>
354 </listitem>
355 <listitem>
356 <para>
357 wpa_supplicant-wired@.service
358 </para>
359 </listitem>
360 </itemizedlist>
361
362 <para>
363 The only difference between 3 of them is what driver
364 is used for connecting (-D option). The first one uses
365 the default driver, the second one uses the nl80211
366 driver and the third one uses the wired driver.
367 </para>
368
369 <para>
370 You can connect to the wireless access point by
371 running the following command as the
372 <systemitem class="username">root</systemitem> user:
373 </para>
374
375<screen role="root"><userinput>systemctl start wpa_supplicant@<replaceable>wlan0</replaceable></userinput></screen>
376
377 <para>
378 To connect to the wireless access point at
379 boot, simply enable the appropriate
380 <command>wpa_supplicant</command> service
381 by running the following command as the
382 <systemitem class="username">root</systemitem> user:
383 </para>
384
385<screen role="root"><userinput>systemctl enable wpa_supplicant@<replaceable>wlan0</replaceable></userinput></screen>
386
387 <para>
388 Depending on your setup, you can replace the
389 <filename>wpa_supplicant@.service</filename>
390 with any other listed above.
391 </para>
392
393 <para>
394 To assign a network address to your wireless interface,
395 consult the <ulink
396 url="&lfs-root;/chapter07/network.html">General Network Configuration</ulink>
397 page in LFS.
398 </para>
399
400 </sect3>
401
402 </sect2>
403
404 <sect2 role="content">
405 <title>Contents</title>
406
407 <segmentedlist>
408 <segtitle>Installed Programs</segtitle>
409 <segtitle>Installed Libraries</segtitle>
410 <segtitle>Installed Directories</segtitle>
411
412 <seglistitem>
413 <seg>
414 wpa_gui, wpa_supplicant, wpa_passphrase and wpa_cli
415 </seg>
416 <seg>
417 None
418 </seg>
419 <seg>
420 None
421 </seg>
422 </seglistitem>
423 </segmentedlist>
424
425 <variablelist>
426 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
427 <?dbfo list-presentation="list"?>
428 <?dbhtml list-presentation="table"?>
429
430 <varlistentry id="wpa_gui">
431 <term><command>wpa_gui</command></term>
432 <listitem>
433 <para>
434 is a graphical frontend program for interacting with
435 <application>wpa_supplicant</application>.
436 </para>
437 <indexterm zone="wpa_supplicant wpa_gui">
438 <primary sortas="b-wpa_gui">wpa_gui</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry id="wpa_supplicant-prog">
444 <term><command>wpa_supplicant</command></term>
445 <listitem>
446 <para>
447 is a daemon that can connect to a password protected wireless
448 access point.
449 </para>
450 <indexterm zone="wpa_supplicant wpa_supplicant-prog">
451 <primary sortas="b-wpa_supplicant">wpa_supplicant</primary>
452 </indexterm>
453 </listitem>
454 </varlistentry>
455
456 <varlistentry id="wpa_passphrase">
457 <term><command>wpa_passphrase</command></term>
458 <listitem>
459 <para>
460 takes an SSID and a password and generates a simple
461 configuration that <command>wpa_supplicant</command> can
462 understand.
463 </para>
464 <indexterm zone="wpa_supplicant wpa_passphrase">
465 <primary sortas="b-wpa_passphrase">wpa_passphrase</primary>
466 </indexterm>
467 </listitem>
468 </varlistentry>
469
470 <varlistentry id="wpa_cli">
471 <term><command>wpa_cli</command></term>
472 <listitem>
473 <para>
474 is a command line interface used to control a running
475 <command>wpa_supplicant</command> daemon.
476 </para>
477 <indexterm zone="wpa_supplicant wpa_cli">
478 <primary sortas="b-wpa_cli">wpa_cli</primary>
479 </indexterm>
480 </listitem>
481 </varlistentry>
482
483 </variablelist>
484
485 </sect2>
486
487</sect1>
Note: See TracBrowser for help on using the repository browser.