b492002435f8364c550b9ed587791af4eb648080
[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 <openssl/des.h> replaces <kerberos/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 typedef unsigned char des_cblock[8];
79 typedef /* const */ unsigned char const_des_cblock[8];
80 /* With "const", gcc 2.8.1 on Solaris thinks that des_cblock *
81  * and const_des_cblock * are incompatible pointer types.
82  * I haven't seen that warning on other systems ... I'll look
83  * what the standard says. */
84
85
86 typedef struct des_ks_struct
87         {
88         union   {
89                 des_cblock cblock;
90                 /* make sure things are correct size on machines with
91                  * 8 byte longs */
92                 DES_LONG deslong[2];
93                 } ks;
94         int weak_key;
95         } des_key_schedule[16];
96
97 #define DES_KEY_SZ      (sizeof(des_cblock))
98 #define DES_SCHEDULE_SZ (sizeof(des_key_schedule))
99
100 #define DES_ENCRYPT     1
101 #define DES_DECRYPT     0
102
103 #define DES_CBC_MODE    0
104 #define DES_PCBC_MODE   1
105
106 #define des_ecb2_encrypt(i,o,k1,k2,e) \
107         des_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))
108
109 #define des_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
110         des_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))
111
112 #define des_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
113         des_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))
114
115 #define des_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
116         des_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))
117
118 OPENSSL_EXTERN int des_check_key;       /* defaults to false */
119 OPENSSL_EXTERN int des_rw_mode;         /* defaults to DES_PCBC_MODE */
120 OPENSSL_EXTERN int des_set_weak_key_flag; /* set the weak key flag */
121
122 const char *des_options(void);
123 void des_ecb3_encrypt(const_des_cblock *input, des_cblock *output,
124                       des_key_schedule ks1,des_key_schedule ks2,
125                       des_key_schedule ks3, int enc);
126 DES_LONG des_cbc_cksum(const unsigned char *input,des_cblock *output,
127                        long length,des_key_schedule schedule,
128                        const_des_cblock *ivec);
129 /* des_cbc_encrypt does not update the IV!  Use des_ncbc_encrypt instead. */
130 void des_cbc_encrypt(const unsigned char *input,unsigned char *output,
131                      long length,des_key_schedule schedule,des_cblock *ivec,
132                      int enc);
133 void des_ncbc_encrypt(const unsigned char *input,unsigned char *output,
134                       long length,des_key_schedule schedule,des_cblock *ivec,
135                       int enc);
136 void des_xcbc_encrypt(const unsigned char *input,unsigned char *output,
137                       long length,des_key_schedule schedule,des_cblock *ivec,
138                       const_des_cblock *inw,const_des_cblock *outw,int enc);
139 void des_cfb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
140                      long length,des_key_schedule schedule,des_cblock *ivec,
141                      int enc);
142 void des_ecb_encrypt(const_des_cblock *input,des_cblock *output,
143                      des_key_schedule ks,int enc);
144 void des_encrypt(DES_LONG *data,des_key_schedule ks, int enc);
145 void des_encrypt2(DES_LONG *data,des_key_schedule ks, int enc);
146 void des_encrypt3(DES_LONG *data, des_key_schedule ks1,
147         des_key_schedule ks2, des_key_schedule ks3);
148 void des_decrypt3(DES_LONG *data, des_key_schedule ks1,
149         des_key_schedule ks2, des_key_schedule ks3);
150 void des_ede3_cbc_encrypt(const unsigned char *input,unsigned char *output, 
151                           long length,
152                           des_key_schedule ks1,des_key_schedule ks2,
153                           des_key_schedule ks3,des_cblock *ivec,int enc);
154 void des_ede3_cbcm_encrypt(const unsigned char *in,unsigned char *out,
155                            long length,
156                            des_key_schedule ks1,des_key_schedule ks2,
157                            des_key_schedule ks3,
158                            des_cblock *ivec1,des_cblock *ivec2,
159                            int enc);
160 void des_ede3_cfb64_encrypt(const unsigned char *in,unsigned char *out,
161                             long length,des_key_schedule ks1,
162                             des_key_schedule ks2,des_key_schedule ks3,
163                             des_cblock *ivec,int *num,int enc);
164 void des_ede3_ofb64_encrypt(const unsigned char *in,unsigned char *out,
165                             long length,des_key_schedule ks1,
166                             des_key_schedule ks2,des_key_schedule ks3,
167                             des_cblock *ivec,int *num);
168
169 void des_xwhite_in2out(const_des_cblock *des_key,const_des_cblock *in_white,
170                        des_cblock *out_white);
171
172 int des_enc_read(int fd,void *buf,int len,des_key_schedule sched,
173                  des_cblock *iv);
174 int des_enc_write(int fd,const void *buf,int len,des_key_schedule sched,
175                   des_cblock *iv);
176 char *des_fcrypt(const char *buf,const char *salt, char *ret);
177 char *des_crypt(const char *buf,const char *salt);
178 #if !defined(PERL5) && !defined(__FreeBSD__) && !defined(NeXT)
179 char *crypt(const char *buf,const char *salt);
180 #endif
181 void des_ofb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
182                      long length,des_key_schedule schedule,des_cblock *ivec);
183 void des_pcbc_encrypt(const unsigned char *input,unsigned char *output,
184                       long length,des_key_schedule schedule,des_cblock *ivec,
185                       int enc);
186 DES_LONG des_quad_cksum(const unsigned char *input,des_cblock output[],
187                         long length,int out_count,des_cblock *seed);
188 void des_random_seed(des_cblock *key);
189 void des_random_key(des_cblock *ret);
190 int des_read_password(des_cblock *key,const char *prompt,int verify);
191 int des_read_2passwords(des_cblock *key1,des_cblock *key2,
192                         const char *prompt,int verify);
193 int des_read_pw_string(char *buf,int length,const char *prompt,int verify);
194 void des_set_odd_parity(des_cblock *key);
195 int des_is_weak_key(const_des_cblock *key);
196 /* des_set_key (= set_key = des_key_sched = key_sched) calls
197  * des_set_key_checked if global variable des_check_key is set,
198  * des_set_key_unchecked otherwise. */
199 int des_set_key(const_des_cblock *key,des_key_schedule schedule);
200 int des_key_sched(const_des_cblock *key,des_key_schedule schedule);
201 int des_set_key_checked(const_des_cblock *key,des_key_schedule schedule);
202 void des_set_key_unchecked(const_des_cblock *key,des_key_schedule schedule);
203 void des_string_to_key(const char *str,des_cblock *key);
204 void des_string_to_2keys(const char *str,des_cblock *key1,des_cblock *key2);
205 void des_cfb64_encrypt(const unsigned char *in,unsigned char *out,long length,
206                        des_key_schedule schedule,des_cblock *ivec,int *num,
207                        int enc);
208 void des_ofb64_encrypt(const unsigned char *in,unsigned char *out,long length,
209                        des_key_schedule schedule,des_cblock *ivec,int *num);
210 int des_read_pw(char *buf,char *buff,int size,const char *prompt,int verify);
211
212 /* Extra functions from Mark Murray <mark@grondar.za> */
213 void des_cblock_print_file(const_des_cblock *cb, FILE *fp);
214
215 /* The following definitions provide compatibility with the MIT Kerberos
216  * library. The des_key_schedule structure is not binary compatible. */
217
218 #define _KERBEROS_DES_H
219
220 #define KRBDES_ENCRYPT DES_ENCRYPT
221 #define KRBDES_DECRYPT DES_DECRYPT
222
223 #ifdef KERBEROS
224 #  define ENCRYPT DES_ENCRYPT
225 #  define DECRYPT DES_DECRYPT
226 #endif
227
228 #ifndef NCOMPAT
229 #  define C_Block des_cblock
230 #  define Key_schedule des_key_schedule
231 #  define KEY_SZ DES_KEY_SZ
232 #  define string_to_key des_string_to_key
233 #  define read_pw_string des_read_pw_string
234 #  define random_key des_random_key
235 #  define pcbc_encrypt des_pcbc_encrypt
236 #  define set_key des_set_key
237 #  define key_sched des_key_sched
238 #  define ecb_encrypt des_ecb_encrypt
239 #  define cbc_encrypt des_cbc_encrypt
240 #  define ncbc_encrypt des_ncbc_encrypt
241 #  define xcbc_encrypt des_xcbc_encrypt
242 #  define cbc_cksum des_cbc_cksum
243 #  define quad_cksum des_quad_cksum
244 #endif
245
246 typedef des_key_schedule bit_64;
247 #define des_fixup_key_parity des_set_odd_parity
248 #define des_check_key_parity check_parity
249
250 #ifdef  __cplusplus
251 }
252 #endif
253
254 #endif