[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[f97d5f6] | 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 |
|
---|
[4c0efc3c] | 35 | &lfs122_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>
|
---|
| 82 | </sect2>
|
---|
| 83 |
|
---|
| 84 | <sect2 role="installation">
|
---|
| 85 | <title>Installation of libpwquality</title>
|
---|
| 86 |
|
---|
| 87 | <para>
|
---|
| 88 | Install <application>libpwquality</application> by running the following
|
---|
| 89 | commands:
|
---|
| 90 | </para>
|
---|
| 91 |
|
---|
[e92e7dc] | 92 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 93 | --disable-static \
|
---|
| 94 | --with-securedir=/usr/lib/security \
|
---|
[b512e97] | 95 | --disable-python-bindings &&
|
---|
| 96 | make &&
|
---|
[4395529] | 97 | &build-wheel-cmd; $PWD/python</userinput></screen>
|
---|
[f97d5f6] | 98 |
|
---|
| 99 | <para>
|
---|
| 100 | This package does not come with a test suite.
|
---|
| 101 | </para>
|
---|
| 102 |
|
---|
| 103 | <para>
|
---|
| 104 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 105 | </para>
|
---|
[8558044] | 106 |
|
---|
[b512e97] | 107 | <screen role="root"><userinput>make install &&
|
---|
[1cdea83] | 108 | &install-wheel; pwquality</userinput></screen>
|
---|
[f97d5f6] | 109 |
|
---|
| 110 | </sect2>
|
---|
| 111 |
|
---|
[2c64887e] | 112 | <sect2 role="commands">
|
---|
| 113 | <title>Command Explanations</title>
|
---|
| 114 |
|
---|
| 115 | <para>
|
---|
[b512e97] | 116 | <parameter>--disable-python-bindings</parameter>: This parameter
|
---|
| 117 | disables building Python bindings with the deprecated
|
---|
| 118 | <command>python3 setup.py build</command> command. The explicit
|
---|
| 119 | instruction to build the Python 3 binding with the
|
---|
| 120 | <command>pip3 wheel</command> command is provided.
|
---|
[2c64887e] | 121 | </para>
|
---|
[7e11b83c] | 122 |
|
---|
[2c64887e] | 123 | </sect2>
|
---|
| 124 |
|
---|
[62066a54] | 125 | <sect2 role="configuration">
|
---|
[eecc046] | 126 | <title>Configuring libpwquality</title>
|
---|
[62066a54] | 127 |
|
---|
[7e11b83c] | 128 | <para>
|
---|
| 129 | <application>libpwquality</application> is intended to be a
|
---|
| 130 | functional replacement for the now-obsolete
|
---|
| 131 | <filename>pam_cracklib.so</filename> PAM module. To configure the system
|
---|
| 132 | to use the <filename>pam_pwquality</filename> module, execute the
|
---|
| 133 | following commands as the
|
---|
| 134 | <systemitem class="username">root</systemitem> user:
|
---|
| 135 | </para>
|
---|
[62066a54] | 136 |
|
---|
| 137 | <screen role="root"><userinput>mv /etc/pam.d/system-password{,.orig} &&
|
---|
| 138 | cat > /etc/pam.d/system-password << "EOF"
|
---|
| 139 | <literal># Begin /etc/pam.d/system-password
|
---|
| 140 |
|
---|
| 141 | # check new passwords for strength (man pam_pwquality)
|
---|
| 142 | password required pam_pwquality.so authtok_type=UNIX retry=1 difok=1 \
|
---|
| 143 | minlen=8 dcredit=0 ucredit=0 \
|
---|
| 144 | lcredit=0 ocredit=0 minclass=1 \
|
---|
| 145 | maxrepeat=0 maxsequence=0 \
|
---|
[cbb07ee4] | 146 | maxclassrepeat=0 gecoscheck=0 \
|
---|
[62066a54] | 147 | dictcheck=1 usercheck=1 \
|
---|
| 148 | enforcing=1 badwords="" \
|
---|
[e92e7dc] | 149 | dictpath=/usr/lib/cracklib/pw_dict
|
---|
[c0464a8] | 150 |
|
---|
| 151 | # use yescrypt hash for encryption, use shadow, and try to use any
|
---|
| 152 | # previously defined authentication token (chosen password) set by any
|
---|
| 153 | # prior module.
|
---|
| 154 | password required pam_unix.so yescrypt shadow try_first_pass
|
---|
[62066a54] | 155 |
|
---|
| 156 | # End /etc/pam.d/system-password</literal>
|
---|
| 157 | EOF
|
---|
| 158 | </userinput></screen>
|
---|
| 159 |
|
---|
| 160 | </sect2>
|
---|
[8558044] | 161 |
|
---|
[f97d5f6] | 162 | <sect2 role="content">
|
---|
| 163 | <title>Contents</title>
|
---|
| 164 |
|
---|
| 165 | <segmentedlist>
|
---|
| 166 | <segtitle>Installed Programs</segtitle>
|
---|
| 167 | <segtitle>Installed Libraries</segtitle>
|
---|
| 168 | <segtitle>Installed Directories</segtitle>
|
---|
| 169 |
|
---|
| 170 | <seglistitem>
|
---|
| 171 | <seg>
|
---|
| 172 | pwscore and pwmake
|
---|
| 173 | </seg>
|
---|
| 174 | <seg>
|
---|
| 175 | pam_pwquality.so and libpwquality.so
|
---|
| 176 | </seg>
|
---|
| 177 | <seg>
|
---|
[b512e97] | 178 | /usr/lib/python3.11/site-packages/pwquality-&libpwquality-version;.dist-info
|
---|
[651c7ebf] | 179 | <!-- /etc/security was installed by Linux-PAM -->
|
---|
[f97d5f6] | 180 | </seg>
|
---|
| 181 | </seglistitem>
|
---|
| 182 | </segmentedlist>
|
---|
[183f254] | 183 |
|
---|
[f97d5f6] | 184 | <variablelist>
|
---|
| 185 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 186 | <?dbfo list-presentation="list"?>
|
---|
| 187 | <?dbhtml list-presentation="table"?>
|
---|
| 188 |
|
---|
[183f254] | 189 | <varlistentry id="pwmake">
|
---|
| 190 | <term><command>pwmake</command></term>
|
---|
| 191 | <listitem>
|
---|
| 192 | <para>
|
---|
| 193 | is a simple configurable tool for generating random
|
---|
[4c24eb0a] | 194 | and relatively easily pronounceable passwords
|
---|
[183f254] | 195 | </para>
|
---|
| 196 | <indexterm zone="libpwquality pwmake">
|
---|
| 197 | <primary sortas="b-pwmake">pwmake</primary>
|
---|
| 198 | </indexterm>
|
---|
| 199 | </listitem>
|
---|
| 200 | </varlistentry>
|
---|
| 201 |
|
---|
| 202 | <varlistentry id="pwscore">
|
---|
| 203 | <term><command>pwscore</command></term>
|
---|
| 204 | <listitem>
|
---|
| 205 | <para>
|
---|
[4c24eb0a] | 206 | is a simple tool for checking quality of a password
|
---|
[183f254] | 207 | </para>
|
---|
| 208 | <indexterm zone="libpwquality pwscore">
|
---|
| 209 | <primary sortas="b-pwscore">pwscore</primary>
|
---|
| 210 | </indexterm>
|
---|
| 211 | </listitem>
|
---|
| 212 | </varlistentry>
|
---|
| 213 |
|
---|
| 214 | <varlistentry id="libpwquality-lib">
|
---|
| 215 | <term><filename class="libraryfile">libpwquality.so</filename></term>
|
---|
| 216 | <listitem>
|
---|
| 217 | <para>
|
---|
[4c24eb0a] | 218 | contains API functions for checking the password quality
|
---|
[183f254] | 219 | </para>
|
---|
| 220 | <indexterm zone="libpwquality libpwquality-lib">
|
---|
| 221 | <primary sortas="c-libpwquality">libpwquality.so</primary>
|
---|
| 222 | </indexterm>
|
---|
| 223 | </listitem>
|
---|
| 224 | </varlistentry>
|
---|
[f97d5f6] | 225 |
|
---|
[183f254] | 226 | <varlistentry id="pam_pwquality">
|
---|
| 227 | <term><filename class="libraryfile">pam_pwquality.so</filename></term>
|
---|
[f97d5f6] | 228 | <listitem>
|
---|
[183f254] | 229 | <para>
|
---|
| 230 | is a <application>Linux PAM</application> module used to perform
|
---|
[4c24eb0a] | 231 | password quality checking
|
---|
[183f254] | 232 | </para>
|
---|
| 233 | <indexterm zone="libpwquality pam_pwquality">
|
---|
| 234 | <primary sortas="c-pam_pwquality">pam_pwquality.so</primary>
|
---|
[f97d5f6] | 235 | </indexterm>
|
---|
| 236 | </listitem>
|
---|
| 237 | </varlistentry>
|
---|
| 238 |
|
---|
| 239 | </variablelist>
|
---|
[183f254] | 240 |
|
---|
[f97d5f6] | 241 | </sect2>
|
---|
| 242 |
|
---|
| 243 | </sect1>
|
---|