lib/libcrypt/crypt.3

   1 .\" FreeSec: libcrypt for NetBSD
   2 .\"
   3 .\" Copyright (c) 1994 David Burren
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 4. Neither the name of the author nor the names of other contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\" $FreeBSD$
  31 .\"
  32 .Dd March 9, 2014
  33 .Dt CRYPT 3
  34 .Os
  35 .Sh NAME
  36 .Nm crypt
  37 .Nd Trapdoor encryption
  38 .Sh LIBRARY
  39 .Lb libcrypt
  40 .Sh SYNOPSIS
  41 .In unistd.h
  42 .Ft char *
  43 .Fn crypt "const char *key" "const char *salt"
  44 .Ft const char *
  45 .Fn crypt_get_format "void"
  46 .Ft int
  47 .Fn crypt_set_format "const char *string"
  48 .Sh DESCRIPTION
  49 The
  50 .Fn crypt
  51 function performs password hashing with additional code added to
  52 deter key search attempts.
  53 Different algorithms can be used to
  54 in the hash.
  55 .\"
  56 .\" NOTICE:
  57 .\" If you add more algorithms, make sure to update this list
  58 .\" and the default used for the Traditional format, below.
  59 .\"
  60 Currently these include the
  61 .Tn NBS
  62 .Tn Data Encryption Standard (DES) ,
  63 .Tn MD5
  64 hash,
  65 .Tn NT-Hash
  66 .Pq compatible with Microsoft's NT scheme
  67 and
  68 .Tn Blowfish .
  69 The algorithm used will depend upon the format of the Salt
  70 .Po
  71 following
  72 the Modular Crypt Format
  73 .Pq MCF
  74 .Pc ,
  75 if
  76 .Tn DES
  77 and/or
  78 .Tn Blowfish
  79 is installed or not, and whether
  80 .Fn crypt_set_format
  81 has been called to change the default.
  82 .Pp
  83 The first argument to
  84 .Nm
  85 is the data to hash
  86 .Pq usually a password ,
  87 in a
  88 .Dv NUL Ns -terminated
  89 string.
  90 The second is the salt, in one of three forms:
  91 .Pp
  92 .Bl -tag -width Traditional -compact -offset indent
  93 .It Extended
  94 If it begins with an underscore
  95 .Pq Dq _
  96 then the
  97 .Tn DES
  98 Extended Format
  99 is used in interpreting both the key and the salt, as outlined below.
 100 .It Modular
 101 If it begins with the string
 102 .Dq $digit$
 103 then the Modular Crypt Format is used, as outlined below.
 104 .It Traditional
 105 If neither of the above is true, it assumes the Traditional Format,
 106 using the entire string as the salt
 107 .Pq or the first portion .
 108 .El
 109 .Pp
 110 All routines are designed to be time-consuming.
 111 .Ss DES Extended Format:
 112 The
 113 .Ar key
 114 is divided into groups of 8 characters
 115 .Pq the last group is NUL-padded
 116 and the low-order 7 bits of each character
 117 .Pq 56 bits per group
 118 are used to form the
 119 .Tn DES
 120 key as follows:
 121 the first group of 56 bits becomes the initial
 122 .Tn DES
 123 key.
 124 For each additional group, the XOR of the encryption of the current
 125 .Tn DES
 126 key with itself and the group bits becomes the next
 127 .Tn DES
 128 key.
 129 .Pp
 130 The salt is a 9-character array consisting of an underscore followed
 131 by 4 bytes of iteration count and 4 bytes of salt.
 132 These are encoded as printable characters, 6 bits per character,
 133 least significant character first.
 134 The values 0 to 63 are encoded as
 135 .Dq ./0-9A-Za-z .
 136 This allows 24 bits for both
 137 .Fa count
 138 and
 139 .Fa salt .
 140 .Pp
 141 The
 142 .Fa salt
 143 introduces disorder in the
 144 .Tn DES
 145 algorithm in one of 16777216 or 4096 possible ways
 146 .Po
 147 i.e., with 24 or 12 bits: if bit
 148 .Em i
 149 of the
 150 .Ar salt
 151 is set, then bits
 152 .Em i
 153 and
 154 .Em i+24
 155 are swapped in the
 156 .Tn DES
 157 E-box output
 158 .Pc .
 159 .Pp
 160 The
 161 .Tn DES
 162 key is used to encrypt a 64-bit constant using
 163 .Ar count
 164 iterations of
 165 .Tn DES .
 166 The value returned is a
 167 .Dv NUL Ns -terminated
 168 string, 20 or 13 bytes
 169 .Pq plus NUL
 170 in length, consisting of the
 171 .Ar salt
 172 followed by the encoded 64-bit encryption.
 173 .Ss Modular crypt:
 174 If the salt begins with the string
 175 .Fa $digit$
 176 then the Modular Crypt Format is used.
 177 The
 178 .Fa digit
 179 represents which algorithm is used in encryption.
 180 Following the token is
 181 the actual salt to use in the encryption.
 182 The maximum length of the salt used depends upon the module.
 183 The salt must be terminated with the end of the string character
 184 .Pq NUL
 185 or a dollar sign.
 186 Any characters after the dollar sign are ignored.
 187 .Pp
 188 Currently supported algorithms are:
 189 .Pp
 190 .Bl -enum -compact -offset indent
 191 .It
 192 MD5
 193 .It
 194 Blowfish
 195 .It
 196 NT-Hash
 197 .It
 198 (unused)
 199 .It
 200 SHA-256
 201 .It
 202 SHA-512
 203 .El
 204 .Pp
 205 Other crypt formats may be easily added.
 206 An example salt would be:
 207 .Bl -tag -width 6n -offset indent
 208 .It Cm "$4$thesalt$rest"
 209 .El
 210 .Ss Traditional crypt:
 211 The algorithm used will depend upon whether
 212 .Fn crypt_set_format
 213 has been called and whether a global default format has been specified.
 214 Unless a global default has been specified or
 215 .Fn crypt_set_format
 216 has set the format to something else, the built-in default format is
 217 used.
 218 This is currently
 219 .\"
 220 .\" NOTICE: Also make sure to update this
 221 .\"
 222 DES
 223 if it is available, or MD5 if not.
 224 .Pp
 225 How the salt is used will depend upon the algorithm for the hash.
 226 For
 227 best results, specify at least eight characters of salt.
 228 .Pp
 229 The
 230 .Fn crypt_get_format
 231 function returns a constant string that represents the name of the
 232 algorithm currently used.
 233 Valid values are
 234 .\"
 235 .\" NOTICE: Also make sure to update this, too, as well
 236 .\"
 237 .Ql des ,
 238 .Ql blf ,
 239 .Ql md5 ,
 240 .Ql sha256 ,
 241 .Ql sha512
 242 and
 243 .Ql nth .
 244 .Pp
 245 The
 246 .Fn crypt_set_format
 247 function sets the default encoding format according to the supplied
 248 .Fa string .
 249 .Sh RETURN VALUES
 250 The
 251 .Fn crypt
 252 function returns a pointer to the encrypted value on success, and NULL on
 253 failure.
 254 Note: this is not a standard behaviour, AT&T
 255 .Fn crypt
 256 will always return a pointer to a string.
 257 .Pp
 258 The
 259 .Fn crypt_set_format
 260 function will return 1 if the supplied encoding format was valid.
 261 Otherwise, a value of 0 is returned.
 262 .Sh SEE ALSO
 263 .Xr login 1 ,
 264 .Xr passwd 1 ,
 265 .Xr getpass 3 ,
 266 .Xr passwd 5
 267 .Sh HISTORY
 268 A rotor-based
 269 .Fn crypt
 270 function appeared in
 271 .At v6 .
 272 The current style
 273 .Fn crypt
 274 first appeared in
 275 .At v7 .
 276 .Pp
 277 The
 278 .Tn DES
 279 section of the code (FreeSec 1.0) was developed outside the United
 280 States of America as an unencumbered replacement for the U.S.-only
 281 .Nx
 282 libcrypt encryption library.
 283 .Sh AUTHORS
 284 .An -nosplit
 285 Originally written by
 286 .An David Burren Aq davidb@werj.com.au ,
 287 later additions and changes by
 288 .An Poul-Henning Kamp ,
 289 .An Mark R V Murray ,
 290 .An Michael Bretterklieber ,
 291 .An Kris Kennaway ,
 292 .An Brian Feldman ,
 293 .An Paul Herman
 294 and
 295 .An Niels Provos .
 296 .Sh BUGS
 297 The
 298 .Fn crypt
 299 function returns a pointer to static data, and subsequent calls to
 300 .Fn crypt
 301 will modify the same data.
 302 Likewise,
 303 .Fn crypt_set_format
 304 modifies static data.
 305 .Pp
 306 The NT-hash scheme does not use a salt,
 307 and is not hard
 308 for a competent attacker
 309 to break.
 310 Its use is not recommended.