]> eyrie.org Git - kerberos/krb5-strength.git/blobdiff - README
Add pkg-config build dependency
[kerberos/krb5-strength.git] / README
diff --git a/README b/README
index dbe519ecb7f11693a8284cf188ed470b9615f66e..8d88ed46d3d63a3a54a9416adaafada9ef66def5 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,10 @@
-                            krb5-strength 2.2
+                            krb5-strength 3.0
                (Kerberos password strength checking plugin)
 
                Maintained by Russ Allbery <eagle@eyrie.org>
 
-  Copyright 2006, 2007, 2009, 2010, 2012, 2013 The Board of Trustees of
-  the Leland Stanford Junior University.  Portions copyright 1993 Alec
+  Copyright 2006, 2007, 2009, 2010, 2012, 2013, 2014 The Board of Trustees
+  of the Leland Stanford Junior University.  Portions copyright 1993 Alec
   Muffett.  Developed by Derrick Brashear and Ken Hornstein of Sine Nomine
   Associates, on behalf of Stanford University.  This software is
   distributed under a BSD-style license and under the Artistic License.
@@ -14,13 +14,13 @@ BLURB
 
   krb5-strength provides a password quality plugin for the MIT Kerberos
   KDC (specifically the kadmind server), an external password quality
-  program for use with Heimdal, and a password history implementation for
-  use with Heimdal.  Passwords can be tested with CrackLib, checked
-  against a CDB database of known weak passwords, checked for length,
-  checked for non-printable or non-ASCII characters that may be difficult
-  to enter reproducibly, required to contain particular character classes,
-  or any combination of these tests.  It supports both Heimdal and MIT
-  Kerberos (1.9 or later).
+  program for use with Heimdal, and a per-principal password history
+  implementation for Heimdal.  Passwords can be tested with CrackLib,
+  checked against a CDB or SQLite database of known weak passwords with
+  some transformations, checked for length, checked for non-printable or
+  non-ASCII characters that may be difficult to enter reproducibly,
+  required to contain particular character classes, or any combination of
+  these tests.  It supports both Heimdal and MIT Kerberos (1.9 or later).
 
 DESCRIPTION
 
@@ -38,8 +38,9 @@ DESCRIPTION
   that only passes passwords that resist attacks from both Crack and Jack
   the Ripper using the same rule sets.  It also supports doing simpler
   dictionary checks against a CDB database, which is fast with very large
-  dictionaries, and imposing other programmatic checks on passwords such
-  as character class requirements.
+  dictionaries, or a SQLite database, which can reject all passwords
+  within edit distance one of a dictionary word.  It can also impose other
+  programmatic checks on passwords such as character class requirements.
 
   For Heimdal, it includes both a program usable as an external password
   quality check and a plugin that implements the dynamic module API.  For
@@ -95,7 +96,10 @@ REQUIREMENTS
 
   You can also optionally build against the TinyCDB library, which
   provides support for simpler and faster password checking against a CDB
-  dictionary file.
+  dictionary file, and the SQLite library (a version new enough to support
+  the sqlite3_open_v2 API; 3.7 should be more than sufficient), which
+  provides support for checking whether passwords are within edit distance
+  one of a dictionary word.
 
   For this module to be effective for either Heimdal or MIT Kerberos, you
   will also need to construct a dictionary.  The mkdict and packer
@@ -105,9 +109,10 @@ REQUIREMENTS
   that come with the stock CrackLib package (often already packaged in a
   Linux distribution); the database format is compatible.
 
-  For building a CDB dictionary, use the provided cdbmake-wordlist
-  program.  The CDB utility must be on your PATH.  cdbmake-wordlist
-  requires Perl 5.006 or later.
+  For building a CDB or SQLite dictionary, use the provided
+  krb5-strength-wordlist program.  For CDB dictionries, the cdb utility
+  must be on your PATH.  For SQLite, the DBI and DBD::SQLite Perl modules
+  are required.  krb5-strength-wordlist requires Perl 5.006 or later.
 
   For a word list to use as source for the dictionary, you can use
   /usr/share/dict/words if it's available on your system, but it would be
