source: postlfs/security/cracklib.xml@ b3285de

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since b3285de was fb3a93b3, checked in by Pierre Labastie <pierre.labastie@…>, 20 months ago

cracklib: Fix commands and command explanations

Prompted by a report by "r1c0n3r0" on irc #lfs-support.
PYTHON=python3.10 is not needed anymore, as well as CPPFLAGS.
Document autoreconf.

  • Property mode set to 100644
File size: 12.5 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 cracklib-url "https://github.com/cracklib/cracklib/releases/download">
8
9 <!ENTITY cracklib-download-http "&cracklib-url;/v&cracklib-version;/cracklib-&cracklib-version;.tar.bz2">
10 <!ENTITY cracklib-download-ftp " ">
11 <!ENTITY cracklib-md5sum "a242301bad13421476db8eecbbc9536a">
12 <!ENTITY cracklib-size "600 KB">
13 <!ENTITY cracklib-buildsize "6.7 MB">
14 <!ENTITY cracklib-time "0.1 SBU">
15
16 <!ENTITY crackdict-download "&cracklib-url;/v&cracklib-version;/cracklib-words-&cracklib-version;.bz2">
17 <!ENTITY crackdict-size "6.7 MB">
18 <!ENTITY crackdict-md5sum "94e9963e4786294f7fb0f2efd7618551">
19]>
20
21<sect1 id="cracklib" xreflabel="CrackLib-&cracklib-version;">
22 <?dbhtml filename="cracklib.html"?>
23
24 <sect1info>
25 <date>$Date$</date>
26 </sect1info>
27
28 <title>CrackLib-&cracklib-version;</title>
29
30 <indexterm zone="cracklib">
31 <primary sortas="a-CrackLib">CrackLib</primary>
32 </indexterm>
33
34 <sect2 role="package">
35 <title>Introduction to CrackLib</title>
36
37 <para>
38 The <application>CrackLib</application> package contains a
39 library used to enforce strong passwords by comparing user selected
40 passwords to words in chosen word lists.
41 </para>
42
43 &lfs112_checked;
44
45 <bridgehead renderas="sect3">Package Information</bridgehead>
46 <itemizedlist spacing="compact">
47 <listitem>
48 <para>
49 Download (HTTP): <ulink url="&cracklib-download-http;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download (FTP): <ulink url="&cracklib-download-ftp;"/>
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download MD5 sum: &cracklib-md5sum;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Download size: &cracklib-size;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated disk space required: &cracklib-buildsize;
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 Estimated build time: &cracklib-time;
75 </para>
76 </listitem>
77 </itemizedlist>
78
79 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
80 <itemizedlist spacing="compact">
81 <listitem>
82 <para>
83 Recommended word list for English-speaking countries (size:
84 &crackdict-size;; md5sum: &crackdict-md5sum;):
85 <ulink url="&crackdict-download;"/>
86 </para>
87 </listitem>
88 </itemizedlist>
89
90 <para>
91 There are additional word lists available for download, e.g., from
92 <ulink url="https://wiki.skullsecurity.org/index.php/Passwords"/>.
93 <application>CrackLib</application> can utilize as many, or as few word
94 lists you choose to install.
95 </para>
96
97 <important>
98 <para>
99 Users tend to base their passwords on regular words of the spoken
100 language, and crackers know that. <application>CrackLib</application>
101 is intended to filter out such bad passwords at the source using a
102 dictionary created from word lists. To accomplish this, the word
103 list(s) for use with <application>CrackLib</application> must be an
104 exhaustive list of words and word-based keystroke combinations likely
105 to be chosen by users of the system as (guessable) passwords.
106 </para>
107
108 <para>
109 The default word list recommended above for downloading mostly
110 satisfies this role in English-speaking countries. In other situations,
111 it may be necessary to download (or even create) additional word lists.
112 </para>
113
114 <para>
115 Note that word lists suitable for spell-checking are not usable
116 as <application>CrackLib</application> word lists in countries with
117 non-Latin based alphabets, because of <quote>word-based keystroke
118 combinations</quote> that make bad passwords.
119 </para>
120 </important>
121
122 <para condition="html" role="usernotes">User Notes:
123 <ulink url="&blfs-wiki;/cracklib"/>
124 </para>
125 </sect2>
126
127 <sect2 role="installation">
128 <title>Installation of CrackLib</title>
129
130 <para>
131 Install <application>CrackLib</application> by running the following
132 commands:
133 </para>
134
135<screen><userinput>autoreconf -fiv &amp;&amp;
136
137PYTHON=python3 \
138./configure --prefix=/usr \
139 --disable-static \
140 --with-default-dict=/usr/lib/cracklib/pw_dict &amp;&amp;
141make</userinput></screen>
142
143 <para>
144 Now, as the <systemitem class="username">root</systemitem> user:
145 </para>
146
147<screen role="root"><userinput>make install</userinput></screen>
148
149 <para>
150 Issue the following commands as the
151 <systemitem class="username">root</systemitem> user to install the
152 recommended word list and create the <application>CrackLib</application>
153 dictionary. Other word lists (text based, one word per line) can also be
154 used by simply installing them into
155 <filename class="directory">/usr/share/dict</filename> and adding them
156 to the <command>create-cracklib-dict</command> command.
157 </para>
158
159<screen role="root"><userinput>install -v -m644 -D ../cracklib-words-&cracklib-version;.bz2 \
160 /usr/share/dict/cracklib-words.bz2 &amp;&amp;
161
162bunzip2 -v /usr/share/dict/cracklib-words.bz2 &amp;&amp;
163ln -v -sf cracklib-words /usr/share/dict/words &amp;&amp;
164echo $(hostname) >> /usr/share/dict/cracklib-extra-words &amp;&amp;
165install -v -m755 -d /usr/lib/cracklib &amp;&amp;
166
167create-cracklib-dict /usr/share/dict/cracklib-words \
168 /usr/share/dict/cracklib-extra-words</userinput></screen>
169
170 <para>
171 If desired, check the proper operation of the library as an
172 unprivileged user by issuing the following command:
173 </para>
174
175<screen remap="test"><userinput>make test</userinput></screen>
176
177 <important>
178 <para>
179 If you are installing <application>CrackLib</application> after
180 your LFS system has been completed and you have the
181 <application>Shadow</application> package installed, you must
182 reinstall <xref linkend="shadow"/> if you wish to provide strong
183 password support on your system. If you are now going to install the
184 <xref linkend="linux-pam"/> package, you may disregard this note as
185 <application>Shadow</application> will be reinstalled after the
186 <application>Linux-PAM</application> installation.
187 </para>
188 </important>
189
190 </sect2>
191
192 <sect2 role="commands">
193 <title>Command Explanations</title>
194
195 <para>
196 <command>sed -i '/skipping/d' util/packer.c</command>:
197 Remove a meaningless warning.
198 </para>
199
200 <para>
201 <command>autoreconf -fiv</command>: The configure script shipped with
202 the package is too old to get the right version string of Python
203 3.10 or later. This command regenerates it with a more recent version
204 of autotools, which fixes the issue.
205 </para>
206
207 <para>
208 <envar>PYTHON=python3</envar>: This forces the installation of
209 python bindings for Python 3, even if Python 2 is installed.
210 </para>
211 <!-- fixed by autoreconf
212 <para>
213 <envar>CPPFLAGS=-I/usr/include/python&python3-majorver;</envar>:
214 This works around an issue caused by incorrect usage of Python 3
215 headers.
216 </para>
217 -->
218 <para>
219 <parameter>--with-default-dict=/lib/cracklib/pw_dict</parameter>:
220 This parameter forces the installation of the
221 <application>CrackLib</application> dictionary to the
222 <filename class="directory">/lib</filename> hierarchy.
223 </para>
224
225 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
226 href="../../xincludes/static-libraries.xml"/>
227
228 <para>
229 <command>install -v -m644 -D ...</command>: This command creates the
230 <filename class="directory">/usr/share/dict</filename> directory (if it
231 doesn't already exist) and installs the compressed word list there.
232 </para>
233
234 <para>
235 <command>ln -v -s cracklib-words /usr/share/dict/words</command>: The
236 word list is linked to <filename>/usr/share/dict/words</filename> as
237 historically, <filename>words</filename> is the primary word list in the
238 <filename class="directory">/usr/share/dict</filename> directory. Omit
239 this command if you already have a
240 <filename>/usr/share/dict/words</filename> file installed on your system.
241 </para>
242
243 <para>
244 <command>echo $(hostname) >>...</command>: The value of
245 <command>hostname</command> is echoed to a file called
246 <filename>cracklib-extra-words</filename>. This extra file is intended
247 to be a site specific list which includes easy to guess passwords such
248 as company or department names, user names, product names, computer
249 names, domain names, etc.
250 </para>
251
252 <para>
253 <command>create-cracklib-dict ...</command>: This command creates the
254 <application>CrackLib</application> dictionary from the word lists.
255 Modify the command to add any additional word lists you have installed.
256 </para>
257
258 </sect2>
259
260 <sect2 role="content">
261 <title>Contents</title>
262
263 <segmentedlist>
264 <segtitle>Installed Programs</segtitle>
265 <segtitle>Installed Libraries</segtitle>
266 <segtitle>Installed Directories</segtitle>
267
268 <seglistitem>
269 <seg>cracklib-check, cracklib-format, cracklib-packer,
270 cracklib-unpacker and create-cracklib-dict</seg>
271
272 <seg>libcrack.so and the _cracklib.so
273 (<application>Python</application> module)</seg>
274
275 <seg>/lib/cracklib, /usr/share/dict and /usr/share/cracklib</seg>
276 </seglistitem>
277 </segmentedlist>
278
279 <variablelist>
280 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
281 <?dbfo list-presentation="list"?>
282 <?dbhtml list-presentation="table"?>
283
284 <varlistentry id="cracklib-check">
285 <term><command>cracklib-check</command></term>
286 <listitem>
287 <para>
288 is used to determine if a password is strong
289 </para>
290 <indexterm zone="cracklib cracklib-check">
291 <primary sortas="b-cracklib-check">cracklib-check</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="cracklib-format">
297 <term><command>cracklib-format</command></term>
298 <listitem>
299 <para>
300 is used to format text files (lowercases all words,
301 removes control characters and sorts the lists)
302 </para>
303 <indexterm zone="cracklib cracklib-format">
304 <primary sortas="b-cracklib-format">cracklib-format</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="cracklib-packer">
310 <term><command>cracklib-packer</command></term>
311 <listitem>
312 <para>
313 creates a database with words read from standard input
314 </para>
315 <indexterm zone="cracklib cracklib-packer">
316 <primary sortas="b-cracklib-packer">cracklib-packer</primary>
317 </indexterm>
318 </listitem>
319 </varlistentry>
320
321 <varlistentry id="cracklib-unpacker">
322 <term><command>cracklib-unpacker</command></term>
323 <listitem>
324 <para>
325 displays on standard output the database specified
326 </para>
327 <indexterm zone="cracklib cracklib-packer">
328 <primary sortas="b-cracklib-packer">cracklib-packer</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="create-cracklib-dict">
334 <term><command>create-cracklib-dict</command></term>
335 <listitem>
336 <para>
337 is used to create the <application>CrackLib</application>
338 dictionary from the given word list(s)
339 </para>
340 <indexterm zone="cracklib create-cracklib-dict">
341 <primary sortas="b-create-cracklib-dict">create-cracklib-dict</primary>
342 </indexterm>
343 </listitem>
344 </varlistentry>
345
346 <varlistentry id="libcrack">
347 <term><filename class="libraryfile">libcrack.so</filename></term>
348 <listitem>
349 <para>
350 provides a fast dictionary lookup method for strong
351 password enforcement
352 </para>
353 <indexterm zone="cracklib libcrack">
354 <primary sortas="c-libcrack">libcrack.so</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 </variablelist>
360
361 </sect2>
362
363</sect1>
Note: See TracBrowser for help on using the repository browser.