tools/cdbmake-wordlist.1

   1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is turned on, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{
  60 .    if \nF \{
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "CDBMAKE-WORDLIST 1"
 136 .TH CDBMAKE-WORDLIST 1 "2013-10-10" "2.1" "krb5-strength"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 cdbmake\-wordlist \- Create a cdb database from a wordlist
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBcdbmake-wordlist\fR [\fB\-am\fR] [\fB\-l\fR \fIlength\fR] \fIwordlist\fR
 146 .SH "DESCRIPTION"
 147 .IX Header "DESCRIPTION"
 148 cdb is a format invented by Dan Bernstein for fast, constant databases.
 149 The database is fixed during creation and cannot be changed without
 150 rebuilding it, and is optimized for very fast access.  This program takes
 151 as input a wordlist file (a set of words, possibly including whitespace,
 152 separated by newlines) and turns it into a cdb file with the words as keys
 153 and the constant \f(CW1\fR as a value.  The resulting database is suitable for
 154 fast existence lookups in the wordlist, such as for password dictionary
 155 checks.
 156 .PP
 157 \&\fBcdbmake-wordlist\fR takes one argument, the input wordlist file.  The
 158 output cdb database will have the same name as \fIwordlist\fR but with
 159 \&\f(CW\*(C`.cdb\*(C'\fR appended.  The input wordlist file does not have to be sorted.
 160 .SH "OPTIONS"
 161 .IX Header "OPTIONS"
 162 .IP "\fB\-a\fR, \fB\-\-ascii\fR" 4
 163 .IX Item "-a, --ascii"
 164 Filter all words that contain non-ASCII characters or control characters
 165 from the resulting cdb file, leaving only words that consist solely of
 166 \&\s-1ASCII\s0 non-control characters.
 167 .IP "\fB\-l\fR \fIminimum\fR, \fB\-\-min\-length\fR=\fIminimum\fR" 4
 168 .IX Item "-l minimum, --min-length=minimum"
 169 Filter all words of length less than \fIminimum\fR from the resulting cdb
 170 database.  The length of each line (minus the separating newline) in the
 171 input wordlist will be checked against \fIminimum\fR and will be filtered out
 172 of the resulting database if it is shorter.  Useful for generating password
 173 dictionaries where shorter passwords will be rejected by a generic length
 174 check and no dictionary lookup will be done for a transform of the password
 175 shorter than the specified minimum.
 176 .Sp
 177 The default is not to filter out any words for minimum length.
 178 .IP "\fB\-m\fR, \fB\-\-man\fR, \fB\-\-manual\fR" 4
 179 .IX Item "-m, --man, --manual"
 180 Print out this documentation (which is done simply by feeding the script to
 181 \&\f(CW\*(C`perldoc \-t\*(C'\fR).
 182 .SH "AUTHOR"
 183 .IX Header "AUTHOR"
 184 Russ Allbery <rra@stanford.edu>
 185 .SH "COPYRIGHT AND LICENSE"
 186 .IX Header "COPYRIGHT AND LICENSE"
 187 Copyright 2013 The Board of Trustees of the Leland Stanford Junior
 188 University
 189 .PP
 190 Permission is hereby granted, free of charge, to any person obtaining a
 191 copy of this software and associated documentation files (the \*(L"Software\*(R"),
 192 to deal in the Software without restriction, including without limitation
 193 the rights to use, copy, modify, merge, publish, distribute, sublicense,
 194 and/or sell copies of the Software, and to permit persons to whom the
 195 Software is furnished to do so, subject to the following conditions:
 196 .PP
 197 The above copyright notice and this permission notice shall be included in
 198 all copies or substantial portions of the Software.
 199 .PP
 200 \&\s-1THE SOFTWARE IS PROVIDED \*(L"AS IS\*(R", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 201 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 202 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 203 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 204 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 205 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 206 DEALINGS IN THE SOFTWARE.\s0
 207 .SH "SEE ALSO"
 208 .IX Header "SEE ALSO"
 209 \&\fIcdb\fR\|(1)
 210 .PP
 211 The cdb file format is defined at <http://cr.yp.to/cdb.html>.
 212 .PP
 213 The current version of this program is available from its web page at
 214 <http://www.eyrie.org/~eagle/software/krb5\-strength/> as part of the
 215 krb5\-strength package.