@@ -129,7 +134,7 @@ REQUIREMENTS
 
   To run the test suite, you will need Perl 5.010 or later and the
   dependencies of the heimdal-history program.  The following additional
-  Perl modules will be used by the test suite if present:
+  Perl modules will also be used by the test suite if present:
 
       Perl6::Slurp
       Test::MinimumVersion
@@ -138,20 +143,23 @@ REQUIREMENTS
       Test::Spelling
       Test::Strict
 
-  All are available on CPAN.  Those tests will be skipped if the modules
+  All are available on CPAN.  Some tests will be skipped if the modules
   are not available.
 
-  To enable tests that may be sensitive to the local environment or that
-  produce a lot of false positives without uncovering many problems, set
-  RRA_MAINTAINER_TESTS to a true value.
+  To enable tests that don't detect functionality problems but are used to
+  sanity-check the release, set the environment variable RELEASE_TESTING
+  to a true value.  To enable tests that may be sensitive to the local
+  environment or that produce a lot of false positives without uncovering
+  many problems, set the environment variable AUTHOR_TESTING to a true
+  value.
 
   To bootstrap from a Git checkout, or If you change the Automake files
   and need to regenerate Makefile.in, you will need Automake 1.11 or
   later.  For bootstrap or if you change configure.ac or any of the m4
   files it includes and need to regenerate configure or config.h.in, you
   will need Autoconf 2.64 or later.  You will also need Perl 5.010 or
-  later and the JSON, Perl6::Slurp, and Readonly modules (from CPAN) to
-  bootstrap the test suite data from a Git checkout.
+  later and the DBI, DBD::SQLite, JSON, Perl6::Slurp, and Readonly modules
+  (from CPAN) to bootstrap the test suite data from a Git checkout.
 
 COMPILING AND INSTALLING
 
@@ -181,6 +189,11 @@ COMPILING AND INSTALLING
   also separately set the include and library path with
   --with-tinycdb-include and --with-tinycdb-lib.
 
+  Similarly, krb5-strength will automatically build with SQLite if it is
+  found.  To specify the installation path of SQLite, use --with-sqlite.
+  You can also separately set the include and library path with
+  --with-sqlite-include and --with-sqlite-lib.
+
   Normally, configure will use krb5-config to determine the flags to use
   to compile with your Kerberos libraries.  If krb5-config isn't found, it
   will look for the standard Kerberos libraries in locations already
@@ -226,12 +239,13 @@ COMPILING AND INSTALLING
 CONFIGURATION
 
   First, build and install either a CrackLib dictionary as described in
-  REQUIREMENTS above, or build a CDB dictionary with cdbmake-wordlist.
-  (Or both.)  The CrackLib dictionary will consist of three files, one
-  each ending in *.hwm, *.pwd, and *.pwi.  The CDB dictionary will consist
-  of a single file ending in *.cdb.  Install those files somewhere on your
-  system.  Then, follow the relevant instructions below for either Heimdal
-  or MIT Kerberos.
+  REQUIREMENTS above, or build a CDB or SQLite dictionary with
+  krb5-strength-wordlist.  (Or any combination thereof.)  The CrackLib
+  dictionary will consist of three files, one each ending in *.hwm, *.pwd,
+  and *.pwi.  The CDB and SQLite dictionaries will be single files,
+  conventionally ending in *.cdb and *.sqlite respectively.  Install those
+  files somewhere on your system.  Then, follow the relevant instructions
+  below for either Heimdal or MIT Kerberos.
 
   See "Other Settings" below for additional krb5.conf setting supported by
   both Heimdal and MIT Kerberos.
@@ -510,7 +524,7 @@ LICENSE
   The krb5-strength package as a whole is covered by the following
   copyright statement and license:
 
-    Copyright 2006, 2007, 2009, 2010, 2012, 2013
+    Copyright 2006, 2007, 2009, 2010, 2012, 2013, 2014
         The Board of Trustees of the Leland Stanford Junior University
 
     Permission is hereby granted, free of charge, to any person obtaining