Use OPENSSL_GLOBAL, OPENSSL_EXTERN instead of GLOBAL and EXTERN.
[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 #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 unsigned char *des_cblocks; /* Unfortunately there's no way to say that
81                                        we want a multiple of 8 */
82 typedef struct des_ks_struct
83         {
84         union   {
85                 des_cblock _;
86                 /* make sure things are correct size on machines with
87                  * 8 byte longs */
88                 DES_LONG pad[2];
89                 } ks;
90 #undef _
91 #define _       ks._
92         int weak_key;
93         } des_key_schedule[16];
94
95 #define DES_KEY_SZ      (sizeof(des_cblock))
96 #define DES_SCHEDULE_SZ (sizeof(des_key_schedule))
97
98 #define DES_ENCRYPT     1
99 #define DES_DECRYPT     0
100
101 #define DES_CBC_MODE    0
102 #define DES_PCBC_MODE   1
103
104 #define des_ecb2_encrypt(i,o,k1,k2,e) \
105         des_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))
106
107 #define des_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
108         des_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))
109
110 #define des_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
111         des_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))
112
113 #define des_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
114         des_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))
115
116 #define C_Block des_cblock
117 #define Key_schedule des_key_schedule
118 #ifdef KERBEROS
119 #define ENCRYPT DES_ENCRYPT
120 #define DECRYPT DES_DECRYPT
121 #endif
122 #define KEY_SZ DES_KEY_SZ
123 #define string_to_key des_string_to_key
124 #define read_pw_string des_read_pw_string
125 #define random_key des_random_key
126 #define pcbc_encrypt des_pcbc_encrypt
127 #define set_key des_set_key
128 #define key_sched des_key_sched
129 #define ecb_encrypt des_ecb_encrypt
130 #define cbc_encrypt des_cbc_encrypt
131 #define ncbc_encrypt des_ncbc_encrypt
132 #define xcbc_encrypt des_xcbc_encrypt
133 #define cbc_cksum des_cbc_cksum
134 #define quad_cksum des_quad_cksum
135
136 /* For compatibility with the MIT lib - eay 20/05/92 */
137 typedef des_key_schedule bit_64;
138 #define des_fixup_key_parity des_set_odd_parity
139 #define des_check_key_parity check_parity
140
141 OPENSSL_EXTERN int des_check_key;       /* defaults to false */
142 OPENSSL_EXTERN int des_rw_mode;         /* defaults to DES_PCBC_MODE */
143 OPENSSL_EXTERN int des_set_weak_key_flag; /* set the weak key flag */
144
145 const char *des_options(void);
146 void des_ecb3_encrypt(const des_cblock input, des_cblock output,
147                       des_key_schedule ks1,des_key_schedule ks2,
148                       des_key_schedule ks3, int enc);
149 DES_LONG des_cbc_cksum(const unsigned char *input,des_cblock output,
150                        long length,des_key_schedule schedule,
151                        const des_cblock ivec);
152 void des_cbc_encrypt(const unsigned char *input,unsigned char *output,
153                      long length,des_key_schedule schedule,des_cblock ivec,
154                      int enc);
155 void des_ncbc_encrypt(const unsigned char *input,unsigned char *output,
156                       long length,des_key_schedule schedule,des_cblock ivec,
157                       int enc);
158 void des_xcbc_encrypt(const unsigned char *input,unsigned char *output,
159                       long length,des_key_schedule schedule,des_cblock ivec,
160                       const des_cblock inw,const des_cblock outw,int enc);
161 void des_cfb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
162                      long length,des_key_schedule schedule,des_cblock ivec,
163                      int enc);
164 void des_ecb_encrypt(const des_cblock input,des_cblock output,
165                      des_key_schedule ks,int enc);
166 void des_encrypt(DES_LONG *data,des_key_schedule ks, int enc);
167 void des_encrypt2(DES_LONG *data,des_key_schedule ks, int enc);
168 void des_encrypt3(DES_LONG *data, des_key_schedule ks1,
169         des_key_schedule ks2, des_key_schedule ks3);
170 void des_decrypt3(DES_LONG *data, des_key_schedule ks1,
171         des_key_schedule ks2, des_key_schedule ks3);
172 void des_ede3_cbc_encrypt(const unsigned char *input,unsigned char *output, 
173                           long length,
174                           des_key_schedule ks1,des_key_schedule ks2,
175                           des_key_schedule ks3,des_cblock ivec,int enc);
176 void des_ede3_cbcm_encrypt(const unsigned char *in,unsigned char *out,
177                            long length,
178                            des_key_schedule ks1,des_key_schedule ks2,
179                            des_key_schedule ks3,
180                            des_cblock ivec1,des_cblock ivec2,
181                            int enc);
182 void des_ede3_cfb64_encrypt(const unsigned char *in,unsigned char *out,
183                             long length,des_key_schedule ks1,
184                             des_key_schedule ks2,des_key_schedule ks3,
185                             des_cblock ivec,int *num,int enc);
186 void des_ede3_ofb64_encrypt(const unsigned char *in,unsigned char *out,
187                             long length,des_key_schedule ks1,
188                             des_key_schedule ks2,des_key_schedule ks3,
189                             des_cblock ivec,int *num);
190
191 void des_xwhite_in2out(const des_cblock des_key,const des_cblock in_white,
192                        des_cblock out_white);
193
194 int des_enc_read(int fd,void *buf,int len,des_key_schedule sched,
195                  des_cblock iv);
196 int des_enc_write(int fd,const void *buf,int len,des_key_schedule sched,
197                   des_cblock iv);
198 char *des_fcrypt(const char *buf,const char *salt, char *ret);
199 #if defined(PERL5) || defined(__FreeBSD__)
200 char *des_crypt(const char *buf,const char *salt);
201 #else
202 /* some stupid compilers complain because I have declared char instead
203  * of const char */
204 #ifdef HEADER_DES_LOCL_H
205 char *crypt(const char *buf,const char *salt);
206 #else
207 char *crypt();
208 #endif
209 #endif
210 void des_ofb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
211                      long length,des_key_schedule schedule,des_cblock ivec);
212 void des_pcbc_encrypt(const unsigned char *input,unsigned char *output,
213                       long length,des_key_schedule schedule,des_cblock ivec,
214                       int enc);
215 DES_LONG des_quad_cksum(const unsigned char *input,des_cblocks output,
216                         long length,int out_count,des_cblock seed);
217 void des_random_seed(des_cblock key);
218 void des_random_key(des_cblock ret);
219 int des_read_password(des_cblock key,const char *prompt,int verify);
220 int des_read_2passwords(des_cblock key1,des_cblock key2,
221                         const char *prompt,int verify);
222 int des_read_pw_string(char *buf,int length,const char *prompt,int verify);
223 void des_set_odd_parity(des_cblock key);
224 int des_is_weak_key(const des_cblock key);
225 int des_set_key(const des_cblock key,des_key_schedule schedule);
226 int des_key_sched(const des_cblock key,des_key_schedule schedule);
227 void des_string_to_key(const char *str,des_cblock key);
228 void des_string_to_2keys(const char *str,des_cblock key1,des_cblock key2);
229 void des_cfb64_encrypt(const unsigned char *in,unsigned char *out,long length,
230                        des_key_schedule schedule,des_cblock ivec,int *num,
231                        int enc);
232 void des_ofb64_encrypt(const unsigned char *in,unsigned char *out,long length,
233                        des_key_schedule schedule,des_cblock ivec,int *num);
234 int des_read_pw(char *buf,char *buff,int size,const char *prompt,int verify);
235
236 /* Extra functions from Mark Murray <mark@grondar.za> */
237 void des_cblock_print_file(const des_cblock cb, FILE *fp);
238
239 #ifdef FreeBSD
240 /* The following functions are not in the normal unix build or the
241  * SSLeay build.  When using the SSLeay build, use RAND_seed()
242  * and RAND_bytes() instead. */
243 int des_new_random_key(des_cblock *key);
244 void des_init_random_number_generator(des_cblock *key);
245 void des_set_random_generator_seed(des_cblock *key);
246 void des_set_sequence_number(des_cblock new_sequence_number);
247 void des_generate_random_block(des_cblock *block);
248 #endif
249
250 #ifdef  __cplusplus
251 }
252 #endif
253
254 #endif