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_cbcm_encrypt, DES_ede3_cfb64_encrypt, DES_ede3_ofb64_encrypt,
  12 DES_read_password, DES_read_2passwords, DES_read_pw_string,
  13 DES_cbc_cksum, DES_quad_cksum, DES_string_to_key, DES_string_to_2keys,
  14 DES_fcrypt, DES_crypt, DES_enc_read, DES_enc_write - DES encryption
  15
  16 =head1 SYNOPSIS
  17
  18  #include <openssl/des.h>
  19
  20  void DES_random_key(DES_cblock *ret);
  21
  22  int DES_set_key(const_DES_cblock *key, DES_key_schedule *schedule);
  23  int DES_key_sched(const_DES_cblock *key, DES_key_schedule *schedule);
  24  int DES_set_key_checked(const_DES_cblock *key,
  25         DES_key_schedule *schedule);
  26  void DES_set_key_unchecked(const_DES_cblock *key,
  27         DES_key_schedule *schedule);
  28
  29  void DES_set_odd_parity(DES_cblock *key);
  30  int DES_is_weak_key(const_DES_cblock *key);
  31
  32  void DES_ecb_encrypt(const_DES_cblock *input, DES_cblock *output,
  33         DES_key_schedule *ks, int enc);
  34  void DES_ecb2_encrypt(const_DES_cblock *input, DES_cblock *output,
  35         DES_key_schedule *ks1, DES_key_schedule *ks2, int enc);
  36  void DES_ecb3_encrypt(const_DES_cblock *input, DES_cblock *output,
  37         DES_key_schedule *ks1, DES_key_schedule *ks2,
  38         DES_key_schedule *ks3, int enc);
  39
  40  void DES_ncbc_encrypt(const unsigned char *input, unsigned char *output,
  41         long length, DES_key_schedule *schedule, DES_cblock *ivec,
  42         int enc);
  43  void DES_cfb_encrypt(const unsigned char *in, unsigned char *out,
  44         int numbits, long length, DES_key_schedule *schedule,
  45         DES_cblock *ivec, int enc);
  46  void DES_ofb_encrypt(const unsigned char *in, unsigned char *out,
  47         int numbits, long length, DES_key_schedule *schedule,
  48         DES_cblock *ivec);
  49  void DES_pcbc_encrypt(const unsigned char *input, unsigned char *output,
  50         long length, DES_key_schedule *schedule, DES_cblock *ivec,
  51         int enc);
  52  void DES_cfb64_encrypt(const unsigned char *in, unsigned char *out,
  53         long length, DES_key_schedule *schedule, DES_cblock *ivec,
  54         int *num, int enc);
  55  void DES_ofb64_encrypt(const unsigned char *in, unsigned char *out,
  56         long length, DES_key_schedule *schedule, DES_cblock *ivec,
  57         int *num);
  58
  59  void DES_xcbc_encrypt(const unsigned char *input, unsigned char *output,
  60         long length, DES_key_schedule *schedule, DES_cblock *ivec,
  61         const_DES_cblock *inw, const_DES_cblock *outw, int enc);
  62
  63  void DES_ede2_cbc_encrypt(const unsigned char *input,
  64         unsigned char *output, long length, DES_key_schedule *ks1,
  65         DES_key_schedule *ks2, DES_cblock *ivec, int enc);
  66  void DES_ede2_cfb64_encrypt(const unsigned char *in,
  67         unsigned char *out, long length, DES_key_schedule *ks1,
  68         DES_key_schedule *ks2, DES_cblock *ivec, int *num, int enc);
  69  void DES_ede2_ofb64_encrypt(const unsigned char *in,
  70         unsigned char *out, long length, DES_key_schedule *ks1,
  71         DES_key_schedule *ks2, DES_cblock *ivec, int *num);
  72
  73  void DES_ede3_cbc_encrypt(const unsigned char *input,
  74         unsigned char *output, long length, DES_key_schedule *ks1,
  75         DES_key_schedule *ks2, DES_key_schedule *ks3, DES_cblock *ivec,
  76         int enc);
  77  void DES_ede3_cbcm_encrypt(const unsigned char *in, unsigned char *out,
  78         long length, DES_key_schedule *ks1, DES_key_schedule *ks2,
  79         DES_key_schedule *ks3, DES_cblock *ivec1, DES_cblock *ivec2,
  80         int enc);
  81  void DES_ede3_cfb64_encrypt(const unsigned char *in, unsigned char *out,
  82         long length, DES_key_schedule *ks1, DES_key_schedule *ks2,
  83         DES_key_schedule *ks3, DES_cblock *ivec, int *num, int enc);
  84  void DES_ede3_ofb64_encrypt(const unsigned char *in, unsigned char *out,
  85         long length, DES_key_schedule *ks1,
  86         DES_key_schedule *ks2, DES_key_schedule *ks3,
  87         DES_cblock *ivec, int *num);
  88
  89  int DES_read_password(DES_cblock *key, const char *prompt, int verify);
  90  int DES_read_2passwords(DES_cblock *key1, DES_cblock *key2,
  91         const char *prompt, int verify);
  92  int DES_read_pw_string(char *buf, int length, const char *prompt,
  93         int verify);
  94
  95  DES_LONG DES_cbc_cksum(const unsigned char *input, DES_cblock *output,
  96         long length, DES_key_schedule *schedule,
  97         const_DES_cblock *ivec);
  98  DES_LONG DES_quad_cksum(const unsigned char *input, DES_cblock output[],
  99         long length, int out_count, DES_cblock *seed);
 100  void DES_string_to_key(const char *str, DES_cblock *key);
 101  void DES_string_to_2keys(const char *str, DES_cblock *key1,
 102         DES_cblock *key2);
 103
 104  char *DES_fcrypt(const char *buf, const char *salt, char *ret);
 105  char *DES_crypt(const char *buf, const char *salt);
 106
 107  int DES_enc_read(int fd, void *buf, int len, DES_key_schedule *sched,
 108         DES_cblock *iv);
 109  int DES_enc_write(int fd, const void *buf, int len,
 110         DES_key_schedule *sched, DES_cblock *iv);
 111
 112 =head1 DESCRIPTION
 113
 114 This library contains a fast implementation of the DES encryption
 115 algorithm.
 116
 117 There are two phases to the use of DES encryption.  The first is the
 118 generation of a I<DES_key_schedule> from a key, the second is the
 119 actual encryption.  A DES key is of type I<DES_cblock>. This type is
 120 consists of 8 bytes with odd parity.  The least significant bit in
 121 each byte is the parity bit.  The key schedule is an expanded form of
 122 the key; it is used to speed the encryption process.
 123
 124 DES_random_key() generates a random key.  The PRNG must be seeded
 125 prior to using this function (see L<rand(3)|rand(3)>).  If the PRNG
 126 could not generate a secure key, 0 is returned.  In earlier versions
 127 of the library, DES_random_key() did not generate secure keys.
 128
 129 Before a DES key can be used, it must be converted into the
 130 architecture dependent I<DES_key_schedule> via the
 131 DES_set_key_checked() or DES_set_key_unchecked() function.
 132
 133 DES_set_key_checked() will check that the key passed is of odd parity
 134 and is not a week or semi-weak key.  If the parity is wrong, then -1
 135 is returned.  If the key is a weak key, then -2 is returned.  If an
 136 error is returned, the key schedule is not generated.
 137
 138 DES_set_key() (called DES_key_sched() in the MIT library) works like
 139 DES_set_key_checked() if the I<DES_check_key> flag is non-zero,
 140 otherwise like DES_set_key_unchecked().  These functions are available
 141 for compatibility; it is recommended to use a function that does not
 142 depend on a global variable.
 143
 144 DES_set_odd_parity() (called DES_fixup_key_parity() in the MIT
 145 library) sets the parity of the passed I<key> to odd.
 146
 147 DES_is_weak_key() returns 1 is the passed key is a weak key, 0 if it
 148 is ok.  The probability that a randomly generated key is weak is
 149 1/2^52, so it is not really worth checking for them.
 150
 151 The following routines mostly operate on an input and output stream of
 152 I<DES_cblock>s.
 153
 154 DES_ecb_encrypt() is the basic DES encryption routine that encrypts or
 155 decrypts a single 8-byte I<DES_cblock> in I<electronic code book>
 156 (ECB) mode.  It always transforms the input data, pointed to by
 157 I<input>, into the output data, pointed to by the I<output> argument.
 158 If the I<encrypt> argument is non-zero (DES_ENCRYPT), the I<input>
 159 (cleartext) is encrypted in to the I<output> (ciphertext) using the
 160 key_schedule specified by the I<schedule> argument, previously set via
 161 I<DES_set_key>. If I<encrypt> is zero (DES_DECRYPT), the I<input> (now
 162 ciphertext) is decrypted into the I<output> (now cleartext).  Input
 163 and output may overlap.  DES_ecb_encrypt() does not return a value.
 164
 165 DES_ecb3_encrypt() encrypts/decrypts the I<input> block by using
 166 three-key Triple-DES encryption in ECB mode.  This involves encrypting
 167 the input with I<ks1>, decrypting with the key schedule I<ks2>, and
 168 then encrypting with I<ks3>.  This routine greatly reduces the chances
 169 of brute force breaking of DES and has the advantage of if I<ks1>,
 170 I<ks2> and I<ks3> are the same, it is equivalent to just encryption
 171 using ECB mode and I<ks1> as the key.
 172
 173 The macro DES_ecb2_encrypt() is provided to perform two-key Triple-DES
 174 encryption by using I<ks1> for the final encryption.
 175
 176 DES_ncbc_encrypt() encrypts/decrypts using the I<cipher-block-chaining>
 177 (CBC) mode of DES.  If the I<encrypt> argument is non-zero, the
 178 routine cipher-block-chain encrypts the cleartext data pointed to by
 179 the I<input> argument into the ciphertext pointed to by the I<output>
 180 argument, using the key schedule provided by the I<schedule> argument,
 181 and initialization vector provided by the I<ivec> argument.  If the
 182 I<length> argument is not an integral multiple of eight bytes, the
 183 last block is copied to a temporary area and zero filled.  The output
 184 is always an integral multiple of eight bytes.
 185
 186 DES_xcbc_encrypt() is RSA's DESX mode of DES.  It uses I<inw> and
 187 I<outw> to 'whiten' the encryption.  I<inw> and I<outw> are secret
 188 (unlike the iv) and are as such, part of the key.  So the key is sort
 189 of 24 bytes.  This is much better than CBC DES.
 190
 191 DES_ede3_cbc_encrypt() implements outer triple CBC DES encryption with
 192 three keys. This means that each DES operation inside the CBC mode is
 193 really an C<C=E(ks3,D(ks2,E(ks1,M)))>.  This mode is used by SSL.
 194
 195 The DES_ede2_cbc_encrypt() macro implements two-key Triple-DES by
 196 reusing I<ks1> for the final encryption.  C<C=E(ks1,D(ks2,E(ks1,M)))>.
 197 This form of Triple-DES is used by the RSAREF library.
 198
 199 DES_pcbc_encrypt() encrypt/decrypts using the propagating cipher block
 200 chaining mode used by Kerberos v4. Its parameters are the same as
 201 DES_ncbc_encrypt().
 202
 203 DES_cfb_encrypt() encrypt/decrypts using cipher feedback mode.  This
 204 method 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 I<numbits>, this function is only
 209 suggested for use when sending small numbers of characters.
 210
 211 DES_cfb64_encrypt()
 212 implements CFB mode of DES with 64bit feedback.  Why is this
 213 useful you ask?  Because this routine will allow you to encrypt an
 214 arbitrary number of bytes, no 8 byte padding.  Each call to this
 215 routine will encrypt the input bytes to output and then update ivec
 216 and num.  num contains 'how far' we are though ivec.  If this does
 217 not make much sense, read more about cfb mode of DES :-).
 218
 219 DES_ede3_cfb64_encrypt() and DES_ede2_cfb64_encrypt() is the same as
 220 DES_cfb64_encrypt() except that Triple-DES is used.
 221
 222 DES_ofb_encrypt() encrypts using output feedback mode.  This method
 223 takes an array of characters as input and outputs and array of
 224 characters.  It does not require any padding to 8 character groups.
 225 Note: the I<ivec> variable is changed and the new changed value needs to
 226 be passed to the next call to this function.  Since this function runs
 227 a complete DES ECB encryption per numbits, this function is only
 228 suggested for use when sending small numbers of characters.
 229
 230 DES_ofb64_encrypt() is the same as DES_cfb64_encrypt() using Output
 231 Feed Back mode.
 232
 233 DES_ede3_ofb64_encrypt() and DES_ede2_ofb64_encrypt() is the same as
 234 DES_ofb64_encrypt(), using Triple-DES.
 235
 236 The following functions are included in the DES library for
 237 compatibility with the MIT Kerberos library. DES_read_pw_string()
 238 is also available under the name EVP_read_pw_string().
 239
 240 DES_read_pw_string() writes the string specified by I<prompt> to
 241 standard output, turns echo off and reads in input string from the
 242 terminal.  The string is returned in I<buf>, which must have space for
 243 at least I<length> bytes.  If I<verify> is set, the user is asked for
 244 the password twice and unless the two copies match, an error is
 245 returned.  A return code of -1 indicates a system error, 1 failure due
 246 to use interaction, and 0 is success.
 247
 248 DES_read_password() does the same and converts the password to a DES
 249 key by calling DES_string_to_key(); DES_read_2password() operates in
 250 the same way as DES_read_password() except that it generates two keys
 251 by using the DES_string_to_2key() function.  DES_string_to_key() is
 252 available for backward compatibility with the MIT library.  New
 253 applications should use a cryptographic hash function.  The same
 254 applies for DES_string_to_2key().
 255
 256 DES_cbc_cksum() produces an 8 byte checksum based on the input stream
 257 (via CBC encryption).  The last 4 bytes of the checksum are returned
 258 and the complete 8 bytes are placed in I<output>. This function is
 259 used by Kerberos v4.  Other applications should use
 260 L<EVP_DigestInit(3)|EVP_DigestInit(3)> etc. instead.
 261
 262 DES_quad_cksum() is a Kerberos v4 function.  It returns a 4 byte
 263 checksum from the input bytes.  The algorithm can be iterated over the
 264 input, depending on I<out_count>, 1, 2, 3 or 4 times.  If I<output> is
 265 non-NULL, the 8 bytes generated by each pass are written into
 266 I<output>.
 267
 268 The following are DES-based transformations:
 269
 270 DES_fcrypt() is a fast version of the Unix crypt(3) function.  This
 271 version takes only a small amount of space relative to other fast
 272 crypt() implementations.  This is different to the normal crypt in
 273 that the third parameter is the buffer that the return value is
 274 written into.  It needs to be at least 14 bytes long.  This function
 275 is thread safe, unlike the normal crypt.
 276
 277 DES_crypt() is a faster replacement for the normal system crypt().
 278 This function calls DES_fcrypt() with a static array passed as the
 279 third parameter.  This emulates the normal non-thread safe semantics
 280 of crypt(3).
 281
 282 DES_enc_write() writes I<len> bytes to file descriptor I<fd> from
 283 buffer I<buf>. The data is encrypted via I<pcbc_encrypt> (default)
 284 using I<sched> for the key and I<iv> as a starting vector.  The actual
 285 data send down I<fd> consists of 4 bytes (in network byte order)
 286 containing the length of the following encrypted data.  The encrypted
 287 data then follows, padded with random data out to a multiple of 8
 288 bytes.
 289
 290 DES_enc_read() is used to read I<len> bytes from file descriptor
 291 I<fd> into buffer I<buf>. The data being read from I<fd> is assumed to
 292 have come from DES_enc_write() and is decrypted using I<sched> for
 293 the key schedule and I<iv> for the initial vector.
 294
 295 B<Warning:> The data format used by DES_enc_write() and DES_enc_read()
 296 has a cryptographic weakness: When asked to write more than MAXWRITE
 297 bytes, DES_enc_write() will split the data into several chunks that
 298 are all encrypted using the same IV.  So don't use these functions
 299 unless you are sure you know what you do (in which case you might not
 300 want to use them anyway).  They cannot handle non-blocking sockets.
 301 DES_enc_read() uses an internal state and thus cannot be used on
 302 multiple files.
 303
 304 I<DES_rw_mode> is used to specify the encryption mode to use with
 305 DES_enc_read() and DES_end_write().  If set to I<DES_PCBC_MODE> (the
 306 default), DES_pcbc_encrypt is used.  If set to I<DES_CBC_MODE>
 307 DES_cbc_encrypt is used.
 308
 309 =head1 NOTES
 310
 311 Single-key DES is insecure due to its short key size.  ECB mode is
 312 not suitable for most applications; see L<DES_modes(7)|DES_modes(7)>.
 313
 314 The L<evp(3)|evp(3)> library provides higher-level encryption functions.
 315
 316 =head1 BUGS
 317
 318 DES_3cbc_encrypt() is flawed and must not be used in applications.
 319
 320 DES_cbc_encrypt() does not modify B<ivec>; use DES_ncbc_encrypt()
 321 instead.
 322
 323 DES_cfb_encrypt() and DES_ofb_encrypt() operates on input of 8 bits.
 324 What this means is that if you set numbits to 12, and length to 2, the
 325 first 12 bits will come from the 1st input byte and the low half of
 326 the second input byte.  The second 12 bits will have the low 8 bits
 327 taken from the 3rd input byte and the top 4 bits taken from the 4th
 328 input byte.  The same holds for output.  This function has been
 329 implemented this way because most people will be using a multiple of 8
 330 and because once you get into pulling bytes input bytes apart things
 331 get ugly!
 332
 333 DES_read_pw_string() is the most machine/OS dependent function and
 334 normally generates the most problems when porting this code.
 335
 336 =head1 CONFORMING TO
 337
 338 ANSI X3.106
 339
 340 The B<des> library was written to be source code compatible with
 341 the MIT Kerberos library.
 342
 343 =head1 SEE ALSO
 344
 345 crypt(3), L<des_modes(7)|des_modes(7)>, L<evp(3)|evp(3)>, L<rand(3)|rand(3)>
 346
 347 =head1 HISTORY
 348
 349 In OpenSSL 0.9.7, all des_ functions were renamed to DES_ to avoid
 350 clashes with older versions of libdes.  Compatibility des_ functions
 351 are provided for a short while, as well as crypt().
 352 Declarations for these are in <openssl/des_old.h>.  des_random_seed()
 353 is were not kept as DES_ variants.  This will happen to other functions
 354 as well if they are deemed redundant (des_random_seed() just calls
 355 RAND_seed() and is present for backward compatibility only), buggy or
 356 already scheduled for removal.
 357
 358 des_cbc_cksum(), des_cbc_encrypt(), des_ecb_encrypt(),
 359 des_is_weak_key(), des_key_sched(), des_pcbc_encrypt(),
 360 des_quad_cksum(), des_random_key(), des_read_password() and
 361 des_string_to_key() are available in the MIT Kerberos library;
 362 des_check_key_parity(), des_fixup_key_parity() and des_is_weak_key()
 363 are available in newer versions of that library.
 364
 365 des_set_key_checked() and des_set_key_unchecked() were added in
 366 OpenSSL 0.9.5.
 367
 368 des_generate_random_block(), des_init_random_number_generator(),
 369 des_new_random_key(), des_set_random_generator_seed() and
 370 des_set_sequence_number() and des_rand_data() are used in newer
 371 versions of Kerberos but are not implemented here.
 372
 373 des_random_key() generated cryptographically weak random data in
 374 SSLeay and in OpenSSL prior version 0.9.5, as well as in the original
 375 MIT library.
 376
 377 =head1 AUTHOR
 378
 379 Eric Young (eay@cryptsoft.com). Modified for the OpenSSL project
 380 (http://www.openssl.org).
 381
 382 =cut