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: src/lib/libcrypt/crypt.3,v 1.6.2.14 2002/12/29 16:35:35 schweikh Exp $
  31 .\"
  32 .\" Manual page, using -mandoc macros
  33 .\"
  34 .Dd January 19, 1997
  35 .Dt CRYPT 3
  36 .Os
  37 .Sh NAME
  38 .Nm crypt
  39 .Nd Trapdoor encryption
  40 .Sh LIBRARY
  41 .Lb libcrypt
  42 .Sh SYNOPSIS
  43 .In unistd.h
  44 .Ft char *
  45 .Fn crypt "const char *key" "const char *salt"
  46 .Ft const char *
  47 .Fn crypt_get_format "void"
  48 .Ft int
  49 .Fn crypt_set_format "const char *string"
  50 .Sh DESCRIPTION
  51 The
  52 .Fn crypt
  53 function performs password hashing with additional code added to
  54 deter key search attempts.  Different algorithms can be used to
  55 in the hash.
  56 .\"
  57 .\" NOTICE:
  58 .\" If you add more algorithms, make sure to update this list
  59 .\" and the default used for the Traditional format, below.
  60 .\"
  61 Currently these include the
  62 .Tn NBS
  63 .Tn Data Encryption Standard (DES) ,
  64 .Tn MD5
  65 and
  66 .Tn Blowfish .
  67 The algorithm used will depend upon the format of the Salt (following
  68 the Modular Crypt Format (MCF)), if
  69 .Tn DES
  70 and/or
  71 .Tn Blowfish
  72 is installed or not, and whether
  73 .Fn crypt_set_format
  74 has been called to change the default.
  75 .Pp
  76 The first argument to
  77 .Nm
  78 is the data to hash (usually a password), in a
  79 .Dv null Ns -terminated
  80 string.
  81 The second is the salt, in one of three forms:
  82 .Pp
  83 .Bl -tag -width Traditional -compact -offset indent
  84 .It Extended
  85 If it begins with an underscore
  86 .Pq Dq _
  87 then the
  88 .Tn DES
  89 Extended Format
  90 is used in interpreting both the key and the salt, as outlined below.
  91 .It Modular
  92 If it begins with the string
  93 .Dq $digit$
  94 then the Modular Crypt Format is used, as outlined below.
  95 .It Traditional
  96 If neither of the above is true, it assumes the Traditional Format,
  97 using the entire string as the salt (or the first portion).
  98 .El
  99 .Pp
 100 All routines are designed to be time-consuming.  A brief test on a
 101 .Tn Pentium
 102 166/MMX shows the
 103 .Tn DES
 104 crypt to do approximately 2640 crypts
 105 a CPU second and MD5 to do about 62 crypts a CPU second.
 106 .Ss DES Extended Format:
 107 .Pp
 108 The
 109 .Ar key
 110 is divided into groups of 8 characters (the last group is null-padded)
 111 and the low-order 7 bits of each character (56 bits per group) are
 112 used to form the
 113 .Tn DES
 114 key as follows:
 115 the first group of 56 bits becomes the initial
 116 .Tn DES
 117 key.
 118 For each additional group, the XOR of the encryption of the current
 119 .Tn DES
 120 key with itself and the group bits becomes the next
 121 .Tn DES
 122 key.
 123 .Pp
 124 The salt is a 9-character array consisting of an underscore followed
 125 by 4 bytes of iteration count and 4 bytes of salt.
 126 These are encoded as printable characters, 6 bits per character,
 127 least significant character first.
 128 The values 0 to 63 are encoded as ``./0-9A-Za-z''.
 129 This allows 24 bits for both
 130 .Fa count
 131 and
 132 .Fa salt .
 133 .Pp
 134 The
 135 .Fa salt
 136 introduces disorder in the
 137 .Tn DES
 138 algorithm in one of 16777216 or 4096 possible ways
 139 (ie. with 24 or 12 bits: if bit
 140 .Em i
 141 of the
 142 .Ar salt
 143 is set, then bits
 144 .Em i
 145 and
 146 .Em i+24
 147 are swapped in the
 148 .Tn DES
 149 E-box output).
 150 .Pp
 151 The
 152 .Tn DES
 153 key is used to encrypt a 64-bit constant using
 154 .Ar count
 155 iterations of
 156 .Tn DES .
 157 The value returned is a
 158 .Dv null Ns -terminated
 159 string, 20 or 13 bytes (plus null) in length, consisting of the
 160 .Ar salt
 161 followed by the encoded 64-bit encryption.
 162 .Ss "Modular" crypt:
 163 .Pp
 164 If the salt begins with the string
 165 .Fa $digit$
 166 then the Modular Crypt Format is used.  The
 167 .Fa digit
 168 represents which algorithm is used in encryption.  Following the token is
 169 the actual salt to use in the encryption.  The length of the salt is limited
 170 to 8 characters--because the length of the returned output is also limited
 171 (_PASSWORD_LEN).  The salt must be terminated with the end of the string
 172 (NULL) or a dollar sign.  Any characters after the dollar sign are ignored.
 173 .Pp
 174 Currently supported algorithms are:
 175 .Pp
 176 .Bl -enum -compact -offset indent
 177 .It
 178 MD5
 179 .It
 180 Blowfish
 181 .El
 182 .Pp
 183 Other crypt formats may be easily added.  An example salt would be:
 184 .Bl -tag -offset indent
 185 .It Cm "$3$thesalt$rest"
 186 .El
 187 .Pp
 188 .Ss "Traditional" crypt:
 189 .Pp
 190 The algorithm used will depend upon whether
 191 .Fn crypt_set_format
 192 has been called and whether a global default format has been specified.
 193 Unless a global default has been specified or
 194 .Fn crypt_set_format
 195 has set the format to something else, the built-in default format is
 196 used.
 197 This is currently
 198 .\"
 199 .\" NOTICE: Also make sure to update this
 200 .\"
 201 DES
 202 if it is available, or MD5 if not.
 203 .Pp
 204 How the salt is used will depend upon the algorithm for the hash.  For
 205 best results, specify at least two characters of salt.
 206 .Pp
 207 The
 208 .Fn crypt_get_format
 209 function returns a constant string that represents the name of the
 210 algorithm currently used.
 211 Valid values are
 212 .\"
 213 .\" NOTICE: Also make sure to update this, too, as well
 214 .\"
 215 .Ql des ,
 216 .Ql blf
 217 and
 218 .Ql md5 .
 219 .Pp
 220 The
 221 .Fn crypt_set_format
 222 function sets the default encoding format according to the supplied
 223 .Fa string .
 224 .Pp
 225 The global default format can be set using the
 226 .Pa /etc/auth.conf
 227 file using the
 228 .Va crypt_default
 229 property.
 230 .Sh RETURN VALUES
 231 .Fn crypt
 232 returns a pointer to the encrypted value on success, and NULL on failure.
 233 Note: this is not a standard behaviour, AT&T
 234 .Fn crypt
 235 will always return a pointer to a string.
 236 .Pp
 237 .Fn crypt_set_format
 238 will return 1 if the supplied encoding format was valid.
 239 Otherwise, a value of 0 is returned.
 240 .Sh SEE ALSO
 241 .Xr login 1 ,
 242 .Xr passwd 1 ,
 243 .Xr auth_getval 3 ,
 244 .Xr cipher 3 ,
 245 .Xr getpass 3 ,
 246 .Xr auth.conf 5 ,
 247 .Xr passwd 5
 248 .Sh BUGS
 249 The
 250 .Fn crypt
 251 function returns a pointer to static data, and subsequent calls to
 252 .Fn crypt
 253 will modify the same data.  Likewise,
 254 .Fn crypt_set_format
 255 modifies static data.
 256 .Sh HISTORY
 257 A rotor-based
 258 .Fn crypt
 259 function appeared in
 260 .At v6 .
 261 The current style
 262 .Fn crypt
 263 first appeared in
 264 .At v7 .
 265 .Pp
 266 The
 267 .Tn DES
 268 section of the code (FreeSec 1.0) was developed outside the United
 269 States of America as an unencumbered replacement for the U.S.-only
 270 .Nx
 271 libcrypt encryption library.
 272 .Sh AUTHORS
 273 .An -nosplit
 274 Originally written by
 275 .An David Burren Aq davidb@werj.com.au ,
 276 later additions and changes by
 277 .An Poul-Henning Kamp ,
 278 .An Mark R V Murray ,
 279 .An Kris Kennaway ,
 280 .An Brian Feldman ,
 281 .An Paul Herman
 282 and
 283 .An Niels Provos .