295fb75ad7914a56e215ad4893133af783e02c63
[openssl.git] / crypto / des / des.org
1 /* crypto/des/des.org */
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 /* WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING 
60  *
61  * Always modify des.org since des.h is automatically generated from
62  * it during SSLeay configuration.
63  *
64  * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
65  */
66
67 #ifndef HEADER_DES_H
68 #define HEADER_DES_H
69
70 #ifdef  __cplusplus
71 extern "C" {
72 #endif
73
74 #include <stdio.h>
75
76 /* If this is set to 'unsigned int' on a DEC Alpha, this gives about a
77  * %20 speed up (longs are 8 bytes, int's are 4). */
78 #ifndef DES_LONG
79 #define DES_LONG unsigned long
80 #endif
81
82 typedef unsigned char des_cblock[8];
83 typedef unsigned char *des_cblocks; /* Unfortunately there's no way to say that
84                                        we want a multiple of 8 */
85 typedef struct des_ks_struct
86         {
87         union   {
88                 des_cblock _;
89                 /* make sure things are correct size on machines with
90                  * 8 byte longs */
91                 DES_LONG pad[2];
92                 } ks;
93 #undef _
94 #define _       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 C_Block des_cblock
120 #define Key_schedule des_key_schedule
121 #ifdef KERBEROS
122 #define ENCRYPT DES_ENCRYPT
123 #define DECRYPT DES_DECRYPT
124 #endif
125 #define KEY_SZ DES_KEY_SZ
126 #define string_to_key des_string_to_key
127 #define read_pw_string des_read_pw_string
128 #define random_key des_random_key
129 #define pcbc_encrypt des_pcbc_encrypt
130 #define set_key des_set_key
131 #define key_sched des_key_sched
132 #define ecb_encrypt des_ecb_encrypt
133 #define cbc_encrypt des_cbc_encrypt
134 #define ncbc_encrypt des_ncbc_encrypt
135 #define xcbc_encrypt des_xcbc_encrypt
136 #define cbc_cksum des_cbc_cksum
137 #define quad_cksum des_quad_cksum
138
139 /* For compatibility with the MIT lib - eay 20/05/92 */
140 typedef des_key_schedule bit_64;
141 #define des_fixup_key_parity des_set_odd_parity
142 #define des_check_key_parity check_parity
143
144 extern int des_check_key;       /* defaults to false */
145 extern int des_rw_mode;         /* defaults to DES_PCBC_MODE */
146 extern int des_set_weak_key_flag; /* set the weak key flag */
147
148 /* The next line is used to disable full ANSI prototypes, if your
149  * compiler has problems with the prototypes, make sure this line always
150  * evaluates to true :-) */
151 #if defined(MSDOS) || defined(__STDC__)
152 #undef NOPROTO
153 #endif
154 #ifndef NOPROTO
155 const char *des_options(void);
156 void des_ecb3_encrypt(const unsigned char *input,unsigned char *output,
157                       des_key_schedule ks1,des_key_schedule ks2,
158                       des_key_schedule ks3, int enc);
159 DES_LONG des_cbc_cksum(const unsigned char *input,des_cblock output,
160                        long length,des_key_schedule schedule,
161                        const des_cblock ivec);
162 void des_cbc_encrypt(const unsigned char *input,unsigned char *output,
163                      long length,des_key_schedule schedule,des_cblock ivec,
164                      int enc);
165 void des_ncbc_encrypt(const unsigned char *input,unsigned char *output,
166                       long length,des_key_schedule schedule,des_cblock ivec,
167                       int enc);
168 void des_xcbc_encrypt(const unsigned char *input,unsigned char *output,
169                       long length,des_key_schedule schedule,des_cblock ivec,
170                       const des_cblock inw,const des_cblock outw,int enc);
171 void des_cfb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
172                      long length,des_key_schedule schedule,des_cblock ivec,
173                      int enc);
174 void des_ecb_encrypt(const des_cblock input,des_cblock output,
175                      des_key_schedule ks,int enc);
176 void des_encrypt(DES_LONG *data,des_key_schedule ks, int enc);
177 void des_encrypt2(DES_LONG *data,des_key_schedule ks, int enc);
178 void des_encrypt3(DES_LONG *data, des_key_schedule ks1,
179         des_key_schedule ks2, des_key_schedule ks3);
180 void des_decrypt3(DES_LONG *data, des_key_schedule ks1,
181         des_key_schedule ks2, des_key_schedule ks3);
182 void des_ede3_cbc_encrypt(const unsigned char *input,unsigned char *output, 
183                           long length,
184                           des_key_schedule ks1,des_key_schedule ks2,
185                           des_key_schedule ks3,des_cblock ivec,int enc);
186 void des_ede3_cbcm_encrypt(const unsigned char *in,unsigned char *out,
187                            long length,
188                            des_key_schedule ks1,des_key_schedule ks2,
189                            des_key_schedule ks3,
190                            des_cblock ivec1,des_cblock ivec2,
191                            int enc);
192 void des_ede3_cfb64_encrypt(const unsigned char *in,unsigned char *out,
193                             long length,des_key_schedule ks1,
194                             des_key_schedule ks2,des_key_schedule ks3,
195                             des_cblock ivec,int *num,int enc);
196 void des_ede3_ofb64_encrypt(const unsigned char *in,unsigned char *out,
197                             long length,des_key_schedule ks1,
198                             des_key_schedule ks2,des_key_schedule ks3,
199                             des_cblock ivec,int *num);
200
201 void des_xwhite_in2out(const des_cblock des_key,const des_cblock in_white,
202                        des_cblock out_white);
203
204 int des_enc_read(int fd,char *buf,int len,des_key_schedule sched,
205                  des_cblock iv);
206 int des_enc_write(int fd,const char *buf,int len,des_key_schedule sched,
207                   des_cblock iv);
208 char *des_fcrypt(const char *buf,const char *salt, char *ret);
209 #if defined(PERL5) || defined(__FreeBSD__)
210 char *des_crypt(const char *buf,const char *salt);
211 #else
212 /* some stupid compilers complain because I have declared char instead
213  * of const char */
214 #ifdef HEADER_DES_LOCL_H
215 char *crypt(const char *buf,const char *salt);
216 #else
217 char *crypt();
218 #endif
219 #endif
220 void des_ofb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
221                      long length,des_key_schedule schedule,des_cblock ivec);
222 void des_pcbc_encrypt(const unsigned char *input,unsigned char *output,
223                       long length,des_key_schedule schedule,des_cblock ivec,
224                       int enc);
225 DES_LONG des_quad_cksum(const unsigned char *input,des_cblocks output,
226                         long length,int out_count,des_cblock seed);
227 void des_random_seed(des_cblock key);
228 void des_random_key(des_cblock ret);
229 int des_read_password(des_cblock key,const char *prompt,int verify);
230 int des_read_2passwords(des_cblock key1,des_cblock key2,
231                         const char *prompt,int verify);
232 int des_read_pw_string(char *buf,int length,const char *prompt,int verify);
233 void des_set_odd_parity(des_cblock key);
234 int des_is_weak_key(const des_cblock key);
235 int des_set_key(const des_cblock key,des_key_schedule schedule);
236 int des_key_sched(const des_cblock key,des_key_schedule schedule);
237 void des_string_to_key(const char *str,des_cblock key);
238 void des_string_to_2keys(const char *str,des_cblock key1,des_cblock key2);
239 void des_cfb64_encrypt(const unsigned char *in,unsigned char *out,long length,
240                        des_key_schedule schedule,des_cblock ivec,int *num,
241                        int enc);
242 void des_ofb64_encrypt(const unsigned char *in,unsigned char *out,long length,
243                        des_key_schedule schedule,des_cblock ivec,int *num);
244 int des_read_pw(char *buf,char *buff,int size,const char *prompt,int verify);
245
246 /* Extra functions from Mark Murray <mark@grondar.za> */
247 void des_cblock_print_file(const des_cblock cb, FILE *fp);
248 /* The following functions are not in the normal unix build or the
249  * SSLeay build.  When using the SSLeay build, use RAND_seed()
250  * and RAND_bytes() instead. */
251 int des_new_random_key(des_cblock *key);
252 void des_init_random_number_generator(des_cblock *key);
253 void des_set_random_generator_seed(des_cblock *key);
254 void des_set_sequence_number(des_cblock new_sequence_number);
255 void des_generate_random_block(des_cblock *block);
256
257 #else
258
259 char *des_options();
260 void des_ecb3_encrypt();
261 DES_LONG des_cbc_cksum();
262 void des_cbc_encrypt();
263 void des_ncbc_encrypt();
264 void des_xcbc_encrypt();
265 void des_cfb_encrypt();
266 void des_ede3_cfb64_encrypt();
267 void des_ede3_ofb64_encrypt();
268 void des_ecb_encrypt();
269 void des_encrypt();
270 void des_encrypt2();
271 void des_encrypt3();
272 void des_decrypt3();
273 void des_ede3_cbc_encrypt();
274 void des_ede3_cbcm_encrypt();
275 int des_enc_read();
276 int des_enc_write();
277 char *des_fcrypt();
278 #ifdef PERL5
279 char *des_crypt();
280 #else
281 char *crypt();
282 #endif
283 void des_ofb_encrypt();
284 void des_pcbc_encrypt();
285 DES_LONG des_quad_cksum();
286 void des_random_seed();
287 void des_random_key();
288 int des_read_password();
289 int des_read_2passwords();
290 int des_read_pw_string();
291 void des_set_odd_parity();
292 int des_is_weak_key();
293 int des_set_key();
294 int des_key_sched();
295 void des_string_to_key();
296 void des_string_to_2keys();
297 void des_cfb64_encrypt();
298 void des_ofb64_encrypt();
299 int des_read_pw();
300 void des_xwhite_in2out();
301
302 /* Extra functions from Mark Murray <mark@grondar.za> */
303 void des_cblock_print_file();
304 /* The following functions are not in the normal unix build or the
305  * SSLeay build.  When using the SSLeay build, use RAND_seed()
306  * and RAND_bytes() instead. */
307 #ifdef FreeBSD
308 int des_new_random_key();
309 void des_init_random_number_generator();
310 void des_set_random_generator_seed();
311 void des_set_sequence_number();
312 void des_generate_random_block();
313 #endif
314
315 #endif
316
317 #ifdef  __cplusplus
318 }
319 #endif
320
321 #endif