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 # define DES_LONG OSSL_DES_LONG
  70
  71 # ifdef OPENSSL_BUILD_SHLIBCRYPTO
  72 #  undef OPENSSL_EXTERN
  73 #  define OPENSSL_EXTERN OPENSSL_EXPORT
  74 # endif
  75
  76 #ifdef  __cplusplus
  77 extern "C" {
  78 #endif
  79
  80 typedef unsigned char DES_cblock[8];
  81 typedef /* const */ unsigned char const_DES_cblock[8];
  82 /*
  83  * With "const", gcc 2.8.1 on Solaris thinks that DES_cblock * and
  84  * const_DES_cblock * are incompatible pointer types.
  85  */
  86
  87 typedef struct DES_ks {
  88     union {
  89         DES_cblock cblock;
  90         /*
  91          * make sure things are correct size on machines with 8 byte longs
  92          */
  93         DES_LONG deslong[2];
  94     } ks[16];
  95 } DES_key_schedule;
  96
  97 # define DES_KEY_SZ      (sizeof(DES_cblock))
  98 # define DES_SCHEDULE_SZ (sizeof(DES_key_schedule))
  99
 100 # define DES_ENCRYPT     1
 101 # define DES_DECRYPT     0
 102
 103 # define DES_CBC_MODE    0
 104 # define DES_PCBC_MODE   1
 105
 106 # define DES_ecb2_encrypt(i,o,k1,k2,e) \
 107         DES_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))
 108
 109 # define DES_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
 110         DES_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))
 111
 112 # define DES_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
 113         DES_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))
 114
 115 # define DES_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
 116         DES_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))
 117
 118 OPENSSL_DECLARE_GLOBAL(int, DES_check_key); /* defaults to false */
 119 # define DES_check_key OPENSSL_GLOBAL_REF(DES_check_key)
 120 OPENSSL_DECLARE_GLOBAL(int, DES_rw_mode); /* defaults to DES_PCBC_MODE */
 121 # define DES_rw_mode OPENSSL_GLOBAL_REF(DES_rw_mode)
 122
 123 const char *DES_options(void);
 124 void DES_ecb3_encrypt(const_DES_cblock *input, DES_cblock *output,
 125                       DES_key_schedule *ks1, DES_key_schedule *ks2,
 126                       DES_key_schedule *ks3, int enc);
 127 DES_LONG DES_cbc_cksum(const unsigned char *input, DES_cblock *output,
 128                        long length, DES_key_schedule *schedule,
 129                        const_DES_cblock *ivec);
 130 /* DES_cbc_encrypt does not update the IV!  Use DES_ncbc_encrypt instead. */
 131 void DES_cbc_encrypt(const unsigned char *input, unsigned char *output,
 132                      long length, DES_key_schedule *schedule,
 133                      DES_cblock *ivec, int enc);
 134 void DES_ncbc_encrypt(const unsigned char *input, unsigned char *output,
 135                       long length, DES_key_schedule *schedule,
 136                       DES_cblock *ivec, int enc);
 137 void DES_xcbc_encrypt(const unsigned char *input, unsigned char *output,
 138                       long length, DES_key_schedule *schedule,
 139                       DES_cblock *ivec, const_DES_cblock *inw,
 140                       const_DES_cblock *outw, int enc);
 141 void DES_cfb_encrypt(const unsigned char *in, unsigned char *out, int numbits,
 142                      long length, DES_key_schedule *schedule,
 143                      DES_cblock *ivec, int enc);
 144 void DES_ecb_encrypt(const_DES_cblock *input, DES_cblock *output,
 145                      DES_key_schedule *ks, int enc);
 146
 147 /*
 148  * This is the DES encryption function that gets called by just about every
 149  * other DES routine in the library.  You should not use this function except
 150  * to implement 'modes' of DES.  I say this because the functions that call
 151  * this routine do the conversion from 'char *' to long, and this needs to be
 152  * done to make sure 'non-aligned' memory access do not occur.  The
 153  * characters are loaded 'little endian'. Data is a pointer to 2 unsigned
 154  * long's and ks is the DES_key_schedule to use.  enc, is non zero specifies
 155  * encryption, zero if decryption.
 156  */
 157 void DES_encrypt1(DES_LONG *data, DES_key_schedule *ks, int enc);
 158
 159 /*
 160  * This functions is the same as DES_encrypt1() except that the DES initial
 161  * permutation (IP) and final permutation (FP) have been left out.  As for
 162  * DES_encrypt1(), you should not use this function. It is used by the
 163  * routines in the library that implement triple DES. IP() DES_encrypt2()
 164  * DES_encrypt2() DES_encrypt2() FP() is the same as DES_encrypt1()
 165  * DES_encrypt1() DES_encrypt1() except faster :-).
 166  */
 167 void DES_encrypt2(DES_LONG *data, DES_key_schedule *ks, int enc);
 168
 169 void DES_encrypt3(DES_LONG *data, DES_key_schedule *ks1,
 170                   DES_key_schedule *ks2, DES_key_schedule *ks3);
 171 void DES_decrypt3(DES_LONG *data, DES_key_schedule *ks1,
 172                   DES_key_schedule *ks2, DES_key_schedule *ks3);
 173 void DES_ede3_cbc_encrypt(const unsigned char *input, unsigned char *output,
 174                           long length,
 175                           DES_key_schedule *ks1, DES_key_schedule *ks2,
 176                           DES_key_schedule *ks3, DES_cblock *ivec, int enc);
 177 void DES_ede3_cfb64_encrypt(const unsigned char *in, unsigned char *out,
 178                             long length, DES_key_schedule *ks1,
 179                             DES_key_schedule *ks2, DES_key_schedule *ks3,
 180                             DES_cblock *ivec, int *num, int enc);
 181 void DES_ede3_cfb_encrypt(const unsigned char *in, unsigned char *out,
 182                           int numbits, long length, DES_key_schedule *ks1,
 183                           DES_key_schedule *ks2, DES_key_schedule *ks3,
 184                           DES_cblock *ivec, int enc);
 185 void DES_ede3_ofb64_encrypt(const unsigned char *in, unsigned char *out,
 186                             long length, DES_key_schedule *ks1,
 187                             DES_key_schedule *ks2, DES_key_schedule *ks3,
 188                             DES_cblock *ivec, int *num);
 189 int DES_enc_read(int fd, void *buf, int len, DES_key_schedule *sched,
 190                  DES_cblock *iv);
 191 int DES_enc_write(int fd, const void *buf, int len, DES_key_schedule *sched,
 192                   DES_cblock *iv);
 193 char *DES_fcrypt(const char *buf, const char *salt, char *ret);
 194 char *DES_crypt(const char *buf, const char *salt);
 195 void DES_ofb_encrypt(const unsigned char *in, unsigned char *out, int numbits,
 196                      long length, DES_key_schedule *schedule,
 197                      DES_cblock *ivec);
 198 void DES_pcbc_encrypt(const unsigned char *input, unsigned char *output,
 199                       long length, DES_key_schedule *schedule,
 200                       DES_cblock *ivec, int enc);
 201 DES_LONG DES_quad_cksum(const unsigned char *input, DES_cblock output[],
 202                         long length, int out_count, DES_cblock *seed);
 203 int DES_random_key(DES_cblock *ret);
 204 void DES_set_odd_parity(DES_cblock *key);
 205 int DES_check_key_parity(const_DES_cblock *key);
 206 int DES_is_weak_key(const_DES_cblock *key);
 207 /*
 208  * DES_set_key (= set_key = DES_key_sched = key_sched) calls
 209  * DES_set_key_checked if global variable DES_check_key is set,
 210  * DES_set_key_unchecked otherwise.
 211  */
 212 int DES_set_key(const_DES_cblock *key, DES_key_schedule *schedule);
 213 int DES_key_sched(const_DES_cblock *key, DES_key_schedule *schedule);
 214 int DES_set_key_checked(const_DES_cblock *key, DES_key_schedule *schedule);
 215 void DES_set_key_unchecked(const_DES_cblock *key, DES_key_schedule *schedule);
 216 void DES_string_to_key(const char *str, DES_cblock *key);
 217 void DES_string_to_2keys(const char *str, DES_cblock *key1, DES_cblock *key2);
 218 void DES_cfb64_encrypt(const unsigned char *in, unsigned char *out,
 219                        long length, DES_key_schedule *schedule,
 220                        DES_cblock *ivec, int *num, int enc);
 221 void DES_ofb64_encrypt(const unsigned char *in, unsigned char *out,
 222                        long length, DES_key_schedule *schedule,
 223                        DES_cblock *ivec, int *num);
 224
 225 int DES_read_password(DES_cblock *key, const char *prompt, int verify);
 226 int DES_read_2passwords(DES_cblock *key1, DES_cblock *key2,
 227                         const char *prompt, int verify);
 228
 229 # define DES_fixup_key_parity DES_set_odd_parity
 230
 231 #ifdef  __cplusplus
 232 }
 233 #endif
 234
 235 #endif