tools/heimdal-strength.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 "HEIMDAL-STRENGTH 1"
 136 .TH HEIMDAL-STRENGTH 1 "2014-03-25" "3.0" "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 heimdal\-strength \- Heimdal password quality check embedding CrackLib
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 \&\fBheimdal-strength\fR [\fIprincipal\fR]
 146 .SH "DESCRIPTION"
 147 .IX Header "DESCRIPTION"
 148 \&\fBheimdal-strength\fR is an external password quality check program for
 149 Heimdal that verifies the strength of a password.  Passwords can be tested
 150 with CrackLib, checked against a \s-1CDB\s0 database of known weak passwords,
 151 checked for length, checked for non-printable or non-ASCII characters that
 152 may be difficult to enter reproducibly, required to contain particular
 153 character classes, or any combination of these tests.  It is normally run
 154 via \fIkpasswdd\fR\|(8) using the Heimdal password quality check interface rather
 155 than directly.
 156 .PP
 157 To use this program, it must be configured in \fIkrb5.conf\fR via settings
 158 in \f(CW\*(C`[appdefaults]\*(C'\fR for the application name \f(CW\*(C`krb5\-strength\*(C'\fR.  A typical
 159 setting would be:
 160 .PP
 161 .Vb 3
 162 \&    krb5\-strength = {
 163 \&        password_dictionary = /usr/local/lib/kadmind/dictionary
 164 \&    }
 165 .Ve
 166 .PP
 167 which says to check passwords with CrackLib using the given path as the
 168 base path of the CrackLib dictionary.  See \*(L"\s-1CONFIGURATION\*(R"\s0 below for
 169 details on the supported configuration options.
 170 .PP
 171 \&\fBheimdal-strength\fR then expects the Heimdal password quality check
 172 information on standard input, specifically:
 173 .PP
 174 .Vb 3
 175 \&    principal: <principal>
 176 \&    new\-password: <password>
 177 \&    end
 178 .Ve
 179 .PP
 180 where <principal> is the principal whose password would be changed and
 181 <password> is the new password.  If the password appears to be strong, it
 182 prints \f(CW\*(C`APPROVED\*(C'\fR on standard output and exits with a status of 0.  If
 183 the password is rejected as being too weak, it will print the reason for
 184 rejecting the password on standard error and exit with a status of 0.  If
 185 some fatal error occurs, it will print that error to standard error and
 186 exit with a non-zero status.
 187 .SH "CONFIGURATION"
 188 .IX Header "CONFIGURATION"
 189 The following \fIkrb5.conf\fR configuration options are supported:
 190 .IP "minimum_different" 4
 191 .IX Item "minimum_different"
 192 If set to a numeric value, passwords with fewer than this number of unique
 193 characters will be rejected.  This can be used to reject, for example,
 194 passwords that are long strings of the same character or repetitions of
 195 small numbers of characters, which may be too easy to guess.
 196 .IP "minimum_length" 4
 197 .IX Item "minimum_length"
 198 If set to a numeric value, passwords with fewer than that number of
 199 characters will be rejected, independent of any length restrictions in
 200 CrackLib.  Note that this setting does not bypass the minimum length
 201 requirements in CrackLib itself.
 202 .IP "password_dictionary" 4
 203 .IX Item "password_dictionary"
 204 Specifies the base path to a CrackLib dictionary and enables password
 205 strength testing using CrackLib.  The provided path should be the full
 206 path to the dictionary files, omitting the trailing \fI*.hwm\fR, \fI*.pwd\fR,
 207 and \fI*.pwi\fR extensions for the CrackLib dictionary.
 208 .IP "password_dictionary_cdb" 4
 209 .IX Item "password_dictionary_cdb"
 210 Specifies the base path to a \s-1CDB\s0 dictionary and enables \s-1CDB\s0 password
 211 dictionary lookups.  The path must point to a CDB-format database whose
 212 keys are the known passwords or dictionary words.  The values are ignored.
 213 You can use the \fBkrb5\-strength\-wordlist\fR utility to generate the \s-1CDB\s0
 214 database from a word list.
 215 .Sp
 216 The \s-1CDB\s0 dictionary lookups do not do the complex password mangling that
 217 CrackLib does.  Instead, the password itself will be checked against the
 218 dictionary, and then variations of the password formed by removing the
 219 first character, the last character, the first and last characters, the
 220 first two characters, and the last two characters.  If any of these
 221 strings are found in the \s-1CDB\s0 database, the password will be rejected;
 222 otherwise, it will be accepted, at least by this check.
 223 .Sp
 224 A CrackLib dictionary, a \s-1CDB\s0 dictionary, and a SQLite dictionary may all
 225 be configured at the same time or in any combination, in which case
 226 CrackLib will be run first, followed by \s-1CDB\s0 and then SQLite as
 227 appropriate.
 228 .IP "password_dictionary_sqlite" 4
 229 .IX Item "password_dictionary_sqlite"
 230 Specifies the base path to a SQLite dictionary and enables SQLite password
 231 dictionary lookups.  The path must point to a SQLite 3 database with a
 232 table named \f(CW\*(C`passwords\*(C'\fR.  This table should have two columns, \f(CW\*(C`password\*(C'\fR
 233 and \f(CW\*(C`drowssap\*(C'\fR, which, for each dictionary word, holds the word and the
 234 reversed form of the word.  You can use the \fBkrb5\-strength\-wordlist\fR
 235 utility to generate the SQLite database from a word list.
 236 .Sp
 237 The SQLite dictionary lookups do not do the complex password mangling that
 238 CrackLib does, but they will detect and reject any password that is within
 239 edit distance one of a word in the dictionary, meaning that the dictionary
 240 word can be formed from the password by adding, deleting, or modifying a
 241 single character.
 242 .Sp
 243 A CrackLib dictionary, a \s-1CDB\s0 dictionary, and a SQLite dictionary may all
 244 be configured at the same time or in any combination, in which case
 245 CrackLib will be run first, followed by \s-1CDB\s0 and then SQLite as
 246 appropriate.
 247 .IP "require_ascii_printable" 4
 248 .IX Item "require_ascii_printable"
 249 If set to a true boolean value, rejects any password that contains
 250 non-ASCII characters or \s-1ASCII\s0 control characters.  Spaces are allowed;
 251 tabs are not (at least assuming the \s-1POSIX C\s0 locale).  No canonicalization
 252 or character set is defined for Kerberos passwords in general, so you may
 253 want to reject non-ASCII characters to avoid interoperability problems
 254 with computers with different default character sets or Unicode
 255 normalization forms.
 256 .IP "require_classes" 4
 257 .IX Item "require_classes"
 258 This option allows specification of more complex character class
 259 requirements.  The value of this parameter should be one or more
 260 whitespace-separated rule.  Each rule has the syntax:
 261 .Sp
 262 .Vb 1
 263 \&    [<min>\-<max>:]<class>[,<class>...]
 264 .Ve
 265 .Sp
 266 where <class> is one of \f(CW\*(C`upper\*(C'\fR, \f(CW\*(C`lower\*(C'\fR, \f(CW\*(C`digit\*(C'\fR, or \f(CW\*(C`symbol\*(C'\fR.  The
 267 symbol class includes all characters other than alphanumeric characters,
 268 including space.  The listed classes must appear in the password.
 269 Separate multiple required classes with a comma (and no space).
 270 .Sp
 271 The character class checks will be done in whatever locale the plugin or
 272 password check program is run in, which will normally be the \s-1POSIX C\s0
 273 locale but may be different depending on local configuration.
 274 .Sp
 275 A simple example:
 276 .Sp
 277 .Vb 1
 278 \&    require_classes = upper,lower,digit
 279 .Ve
 280 .Sp
 281 This requires all passwords contain at least one uppercase letter, at
 282 least one lowercase letter, and at least one digit.
 283 .Sp
 284 If present, <min> and <max> specify the minimum password length and
 285 maximum password length to which this rule applies.  This allows one to
 286 specify character class requirements that change with password length.
 287 So, for example:
 288 .Sp
 289 .Vb 1
 290 \&    require_classes = 8\-19:upper,lower 8\-15:digit 8\-11:symbol
 291 .Ve
 292 .Sp
 293 requires all passwords from 8 to 11 characters long contain all four
 294 character classes, passwords from 12 to 15 characters long contain upper
 295 and lower case and a digit, and passwords from 16 to 19 characters long
 296 contain both upper and lower case.  Passwords longer than 20 characters
 297 have no character class restrictions.  (This example is probably used in
 298 conjunction with minimum_length = 8.)
 299 .IP "require_non_letter" 4
 300 .IX Item "require_non_letter"
 301 If set to a true boolean value, the password must contain at least one
 302 character that is not a letter (uppercase or lowercase) or a space.  This
 303 may be helpful in combination with passphrases; users may choose a stock
 304 English phrase, and this will force at least some additional complexity.
 305 .SH "SEE ALSO"
 306 .IX Header "SEE ALSO"
 307 \&\fIkrb5\-strength\-wordlist\fR\|(1), \fIkadm5\-strength\fR\|(3), \fIkpasswdd\fR\|(8), \fIkrb5.conf\fR\|(5)
 308 .PP
 309 The \*(L"Password changing\*(R" section of the Heimdal info documentation
 310 describes the interface that this program implements and how to configure
 311 Heimdal to use it.
 312 .PP
 313 The current version of this program is available from its web page at
 314 <http://www.eyrie.org/~eagle/software/krb5\-strength/> as part of the
 315 krb5\-strength package.
 316 .SH "AUTHOR"
 317 .IX Header "AUTHOR"
 318 Russ Allbery <eagle@eyrie.org>
 319 .SH "COPYRIGHT AND LICENSE"
 320 .IX Header "COPYRIGHT AND LICENSE"
 321 Copyright 2010, 2013, 2014 The Board of Trustees of the Leland Stanford
 322 Junior University
 323 .PP
 324 Copying and distribution of this file, with or without modification, are
 325 permitted in any medium without royalty provided the copyright notice and
 326 this notice are preserved.  This file is offered as-is, without any
 327 warranty.