X-Git-Url: https://git.eyrie.org/?a=blobdiff_plain;f=README;h=65b5e0aff8bae12e90d4197187941a02826af679;hb=00bf5d22c060b9d3d6a3c62a0633ad383343f3cd;hp=205eb48b390db45a380e41857a9bab66af02d932;hpb=936f5945da0a3228c4e7ba2a88c9560970bf013a;p=kerberos%2Fkrb5-strength.git diff --git a/README b/README index 205eb48..65b5e0a 100644 --- a/README +++ b/README @@ -1,12 +1,12 @@ - krb5-strength 3.1 + krb5-strength 3.3 (Kerberos password strength checking plugin) Maintained by Russ Allbery - Copyright 2016 Russ Allbery . Copyright 2006-2007, - 2009-2010, 2012-2014 The Board of Trustees of the Leland Stanford Junior - University. Copyright 1993 Alec Muffett. This software is distributed - under a BSD-style license. Please see the section LICENSE below for - more information. + Copyright 2016, 2020, 2023 Russ Allbery . Copyright + 2006-2007, 2009-2010, 2012-2014 The Board of Trustees of the Leland + Stanford Junior University. Copyright 1993 Alec Muffett. This software + is distributed under a BSD-style license. Please see the section + LICENSE below for more information. BLURB @@ -82,7 +82,7 @@ REQUIREMENTS For Heimdal, you may use either the external password quality check tool, installed as heimdal-strength, or the plugin as you choose. It has been tested with Heimdal 1.2.1 and later, but has not recently been - tested with versions prior to 1.5. + tested with versions prior to 7.0. For MIT Kerberos, version 1.9 or higher is required for the password quality plugin interface. MIT Kerberos does not support an external @@ -115,7 +115,7 @@ REQUIREMENTS 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. + are required. krb5-strength-wordlist requires Perl 5.010 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 @@ -126,44 +126,24 @@ REQUIREMENTS The password history program, heimdal-history, requires Perl 5.010 or later plus the following CPAN modules: - * DB_File::Lock + * Const::Fast * Crypt::PBKDF2 + * DB_File::Lock * Getopt::Long::Descriptive * IPC::Run - * JSON - * Readonly + * JSON::MaybeXS and their dependencies. - 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 also be used by the test suite if present: - - * Perl6::Slurp - * Test::MinimumVersion - * Test::Perl::Critic - * Test::Pod - * Test::Spelling - * Test::Strict - - All are available on CPAN. Some tests will be skipped if the modules - are not available. - - 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 DBI, DBD::SQLite, JSON, Perl6::Slurp, and Readonly modules - (from CPAN) to generate man pages and bootstrap the test suite data from - a Git checkout. + will need Autoconf 2.64 or later. Perl is also required to generate + manual pages from a fresh Git checkout. You will also need Perl 5.010 + or later and the Const::Fast, DBI, DBD::SQLite, JSON::MaybeXS, and + Perl6::Slurp modules (from CPAN) to bootstrap the test suite data from a + Git checkout. BUILDING AND INSTALLATION @@ -188,7 +168,9 @@ BUILDING AND INSTALLATION with the system version of CrackLib, pass --with-cracklib to configure. You can optionally add a directory, giving the root directory where CrackLib was installed, or separately set the include and library path - with --with-cracklib-include and --with-cracklib-lib. + with --with-cracklib-include and --with-cracklib-lib. You can also + build without any CrackLib support by passing --without-cracklib to + configure. krb5-strength will automatically build with TinyCDB if it is found. To specify the installation path of TinyCDB, use --with-tinycdb. You can @@ -233,7 +215,8 @@ BUILDING AND INSTALLATION Pass --enable-silent-rules to configure for a quieter build (similar to the Linux kernel). Use make warnings instead of make to build with full - GCC compiler warnings (requires a relatively current version of GCC). + compiler warnings (requires either GCC or Clang and may require a + relatively current version of the compiler). You can pass the --enable-reduced-depends flag to configure to try to minimize the shared library dependencies encoded in the binaries. This @@ -264,6 +247,27 @@ TESTING Do this instead of running the test program directly since it will ensure that necessary environment variables are set up. + 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 also be used by the test suite if present: + + * Perl6::Slurp + * Test::MinimumVersion + * Test::Perl::Critic + * Test::Pod + * Test::Spelling + * Test::Strict + + All are available on CPAN. Some tests will be skipped if the modules + are not available. + + 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. + SUPPORT The krb5-strength web page at: @@ -305,7 +309,7 @@ LICENSE The krb5-strength package as a whole is covered by the following copyright statement and license: - Copyright 2016 Russ Allbery + Copyright 2016, 2020, 2023 Russ Allbery Copyright 2006-2007, 2009-2010, 2012-2014 The Board of Trustees of the Leland Stanford Junior University Copyright 1993 Alec Muffett @@ -329,7 +333,7 @@ LICENSE TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - Developed by Derrick Brashear and Ken Hornstein of Sine Nomine + Developed by Daria Phoebe Brashear and Ken Hornstein of Sine Nomine Associates, on behalf of Stanford University. The embedded version of CrackLib (all files in the cracklib @@ -345,5 +349,10 @@ LICENSE notices. All required notices, and detailed information about the licensing of each file, are recorded in the LICENSE file. + Files covered by a license with an assigned SPDX License Identifier + include SPDX-License-Identifier tags to enable automated processing of + license information. See https://spdx.org/licenses/ for more + information. + For any copyright range specified by files in this package as YYYY-ZZZZ, the range specifies every single year in that closed interval.