NAME

       cdbmake-wordlist - Create a cdb database from a wordlist

SYNOPSIS

       cdbmake-wordlist [-am] [-l min-length] [-L max-length]
           [-o output-wordlist] [-x exclude ...] wordlist

DESCRIPTION

       cdb 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 1 as a value.  The
       resulting database is suitable for fast existence lookups in the wordlist, such as for password
       dictionary checks.

       cdbmake-wordlist takes one argument, the input wordlist file.  The output cdb database will have the same
       name as wordlist but with ".cdb" appended.  The input wordlist file does not have to be sorted.

       cdbmake-wordlist can, instead of building a CDB file, filter a wordlist against the criteria given on the
       command line and generate a new wordlist.  See the -o option for more details.

OPTIONS

       -a, --ascii
           Filter all words that contain non-ASCII characters or control characters from the resulting cdb file,
           leaving only words that consist solely of ASCII non-control characters.

       -L maximum, --max-length=maximum
           Filter  all words of length greater than maximum from the resulting cdb database.  The length of each
           line (minus the separating newline) in the input wordlist will be checked against minimum 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.

           The default is to not filter out any words for maximum length.

       -l minimum, --min-length=minimum
           Filter all words of length less than minimum from the resulting cdb database.   The  length  of  each
           line (minus the separating newline) in the input wordlist will be checked against minimum 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.

           The default is not to filter out any words for minimum length.

       -m, --man, --manual
           Print out this documentation (which is done simply by feeding the script to "perldoc -t").

       -o wordlist, --output=wordlist
           Rather than creating a CDB database, apply the filter rules given by the other command-line arguments
           and generate a new wordlist in the file name given by the wordlist  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 CDB file anyway, thus reducing the size of the source required
           to regenerate the CDB database.

           If this option is given, no CDB database will be created.

       -x exclude, --exclude=exclude
           Filter all words matching the regular expression exclude  from  the  resulting  cdb  database.   This
           regular  expression  will  be  matched  against  each  line of the source wordlist after the trailing
           newline is removed.  This option may be given repeatedly to add multiple exclusion regexes.

AUTHOR

       Russ Allbery <eagle@eyrie.org>

COPYRIGHT AND LICENSE

       Copyright 2013 The Board of Trustees of the Leland Stanford Junior University

       Permission is hereby granted, free of charge, to any  person  obtaining  a  copy  of  this  software  and
       associated  documentation  files (the "Software"), to deal in the Software without restriction, including
       without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,  and/or  sell
       copies  of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
       following conditions:

       The above copyright notice and this permission notice shall be included  in  all  copies  or  substantial
       portions of the Software.

       THE  SOFTWARE  IS  PROVIDED  "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
       LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND  NONINFRINGEMENT.   IN
       NO  EVENT  SHALL  THE  AUTHORS  OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
       WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT  OF  OR  IN  CONNECTION  WITH  THE
       SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

SEE ALSO

       cdb(1)

       The cdb file format is defined at <http://cr.yp.to/cdb.html>.

       The    current    version    of    this    program    is    available    from    its    web    page    at
       <http://www.eyrie.org/~eagle/software/krb5-strength/> as part of the krb5-strength package.

2.2                                                2013-12-16                                CDBMAKE-WORDLIST(1)