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