fba3d81c010a1142cf9331b1a20db6de71fbe612
[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  __cplusplus
63 extern "C" {
64 #endif
65
66 #include <stdio.h>
67 #include <openssl/opensslconf.h> /* DES_LONG */
68
69 typedef unsigned char des_cblock[8];
70 typedef unsigned char *des_cblocks; /* Unfortunately there's no way to say that
71                                        we want a multiple of 8 */
72 typedef struct des_ks_struct
73         {
74         union   {
75                 des_cblock _;
76                 /* make sure things are correct size on machines with
77                  * 8 byte longs */
78                 DES_LONG pad[2];
79                 } ks;
80 #undef _
81 #define _       ks._
82         int weak_key;
83         } des_key_schedule[16];
84
85 #define DES_KEY_SZ      (sizeof(des_cblock))
86 #define DES_SCHEDULE_SZ (sizeof(des_key_schedule))
87
88 #define DES_ENCRYPT     1
89 #define DES_DECRYPT     0
90
91 #define DES_CBC_MODE    0
92 #define DES_PCBC_MODE   1
93
94 #define des_ecb2_encrypt(i,o,k1,k2,e) \
95         des_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))
96
97 #define des_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
98         des_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))
99
100 #define des_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
101         des_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))
102
103 #define des_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
104         des_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))
105
106 #define C_Block des_cblock
107 #define Key_schedule des_key_schedule
108 #ifdef KERBEROS
109 #define ENCRYPT DES_ENCRYPT
110 #define DECRYPT DES_DECRYPT
111 #endif
112 #define KEY_SZ DES_KEY_SZ
113 #define string_to_key des_string_to_key
114 #define read_pw_string des_read_pw_string
115 #define random_key des_random_key
116 #define pcbc_encrypt des_pcbc_encrypt
117 #define set_key des_set_key
118 #define key_sched des_key_sched
119 #define ecb_encrypt des_ecb_encrypt
120 #define cbc_encrypt des_cbc_encrypt
121 #define ncbc_encrypt des_ncbc_encrypt
122 #define xcbc_encrypt des_xcbc_encrypt
123 #define cbc_cksum des_cbc_cksum
124 #define quad_cksum des_quad_cksum
125
126 /* For compatibility with the MIT lib - eay 20/05/92 */
127 typedef des_key_schedule bit_64;
128 #define des_fixup_key_parity des_set_odd_parity
129 #define des_check_key_parity check_parity
130
131 extern int des_check_key;       /* defaults to false */
132 extern int des_rw_mode;         /* defaults to DES_PCBC_MODE */
133 extern int des_set_weak_key_flag; /* set the weak key flag */
134
135 #ifndef NOPROTO
136 const char *des_options(void);
137 void des_ecb3_encrypt(const des_cblock input, des_cblock output,
138                       des_key_schedule ks1,des_key_schedule ks2,
139                       des_key_schedule ks3, int enc);
140 DES_LONG des_cbc_cksum(const unsigned char *input,des_cblock output,
141                        long length,des_key_schedule schedule,
142                        const des_cblock ivec);
143 void des_cbc_encrypt(const unsigned char *input,unsigned char *output,
144                      long length,des_key_schedule schedule,des_cblock ivec,
145                      int enc);
146 void des_ncbc_encrypt(const unsigned char *input,unsigned char *output,
147                       long length,des_key_schedule schedule,des_cblock ivec,
148                       int enc);
149 void des_xcbc_encrypt(const unsigned char *input,unsigned char *output,
150                       long length,des_key_schedule schedule,des_cblock ivec,
151                       const des_cblock inw,const des_cblock outw,int enc);
152 void des_cfb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
153                      long length,des_key_schedule schedule,des_cblock ivec,
154                      int enc);
155 void des_ecb_encrypt(const des_cblock input,des_cblock output,
156                      des_key_schedule ks,int enc);
157 void des_encrypt(DES_LONG *data,des_key_schedule ks, int enc);
158 void des_encrypt2(DES_LONG *data,des_key_schedule ks, int enc);
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 #if defined(PERL5) || defined(__FreeBSD__)
191 char *des_crypt(const char *buf,const char *salt);
192 #else
193 /* some stupid compilers complain because I have declared char instead
194  * of const char */
195 #ifdef HEADER_DES_LOCL_H
196 char *crypt(const char *buf,const char *salt);
197 #else
198 char *crypt();
199 #endif
200 #endif
201 void des_ofb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
202                      long length,des_key_schedule schedule,des_cblock ivec);
203 void des_pcbc_encrypt(const unsigned char *input,unsigned char *output,
204                       long length,des_key_schedule schedule,des_cblock ivec,
205                       int enc);
206 DES_LONG des_quad_cksum(const unsigned char *input,des_cblocks output,
207                         long length,int out_count,des_cblock seed);
208 void des_random_seed(des_cblock key);
209 void des_random_key(des_cblock ret);
210 int des_read_password(des_cblock key,const char *prompt,int verify);
211 int des_read_2passwords(des_cblock key1,des_cblock key2,
212                         const char *prompt,int verify);
213 int des_read_pw_string(char *buf,int length,const char *prompt,int verify);
214 void des_set_odd_parity(des_cblock key);
215 int des_is_weak_key(const des_cblock key);
216 int des_set_key(const des_cblock key,des_key_schedule schedule);
217 int des_key_sched(const des_cblock key,des_key_schedule schedule);
218 void des_string_to_key(const char *str,des_cblock key);
219 void des_string_to_2keys(const char *str,des_cblock key1,des_cblock key2);
220 void des_cfb64_encrypt(const unsigned char *in,unsigned char *out,long length,
221                        des_key_schedule schedule,des_cblock ivec,int *num,
222                        int enc);
223 void des_ofb64_encrypt(const unsigned char *in,unsigned char *out,long length,
224                        des_key_schedule schedule,des_cblock ivec,int *num);
225 int des_read_pw(char *buf,char *buff,int size,const char *prompt,int verify);
226
227 /* Extra functions from Mark Murray <mark@grondar.za> */
228 void des_cblock_print_file(const des_cblock cb, FILE *fp);
229 /* The following functions are not in the normal unix build or the
230  * SSLeay build.  When using the SSLeay build, use RAND_seed()
231  * and RAND_bytes() instead. */
232 int des_new_random_key(des_cblock *key);
233 void des_init_random_number_generator(des_cblock *key);
234 void des_set_random_generator_seed(des_cblock *key);
235 void des_set_sequence_number(des_cblock new_sequence_number);
236 void des_generate_random_block(des_cblock *block);
237
238 #else
239
240 char *des_options();
241 void des_ecb3_encrypt();
242 DES_LONG des_cbc_cksum();
243 void des_cbc_encrypt();
244 void des_ncbc_encrypt();
245 void des_xcbc_encrypt();
246 void des_cfb_encrypt();
247 void des_ede3_cfb64_encrypt();
248 void des_ede3_ofb64_encrypt();
249 void des_ecb_encrypt();
250 void des_encrypt();
251 void des_encrypt2();
252 void des_encrypt3();
253 void des_decrypt3();
254 void des_ede3_cbc_encrypt();
255 void des_ede3_cbcm_encrypt();
256 int des_enc_read();
257 int des_enc_write();
258 char *des_fcrypt();
259 #ifdef PERL5
260 char *des_crypt();
261 #else
262 char *crypt();
263 #endif
264 void des_ofb_encrypt();
265 void des_pcbc_encrypt();
266 DES_LONG des_quad_cksum();
267 void des_random_seed();
268 void des_random_key();
269 int des_read_password();
270 int des_read_2passwords();
271 int des_read_pw_string();
272 void des_set_odd_parity();
273 int des_is_weak_key();
274 int des_set_key();
275 int des_key_sched();
276 void des_string_to_key();
277 void des_string_to_2keys();
278 void des_cfb64_encrypt();
279 void des_ofb64_encrypt();
280 int des_read_pw();
281 void des_xwhite_in2out();
282
283 /* Extra functions from Mark Murray <mark@grondar.za> */
284 void des_cblock_print_file();
285 /* The following functions are not in the normal unix build or the
286  * SSLeay build.  When using the SSLeay build, use RAND_seed()
287  * and RAND_bytes() instead. */
288 #ifdef FreeBSD
289 int des_new_random_key();
290 void des_init_random_number_generator();
291 void des_set_random_generator_seed();
292 void des_set_sequence_number();
293 void des_generate_random_block();
294 #endif
295
296 #endif
297
298 #ifdef  __cplusplus
299 }
300 #endif
301
302 #endif