docs/metadata/requirements

   1 For Heimdal, you may use either the external password quality check tool,
   2 installed as heimdal-strength, or the plugin as you choose.  It has been
   3 tested with Heimdal 1.2.1 and later, but has not recently been tested with
   4 versions prior to 7.0.
   5
   6 For MIT Kerberos, version 1.9 or higher is required for the password
   7 quality plugin interface.  MIT Kerberos does not support an external
   8 password quality check tool directly, so you will need to install the
   9 plugin.
  10
  11 You can optionally build against the system CrackLib library.  Any version
  12 should be supported, but note that some versions, particularly older
  13 versions close to the original code, do things like printing diagnostics
  14 to stderr, calling exit, and otherwise not being well-behaved for use
  15 inside plugins or libraries.  They also have known security
  16 vulnerabilities.  If using a system CrackLib library, use version 2.8.22
  17 or later to avoid these problems.
  18
  19 You can also optionally build against the TinyCDB library, which provides
  20 support for simpler and faster password checking against a CDB dictionary
  21 file, and the SQLite library (a version new enough to support the
  22 `sqlite3_open_v2` API; 3.7 should be more than sufficient), which provides
  23 support for checking whether passwords are within edit distance one of a
  24 dictionary word.
  25
  26 For this module to be effective for either Heimdal or MIT Kerberos, you
  27 will also need to construct a dictionary.  The `mkdict` and `packer`
  28 utilities to build a CrackLib dictionary from a word list are included in
  29 this toolkit but not installed by default.  You can run them out of the
  30 `cracklib` directory after building.  You can also use the utilities that
  31 come with the stock CrackLib package (often already packaged in a Linux
  32 distribution); the database format is compatible.
  33
  34 For building a CDB or SQLite dictionary, use the provided
  35 `krb5-strength-wordlist` program.  For CDB dictionries, the `cdb` utility
  36 must be on your `PATH`.  For SQLite, the DBI and DBD::SQLite Perl modules
  37 are required.  `krb5-strength-wordlist` requires Perl 5.010 or later.
  38
  39 For a word list to use as source for the dictionary, you can use
  40 `/usr/share/dict/words` if it's available on your system, but it would be
  41 better to find a more comprehensive word list.  Since word lists are
  42 bulky, often covered by murky copyrights, and easily locatable on the
  43 Internet with a modicum of searching, none are included in this toolkit.
  44
  45 The password history program, heimdal-history, requires Perl 5.010 or
  46 later plus the following CPAN modules:
  47
  48 * DB_File::Lock
  49 * Crypt::PBKDF2
  50 * Getopt::Long::Descriptive
  51 * IPC::Run
  52 * JSON
  53 * Readonly
  54
  55 and their dependencies.