.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
-.IX Title "CDBMAKE-WORDLIST 1"
-.TH CDBMAKE-WORDLIST 1 "2013-12-16" "2.2" "krb5-strength"
+.IX Title "KRB5-STRENGTH-WORDLIST 1"
+.TH KRB5-STRENGTH-WORDLIST 1 "2014-03-25" "3.0" "krb5-strength"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
-cdbmake\-wordlist \- Create a cdb database from a wordlist
+krb5\-strength\-wordlist \- Create a krb5\-strength database from a word list
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
-\&\fBcdbmake-wordlist\fR [\fB\-am\fR] [\fB\-l\fR \fImin-length\fR] [\fB\-L\fR \fImax-length\fR]
- [\fB\-o\fR \fIoutput-wordlist\fR] [\fB\-x\fR \fIexclude\fR ...] \fIwordlist\fR
+\&\fBkrb5\-strength\-wordlist\fR [\fB\-am\fR] [\fB\-c\fR \fIoutput-cdb\fR] [\fB\-l\fR \fImin-length\fR]
+ [\fB\-L\fR \fImax-length\fR] [\fB\-o\fR \fIoutput-wordlist\fR] [\fB\-s\fR \fIoutput-sqlite\fR]
+ [\fB\-x\fR \fIexclude\fR ...] \fIwordlist\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
-cdb is a format invented by Dan Bernstein for fast, constant databases.
+\&\fBkrb5\-strength\-wordlist\fR converts a word list (a file containing one word
+per line) into a database that can be used by the krb5\-strength plugin or
+\&\fBheimdal-strength\fR command for checking passwords. Two database formats
+are supported, with different features. \s-1CDB\s0 is more space-efficient and
+possibly faster, but supports checking passwords only against exact
+matches or simple transformations (removing small numbers of leading and
+trailing characters). SQLite creates a much larger database, but supports
+rejecting any password within edit distance one of a word in the word
+list.
+.PP
+\&\s-1CDB\s0 is a format invented by Dan Bernstein for fast, constant databases.
The database is fixed during creation and cannot be changed without
-rebuilding it, and is optimized for very fast access. This program takes
-as input a wordlist file (a set of words, possibly including whitespace,
-separated by newlines) and turns it into a cdb file with the words as keys
-and the constant \f(CW1\fR as a value. The resulting database is suitable for
-fast existence lookups in the wordlist, such as for password dictionary
-checks.
+rebuilding it, and is optimized for very fast access. For cdb, the
+database generated by this program will have keys for each word in the
+word list and the constant \f(CW1\fR as the value.
.PP
-\&\fBcdbmake-wordlist\fR takes one argument, the input wordlist file. The
-output cdb database will have the same name as \fIwordlist\fR but with
-\&\f(CW\*(C`.cdb\*(C'\fR appended. The input wordlist file does not have to be sorted.
+SQLite stores the word list in a single table containing both each word
+and each word reversed. This allows the krb5\-strength plugin or
+\&\fBheimdal-strength\fR command to reject passwords within edit distance one
+of any word in the word list. (Edit distance one means that the word list
+entry can be formed by changing a single character of the password, either
+by adding one character, removing one character, or changing one character
+to a different character.) However, the SQLite database will be much
+larger and lookups may be somewhat slower.
.PP
-\&\fBcdbmake-wordlist\fR can, instead of building a \s-1CDB\s0 file, filter a wordlist
-against the criteria given on the command line and generate a new
-wordlist. See the \fB\-o\fR option for more details.
+\&\fBkrb5\-strength\-wordlist\fR takes one argument, the input word list file.
+Use the \fB\-c\fR option to specify an output \s-1CDB\s0 file, \fB\-s\fR to specify an
+output SQLite file, or \fB\-o\fR to just filter the word list against the
+criteria given on the command line and generate a new word list.
+The input word list file does not have to be sorted. See the individual
+option descriptions for more information.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-a\fR, \fB\-\-ascii\fR" 4
Filter all words that contain non-ASCII characters or control characters
from the resulting cdb file, leaving only words that consist solely of
\&\s-1ASCII\s0 non-control characters.
+.IP "\fB\-c\fR \fIoutput-cdb\fR, \fB\-\-cdb\fR=\fIoutput-cdb\fR" 4
+.IX Item "-c output-cdb, --cdb=output-cdb"
+Create a \s-1CDB\s0 database in \fIoutput-cdb\fR. A temporary file named after
+\&\fIoutput-cdb\fR with \f(CW\*(C`.data\*(C'\fR appended will be created in the same directory
+and used to stage the database contents. The actual \s-1CDB\s0 file will be
+built using the \fBcdb\fR command, which must be on the user's path. If
+either file already exists, \fBkrb5\-strength\-wordlist\fR will abort with an
+error.
+.Sp
+This option cannot be used with \fB\-o\fR or \fB\-s\fR.
.IP "\fB\-L\fR \fImaximum\fR, \fB\-\-max\-length\fR=\fImaximum\fR" 4
.IX Item "-L maximum, --max-length=maximum"
Filter all words of length greater than \fImaximum\fR from the resulting cdb
database. The length of each line (minus the separating newline) in the
-input wordlist will be checked against \fIminimum\fR and will be filtered out
-of the resulting database if it is shorter. Useful for generating
+input word list will be checked against \fIminimum\fR and will be filtered
+out of the resulting database if it is shorter. Useful for generating
password dictionaries from word lists that contain random noise that's
highly unlikely to be used as a password.
.Sp
.IX Item "-l minimum, --min-length=minimum"
Filter all words of length less than \fIminimum\fR from the resulting cdb
database. The length of each line (minus the separating newline) in the
-input wordlist will be checked against \fIminimum\fR and will be filtered out
-of the resulting database if it is shorter. Useful for generating password
-dictionaries where shorter passwords will be rejected by a generic length
-check and no dictionary lookup will be done for a transform of the password
-shorter than the specified minimum.
+input word list will be checked against \fIminimum\fR and will be filtered
+out of the resulting database if it is shorter. Useful for generating
+password dictionaries where shorter passwords will be rejected by a
+generic length check and no dictionary lookup will be done for a transform
+of the password shorter than the specified minimum.
.Sp
The default is not to filter out any words for minimum length.
.IP "\fB\-m\fR, \fB\-\-man\fR, \fB\-\-manual\fR" 4
\&\f(CW\*(C`perldoc \-t\*(C'\fR).
.IP "\fB\-o\fR \fIwordlist\fR, \fB\-\-output\fR=\fIwordlist\fR" 4
.IX Item "-o wordlist, --output=wordlist"
-Rather than creating a \s-1CDB\s0 database, apply the filter rules given by the
-other command-line arguments and generate a new wordlist in the file name
-given by the \fIwordlist\fR option. This can be used to reduce the size of
-a raw wordlist file (such as one taken from Internet sources) by removing
-the words that will be filtered out of the \s-1CDB\s0 file anyway, thus reducing
-the size of the source required to regenerate the \s-1CDB\s0 database.
+Rather than creating a database, apply the filter rules given by the other
+command-line arguments and generate a new word list in the file name given
+by the \fIwordlist\fR option. This can be used to reduce the size of a raw
+word list file (such as one taken from Internet sources) by removing the
+words that will be filtered out of the dictionary anyway, thus reducing
+the size of the source required to regenerate the dictionary.
+.Sp
+This option cannot be used with \fB\-c\fR or \fB\-s\fR.
+.IP "\fB\-s\fR \fIoutput-sqlite\fR, \fB\-\-sqlite\fR=\fIoutput-sqlite\fR" 4
+.IX Item "-s output-sqlite, --sqlite=output-sqlite"
+Create a SQLite database in \fIoutput-sqlite\fR. If this file already
+exists, \fBkrb5\-strength\-wordlist\fR will abort with an error. The resulting
+SQLite database will have one table, \f(CW\*(C`passwords\*(C'\fR, with two columns,
+\&\f(CW\*(C`password\*(C'\fR and \f(CW\*(C`drowssap\*(C'\fR. The first holds a word from the word list,
+and the second holds the same word reversed.
+.Sp
+Using this option requires the \s-1DBI\s0 and DBD::SQLite Perl modules be
+installed.
.Sp
-If this option is given, no \s-1CDB\s0 database will be created.
+This option cannot be used with \fB\-c\fR or \fB\-o\fR.
.IP "\fB\-x\fR \fIexclude\fR, \fB\-\-exclude\fR=\fIexclude\fR" 4
.IX Item "-x exclude, --exclude=exclude"
Filter all words matching the regular expression \fIexclude\fR from the
resulting cdb database. This regular expression will be matched against
-each line of the source wordlist after the trailing newline is removed.
+each line of the source word list after the trailing newline is removed.
This option may be given repeatedly to add multiple exclusion regexes.
.SH "AUTHOR"
.IX Header "AUTHOR"
Russ Allbery <eagle@eyrie.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
-Copyright 2013 The Board of Trustees of the Leland Stanford Junior
+Copyright 2013, 2014 The Board of Trustees of the Leland Stanford Junior
University
.PP
Permission is hereby granted, free of charge, to any person obtaining a
DEALINGS IN THE SOFTWARE.\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
-\&\fIcdb\fR\|(1)
+\&\fIcdb\fR\|(1), \s-1DBI\s0, DBD::SQLite
.PP
The cdb file format is defined at <http://cr.yp.to/cdb.html>.
.PP
projects / kerberos / krb5-strength.git / blobdiff