[f97d5f6] | 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 |
|
---|
[3c64e32] | 7 | <!ENTITY libpwquality-download-http "https://github.com/libpwquality/libpwquality/releases/download/libpwquality-&libpwquality-version;/libpwquality-&libpwquality-version;.tar.bz2">
|
---|
[f97d5f6] | 8 | <!ENTITY libpwquality-download-ftp " ">
|
---|
[2bfa995] | 9 | <!ENTITY libpwquality-md5sum "6b70e355269aef0b9ddb2b9d17936f21">
|
---|
| 10 | <!ENTITY libpwquality-size "424 KB">
|
---|
| 11 | <!ENTITY libpwquality-buildsize "5.4 MB">
|
---|
| 12 | <!ENTITY libpwquality-time "0.1 SBU">
|
---|
[f97d5f6] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="libpwquality" xreflabel="libpwquality-&libpwquality-version;">
|
---|
| 16 | <?dbhtml filename="libpwquality.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>libpwquality-&libpwquality-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="libpwquality">
|
---|
[183f254] | 22 | <primary sortas="a-libpwquality">libpwquality</primary>
|
---|
[f97d5f6] | 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[183f254] | 26 | <title>Introduction to libpwquality</title>
|
---|
[f97d5f6] | 27 |
|
---|
| 28 | <para>
|
---|
[096ed61] | 29 | The <application>libpwquality</application> package provides common
|
---|
[f97d5f6] | 30 | functions for password quality checking and also scoring them based on
|
---|
| 31 | their apparent randomness. The library also provides a function for
|
---|
[f3429309] | 32 | generating random passwords with good pronounceability.
|
---|
[f97d5f6] | 33 | </para>
|
---|
| 34 |
|
---|
[fbd04125] | 35 | &lfs120_checked;
|
---|
[f97d5f6] | 36 |
|
---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
| 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&libpwquality-download-http;"/>
|
---|
| 42 | </para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&libpwquality-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download MD5 sum: &libpwquality-md5sum;
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download size: &libpwquality-size;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Estimated disk space required: &libpwquality-buildsize;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated build time: &libpwquality-time;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect3">libpwquality Dependencies</bridgehead>
|
---|
| 72 |
|
---|
[9dc3146] | 73 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 74 | <para role="required">
|
---|
| 75 | <xref linkend="cracklib"/>
|
---|
| 76 | </para>
|
---|
| 77 |
|
---|
[f97d5f6] | 78 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 79 | <para role="recommended">
|
---|
[9dc3146] | 80 | <xref linkend="linux-pam"/>
|
---|
[f97d5f6] | 81 | </para>
|
---|
[85ac148] | 82 | <!-- Do not advertise python 2 since python 3 can be used
|
---|
[2c64887e] | 83 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 84 | <para role="optional">
|
---|
| 85 | <xref linkend="python2"/>
|
---|
| 86 | </para>
|
---|
[85ac148] | 87 | -->
|
---|
[f97d5f6] | 88 | </sect2>
|
---|
| 89 |
|
---|
| 90 | <sect2 role="installation">
|
---|
| 91 | <title>Installation of libpwquality</title>
|
---|
| 92 |
|
---|
| 93 | <para>
|
---|
| 94 | Install <application>libpwquality</application> by running the following
|
---|
| 95 | commands:
|
---|
| 96 | </para>
|
---|
| 97 |
|
---|
[e92e7dc] | 98 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 99 | --disable-static \
|
---|
| 100 | --with-securedir=/usr/lib/security \
|
---|
| 101 | --with-python-binary=python3 &&
|
---|
[f97d5f6] | 102 | make</userinput></screen>
|
---|
| 103 |
|
---|
| 104 | <para>
|
---|
| 105 | This package does not come with a test suite.
|
---|
| 106 | </para>
|
---|
| 107 |
|
---|
| 108 | <para>
|
---|
| 109 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 110 | </para>
|
---|
[8558044] | 111 |
|
---|
[e92e7dc] | 112 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[f97d5f6] | 113 |
|
---|
| 114 | </sect2>
|
---|
| 115 |
|
---|
[2c64887e] | 116 | <sect2 role="commands">
|
---|
| 117 | <title>Command Explanations</title>
|
---|
| 118 |
|
---|
| 119 | <para>
|
---|
| 120 | <parameter>--with-python-binary=python3</parameter>: This parameter gives
|
---|
| 121 | the location of the <application>Python</application> binary. The default
|
---|
| 122 | is <parameter>python</parameter>, and requires <xref linkend="python2"/>.
|
---|
| 123 | </para>
|
---|
[7e11b83c] | 124 |
|
---|
[2c64887e] | 125 | </sect2>
|
---|
| 126 |
|
---|
[62066a54] | 127 | <sect2 role="configuration">
|
---|
[eecc046] | 128 | <title>Configuring libpwquality</title>
|
---|
[62066a54] | 129 |
|
---|
[7e11b83c] | 130 | <para>
|
---|
| 131 | <application>libpwquality</application> is intended to be a
|
---|
| 132 | functional replacement for the now-obsolete
|
---|
| 133 | <filename>pam_cracklib.so</filename> PAM module. To configure the system
|
---|
| 134 | to use the <filename>pam_pwquality</filename> module, execute the
|
---|
| 135 | following commands as the
|
---|
| 136 | <systemitem class="username">root</systemitem> user:
|
---|
| 137 | </para>
|
---|
[62066a54] | 138 |
|
---|
| 139 | <screen role="root"><userinput>mv /etc/pam.d/system-password{,.orig} &&
|
---|
| 140 | cat > /etc/pam.d/system-password << "EOF"
|
---|
| 141 | <literal># Begin /etc/pam.d/system-password
|
---|
| 142 |
|
---|
| 143 | # check new passwords for strength (man pam_pwquality)
|
---|
| 144 | password required pam_pwquality.so authtok_type=UNIX retry=1 difok=1 \
|
---|
| 145 | minlen=8 dcredit=0 ucredit=0 \
|
---|
| 146 | lcredit=0 ocredit=0 minclass=1 \
|
---|
| 147 | maxrepeat=0 maxsequence=0 \
|
---|
[cbb07ee4] | 148 | maxclassrepeat=0 gecoscheck=0 \
|
---|
[62066a54] | 149 | dictcheck=1 usercheck=1 \
|
---|
| 150 | enforcing=1 badwords="" \
|
---|
[e92e7dc] | 151 | dictpath=/usr/lib/cracklib/pw_dict
|
---|
[c0464a8] | 152 |
|
---|
| 153 | # use yescrypt hash for encryption, use shadow, and try to use any
|
---|
| 154 | # previously defined authentication token (chosen password) set by any
|
---|
| 155 | # prior module.
|
---|
| 156 | password required pam_unix.so yescrypt shadow try_first_pass
|
---|
[62066a54] | 157 |
|
---|
| 158 | # End /etc/pam.d/system-password</literal>
|
---|
| 159 | EOF
|
---|
| 160 | </userinput></screen>
|
---|
| 161 |
|
---|
| 162 | </sect2>
|
---|
[8558044] | 163 |
|
---|
[f97d5f6] | 164 | <sect2 role="content">
|
---|
| 165 | <title>Contents</title>
|
---|
| 166 |
|
---|
| 167 | <segmentedlist>
|
---|
| 168 | <segtitle>Installed Programs</segtitle>
|
---|
| 169 | <segtitle>Installed Libraries</segtitle>
|
---|
| 170 | <segtitle>Installed Directories</segtitle>
|
---|
| 171 |
|
---|
| 172 | <seglistitem>
|
---|
| 173 | <seg>
|
---|
| 174 | pwscore and pwmake
|
---|
| 175 | </seg>
|
---|
| 176 | <seg>
|
---|
| 177 | pam_pwquality.so and libpwquality.so
|
---|
| 178 | </seg>
|
---|
| 179 | <seg>
|
---|
[651c7ebf] | 180 | None
|
---|
| 181 | <!-- /etc/security was installed by Linux-PAM -->
|
---|
[f97d5f6] | 182 | </seg>
|
---|
| 183 | </seglistitem>
|
---|
| 184 | </segmentedlist>
|
---|
[183f254] | 185 |
|
---|
[f97d5f6] | 186 | <variablelist>
|
---|
| 187 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 188 | <?dbfo list-presentation="list"?>
|
---|
| 189 | <?dbhtml list-presentation="table"?>
|
---|
| 190 |
|
---|
[183f254] | 191 | <varlistentry id="pwmake">
|
---|
| 192 | <term><command>pwmake</command></term>
|
---|
| 193 | <listitem>
|
---|
| 194 | <para>
|
---|
| 195 | is a simple configurable tool for generating random
|
---|
[4c24eb0a] | 196 | and relatively easily pronounceable passwords
|
---|
[183f254] | 197 | </para>
|
---|
| 198 | <indexterm zone="libpwquality pwmake">
|
---|
| 199 | <primary sortas="b-pwmake">pwmake</primary>
|
---|
| 200 | </indexterm>
|
---|
| 201 | </listitem>
|
---|
| 202 | </varlistentry>
|
---|
| 203 |
|
---|
| 204 | <varlistentry id="pwscore">
|
---|
| 205 | <term><command>pwscore</command></term>
|
---|
| 206 | <listitem>
|
---|
| 207 | <para>
|
---|
[4c24eb0a] | 208 | is a simple tool for checking quality of a password
|
---|
[183f254] | 209 | </para>
|
---|
| 210 | <indexterm zone="libpwquality pwscore">
|
---|
| 211 | <primary sortas="b-pwscore">pwscore</primary>
|
---|
| 212 | </indexterm>
|
---|
| 213 | </listitem>
|
---|
| 214 | </varlistentry>
|
---|
| 215 |
|
---|
| 216 | <varlistentry id="libpwquality-lib">
|
---|
| 217 | <term><filename class="libraryfile">libpwquality.so</filename></term>
|
---|
| 218 | <listitem>
|
---|
| 219 | <para>
|
---|
[4c24eb0a] | 220 | contains API functions for checking the password quality
|
---|
[183f254] | 221 | </para>
|
---|
| 222 | <indexterm zone="libpwquality libpwquality-lib">
|
---|
| 223 | <primary sortas="c-libpwquality">libpwquality.so</primary>
|
---|
| 224 | </indexterm>
|
---|
| 225 | </listitem>
|
---|
| 226 | </varlistentry>
|
---|
[f97d5f6] | 227 |
|
---|
[183f254] | 228 | <varlistentry id="pam_pwquality">
|
---|
| 229 | <term><filename class="libraryfile">pam_pwquality.so</filename></term>
|
---|
[f97d5f6] | 230 | <listitem>
|
---|
[183f254] | 231 | <para>
|
---|
| 232 | is a <application>Linux PAM</application> module used to perform
|
---|
[4c24eb0a] | 233 | password quality checking
|
---|
[183f254] | 234 | </para>
|
---|
| 235 | <indexterm zone="libpwquality pam_pwquality">
|
---|
| 236 | <primary sortas="c-pam_pwquality">pam_pwquality.so</primary>
|
---|
[f97d5f6] | 237 | </indexterm>
|
---|
| 238 | </listitem>
|
---|
| 239 | </varlistentry>
|
---|
| 240 |
|
---|
| 241 | </variablelist>
|
---|
[183f254] | 242 |
|
---|
[f97d5f6] | 243 | </sect2>
|
---|
| 244 |
|
---|
| 245 | </sect1>
|
---|