source: networking/netprogs/wpa_supplicant.xml@ eb3dbe3

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since eb3dbe3 was eb3dbe3, checked in by Bruce Dubbs <bdubbs@…>, 8 years ago

Remove references to qt4 from obconf-qt, qscintilla, qtermwidget,
gst10-plugins-base, v4l-utils, wpa_supplicant, wireshark,
and transmission.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@17445 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 17.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"/>, make sure that you have installed
172 <xref linkend="dbus"/> and <xref linkend="libxml2"/>, then add the
173 following options to the <application>WPA Supplicant</application>
174 build configuration file by running the following command:
175 </para>
176
177<screen><userinput>cat &gt;&gt; wpa_supplicant/.config &lt;&lt; "EOF"
178<literal>CONFIG_CTRL_IFACE_DBUS=y
179CONFIG_CTRL_IFACE_DBUS_NEW=y
180CONFIG_CTRL_IFACE_DBUS_INTRO=y</literal>
181EOF</userinput></screen>
182
183 <para>
184 Install <application>WPA Supplicant</application> by running the
185 following commands:
186 </para>
187
188<screen><userinput>cd wpa_supplicant &amp;&amp;
189make BINDIR=/sbin LIBDIR=/lib</userinput></screen>
190
191 <para>
192 If you have installed <xref linkend="qt5"/> and wish to build
193 the <application>WPA Supplicant</application> GUI program, run
194 the following commands:
195 </para>
196
197 <note><para>The following directory name is labelled qt4, but
198 is compatible with <xref linkend="qt5"/>.</para></note>
199
200<screen><userinput>pushd wpa_gui-qt4 &amp;&amp;
201qmake wpa_gui.pro &amp;&amp;
202make &amp;&amp;
203popd</userinput></screen>
204
205 <para>
206 This package does not come with a test suite.
207 </para>
208
209 <para>
210 Now, as the <systemitem class="username">root</systemitem> user:
211 </para>
212
213<screen role="root"><userinput>install -v -m755 wpa_{cli,passphrase,supplicant} /sbin/ &amp;&amp;
214install -v -m644 doc/docbook/wpa_supplicant.conf.5 /usr/share/man/man5/ &amp;&amp;
215install -v -m644 doc/docbook/wpa_{cli,passphrase,supplicant}.8 /usr/share/man/man8/</userinput></screen>
216
217 <para>
218 If you have built <application>WPA Supplicant</application> with
219 <application>D-Bus</application> support, you will need to install
220 <application>D-Bus</application> configuration files. Install them
221 by running the following commands as the
222 <systemitem class="username">root</systemitem> user:
223 </para>
224
225<screen role="root"><userinput>install -v -m644 dbus/fi.{epitest.hostap.WPASupplicant,w1.wpa_supplicant1}.service \
226 /usr/share/dbus-1/system-services/ &amp;&amp;
227install -v -m644 dbus/dbus-wpa_supplicant.conf \
228 /etc/dbus-1/system.d/wpa_supplicant.conf</userinput></screen>
229
230 <para>
231 If you have built the <application>WPA Supplicant</application> GUI
232 program, install it by running the following commands as the
233 <systemitem class="username">root</systemitem> user:
234 </para>
235
236<screen role="root"><userinput>install -v -m755 wpa_gui-qt4/wpa_gui /usr/bin/ &amp;&amp;
237install -v -m644 doc/docbook/wpa_gui.8 /usr/share/man/man8/ &amp;&amp;
238install -v -m644 wpa_gui-qt4/wpa_gui.desktop /usr/share/applications/ &amp;&amp;
239install -v -m644 wpa_gui-qt4/icons/wpa_gui.svg /usr/share/pixmaps/</userinput></screen>
240
241 <note>
242 <para>
243 You will need to restart the system <application>D-Bus</application> daemon
244 before you can use the <application>WPA Supplicant</application>
245 <application>D-Bus</application> interface.
246 </para>
247 </note>
248
249 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
250 href="../../xincludes/update-desktop-database.xml"/>
251
252 </sect2>
253
254 <sect2 role="configuration">
255 <title>Configuring wpa_supplicant</title>
256
257 <sect3 id="wpa_supplicant-config">
258 <title>Config File</title>
259
260 <para>
261 <filename>/etc/sysconfig/wpa_supplicant-*.conf</filename>
262 </para>
263
264 <indexterm zone="wpa_supplicant wpa_supplicant-config">
265 <primary
266 sortas="e-etc-sysconfig-wpa_supplicant-star.conf">/etc/sysconfig/wpa_supplicant-*.conf</primary>
267 </indexterm>
268
269 </sect3>
270
271 <sect3>
272 <title>Configuration Information</title>
273
274 <para>
275 To connect to an access point that uses a password, you need to put
276 the pre-shared key in <filename>
277 /etc/sysconfig/wpa_supplicant-<replaceable>wifi0</replaceable>.conf</filename>.
278 SSID is the string that the access point/router transmits to
279 identify itself. Run the following command as the
280 <systemitem class="username">root</systemitem> user:
281 </para>
282
283<screen role="root"><userinput>wpa_passphrase <replaceable>SSID</replaceable> <replaceable>SECRET_PASSWORD</replaceable> &gt; /etc/sysconfig/wpa_supplicant-<replaceable>wifi0</replaceable>.conf</userinput></screen>
284
285 <para>
286 <filename>/etc/sysconfig/wpa_supplicant-<replaceable>wifi0</replaceable>.conf
287 </filename> can hold the details of several access points. When
288 <command>wpa_supplicant</command> is started, it will scan for the
289 SSIDs it can see and choose the appropriate password to connect.
290 </para>
291
292 <para>
293 If you want to connect to an access point that isn't password
294 protected, put an entry like this in <filename>
295 /etc/sysconfig/wpa_supplicant-<replaceable>wifi0</replaceable>.conf</filename>.
296 Replace "Some-SSID" with the SSID of the access point/router.
297 </para>
298
299<screen>network={
300 ssid="<replaceable>Some-SSID</replaceable>"
301 key_mgmt=NONE
302}</screen>
303
304 <para>
305 There are many options that you could use to tweak how you connect
306 to each access point. They are described in some detail in the
307 <filename>wpa_supplicant/wpa_supplicant.conf</filename> file in the
308 source tree.
309 </para>
310
311 </sect3>
312
313 <sect3>
314 <title>Connecting to an Access Point</title>
315
316 <para id="wpa-service">
317 If you want to configure network interfaces at boot using
318 <command>wpa_supplicant</command>, you need to install the
319 <filename>/lib/services/wpa</filename> script
320 included in <xref linkend="bootscripts" revision="sysv"/>
321 <xref linkend="systemd-units" revision="systemd"/> package:
322 </para>
323
324<screen role="root"><userinput>make install-service-wpa</userinput></screen>
325
326 <indexterm zone="wpa_supplicant wpa-service">
327 <primary sortas="f-wpa">wpa</primary>
328 </indexterm>
329
330 <para>
331 If your router/access point uses DHCP to allocate IP addresses, you
332 can install <xref linkend="dhcp"/> client and use it to
333 automatically obtain network addresses. Create the
334 <filename>/etc/sysconfig/ifconfig-<replaceable>wifi0</replaceable>
335 </filename> by running the following command as the
336 <systemitem class="username">root</systemitem> user:
337 </para>
338
339<screen role="root"><userinput>cat &gt; /etc/sysconfig/ifconfig.<replaceable>wifi0</replaceable> &lt;&lt; "EOF"
340<literal>ONBOOT="yes"
341IFACE="<replaceable>wlan0</replaceable>"
342SERVICE="wpa"
343
344# Additional arguments to wpa_supplicant
345WPA_ARGS=""
346
347WPA_SERVICE="dhclient"
348DHCP_START=""
349DHCP_STOP=""
350
351# Set PRINTIP="yes" to have the script print
352# the DHCP assigned IP address
353PRINTIP="no"
354
355# Set PRINTALL="yes" to print the DHCP assigned values for
356# IP, SM, DG, and 1st NS. This requires PRINTIP="yes".
357PRINTALL="no"</literal>
358EOF</userinput></screen>
359
360 <para>
361 If you prefer <xref linkend="dhcpcd"/> instead of
362 <xref linkend="dhcp"/> client, then create the
363 <filename>/etc/sysconfig/ifconfig-<replaceable>wifi0</replaceable>
364 </filename> by running the following command as the
365 <systemitem class="username">root</systemitem> user:
366 </para>
367
368<screen role="root"><userinput>cat &gt; /etc/sysconfig/ifconfig.<replaceable>wifi0</replaceable> &lt;&lt; "EOF"
369<literal>ONBOOT="yes"
370IFACE="<replaceable>wlan0</replaceable>"
371SERVICE="wpa"
372
373# Additional arguments to wpa_supplicant
374WPA_ARGS=""
375
376WPA_SERVICE="dhcpcd"
377DHCP_START="-b -q <replaceable>&lt;insert appropriate start options here&gt;</replaceable>"
378DHCP_STOP="-k <replaceable>&lt;insert additional stop options here&gt;</replaceable>"</literal>
379EOF</userinput></screen>
380
381 <para>
382 Alternatively, if you use static addresses on your local network,
383 then create the
384 <filename>/etc/sysconfig/ifconfig-<replaceable>wifi0</replaceable>
385 </filename> by running the following command as the
386 <systemitem class="username">root</systemitem> user:
387 </para>
388
389<screen role="root"><userinput>cat &gt; /etc/sysconfig/ifconfig.<replaceable>wifi0</replaceable> &lt;&lt; "EOF"
390<literal>ONBOOT="yes"
391IFACE="<replaceable>wlan0</replaceable>"
392SERVICE="wpa"
393
394# Additional arguments to wpa_supplicant
395WPA_ARGS=""
396
397WPA_SERVICE="ipv4-static"
398IP="192.168.1.1"
399GATEWAY="192.168.1.2"
400PREFIX="24"
401BROADCAST="192.168.1.255"</literal>
402EOF</userinput></screen>
403
404 <para>
405 You can connect to the wireless access point by
406 running the following command as the
407 <systemitem class="username">root</systemitem> user:
408 </para>
409
410<screen role="root"><userinput>ifup <replaceable>wifi0</replaceable></userinput></screen>
411
412 <para>
413 Replace <replaceable>wlan0</replaceable> with the correct
414 wireless interface and <replaceable>wifi0</replaceable>
415 with desired name for the configuration file. Please note
416 that <filename>wpa_supplicant-*.conf</filename> and
417 <filename>ifconfig.*</filename> configuration files need
418 to have identical names, ie both contain
419 <replaceable>wifi0</replaceable> in their name.
420 </para>
421
422 </sect3>
423
424 </sect2>
425
426 <sect2 role="content">
427 <title>Contents</title>
428
429 <segmentedlist>
430 <segtitle>Installed Programs</segtitle>
431 <segtitle>Installed Libraries</segtitle>
432 <segtitle>Installed Directories</segtitle>
433
434 <seglistitem>
435 <seg>
436 wpa_gui, wpa_supplicant, wpa_passphrase and wpa_cli
437 </seg>
438 <seg>
439 None
440 </seg>
441 <seg>
442 None
443 </seg>
444 </seglistitem>
445 </segmentedlist>
446
447 <variablelist>
448 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
449 <?dbfo list-presentation="list"?>
450 <?dbhtml list-presentation="table"?>
451
452 <varlistentry id="wpa_gui">
453 <term><command>wpa_gui</command></term>
454 <listitem>
455 <para>
456 is a graphical frontend program for interacting with
457 <application>wpa_supplicant</application>.
458 </para>
459 <indexterm zone="wpa_supplicant wpa_gui">
460 <primary sortas="b-wpa_gui">wpa_gui</primary>
461 </indexterm>
462 </listitem>
463 </varlistentry>
464
465 <varlistentry id="wpa_supplicant-prog">
466 <term><command>wpa_supplicant</command></term>
467 <listitem>
468 <para>
469 is a daemon that can connect to a password protected wireless
470 access point.
471 </para>
472 <indexterm zone="wpa_supplicant wpa_supplicant-prog">
473 <primary sortas="b-wpa_supplicant">wpa_supplicant</primary>
474 </indexterm>
475 </listitem>
476 </varlistentry>
477
478 <varlistentry id="wpa_passphrase">
479 <term><command>wpa_passphrase</command></term>
480 <listitem>
481 <para>
482 takes an SSID and a password and generates a simple
483 configuration that <command>wpa_supplicant</command> can
484 understand.
485 </para>
486 <indexterm zone="wpa_supplicant wpa_passphrase">
487 <primary sortas="b-wpa_passphrase">wpa_passphrase</primary>
488 </indexterm>
489 </listitem>
490 </varlistentry>
491
492 <varlistentry id="wpa_cli">
493 <term><command>wpa_cli</command></term>
494 <listitem>
495 <para>
496 is a command line interface used to control a running
497 <command>wpa_supplicant</command> daemon.
498 </para>
499 <indexterm zone="wpa_supplicant wpa_cli">
500 <primary sortas="b-wpa_cli">wpa_cli</primary>
501 </indexterm>
502 </listitem>
503 </varlistentry>
504
505 </variablelist>
506
507 </sect2>
508
509</sect1>
Note: See TracBrowser for help on using the repository browser.