lib/libcrypto/des/des.h

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