source: postlfs/security/libpwquality.xml@ 183f254

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY libpwquality-download-http "https://fedorahosted.org/releases/l/i/libpwquality/libpwquality-&libpwquality-version;.tar.bz2">
  <!ENTITY libpwquality-download-ftp  " ">
  <!ENTITY libpwquality-md5sum        "2a3d4ba1d11b52b4f6a7f39622ebf736">
  <!ENTITY libpwquality-size          "416 KB">
  <!ENTITY libpwquality-buildsize     "4.1 MB">
  <!ENTITY libpwquality-time          "less than 0.1 SBU">
]>

<sect1 id="libpwquality" xreflabel="libpwquality-&libpwquality-version;">
  <?dbhtml filename="libpwquality.html"?>

  <sect1info>
    <othername>$LastChangedBy: fernando $</othername>
    <date>$Date: 2015-09-25 08:48:24 -0500 (Fri, 25 Sep 2015) $</date>
  </sect1info>

  <title>libpwquality-&libpwquality-version;</title>

  <indexterm zone="libpwquality">
    <primary sortas="a-libpwquality">libpwquality</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libpwquality</title>

    <para>
      The <application>libpwquality</application> package provides common
      functions for password quality checking and also scoring them based on
      their apparent randomness. The library also provides a function for
      generating random passwords with good pronounceability. 
    </para>

    &lfs78_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&libpwquality-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&libpwquality-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &libpwquality-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &libpwquality-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &libpwquality-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &libpwquality-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">libpwquality Dependencies</bridgehead>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="linux-pam"/> and
      <xref linkend="cracklib"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/libpwquality"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of libpwquality</title>

    <para>
      Install <application>libpwquality</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          pwscore and pwmake
        </seg>
        <seg>
          pam_pwquality.so and libpwquality.so
        </seg>
        <seg>
          /etc/security
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="pwmake">
        <term><command>pwmake</command></term>
        <listitem>
          <para>
            is a simple configurable tool for generating random
            and relatively easily pronounceable passwords.
          </para>
          <indexterm zone="libpwquality pwmake">
            <primary sortas="b-pwmake">pwmake</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pwscore">
        <term><command>pwscore</command></term>
        <listitem>
          <para>
            is a simple tool for checking quality of a password.
          </para>
          <indexterm zone="libpwquality pwscore">
            <primary sortas="b-pwscore">pwscore</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpwquality-lib">
        <term><filename class="libraryfile">libpwquality.so</filename></term>
        <listitem>
          <para>
            contains API functions for checking the password quality.
          </para>
          <indexterm zone="libpwquality libpwquality-lib">
            <primary sortas="c-libpwquality">libpwquality.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pam_pwquality">
        <term><filename class="libraryfile">pam_pwquality.so</filename></term>
        <listitem>
          <para>
            is a <application>Linux PAM</application> module used to perform
            password quality checking.
          </para>
          <indexterm zone="libpwquality pam_pwquality">
            <primary sortas="c-pam_pwquality">pam_pwquality.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>