man3/crypt.3

   1 .\" Michael Haardt (michael@cantor.informatik.rwth.aachen.de)
   2 .\"     Sat Sep  3 22:00:30 MET DST 1994
   3 .\"
   4 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
   5 .\" This is free documentation; you can redistribute it and/or
   6 .\" modify it under the terms of the GNU General Public License as
   7 .\" published by the Free Software Foundation; either version 2 of
   8 .\" the License, or (at your option) any later version.
   9 .\"
  10 .\" The GNU General Public License's references to "object code"
  11 .\" and "executables" are to be interpreted as the output of any
  12 .\" document formatting or typesetting system, including
  13 .\" intermediate and printed output.
  14 .\"
  15 .\" This manual is distributed in the hope that it will be useful,
  16 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 .\" GNU General Public License for more details.
  19 .\"
  20 .\" You should have received a copy of the GNU General Public
  21 .\" License along with this manual; if not, see
  22 .\" <http://www.gnu.org/licenses/>.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" Sun Feb 19 21:32:25 1995, faith@cs.unc.edu edited details away
  26 .\"
  27 .\" TO DO: This manual page should go more into detail how DES is perturbed,
  28 .\" which string will be encrypted, and what determines the repetition factor.
  29 .\" Is a simple repetition using ECB used, or something more advanced?  I hope
  30 .\" the presented explanations are at least better than nothing, but by no
  31 .\" means enough.
  32 .\"
  33 .\" added _XOPEN_SOURCE, aeb, 970705
  34 .\" added GNU MD5 stuff, aeb, 011223
  35 .\"
  36 .TH CRYPT 3 2015-08-08 "" "Linux Programmer's Manual"
  37 .SH NAME
  38 crypt, crypt_r \- password and data encryption
  39 .SH SYNOPSIS
  40 .nf
  41 .BR "#define _XOPEN_SOURCE" "       /* See feature_test_macros(7) */"
  42 .br
  43 .B #include <unistd.h>
  44 .sp
  45 .BI "char *crypt(const char *" key ", const char *" salt );
  46 .sp
  47 .BR "#define _GNU_SOURCE" "         /* See feature_test_macros(7) */"
  48 .br
  49 .B #include <crypt.h>
  50 .sp
  51 .BI "char *crypt_r(const char *" key ", const char *" salt ,
  52 .BI "              struct crypt_data *" data );
  53 .fi
  54 .sp
  55 Link with \fI\-lcrypt\fP.
  56 .SH DESCRIPTION
  57 .BR crypt ()
  58 is the password encryption function.
  59 It is based on the Data Encryption
  60 Standard algorithm with variations intended (among other things) to
  61 discourage use of hardware implementations of a key search.
  62 .PP
  63 .I key
  64 is a user's typed password.
  65 .PP
  66 .I salt
  67 is a two-character string chosen from the set
  68 [\fBa\-zA\-Z0\-9./\fP].
  69 This string is used to
  70 perturb the algorithm in one of 4096 different ways.
  71 .PP
  72 By taking the lowest 7 bits of each of the first eight characters of the
  73 .IR key ,
  74 a 56-bit key is obtained.
  75 This 56-bit key is used to encrypt repeatedly a
  76 constant string (usually a string consisting of all zeros).
  77 The returned
  78 value points to the encrypted password, a series of 13 printable ASCII
  79 characters (the first two characters represent the salt itself).
  80 The return value points to static data whose content is
  81 overwritten by each call.
  82 .PP
  83 Warning: the key space consists of
  84 .if t 2\s-2\u56\s0\d
  85 .if n 2**56
  86 equal 7.2e16 possible values.
  87 Exhaustive searches of this key space are
  88 possible using massively parallel computers.
  89 Software, such as
  90 .BR crack (1),
  91 is available which will search the portion of this key space that is
  92 generally used by humans for passwords.
  93 Hence, password selection should,
  94 at minimum, avoid common words and names.
  95 The use of a
  96 .BR passwd (1)
  97 program that checks for crackable passwords during the selection process is
  98 recommended.
  99 .PP
 100 The DES algorithm itself has a few quirks which make the use of the
 101 .BR crypt ()
 102 interface a very poor choice for anything other than password
 103 authentication.
 104 If you are planning on using the
 105 .BR crypt ()
 106 interface for a cryptography project, don't do it: get a good book on
 107 encryption and one of the widely available DES libraries.
 108
 109 .BR crypt_r ()
 110 is a reentrant version of
 111 .BR crypt ().
 112 The structure pointed to by
 113 .I data
 114 is used to store result data and bookkeeping information.
 115 Other than allocating it,
 116 the only thing that the caller should do with this structure is to set
 117 .I data->initialized
 118 to zero before the first call to
 119 .BR crypt_r ().
 120 .SH RETURN VALUE
 121 On success, a pointer to the encrypted password is returned.
 122 On error, NULL is returned.
 123 .SH ERRORS
 124 .TP
 125 .B EINVAL
 126 .I salt
 127 has the wrong format.
 128 .TP
 129 .B ENOSYS
 130 The
 131 .BR crypt ()
 132 function was not implemented, probably because of U.S.A. export restrictions.
 133 .\" This level of detail is not necessary in this man page. . .
 134 .\" .PP
 135 .\" When encrypting a plain text P using DES with the key K results in the
 136 .\" encrypted text C, then the complementary plain text P' being encrypted
 137 .\" using the complementary key K' will result in the complementary encrypted
 138 .\" text C'.
 139 .\" .PP
 140 .\" Weak keys are keys which stay invariant under the DES key transformation.
 141 .\" The four known weak keys 0101010101010101, fefefefefefefefe,
 142 .\" 1f1f1f1f0e0e0e0e and e0e0e0e0f1f1f1f1 must be avoided.
 143 .\" .PP
 144 .\" There are six known half weak key pairs, which keys lead to the same
 145 .\" encrypted data.  Keys which are part of such key clusters should be
 146 .\" avoided.
 147 .\" Sorry, I could not find out what they are.
 148 .\""
 149 .\" .PP
 150 .\" Heavily redundant data causes trouble with DES encryption, when used in the
 151 .\" .I codebook
 152 .\" mode that
 153 .\" .BR crypt ()
 154 .\" implements.  The
 155 .\" .BR crypt ()
 156 .\" interface should be used only for its intended purpose of password
 157 .\" verification, and should not be used as part of a data encryption tool.
 158 .\" .PP
 159 .\" The first and last three output bits of the fourth S-box can be
 160 .\" represented as function of their input bits.  Empiric studies have
 161 .\" shown that S-boxes partially compute the same output for similar input.
 162 .\" It is suspected that this may contain a back door which could allow the
 163 .\" NSA to decrypt DES encrypted data.
 164 .\" .PP
 165 .\" Making encrypted data computed using crypt() publicly available has
 166 .\" to be considered insecure for the given reasons.
 167 .TP
 168 .B EPERM
 169 .I /proc/sys/crypto/fips_enabled
 170 has a nonzero value,
 171 and an attempt was made to use a weak encryption type, such as DES.
 172 .SH ATTRIBUTES
 173 For an explanation of the terms used in this section, see
 174 .BR attributes (7).
 175 .TS
 176 allbox;
 177 lb lb lb
 178 l l l.
 179 Interface       Attribute       Value
 180 T{
 181 .BR crypt ()
 182 T}      Thread safety   MT-Unsafe race:crypt
 183 T{
 184 .BR crypt_r ()
 185 T}      Thread safety   MT-Safe
 186 .TE
 187 .SH CONFORMING TO
 188 .BR crypt ():
 189 POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD.
 190 .BR crypt_r ()
 191 is a GNU extension.
 192 .SH NOTES
 193 .SS Glibc notes
 194 The glibc2 version of this function supports additional
 195 encryption algorithms.
 196
 197 If
 198 .I salt
 199 is a character string starting with the characters "$\fIid\fP$"
 200 followed by a string terminated by "$":
 201 .RS
 202
 203 $\fIid\fP$\fIsalt\fP$\fIencrypted\fP
 204
 205 .RE
 206 then instead of using the DES machine,
 207 .I id
 208 identifies the encryption method used and this then determines how the rest
 209 of the password string is interpreted.
 210 The following values of
 211 .I id
 212 are supported:
 213 .RS
 214 .TS
 215 l l.
 216 ID  | Method
 217 _
 218 1   | MD5
 219 2a  | Blowfish (not in mainline glibc; added in some
 220     | Linux distributions)
 221 .\" openSUSE has Blowfish, but AFAICS, this option is not supported
 222 .\" natively by glibc -- mtk, Jul 08
 223 .\"
 224 .\" md5 | Sun MD5
 225 .\" glibc doesn't appear to natively support Sun MD5; I don't know
 226 .\" if any distros add the support.
 227 5   | SHA-256 (since glibc 2.7)
 228 6   | SHA-512 (since glibc 2.7)
 229 .TE
 230 .RE
 231
 232 So $5$\fIsalt\fP$\fIencrypted\fP is an SHA-256 encoded
 233 password and $6$\fIsalt\fP$\fIencrypted\fP is an
 234 SHA-512 encoded one.
 235
 236 "\fIsalt\fP" stands for the up to 16 characters
 237 following "$\fIid\fP$" in the salt.
 238 The encrypted part of the password string is the actual computed password.
 239 The size of this string is fixed:
 240 .TS
 241 l l.
 242 MD5     | 22 characters
 243 SHA-256 | 43 characters
 244 SHA-512 | 86 characters
 245 .TE
 246
 247 The characters in "\fIsalt\fP" and "\fIencrypted\fP" are drawn from the set
 248 [\fBa\-zA\-Z0\-9./\fP].
 249 In the MD5 and SHA implementations the entire
 250 .I key
 251 is significant (instead of only the first
 252 8 bytes in DES).
 253 .SH SEE ALSO
 254 .BR login (1),
 255 .BR passwd (1),
 256 .BR encrypt (3),
 257 .BR getpass (3),
 258 .BR passwd (5)