VMS updates.
[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 #ifdef _KERBEROS_DES_H
71 #error kerberos/des.h and openssl/des.h
72 #endif
73
74 #include <stdio.h>
75 #include <openssl/opensslconf.h> /* DES_LONG */
76 #include <openssl/e_os2.h>      /* OPENSSL_EXTERN */
77
78 #ifdef VMS
79 #undef des_init_random_number_generator
80 #define des_init_random_number_generator des_init_random_num_generator
81 #endif
82
83 typedef unsigned char des_cblock[8];
84 typedef /* const */ unsigned char const_des_cblock[8];
85 /* With "const", gcc 2.8.1 on Solaris thinks that des_cblock *
86  * and const_des_cblock * are incompatible pointer types.
87  * I haven't seen that warning on other systems ... I'll look
88  * what the standard says. */
89
90
91 typedef struct des_ks_struct
92         {
93         union   {
94                 des_cblock cblock;
95                 /* make sure things are correct size on machines with
96                  * 8 byte longs */
97                 DES_LONG deslong[2];
98                 } ks;
99         int weak_key;
100         } des_key_schedule[16];
101
102 #define DES_KEY_SZ      (sizeof(des_cblock))
103 #define DES_SCHEDULE_SZ (sizeof(des_key_schedule))
104
105 #define DES_ENCRYPT     1
106 #define DES_DECRYPT     0
107
108 #define DES_CBC_MODE    0
109 #define DES_PCBC_MODE   1
110
111 #define des_ecb2_encrypt(i,o,k1,k2,e) \
112         des_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))
113
114 #define des_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
115         des_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))
116
117 #define des_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
118         des_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))
119
120 #define des_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
121         des_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))
122
123 #ifdef KERBEROS
124 #define ENCRYPT DES_ENCRYPT
125 #define DECRYPT DES_DECRYPT
126 #endif
127
128 #define KEY_SZ DES_KEY_SZ
129 #define string_to_key des_string_to_key
130 #define read_pw_string des_read_pw_string
131 #define random_key des_random_key
132 #define pcbc_encrypt des_pcbc_encrypt
133 #define set_key des_set_key
134 #define key_sched des_key_sched
135 #define ecb_encrypt des_ecb_encrypt
136 #define cbc_encrypt des_cbc_encrypt
137 #define ncbc_encrypt des_ncbc_encrypt
138 #define xcbc_encrypt des_xcbc_encrypt
139 #define cbc_cksum des_cbc_cksum
140 #define quad_cksum des_quad_cksum
141
142 /* For compatibility with the MIT lib - eay 20/05/92 */
143 typedef des_key_schedule bit_64;
144 #define des_fixup_key_parity des_set_odd_parity
145 #define des_check_key_parity check_parity
146
147 OPENSSL_EXTERN int des_check_key;       /* defaults to false */
148 OPENSSL_EXTERN int des_rw_mode;         /* defaults to DES_PCBC_MODE */
149 OPENSSL_EXTERN int des_set_weak_key_flag; /* set the weak key flag */
150
151 const char *des_options(void);
152 void des_ecb3_encrypt(const_des_cblock *input, des_cblock *output,
153                       des_key_schedule ks1,des_key_schedule ks2,
154                       des_key_schedule ks3, int enc);
155 DES_LONG des_cbc_cksum(const unsigned char *input,des_cblock *output,
156                        long length,des_key_schedule schedule,
157                        const_des_cblock *ivec);
158 /* des_cbc_encrypt does not update the IV!  Use des_ncbc_encrypt instead. */
159 void des_cbc_encrypt(const unsigned char *input,unsigned char *output,
160                      long length,des_key_schedule schedule,des_cblock *ivec,
161                      int enc);
162 void des_ncbc_encrypt(const unsigned char *input,unsigned char *output,
163                       long length,des_key_schedule schedule,des_cblock *ivec,
164                       int enc);
165 void des_xcbc_encrypt(const unsigned char *input,unsigned char *output,
166                       long length,des_key_schedule schedule,des_cblock *ivec,
167                       const_des_cblock *inw,const_des_cblock *outw,int enc);
168 void des_cfb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
169                      long length,des_key_schedule schedule,des_cblock *ivec,
170                      int enc);
171 void des_ecb_encrypt(const_des_cblock *input,des_cblock *output,
172                      des_key_schedule ks,int enc);
173 void des_encrypt(DES_LONG *data,des_key_schedule ks, int enc);
174 void des_encrypt2(DES_LONG *data,des_key_schedule ks, int enc);
175 void des_encrypt3(DES_LONG *data, des_key_schedule ks1,
176         des_key_schedule ks2, des_key_schedule ks3);
177 void des_decrypt3(DES_LONG *data, des_key_schedule ks1,
178         des_key_schedule ks2, des_key_schedule ks3);
179 void des_ede3_cbc_encrypt(const unsigned char *input,unsigned char *output, 
180                           long length,
181                           des_key_schedule ks1,des_key_schedule ks2,
182                           des_key_schedule ks3,des_cblock *ivec,int enc);
183 void des_ede3_cbcm_encrypt(const unsigned char *in,unsigned char *out,
184                            long length,
185                            des_key_schedule ks1,des_key_schedule ks2,
186                            des_key_schedule ks3,
187                            des_cblock *ivec1,des_cblock *ivec2,
188                            int enc);
189 void des_ede3_cfb64_encrypt(const unsigned char *in,unsigned char *out,
190                             long length,des_key_schedule ks1,
191                             des_key_schedule ks2,des_key_schedule ks3,
192                             des_cblock *ivec,int *num,int enc);
193 void des_ede3_ofb64_encrypt(const unsigned char *in,unsigned char *out,
194                             long length,des_key_schedule ks1,
195                             des_key_schedule ks2,des_key_schedule ks3,
196                             des_cblock *ivec,int *num);
197
198 void des_xwhite_in2out(const_des_cblock *des_key,const_des_cblock *in_white,
199                        des_cblock *out_white);
200
201 int des_enc_read(int fd,void *buf,int len,des_key_schedule sched,
202                  des_cblock *iv);
203 int des_enc_write(int fd,const void *buf,int len,des_key_schedule sched,
204                   des_cblock *iv);
205 char *des_fcrypt(const char *buf,const char *salt, char *ret);
206 char *des_crypt(const char *buf,const char *salt);
207 #if !defined(PERL5) && !defined(__FreeBSD__) && !defined(NeXT)
208 char *crypt(const char *buf,const char *salt);
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_cblock 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