RT4337: Crash in DES
[openssl.git] / doc / crypto / des.pod
1 =pod
2
3 =head1 NAME
4
5 DES_random_key, DES_set_key, DES_key_sched, DES_set_key_checked,
6 DES_set_key_unchecked, DES_set_odd_parity, DES_is_weak_key,
7 DES_ecb_encrypt, DES_ecb2_encrypt, DES_ecb3_encrypt, DES_ncbc_encrypt,
8 DES_cfb_encrypt, DES_ofb_encrypt, DES_pcbc_encrypt, DES_cfb64_encrypt,
9 DES_ofb64_encrypt, DES_xcbc_encrypt, DES_ede2_cbc_encrypt,
10 DES_ede2_cfb64_encrypt, DES_ede2_ofb64_encrypt, DES_ede3_cbc_encrypt,
11 DES_ede3_cfb64_encrypt, DES_ede3_ofb64_encrypt,
12 DES_cbc_cksum, DES_quad_cksum, DES_string_to_key, DES_string_to_2keys,
13 DES_fcrypt, DES_crypt - DES encryption
14
15 =head1 SYNOPSIS
16
17  #include <openssl/des.h>
18
19  void DES_random_key(DES_cblock *ret);
20
21  int DES_set_key(const_DES_cblock *key, DES_key_schedule *schedule);
22  int DES_key_sched(const_DES_cblock *key, DES_key_schedule *schedule);
23  int DES_set_key_checked(const_DES_cblock *key,
24         DES_key_schedule *schedule);
25  void DES_set_key_unchecked(const_DES_cblock *key,
26         DES_key_schedule *schedule);
27
28  void DES_set_odd_parity(DES_cblock *key);
29  int DES_is_weak_key(const_DES_cblock *key);
30
31  void DES_ecb_encrypt(const_DES_cblock *input, DES_cblock *output,
32         DES_key_schedule *ks, int enc);
33  void DES_ecb2_encrypt(const_DES_cblock *input, DES_cblock *output,
34         DES_key_schedule *ks1, DES_key_schedule *ks2, int enc);
35  void DES_ecb3_encrypt(const_DES_cblock *input, DES_cblock *output,
36         DES_key_schedule *ks1, DES_key_schedule *ks2,
37         DES_key_schedule *ks3, int enc);
38
39  void DES_ncbc_encrypt(const unsigned char *input, unsigned char *output,
40         long length, DES_key_schedule *schedule, DES_cblock *ivec,
41         int enc);
42  void DES_cfb_encrypt(const unsigned char *in, unsigned char *out,
43         int numbits, long length, DES_key_schedule *schedule,
44         DES_cblock *ivec, int enc);
45  void DES_ofb_encrypt(const unsigned char *in, unsigned char *out,
46         int numbits, long length, DES_key_schedule *schedule,
47         DES_cblock *ivec);
48  void DES_pcbc_encrypt(const unsigned char *input, unsigned char *output,
49         long length, DES_key_schedule *schedule, DES_cblock *ivec,
50         int enc);
51  void DES_cfb64_encrypt(const unsigned char *in, unsigned char *out,
52         long length, DES_key_schedule *schedule, DES_cblock *ivec,
53         int *num, int enc);
54  void DES_ofb64_encrypt(const unsigned char *in, unsigned char *out,
55         long length, DES_key_schedule *schedule, DES_cblock *ivec,
56         int *num);
57
58  void DES_xcbc_encrypt(const unsigned char *input, unsigned char *output,
59         long length, DES_key_schedule *schedule, DES_cblock *ivec,
60         const_DES_cblock *inw, const_DES_cblock *outw, int enc);
61
62  void DES_ede2_cbc_encrypt(const unsigned char *input,
63         unsigned char *output, long length, DES_key_schedule *ks1,
64         DES_key_schedule *ks2, DES_cblock *ivec, int enc);
65  void DES_ede2_cfb64_encrypt(const unsigned char *in,
66         unsigned char *out, long length, DES_key_schedule *ks1,
67         DES_key_schedule *ks2, DES_cblock *ivec, int *num, int enc);
68  void DES_ede2_ofb64_encrypt(const unsigned char *in,
69         unsigned char *out, long length, DES_key_schedule *ks1,
70         DES_key_schedule *ks2, DES_cblock *ivec, int *num);
71
72  void DES_ede3_cbc_encrypt(const unsigned char *input,
73         unsigned char *output, long length, DES_key_schedule *ks1,
74         DES_key_schedule *ks2, DES_key_schedule *ks3, DES_cblock *ivec,
75         int enc);
76  void DES_ede3_cfb64_encrypt(const unsigned char *in, unsigned char *out,
77         long length, DES_key_schedule *ks1, DES_key_schedule *ks2,
78         DES_key_schedule *ks3, DES_cblock *ivec, int *num, int enc);
79  void DES_ede3_ofb64_encrypt(const unsigned char *in, unsigned char *out,
80         long length, DES_key_schedule *ks1,
81         DES_key_schedule *ks2, DES_key_schedule *ks3,
82         DES_cblock *ivec, int *num);
83
84  DES_LONG DES_cbc_cksum(const unsigned char *input, DES_cblock *output,
85         long length, DES_key_schedule *schedule,
86         const_DES_cblock *ivec);
87  DES_LONG DES_quad_cksum(const unsigned char *input, DES_cblock output[],
88         long length, int out_count, DES_cblock *seed);
89  void DES_string_to_key(const char *str, DES_cblock *key);
90  void DES_string_to_2keys(const char *str, DES_cblock *key1,
91         DES_cblock *key2);
92
93  char *DES_fcrypt(const char *buf, const char *salt, char *ret);
94  char *DES_crypt(const char *buf, const char *salt);
95
96 =head1 DESCRIPTION
97
98 This library contains a fast implementation of the DES encryption
99 algorithm.
100
101 There are two phases to the use of DES encryption.  The first is the
102 generation of a I<DES_key_schedule> from a key, the second is the
103 actual encryption.  A DES key is of type I<DES_cblock>. This type is
104 consists of 8 bytes with odd parity.  The least significant bit in
105 each byte is the parity bit.  The key schedule is an expanded form of
106 the key; it is used to speed the encryption process.
107
108 DES_random_key() generates a random key.  The PRNG must be seeded
109 prior to using this function (see L<rand(3)>).  If the PRNG
110 could not generate a secure key, 0 is returned.
111
112 Before a DES key can be used, it must be converted into the
113 architecture dependent I<DES_key_schedule> via the
114 DES_set_key_checked() or DES_set_key_unchecked() function.
115
116 DES_set_key_checked() will check that the key passed is of odd parity
117 and is not a week or semi-weak key.  If the parity is wrong, then -1
118 is returned.  If the key is a weak key, then -2 is returned.  If an
119 error is returned, the key schedule is not generated.
120
121 DES_set_key() works like
122 DES_set_key_checked() if the I<DES_check_key> flag is non-zero,
123 otherwise like DES_set_key_unchecked().  These functions are available
124 for compatibility; it is recommended to use a function that does not
125 depend on a global variable.
126
127 DES_set_odd_parity() sets the parity of the passed I<key> to odd.
128
129 DES_is_weak_key() returns 1 if the passed key is a weak key, 0 if it
130 is ok.
131
132 The following routines mostly operate on an input and output stream of
133 I<DES_cblock>s.
134
135 DES_ecb_encrypt() is the basic DES encryption routine that encrypts or
136 decrypts a single 8-byte I<DES_cblock> in I<electronic code book>
137 (ECB) mode.  It always transforms the input data, pointed to by
138 I<input>, into the output data, pointed to by the I<output> argument.
139 If the I<encrypt> argument is non-zero (DES_ENCRYPT), the I<input>
140 (cleartext) is encrypted in to the I<output> (ciphertext) using the
141 key_schedule specified by the I<schedule> argument, previously set via
142 I<DES_set_key>. If I<encrypt> is zero (DES_DECRYPT), the I<input> (now
143 ciphertext) is decrypted into the I<output> (now cleartext).  Input
144 and output may overlap.  DES_ecb_encrypt() does not return a value.
145
146 DES_ecb3_encrypt() encrypts/decrypts the I<input> block by using
147 three-key Triple-DES encryption in ECB mode.  This involves encrypting
148 the input with I<ks1>, decrypting with the key schedule I<ks2>, and
149 then encrypting with I<ks3>.  This routine greatly reduces the chances
150 of brute force breaking of DES and has the advantage of if I<ks1>,
151 I<ks2> and I<ks3> are the same, it is equivalent to just encryption
152 using ECB mode and I<ks1> as the key.
153
154 The macro DES_ecb2_encrypt() is provided to perform two-key Triple-DES
155 encryption by using I<ks1> for the final encryption.
156
157 DES_ncbc_encrypt() encrypts/decrypts using the I<cipher-block-chaining>
158 (CBC) mode of DES.  If the I<encrypt> argument is non-zero, the
159 routine cipher-block-chain encrypts the cleartext data pointed to by
160 the I<input> argument into the ciphertext pointed to by the I<output>
161 argument, using the key schedule provided by the I<schedule> argument,
162 and initialization vector provided by the I<ivec> argument.  If the
163 I<length> argument is not an integral multiple of eight bytes, the
164 last block is copied to a temporary area and zero filled.  The output
165 is always an integral multiple of eight bytes.
166
167 DES_xcbc_encrypt() is RSA's DESX mode of DES.  It uses I<inw> and
168 I<outw> to 'whiten' the encryption.  I<inw> and I<outw> are secret
169 (unlike the iv) and are as such, part of the key.  So the key is sort
170 of 24 bytes.  This is much better than CBC DES.
171
172 DES_ede3_cbc_encrypt() implements outer triple CBC DES encryption with
173 three keys. This means that each DES operation inside the CBC mode is
174 an C<C=E(ks3,D(ks2,E(ks1,M)))>.  This mode is used by SSL.
175
176 The DES_ede2_cbc_encrypt() macro implements two-key Triple-DES by
177 reusing I<ks1> for the final encryption.  C<C=E(ks1,D(ks2,E(ks1,M)))>.
178 This form of Triple-DES is used by the RSAREF library.
179
180 DES_pcbc_encrypt() encrypt/decrypts using the propagating cipher block
181 chaining mode used by Kerberos v4. Its parameters are the same as
182 DES_ncbc_encrypt().
183
184 DES_cfb_encrypt() encrypt/decrypts using cipher feedback mode.  This
185 method takes an array of characters as input and outputs and array of
186 characters.  It does not require any padding to 8 character groups.
187 Note: the I<ivec> variable is changed and the new changed value needs to
188 be passed to the next call to this function.  Since this function runs
189 a complete DES ECB encryption per I<numbits>, this function is only
190 suggested for use when sending small numbers of characters.
191
192 DES_cfb64_encrypt()
193 implements CFB mode of DES with 64bit feedback.  Why is this
194 useful you ask?  Because this routine will allow you to encrypt an
195 arbitrary number of bytes, no 8 byte padding.  Each call to this
196 routine will encrypt the input bytes to output and then update ivec
197 and num.  num contains 'how far' we are though ivec.  If this does
198 not make much sense, read more about cfb mode of DES :-).
199
200 DES_ede3_cfb64_encrypt() and DES_ede2_cfb64_encrypt() is the same as
201 DES_cfb64_encrypt() except that Triple-DES is used.
202
203 DES_ofb_encrypt() encrypts using output feedback mode.  This method
204 takes an array of characters as input and outputs and array of
205 characters.  It does not require any padding to 8 character groups.
206 Note: the I<ivec> variable is changed and the new changed value needs to
207 be passed to the next call to this function.  Since this function runs
208 a complete DES ECB encryption per numbits, this function is only
209 suggested for use when sending small numbers of characters.
210
211 DES_ofb64_encrypt() is the same as DES_cfb64_encrypt() using Output
212 Feed Back mode.
213
214 DES_ede3_ofb64_encrypt() and DES_ede2_ofb64_encrypt() is the same as
215 DES_ofb64_encrypt(), using Triple-DES.
216
217 The following functions are included in the DES library for
218 compatibility with the MIT Kerberos library.
219
220 DES_cbc_cksum() produces an 8 byte checksum based on the input stream
221 (via CBC encryption).  The last 4 bytes of the checksum are returned
222 and the complete 8 bytes are placed in I<output>. This function is
223 used by Kerberos v4.  Other applications should use
224 L<EVP_DigestInit(3)> etc. instead.
225
226 DES_quad_cksum() is a Kerberos v4 function.  It returns a 4 byte
227 checksum from the input bytes.  The algorithm can be iterated over the
228 input, depending on I<out_count>, 1, 2, 3 or 4 times.  If I<output> is
229 non-NULL, the 8 bytes generated by each pass are written into
230 I<output>.
231
232 The following are DES-based transformations:
233
234 DES_fcrypt() is a fast version of the Unix crypt(3) function.  This
235 version takes only a small amount of space relative to other fast
236 crypt() implementations.  This is different to the normal crypt in
237 that the third parameter is the buffer that the return value is
238 written into.  It needs to be at least 14 bytes long.  This function
239 is thread safe, unlike the normal crypt.
240
241 DES_crypt() is a faster replacement for the normal system crypt().
242 This function calls DES_fcrypt() with a static array passed as the
243 third parameter.  This mostly emulates the normal non-thread-safe semantics
244 of crypt(3).
245 The B<salt> must be two ASCII characters.
246
247 DES_enc_write() writes I<len> bytes to file descriptor I<fd> from
248 buffer I<buf>. The data is encrypted via I<pcbc_encrypt> (default)
249 using I<sched> for the key and I<iv> as a starting vector.  The actual
250 data send down I<fd> consists of 4 bytes (in network byte order)
251 containing the length of the following encrypted data.  The encrypted
252 data then follows, padded with random data out to a multiple of 8
253 bytes.
254
255 =head1 BUGS
256
257 DES_3cbc_encrypt() is flawed and must not be used in applications.
258
259 DES_cbc_encrypt() does not modify B<ivec>; use DES_ncbc_encrypt()
260 instead.
261
262 DES_cfb_encrypt() and DES_ofb_encrypt() operates on input of 8 bits.
263 What this means is that if you set numbits to 12, and length to 2, the
264 first 12 bits will come from the 1st input byte and the low half of
265 the second input byte.  The second 12 bits will have the low 8 bits
266 taken from the 3rd input byte and the top 4 bits taken from the 4th
267 input byte.  The same holds for output.  This function has been
268 implemented this way because most people will be using a multiple of 8
269 and because once you get into pulling bytes input bytes apart things
270 get ugly!
271
272 DES_string_to_key() is available for backward compatibility with the
273 MIT library.  New applications should use a cryptographic hash function.
274 The same applies for DES_string_to_2key().
275
276 =head1 NOTES
277
278 The B<des> library was written to be source code compatible with
279 the MIT Kerberos library.
280
281 Applications should use the higher level functions
282 L<EVP_EncryptInit(3)> etc. instead of calling these
283 functions directly.
284
285 Single-key DES is insecure due to its short key size.  ECB mode is
286 not suitable for most applications; see L<des_modes(7)>.
287
288 =head1 HISTORY
289
290 The requirement that the B<salt> parameter to DES_crypt() and DES_fcrypt()
291 be two ASCII characters was first enforced in
292 OpenSSL 1.1.0.  Previous versions tried to use the letter uppercase B<A>
293 if both character were not present, and could crash when given non-ASCII
294 on some platforms.
295
296 =head1 SEE ALSO
297
298 L<des_modes(7)>,
299 L<EVP_EncryptInit(3)>
300
301 =head1 COPYRIGHT
302
303 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
304
305 Licensed under the OpenSSL license (the "License").  You may not use
306 this file except in compliance with the License.  You can obtain a copy
307 in the file LICENSE in the source distribution or at
308 L<https://www.openssl.org/source/license.html>.
309
310 =cut