des.h

00001 /* crypto/des/des.h */
00002 /* Copyright (C) 1995-1997 Eric Young ([email protected])
00003  * All rights reserved.
00004  *
00005  * This package is an SSL implementation written
00006  * by Eric Young ([email protected]).
00007  * The implementation was written so as to conform with Netscapes SSL.
00008  * 
00009  * This library is free for commercial and non-commercial use as long as
00010  * the following conditions are aheared to.  The following conditions
00011  * apply to all code found in this distribution, be it the RC4, RSA,
00012  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
00013  * included with this distribution is covered by the same copyright terms
00014  * except that the holder is Tim Hudson ([email protected]).
00015  * 
00016  * Copyright remains Eric Young's, and as such any Copyright notices in
00017  * the code are not to be removed.
00018  * If this package is used in a product, Eric Young should be given attribution
00019  * as the author of the parts of the library used.
00020  * This can be in the form of a textual message at program startup or
00021  * in documentation (online or textual) provided with the package.
00022  * 
00023  * Redistribution and use in source and binary forms, with or without
00024  * modification, are permitted provided that the following conditions
00025  * are met:
00026  * 1. Redistributions of source code must retain the copyright
00027  *    notice, this list of conditions and the following disclaimer.
00028  * 2. Redistributions in binary form must reproduce the above copyright
00029  *    notice, this list of conditions and the following disclaimer in the
00030  *    documentation and/or other materials provided with the distribution.
00031  * 3. All advertising materials mentioning features or use of this software
00032  *    must display the following acknowledgement:
00033  *    "This product includes cryptographic software written by
00034  *     Eric Young ([email protected])"
00035  *    The word 'cryptographic' can be left out if the rouines from the library
00036  *    being used are not cryptographic related :-).
00037  * 4. If you include any Windows specific code (or a derivative thereof) from 
00038  *    the apps directory (application code) you must include an acknowledgement:
00039  *    "This product includes software written by Tim Hudson ([email protected])"
00040  * 
00041  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
00042  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00043  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00044  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
00045  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00046  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00047  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00048  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00049  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00050  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00051  * SUCH DAMAGE.
00052  * 
00053  * The licence and distribution terms for any publically available version or
00054  * derivative of this code cannot be changed.  i.e. this code cannot simply be
00055  * copied and put under another distribution licence
00056  * [including the GNU Public Licence.]
00057  */
00058 /*
00059  © Portions copyright (c) 2006 Nokia Corporation.  All rights reserved.
00060  */
00061 
00062 #ifndef HEADER_NEW_DES_H
00063 #define HEADER_NEW_DES_H
00064 
00065 #if (defined(__SYMBIAN32__) && !defined(SYMBIAN))
00066 #define SYMBIAN
00067 #endif
00068 
00069 #ifdef SYMBIAN
00070 #include <e32def.h>
00071 #endif
00072 #include <openssl/e_os2.h>      /* OPENSSL_EXTERN, OPENSSL_NO_DES,
00073                                    DES_LONG (via openssl/opensslconf.h */
00074                            
00075 
00076 #ifdef OPENSSL_NO_DES
00077 #error DES is disabled.
00078 #endif
00079 
00080 #ifdef OPENSSL_BUILD_SHLIBCRYPTO
00081 # undef OPENSSL_EXTERN
00082 # define OPENSSL_EXTERN OPENSSL_EXPORT
00083 #endif
00084 
00085 #ifdef  __cplusplus
00086 extern "C" {
00087 #endif
00088 
00089 typedef unsigned char DES_cblock[8];
00090 typedef /* const */ unsigned char const_DES_cblock[8];
00091 /* With "const", gcc 2.8.1 on Solaris thinks that DES_cblock *
00092  * and const_DES_cblock * are incompatible pointer types. */
00093 
00094 typedef struct DES_ks
00095     {
00096     union
00097         {
00098         DES_cblock cblock;
00099         /* make sure things are correct size on machines with
00100          * 8 byte longs */
00101         DES_LONG deslong[2];
00102         } ks[16];
00103     } DES_key_schedule;
00104 
00105 #ifndef OPENSSL_DISABLE_OLD_DES_SUPPORT
00106 # ifndef OPENSSL_ENABLE_OLD_DES_SUPPORT
00107 #  define OPENSSL_ENABLE_OLD_DES_SUPPORT
00108 # endif
00109 #endif
00110 
00111 #ifdef OPENSSL_ENABLE_OLD_DES_SUPPORT
00112 # include <openssl/des_old.h>
00113 #endif
00114 #define DES_KEY_SZ      (sizeof(DES_cblock))
00115 #define DES_SCHEDULE_SZ (sizeof(DES_key_schedule))
00116 
00117 #define DES_ENCRYPT     1
00118 #define DES_DECRYPT     0
00119 
00120 #define DES_CBC_MODE    0
00121 #define DES_PCBC_MODE   1
00122 
00123 #define DES_ecb2_encrypt(i,o,k1,k2,e) \
00124         DES_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))
00125 
00126 #define DES_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
00127         DES_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))
00128 
00129 #define DES_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
00130         DES_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))
00131 
00132 #define DES_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
00133         DES_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))
00134 #if (defined(SYMBIAN) && (defined(__WINSCW__) || defined(__WINS__)))
00135 #else
00136 OPENSSL_DECLARE_GLOBAL(int,DES_check_key);      /* defaults to false */
00137 #define DES_check_key OPENSSL_GLOBAL_REF(DES_check_key)
00138 OPENSSL_DECLARE_GLOBAL(int,DES_rw_mode);        /* defaults to DES_PCBC_MODE */
00139 #define DES_rw_mode OPENSSL_GLOBAL_REF(DES_rw_mode)
00140 #endif
00141 IMPORT_C const char *DES_options(void);
00142 IMPORT_C void DES_ecb3_encrypt(const_DES_cblock *input, DES_cblock *output,
00143                       DES_key_schedule *ks1,DES_key_schedule *ks2,
00144                       DES_key_schedule *ks3, int enc);
00145 IMPORT_C DES_LONG DES_cbc_cksum(const unsigned char *input,DES_cblock *output,
00146                        long length,DES_key_schedule *schedule,
00147                        const_DES_cblock *ivec);
00148 /* DES_cbc_encrypt does not update the IV!  Use DES_ncbc_encrypt instead. */
00149 IMPORT_C void DES_cbc_encrypt(const unsigned char *input,unsigned char *output,
00150                      long length,DES_key_schedule *schedule,DES_cblock *ivec,
00151                      int enc);
00152 IMPORT_C void DES_ncbc_encrypt(const unsigned char *input,unsigned char *output,
00153                       long length,DES_key_schedule *schedule,DES_cblock *ivec,
00154                       int enc);
00155 IMPORT_C void DES_xcbc_encrypt(const unsigned char *input,unsigned char *output,
00156                       long length,DES_key_schedule *schedule,DES_cblock *ivec,
00157                       const_DES_cblock *inw,const_DES_cblock *outw,int enc);
00158 IMPORT_C void DES_cfb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
00159                      long length,DES_key_schedule *schedule,DES_cblock *ivec,
00160                      int enc);
00161 IMPORT_C void DES_ecb_encrypt(const_DES_cblock *input,DES_cblock *output,
00162                      DES_key_schedule *ks,int enc);
00163 
00164 /*      This is the DES encryption function that gets called by just about
00165         every other DES routine in the library.  You should not use this
00166         function except to implement 'modes' of DES.  I say this because the
00167         functions that call this routine do the conversion from 'char *' to
00168         long, and this needs to be done to make sure 'non-aligned' memory
00169         access do not occur.  The characters are loaded 'little endian'.
00170         Data is a pointer to 2 unsigned long's and ks is the
00171         DES_key_schedule to use.  enc, is non zero specifies encryption,
00172         zero if decryption. */
00173 IMPORT_C void DES_encrypt1(DES_LONG *data,DES_key_schedule *ks, int enc);
00174 
00175 /*      This functions is the same as DES_encrypt1() except that the DES
00176         initial permutation (IP) and final permutation (FP) have been left
00177         out.  As for DES_encrypt1(), you should not use this function.
00178         It is used by the routines in the library that implement triple DES.
00179         IP() DES_encrypt2() DES_encrypt2() DES_encrypt2() FP() is the same
00180         as DES_encrypt1() DES_encrypt1() DES_encrypt1() except faster :-). */
00181 IMPORT_C void DES_encrypt2(DES_LONG *data,DES_key_schedule *ks, int enc);
00182 
00183 IMPORT_C void DES_encrypt3(DES_LONG *data, DES_key_schedule *ks1,
00184                   DES_key_schedule *ks2, DES_key_schedule *ks3);
00185 IMPORT_C void DES_decrypt3(DES_LONG *data, DES_key_schedule *ks1,
00186                   DES_key_schedule *ks2, DES_key_schedule *ks3);
00187 IMPORT_C void DES_ede3_cbc_encrypt(const unsigned char *input,unsigned char *output, 
00188                           long length,
00189                           DES_key_schedule *ks1,DES_key_schedule *ks2,
00190                           DES_key_schedule *ks3,DES_cblock *ivec,int enc);
00191 IMPORT_C void DES_ede3_cbcm_encrypt(const unsigned char *in,unsigned char *out,
00192                            long length,
00193                            DES_key_schedule *ks1,DES_key_schedule *ks2,
00194                            DES_key_schedule *ks3,
00195                            DES_cblock *ivec1,DES_cblock *ivec2,
00196                            int enc);
00197 IMPORT_C void DES_ede3_cfb64_encrypt(const unsigned char *in,unsigned char *out,
00198                             long length,DES_key_schedule *ks1,
00199                             DES_key_schedule *ks2,DES_key_schedule *ks3,
00200                             DES_cblock *ivec,int *num,int enc);
00201 IMPORT_C void DES_ede3_cfb_encrypt(const unsigned char *in,unsigned char *out,
00202                           int numbits,long length,DES_key_schedule *ks1,
00203                           DES_key_schedule *ks2,DES_key_schedule *ks3,
00204                           DES_cblock *ivec,int enc);
00205 IMPORT_C void DES_ede3_ofb64_encrypt(const unsigned char *in,unsigned char *out,
00206                             long length,DES_key_schedule *ks1,
00207                             DES_key_schedule *ks2,DES_key_schedule *ks3,
00208                             DES_cblock *ivec,int *num);
00209 
00210 IMPORT_C void DES_xwhite_in2out(const_DES_cblock *DES_key,const_DES_cblock *in_white,
00211                        DES_cblock *out_white);
00212 
00213 IMPORT_C int DES_enc_read(int fd,void *buf,int len,DES_key_schedule *sched,
00214                  DES_cblock *iv);
00215 IMPORT_C int DES_enc_write(int fd,const void *buf,int len,DES_key_schedule *sched,
00216                   DES_cblock *iv);
00217 IMPORT_C char *DES_fcrypt(const char *buf,const char *salt, char *ret);
00218 IMPORT_C char *DES_crypt(const char *buf,const char *salt);
00219 IMPORT_C void DES_ofb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
00220                      long length,DES_key_schedule *schedule,DES_cblock *ivec);
00221 IMPORT_C void DES_pcbc_encrypt(const unsigned char *input,unsigned char *output,
00222                       long length,DES_key_schedule *schedule,DES_cblock *ivec,
00223                       int enc);
00224 IMPORT_C DES_LONG DES_quad_cksum(const unsigned char *input,DES_cblock output[],
00225                         long length,int out_count,DES_cblock *seed);
00226 IMPORT_C int DES_random_key(DES_cblock *ret);
00227 IMPORT_C void DES_set_odd_parity(DES_cblock *key);
00228 IMPORT_C int DES_check_key_parity(const_DES_cblock *key);
00229 IMPORT_C int DES_is_weak_key(const_DES_cblock *key);
00230 /* DES_set_key (= set_key = DES_key_sched = key_sched) calls
00231  * DES_set_key_checked if global variable DES_check_key is set,
00232  * DES_set_key_unchecked otherwise. */
00233 IMPORT_C int DES_set_key(const_DES_cblock *key,DES_key_schedule *schedule);
00234 IMPORT_C int DES_key_sched(const_DES_cblock *key,DES_key_schedule *schedule);
00235 IMPORT_C int DES_set_key_checked(const_DES_cblock *key,DES_key_schedule *schedule);
00236 IMPORT_C void DES_set_key_unchecked(const_DES_cblock *key,DES_key_schedule *schedule);
00237 IMPORT_C void DES_string_to_key(const char *str,DES_cblock *key);
00238 IMPORT_C void DES_string_to_2keys(const char *str,DES_cblock *key1,DES_cblock *key2);
00239 IMPORT_C void DES_cfb64_encrypt(const unsigned char *in,unsigned char *out,long length,
00240                        DES_key_schedule *schedule,DES_cblock *ivec,int *num,
00241                        int enc);
00242 IMPORT_C void DES_ofb64_encrypt(const unsigned char *in,unsigned char *out,long length,
00243                        DES_key_schedule *schedule,DES_cblock *ivec,int *num);
00244 
00245 IMPORT_C int DES_read_password(DES_cblock *key, const char *prompt, int verify);
00246 IMPORT_C int DES_read_2passwords(DES_cblock *key1, DES_cblock *key2, const char *prompt,
00247         int verify);
00248 
00249 #define DES_fixup_key_parity DES_set_odd_parity
00250 
00251 #ifdef  __cplusplus
00252 }
00253 #endif
00254 
00255 #endif