include/openssl/des.h

   1 /* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.]
  56  */
  57
  58 #ifndef HEADER_DES_H
  59 # define HEADER_DES_H
  60
  61 # include <openssl/opensslconf.h>
  62
  63 # ifndef OPENSSL_NO_DES
  64 # ifdef  __cplusplus
  65 extern "C" {
  66 # endif
  67 # include <openssl/e_os2.h>
  68
  69 typedef unsigned int DES_LONG;
  70
  71 # ifdef OPENSSL_BUILD_SHLIBCRYPTO
  72 #  undef OPENSSL_EXTERN
  73 #  define OPENSSL_EXTERN OPENSSL_EXPORT
  74 # endif
  75
  76 typedef unsigned char DES_cblock[8];
  77 typedef /* const */ unsigned char const_DES_cblock[8];
  78 /*
  79  * With "const", gcc 2.8.1 on Solaris thinks that DES_cblock * and
  80  * const_DES_cblock * are incompatible pointer types.
  81  */
  82
  83 typedef struct DES_ks {
  84     union {
  85         DES_cblock cblock;
  86         /*
  87          * make sure things are correct size on machines with 8 byte longs
  88          */
  89         DES_LONG deslong[2];
  90     } ks[16];
  91 } DES_key_schedule;
  92
  93 # define DES_KEY_SZ      (sizeof(DES_cblock))
  94 # define DES_SCHEDULE_SZ (sizeof(DES_key_schedule))
  95
  96 # define DES_ENCRYPT     1
  97 # define DES_DECRYPT     0
  98
  99 # define DES_CBC_MODE    0
 100 # define DES_PCBC_MODE   1
 101
 102 # define DES_ecb2_encrypt(i,o,k1,k2,e) \
 103         DES_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))
 104
 105 # define DES_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
 106         DES_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))
 107
 108 # define DES_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
 109         DES_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))
 110
 111 # define DES_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
 112         DES_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))
 113
 114 OPENSSL_DECLARE_GLOBAL(int, DES_check_key); /* defaults to false */
 115 # define DES_check_key OPENSSL_GLOBAL_REF(DES_check_key)
 116 OPENSSL_DECLARE_GLOBAL(int, DES_rw_mode); /* defaults to DES_PCBC_MODE */
 117 # define DES_rw_mode OPENSSL_GLOBAL_REF(DES_rw_mode)
 118
 119 const char *DES_options(void);
 120 void DES_ecb3_encrypt(const_DES_cblock *input, DES_cblock *output,
 121                       DES_key_schedule *ks1, DES_key_schedule *ks2,
 122                       DES_key_schedule *ks3, int enc);
 123 DES_LONG DES_cbc_cksum(const unsigned char *input, DES_cblock *output,
 124                        long length, DES_key_schedule *schedule,
 125                        const_DES_cblock *ivec);
 126 /* DES_cbc_encrypt does not update the IV!  Use DES_ncbc_encrypt instead. */
 127 void DES_cbc_encrypt(const unsigned char *input, unsigned char *output,
 128                      long length, DES_key_schedule *schedule,
 129                      DES_cblock *ivec, int enc);
 130 void DES_ncbc_encrypt(const unsigned char *input, unsigned char *output,
 131                       long length, DES_key_schedule *schedule,
 132                       DES_cblock *ivec, int enc);
 133 void DES_xcbc_encrypt(const unsigned char *input, unsigned char *output,
 134                       long length, DES_key_schedule *schedule,
 135                       DES_cblock *ivec, const_DES_cblock *inw,
 136                       const_DES_cblock *outw, int enc);
 137 void DES_cfb_encrypt(const unsigned char *in, unsigned char *out, int numbits,
 138                      long length, DES_key_schedule *schedule,
 139                      DES_cblock *ivec, int enc);
 140 void DES_ecb_encrypt(const_DES_cblock *input, DES_cblock *output,
 141                      DES_key_schedule *ks, int enc);
 142
 143 /*
 144  * This is the DES encryption function that gets called by just about every
 145  * other DES routine in the library.  You should not use this function except
 146  * to implement 'modes' of DES.  I say this because the functions that call
 147  * this routine do the conversion from 'char *' to long, and this needs to be
 148  * done to make sure 'non-aligned' memory access do not occur.  The
 149  * characters are loaded 'little endian'. Data is a pointer to 2 unsigned
 150  * long's and ks is the DES_key_schedule to use.  enc, is non zero specifies
 151  * encryption, zero if decryption.
 152  */
 153 void DES_encrypt1(DES_LONG *data, DES_key_schedule *ks, int enc);
 154
 155 /*
 156  * This functions is the same as DES_encrypt1() except that the DES initial
 157  * permutation (IP) and final permutation (FP) have been left out.  As for
 158  * DES_encrypt1(), you should not use this function. It is used by the
 159  * routines in the library that implement triple DES. IP() DES_encrypt2()
 160  * DES_encrypt2() DES_encrypt2() FP() is the same as DES_encrypt1()
 161  * DES_encrypt1() DES_encrypt1() except faster :-).
 162  */
 163 void DES_encrypt2(DES_LONG *data, DES_key_schedule *ks, int enc);
 164
 165 void DES_encrypt3(DES_LONG *data, DES_key_schedule *ks1,
 166                   DES_key_schedule *ks2, DES_key_schedule *ks3);
 167 void DES_decrypt3(DES_LONG *data, DES_key_schedule *ks1,
 168                   DES_key_schedule *ks2, DES_key_schedule *ks3);
 169 void DES_ede3_cbc_encrypt(const unsigned char *input, unsigned char *output,
 170                           long length,
 171                           DES_key_schedule *ks1, DES_key_schedule *ks2,
 172                           DES_key_schedule *ks3, DES_cblock *ivec, int enc);
 173 void DES_ede3_cfb64_encrypt(const unsigned char *in, unsigned char *out,
 174                             long length, DES_key_schedule *ks1,
 175                             DES_key_schedule *ks2, DES_key_schedule *ks3,
 176                             DES_cblock *ivec, int *num, int enc);
 177 void DES_ede3_cfb_encrypt(const unsigned char *in, unsigned char *out,
 178                           int numbits, long length, DES_key_schedule *ks1,
 179                           DES_key_schedule *ks2, DES_key_schedule *ks3,
 180                           DES_cblock *ivec, int enc);
 181 void DES_ede3_ofb64_encrypt(const unsigned char *in, unsigned char *out,
 182                             long length, DES_key_schedule *ks1,
 183                             DES_key_schedule *ks2, DES_key_schedule *ks3,
 184                             DES_cblock *ivec, int *num);
 185 int DES_enc_read(int fd, void *buf, int len, DES_key_schedule *sched,
 186                  DES_cblock *iv);
 187 int DES_enc_write(int fd, const void *buf, int len, DES_key_schedule *sched,
 188                   DES_cblock *iv);
 189 char *DES_fcrypt(const char *buf, const char *salt, char *ret);
 190 char *DES_crypt(const char *buf, const char *salt);
 191 void DES_ofb_encrypt(const unsigned char *in, unsigned char *out, int numbits,
 192                      long length, DES_key_schedule *schedule,
 193                      DES_cblock *ivec);
 194 void DES_pcbc_encrypt(const unsigned char *input, unsigned char *output,
 195                       long length, DES_key_schedule *schedule,
 196                       DES_cblock *ivec, int enc);
 197 DES_LONG DES_quad_cksum(const unsigned char *input, DES_cblock output[],
 198                         long length, int out_count, DES_cblock *seed);
 199 int DES_random_key(DES_cblock *ret);
 200 void DES_set_odd_parity(DES_cblock *key);
 201 int DES_check_key_parity(const_DES_cblock *key);
 202 int DES_is_weak_key(const_DES_cblock *key);
 203 /*
 204  * DES_set_key (= set_key = DES_key_sched = key_sched) calls
 205  * DES_set_key_checked if global variable DES_check_key is set,
 206  * DES_set_key_unchecked otherwise.
 207  */
 208 int DES_set_key(const_DES_cblock *key, DES_key_schedule *schedule);
 209 int DES_key_sched(const_DES_cblock *key, DES_key_schedule *schedule);
 210 int DES_set_key_checked(const_DES_cblock *key, DES_key_schedule *schedule);
 211 void DES_set_key_unchecked(const_DES_cblock *key, DES_key_schedule *schedule);
 212 void DES_string_to_key(const char *str, DES_cblock *key);
 213 void DES_string_to_2keys(const char *str, DES_cblock *key1, DES_cblock *key2);
 214 void DES_cfb64_encrypt(const unsigned char *in, unsigned char *out,
 215                        long length, DES_key_schedule *schedule,
 216                        DES_cblock *ivec, int *num, int enc);
 217 void DES_ofb64_encrypt(const unsigned char *in, unsigned char *out,
 218                        long length, DES_key_schedule *schedule,
 219                        DES_cblock *ivec, int *num);
 220
 221 #ifndef OPENSSL_NO_UI
 222 int DES_read_password(DES_cblock *key, const char *prompt, int verify);
 223 int DES_read_2passwords(DES_cblock *key1, DES_cblock *key2,
 224                         const char *prompt, int verify);
 225 #endif
 226
 227 # define DES_fixup_key_parity DES_set_odd_parity
 228
 229 # ifdef  __cplusplus
 230 }
 231 # endif
 232 # endif
 233
 234 #endif