Various Win32 related fixes. Doesn't compile yet on
[openssl.git] / 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 NO_DES
63 #error DES is disabled.
64 #endif
65
66 #ifdef _KERBEROS_DES_H
67 #error <openssl/des.h> replaces <kerberos/des.h>.
68 #endif
69
70 #include <openssl/opensslconf.h> /* DES_LONG */
71 #include <openssl/e_os2.h>      /* OPENSSL_EXTERN */
72
73 #ifdef  __cplusplus
74 extern "C" {
75 #endif
76
77 typedef unsigned char des_cblock[8];
78 typedef /* const */ unsigned char const_des_cblock[8];
79 /* With "const", gcc 2.8.1 on Solaris thinks that des_cblock *
80  * and const_des_cblock * are incompatible pointer types. */
81
82 typedef struct des_ks_struct
83         {
84         union   {
85                 des_cblock cblock;
86                 /* make sure things are correct size on machines with
87                  * 8 byte longs */
88                 DES_LONG deslong[2];
89                 } ks;
90         int weak_key;
91         } des_key_schedule[16];
92
93 #define DES_KEY_SZ      (sizeof(des_cblock))
94 #define DES_SCHEDULE_SZ (sizeof(des_key_schedule))
95
96 #define DES_ENCRYPT     1
97 #define DES_DECRYPT     0
98
99 #define DES_CBC_MODE    0
100 #define DES_PCBC_MODE   1
101
102 #define des_ecb2_encrypt(i,o,k1,k2,e) \
103         des_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))
104
105 #define des_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
106         des_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))
107
108 #define des_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
109         des_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))
110
111 #define des_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
112         des_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))
113
114 OPENSSL_EXTERN int des_check_key;       /* defaults to false */
115 OPENSSL_EXTERN int des_rw_mode;         /* defaults to DES_PCBC_MODE */
116
117 const char *des_options(void);
118 void des_ecb3_encrypt(const_des_cblock *input, des_cblock *output,
119                       des_key_schedule ks1,des_key_schedule ks2,
120                       des_key_schedule ks3, int enc);
121 DES_LONG des_cbc_cksum(const unsigned char *input,des_cblock *output,
122                        long length,des_key_schedule schedule,
123                        const_des_cblock *ivec);
124 /* des_cbc_encrypt does not update the IV!  Use des_ncbc_encrypt instead. */
125 void des_cbc_encrypt(const unsigned char *input,unsigned char *output,
126                      long length,des_key_schedule schedule,des_cblock *ivec,
127                      int enc);
128 void des_ncbc_encrypt(const unsigned char *input,unsigned char *output,
129                       long length,des_key_schedule schedule,des_cblock *ivec,
130                       int enc);
131 void des_xcbc_encrypt(const unsigned char *input,unsigned char *output,
132                       long length,des_key_schedule schedule,des_cblock *ivec,
133                       const_des_cblock *inw,const_des_cblock *outw,int enc);
134 void des_cfb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
135                      long length,des_key_schedule schedule,des_cblock *ivec,
136                      int enc);
137 void des_ecb_encrypt(const_des_cblock *input,des_cblock *output,
138                      des_key_schedule ks,int enc);
139
140 /*      This is the DES encryption function that gets called by just about
141         every other DES routine in the library.  You should not use this
142         function except to implement 'modes' of DES.  I say this because the
143         functions that call this routine do the conversion from 'char *' to
144         long, and this needs to be done to make sure 'non-aligned' memory
145         access do not occur.  The characters are loaded 'little endian'.
146         Data is a pointer to 2 unsigned long's and ks is the
147         des_key_schedule to use.  enc, is non zero specifies encryption,
148         zero if decryption. */
149 void des_encrypt(DES_LONG *data,des_key_schedule ks, int enc);
150
151 /*      This functions is the same as des_encrypt() except that the DES
152         initial permutation (IP) and final permutation (FP) have been left
153         out.  As for des_encrypt(), you should not use this function.
154         It is used by the routines in the library that implement triple DES.
155         IP() des_encrypt2() des_encrypt2() des_encrypt2() FP() is the same
156         as des_encrypt() des_encrypt() des_encrypt() except faster :-). */
157 void des_encrypt2(DES_LONG *data,des_key_schedule ks, int enc);
158
159 void des_encrypt3(DES_LONG *data, des_key_schedule ks1,
160         des_key_schedule ks2, des_key_schedule ks3);
161 void des_decrypt3(DES_LONG *data, des_key_schedule ks1,
162         des_key_schedule ks2, des_key_schedule ks3);
163 void des_ede3_cbc_encrypt(const unsigned char *input,unsigned char *output, 
164                           long length,
165                           des_key_schedule ks1,des_key_schedule ks2,
166                           des_key_schedule ks3,des_cblock *ivec,int enc);
167 void des_ede3_cbcm_encrypt(const unsigned char *in,unsigned char *out,
168                            long length,
169                            des_key_schedule ks1,des_key_schedule ks2,
170                            des_key_schedule ks3,
171                            des_cblock *ivec1,des_cblock *ivec2,
172                            int enc);
173 void des_ede3_cfb64_encrypt(const unsigned char *in,unsigned char *out,
174                             long length,des_key_schedule ks1,
175                             des_key_schedule ks2,des_key_schedule ks3,
176                             des_cblock *ivec,int *num,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
182 void des_xwhite_in2out(const_des_cblock *des_key,const_des_cblock *in_white,
183                        des_cblock *out_white);
184
185 int des_enc_read(int fd,void *buf,int len,des_key_schedule sched,
186                  des_cblock *iv);
187 int des_enc_write(int fd,const void *buf,int len,des_key_schedule sched,
188                   des_cblock *iv);
189 char *des_fcrypt(const char *buf,const char *salt, char *ret);
190 char *des_crypt(const char *buf,const char *salt);
191 #if !defined(PERL5) && !defined(__FreeBSD__) && !defined(NeXT)
192 char *crypt(const char *buf,const char *salt);
193 #endif
194 void des_ofb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
195                      long length,des_key_schedule schedule,des_cblock *ivec);
196 void des_pcbc_encrypt(const unsigned char *input,unsigned char *output,
197                       long length,des_key_schedule schedule,des_cblock *ivec,
198                       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 void des_random_seed(des_cblock *key);
202 int des_random_key(des_cblock *ret);
203 int des_read_password(des_cblock *key,const char *prompt,int verify);
204 int des_read_2passwords(des_cblock *key1,des_cblock *key2,
205                         const char *prompt,int verify);
206 int des_read_pw_string(char *buf,int length,const char *prompt,int verify);
207 void des_set_odd_parity(des_cblock *key);
208 int des_check_key_parity(const_des_cblock *key);
209 int des_is_weak_key(const_des_cblock *key);
210 /* des_set_key (= set_key = des_key_sched = key_sched) calls
211  * des_set_key_checked if global variable des_check_key is set,
212  * des_set_key_unchecked otherwise. */
213 int des_set_key(const_des_cblock *key,des_key_schedule schedule);
214 int des_key_sched(const_des_cblock *key,des_key_schedule schedule);
215 int des_set_key_checked(const_des_cblock *key,des_key_schedule schedule);
216 void des_set_key_unchecked(const_des_cblock *key,des_key_schedule schedule);
217 void des_string_to_key(const char *str,des_cblock *key);
218 void des_string_to_2keys(const char *str,des_cblock *key1,des_cblock *key2);
219 void des_cfb64_encrypt(const unsigned char *in,unsigned char *out,long length,
220                        des_key_schedule schedule,des_cblock *ivec,int *num,
221                        int enc);
222 void des_ofb64_encrypt(const unsigned char *in,unsigned char *out,long length,
223                        des_key_schedule schedule,des_cblock *ivec,int *num);
224 int des_read_pw(char *buf,char *buff,int size,const char *prompt,int verify);
225
226 /* The following definitions provide compatibility with the MIT Kerberos
227  * library. The des_key_schedule structure is not binary compatible. */
228
229 #define _KERBEROS_DES_H
230
231 #define KRBDES_ENCRYPT DES_ENCRYPT
232 #define KRBDES_DECRYPT DES_DECRYPT
233
234 #ifdef KERBEROS
235 #  define ENCRYPT DES_ENCRYPT
236 #  define DECRYPT DES_DECRYPT
237 #endif
238
239 #ifndef NCOMPAT
240 #  define C_Block des_cblock
241 #  define Key_schedule des_key_schedule
242 #  define KEY_SZ DES_KEY_SZ
243 #  define string_to_key des_string_to_key
244 #  define read_pw_string des_read_pw_string
245 #  define random_key des_random_key
246 #  define pcbc_encrypt des_pcbc_encrypt
247 #  define set_key des_set_key
248 #  define key_sched des_key_sched
249 #  define ecb_encrypt des_ecb_encrypt
250 #  define cbc_encrypt des_cbc_encrypt
251 #  define ncbc_encrypt des_ncbc_encrypt
252 #  define xcbc_encrypt des_xcbc_encrypt
253 #  define cbc_cksum des_cbc_cksum
254 #  define quad_cksum des_quad_cksum
255 #  define check_parity des_check_key_parity
256 #endif
257
258 typedef des_key_schedule bit_64;
259 #define des_fixup_key_parity des_set_odd_parity
260
261 #ifdef  __cplusplus
262 }
263 #endif
264
265 #endif