include/openssl/des.h

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