crypto/des/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_DES_H
  60 #define HEADER_DES_H
  61
  62 #ifdef  __cplusplus
  63 extern "C" {
  64 #endif
  65
  66 #ifdef NO_DES
  67 #error DES is disabled.
  68 #endif
  69
  70 #include <stdio.h>
  71 #include <openssl/opensslconf.h> /* DES_LONG */
  72 #include <openssl/e_os2.h>      /* OPENSSL_EXTERN */
  73
  74 #ifdef VMS
  75 #undef des_init_random_number_generator
  76 #define des_init_random_number_generator des_init_random_num_generator
  77 #endif
  78
  79 typedef unsigned char des_cblock[8];
  80 typedef /* const */ unsigned char const_des_cblock[8];
  81 /* With "const", gcc 2.8.1 on Solaris thinks that des_cblock *
  82  * and const_des_cblock * are incompatible pointer types.
  83  * I haven't seen that warning on other systems ... I'll look
  84  * what the standard says. */
  85
  86
  87 typedef struct des_ks_struct
  88         {
  89         union   {
  90                 des_cblock cblock;
  91                 /* make sure things are correct size on machines with
  92                  * 8 byte longs */
  93                 DES_LONG deslong[2];
  94                 } ks;
  95         int weak_key;
  96         } des_key_schedule[16];
  97
  98 #define DES_KEY_SZ      (sizeof(des_cblock))
  99 #define DES_SCHEDULE_SZ (sizeof(des_key_schedule))
 100
 101 #define DES_ENCRYPT     1
 102 #define DES_DECRYPT     0
 103
 104 #define DES_CBC_MODE    0
 105 #define DES_PCBC_MODE   1
 106
 107 #define des_ecb2_encrypt(i,o,k1,k2,e) \
 108         des_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))
 109
 110 #define des_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
 111         des_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))
 112
 113 #define des_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
 114         des_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))
 115
 116 #define des_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
 117         des_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))
 118
 119 #define Key_schedule des_key_schedule
 120 #ifdef KERBEROS
 121 #define ENCRYPT DES_ENCRYPT
 122 #define DECRYPT DES_DECRYPT
 123 #endif
 124 #define KEY_SZ DES_KEY_SZ
 125 #define string_to_key des_string_to_key
 126 #define read_pw_string des_read_pw_string
 127 #define random_key des_random_key
 128 #define pcbc_encrypt des_pcbc_encrypt
 129 #define set_key des_set_key
 130 #define key_sched des_key_sched
 131 #define ecb_encrypt des_ecb_encrypt
 132 #define cbc_encrypt des_cbc_encrypt
 133 #define ncbc_encrypt des_ncbc_encrypt
 134 #define xcbc_encrypt des_xcbc_encrypt
 135 #define cbc_cksum des_cbc_cksum
 136 #define quad_cksum des_quad_cksum
 137
 138 /* For compatibility with the MIT lib - eay 20/05/92 */
 139 typedef des_key_schedule bit_64;
 140 #define des_fixup_key_parity des_set_odd_parity
 141 #define des_check_key_parity check_parity
 142
 143 OPENSSL_EXTERN int des_check_key;       /* defaults to false */
 144 OPENSSL_EXTERN int des_rw_mode;         /* defaults to DES_PCBC_MODE */
 145 OPENSSL_EXTERN int des_set_weak_key_flag; /* set the weak key flag */
 146
 147 const char *des_options(void);
 148 void des_ecb3_encrypt(const_des_cblock *input, des_cblock *output,
 149                       des_key_schedule ks1,des_key_schedule ks2,
 150                       des_key_schedule ks3, int enc);
 151 DES_LONG des_cbc_cksum(const unsigned char *input,des_cblock *output,
 152                        long length,des_key_schedule schedule,
 153                        const_des_cblock *ivec);
 154 /* des_cbc_encrypt does not update the IV!  Use des_ncbc_encrypt instead. */
 155 void des_cbc_encrypt(const unsigned char *input,unsigned char *output,
 156                      long length,des_key_schedule schedule,des_cblock *ivec,
 157                      int enc);
 158 void des_ncbc_encrypt(const unsigned char *input,unsigned char *output,
 159                       long length,des_key_schedule schedule,des_cblock *ivec,
 160                       int enc);
 161 void des_xcbc_encrypt(const unsigned char *input,unsigned char *output,
 162                       long length,des_key_schedule schedule,des_cblock *ivec,
 163                       const_des_cblock *inw,const_des_cblock *outw,int enc);
 164 void des_cfb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
 165                      long length,des_key_schedule schedule,des_cblock *ivec,
 166                      int enc);
 167 void des_ecb_encrypt(const_des_cblock *input,des_cblock *output,
 168                      des_key_schedule ks,int enc);
 169 void des_encrypt(DES_LONG *data,des_key_schedule ks, int enc);
 170 void des_encrypt2(DES_LONG *data,des_key_schedule ks, int enc);
 171 void des_encrypt3(DES_LONG *data, des_key_schedule ks1,
 172         des_key_schedule ks2, des_key_schedule ks3);
 173 void des_decrypt3(DES_LONG *data, des_key_schedule ks1,
 174         des_key_schedule ks2, des_key_schedule ks3);
 175 void des_ede3_cbc_encrypt(const unsigned char *input,unsigned char *output,
 176                           long length,
 177                           des_key_schedule ks1,des_key_schedule ks2,
 178                           des_key_schedule ks3,des_cblock *ivec,int enc);
 179 void des_ede3_cbcm_encrypt(const unsigned char *in,unsigned char *out,
 180                            long length,
 181                            des_key_schedule ks1,des_key_schedule ks2,
 182                            des_key_schedule ks3,
 183                            des_cblock *ivec1,des_cblock *ivec2,
 184                            int enc);
 185 void des_ede3_cfb64_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,int enc);
 189 void des_ede3_ofb64_encrypt(const unsigned char *in,unsigned char *out,
 190                             long length,des_key_schedule ks1,
 191                             des_key_schedule ks2,des_key_schedule ks3,
 192                             des_cblock *ivec,int *num);
 193
 194 void des_xwhite_in2out(const_des_cblock *des_key,const_des_cblock *in_white,
 195                        des_cblock *out_white);
 196
 197 int des_enc_read(int fd,void *buf,int len,des_key_schedule sched,
 198                  des_cblock *iv);
 199 int des_enc_write(int fd,const void *buf,int len,des_key_schedule sched,
 200                   des_cblock *iv);
 201 char *des_fcrypt(const char *buf,const char *salt, char *ret);
 202 char *des_crypt(const char *buf,const char *salt);
 203 #if !defined(PERL5) && !defined(__FreeBSD__) && !defined(NeXT)
 204 char *crypt(const char *buf,const char *salt);
 205 #endif
 206 void des_ofb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
 207                      long length,des_key_schedule schedule,des_cblock *ivec);
 208 void des_pcbc_encrypt(const unsigned char *input,unsigned char *output,
 209                       long length,des_key_schedule schedule,des_cblock *ivec,
 210                       int enc);
 211 DES_LONG des_quad_cksum(const unsigned char *input,des_cblock output[],
 212                         long length,int out_count,des_cblock *seed);
 213 void des_random_seed(des_cblock *key);
 214 void des_random_key(des_cblock *ret);
 215 int des_read_password(des_cblock *key,const char *prompt,int verify);
 216 int des_read_2passwords(des_cblock *key1,des_cblock *key2,
 217                         const char *prompt,int verify);
 218 int des_read_pw_string(char *buf,int length,const char *prompt,int verify);
 219 void des_set_odd_parity(des_cblock *key);
 220 int des_is_weak_key(const_des_cblock *key);
 221 int des_set_key(const_des_cblock *key,des_key_schedule schedule);
 222 int des_key_sched(const_des_cblock *key,des_key_schedule schedule);
 223 void des_string_to_key(const char *str,des_cblock *key);
 224 void des_string_to_2keys(const char *str,des_cblock *key1,des_cblock *key2);
 225 void des_cfb64_encrypt(const unsigned char *in,unsigned char *out,long length,
 226                        des_key_schedule schedule,des_cblock *ivec,int *num,
 227                        int enc);
 228 void des_ofb64_encrypt(const unsigned char *in,unsigned char *out,long length,
 229                        des_key_schedule schedule,des_cblock *ivec,int *num);
 230 int des_read_pw(char *buf,char *buff,int size,const char *prompt,int verify);
 231
 232 /* Extra functions from Mark Murray <mark@grondar.za> */
 233 void des_cblock_print_file(const_des_cblock *cb, FILE *fp);
 234
 235 #ifdef FreeBSD
 236 /* The following functions are not in the normal unix build or the
 237  * SSLeay build.  When using the SSLeay build, use RAND_seed()
 238  * and RAND_bytes() instead. */
 239 int des_new_random_key(des_cblock *key);
 240 void des_init_random_number_generator(des_cblock *key);
 241 void des_set_random_generator_seed(des_cblock *key);
 242 void des_set_sequence_number(des_cblock new_sequence_number);
 243 void des_generate_random_block(des_cblock *block);
 244 #endif
 245
 246 #ifdef  __cplusplus
 247 }
 248 #endif
 249
 250 #endif