xref: /freebsd/sys/crypto/des/des.h (revision 23f282aa31e9b6fceacd449020e936e98d6f2298)
1 /* lib/des/des.h */
2 /* Copyright (C) 1995-1996 Eric Young (eay@mincom.oz.au)
3  * All rights reserved.
4  *
5  * This file is part of an SSL implementation written
6  * by Eric Young (eay@mincom.oz.au).
7  * The implementation was written so as to conform with Netscapes SSL
8  * specification.  This library and applications are
9  * FREE FOR COMMERCIAL AND NON-COMMERCIAL USE
10  * as long as the following conditions are aheared to.
11  *
12  * Copyright remains Eric Young's, and as such any Copyright notices in
13  * the code are not to be removed.  If this code is used in a product,
14  * Eric Young should be given attribution as the author of the parts used.
15  * This can be in the form of a textual message at program startup or
16  * in documentation (online or textual) provided with the package.
17  *
18  * Redistribution and use in source and binary forms, with or without
19  * modification, are permitted provided that the following conditions
20  * are met:
21  * 1. Redistributions of source code must retain the copyright
22  *    notice, this list of conditions and the following disclaimer.
23  * 2. Redistributions in binary form must reproduce the above copyright
24  *    notice, this list of conditions and the following disclaimer in the
25  *    documentation and/or other materials provided with the distribution.
26  * 3. All advertising materials mentioning features or use of this software
27  *    must display the following acknowledgement:
28  *    This product includes software developed by Eric Young (eay@mincom.oz.au)
29  *
30  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
31  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
34  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
35  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
36  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
37  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
38  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
39  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40  * SUCH DAMAGE.
41  *
42  * The licence and distribution terms for any publically available version or
43  * derivative of this code cannot be changed.  i.e. this code cannot simply be
44  * copied and put under another distribution licence
45  * [including the GNU Public Licence.]
46  *
47  * $FreeBSD$
48  */
49 
50 #ifndef HEADER_DES_H
51 #define	HEADER_DES_H
52 
53 #ifdef  __cplusplus
54 extern "C" {
55 #endif
56 
57 /* If this is set to 'unsigned int' on a DEC Alpha, this gives about a
58  * %20 speed up (longs are 8 bytes, int's are 4). */
59 #ifndef DES_LONG
60 #define	DES_LONG unsigned long
61 #endif
62 
63 typedef unsigned char des_cblock[8];
64 typedef struct des_ks_struct
65 	{
66 	union	{
67 		des_cblock _;
68 		/* make sure things are correct size on machines with
69 		 * 8 byte longs */
70 		DES_LONG pad[2];
71 		} ks;
72 #undef _
73 #define	_	ks._
74 	} des_key_schedule[16];
75 
76 #define	DES_KEY_SZ 	(sizeof(des_cblock))
77 #define	DES_SCHEDULE_SZ (sizeof(des_key_schedule))
78 
79 #define	DES_ENCRYPT	1
80 #define	DES_DECRYPT	0
81 
82 #define	DES_CBC_MODE	0
83 #define	DES_PCBC_MODE	1
84 
85 #define	des_ecb2_encrypt(i,o,k1,k2,e) \
86 	des_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))
87 
88 #define	des_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
89 	des_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))
90 
91 #define	des_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
92 	des_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))
93 
94 #define	des_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
95 	des_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))
96 
97 #define	C_Block des_cblock
98 #define	Key_schedule des_key_schedule
99 #ifdef KERBEROS
100 #define	ENCRYPT DES_ENCRYPT
101 #define	DECRYPT DES_DECRYPT
102 #endif
103 #define	KEY_SZ DES_KEY_SZ
104 #define	string_to_key des_string_to_key
105 #define	read_pw_string des_read_pw_string
106 #define	random_key des_random_key
107 #define	pcbc_encrypt des_pcbc_encrypt
108 #define	set_key des_set_key
109 #define	key_sched des_key_sched
110 #define	ecb_encrypt des_ecb_encrypt
111 #define	cbc_encrypt des_cbc_encrypt
112 #define	ncbc_encrypt des_ncbc_encrypt
113 #define	xcbc_encrypt des_xcbc_encrypt
114 #define	cbc_cksum des_cbc_cksum
115 #define	quad_cksum des_quad_cksum
116 
117 /* For compatibility with the MIT lib - eay 20/05/92 */
118 typedef des_key_schedule bit_64;
119 #define	des_fixup_key_parity des_set_odd_parity
120 #define	des_check_key_parity check_parity
121 
122 extern int des_check_key;	/* defaults to false */
123 extern int des_rw_mode;		/* defaults to DES_PCBC_MODE */
124 
125 /* The next line is used to disable full ANSI prototypes, if your
126  * compiler has problems with the prototypes, make sure this line always
127  * evaluates to true :-) */
128 #if defined(MSDOS) || defined(__STDC__)
129 #undef NOPROTO
130 #endif
131 #ifndef NOPROTO
132 char *des_options(void);
133 void des_ecb3_encrypt(des_cblock *input,des_cblock *output,
134 	des_key_schedule ks1,des_key_schedule ks2,
135 	des_key_schedule ks3, int enc);
136 DES_LONG des_cbc_cksum(des_cblock *input,des_cblock *output,
137 	long length,des_key_schedule schedule,des_cblock *ivec);
138 /*
139 void des_cbc_encrypt(des_cblock *input,des_cblock *output,long length,
140 	des_key_schedule schedule,des_cblock *ivec,int enc);
141 */
142 void des_cbc_encrypt(struct mbuf *, size_t, size_t,
143 	des_key_schedule schedule,des_cblock *ivec, int enc);
144 void des_ncbc_encrypt(des_cblock *input,des_cblock *output,long length,
145 	des_key_schedule schedule,des_cblock *ivec,int enc);
146 void des_xcbc_encrypt(des_cblock *input,des_cblock *output,long length,
147 	des_key_schedule schedule,des_cblock *ivec,
148 	des_cblock *inw,des_cblock *outw,int enc);
149 void des_3cbc_encrypt(des_cblock *input,des_cblock *output,long length,
150 	des_key_schedule sk1,des_key_schedule sk2,
151 	des_cblock *ivec1,des_cblock *ivec2,int enc);
152 extern void des_3cbc_process(struct mbuf *, size_t, size_t,
153 	des_key_schedule *schedule, des_cblock *ivec, int mode);
154 void des_cfb_encrypt(unsigned char *in,unsigned char *out,int numbits,
155 	long length,des_key_schedule schedule,des_cblock *ivec,int enc);
156 void des_ecb_encrypt(des_cblock *input,des_cblock *output,
157 	des_key_schedule ks,int enc);
158 void des_encrypt(DES_LONG *data,des_key_schedule ks, int enc);
159 void des_encrypt2(DES_LONG *data,des_key_schedule ks, int enc);
160 void des_ede3_cbc_encrypt(des_cblock *input, des_cblock *output,
161 	long length, des_key_schedule ks1, des_key_schedule ks2,
162 	des_key_schedule ks3, des_cblock *ivec, int enc);
163 void des_ede3_cfb64_encrypt(unsigned char *in, unsigned char *out,
164 	long length, des_key_schedule ks1, des_key_schedule ks2,
165 	des_key_schedule ks3, des_cblock *ivec, int *num, int encrypt);
166 void des_ede3_ofb64_encrypt(unsigned char *in, unsigned char *out,
167 	long length, des_key_schedule ks1, des_key_schedule ks2,
168 	des_key_schedule ks3, des_cblock *ivec, int *num);
169 
170 int des_enc_read(int fd,char *buf,int len,des_key_schedule sched,
171 	des_cblock *iv);
172 int des_enc_write(int fd,char *buf,int len,des_key_schedule sched,
173 	des_cblock *iv);
174 #ifdef PERL5
175 char *des_crypt(const char *buf,const char *salt);
176 #else
177 /* some stupid compilers complain because I have declared char instead
178  * of const char */
179 #if 1
180 char *crypt(const char *buf,const char *salt);
181 #else
182 char *crypt();
183 #endif
184 #endif
185 void des_ofb_encrypt(unsigned char *in,unsigned char *out,
186 	int numbits,long length,des_key_schedule schedule,des_cblock *ivec);
187 void des_pcbc_encrypt(des_cblock *input,des_cblock *output,long length,
188 	des_key_schedule schedule,des_cblock *ivec,int enc);
189 DES_LONG des_quad_cksum(des_cblock *input,des_cblock *output,
190 	long length,int out_count,des_cblock *seed);
191 void des_random_seed(des_cblock key);
192 void des_random_key(des_cblock ret);
193 int des_read_password(des_cblock *key,char *prompt,int verify);
194 int des_read_2passwords(des_cblock *key1,des_cblock *key2,
195 	char *prompt,int verify);
196 int des_read_pw_string(char *buf,int length,char *prompt,int verify);
197 void des_set_odd_parity(des_cblock *key);
198 int des_is_weak_key(des_cblock *key);
199 int des_set_key(des_cblock *key,des_key_schedule schedule);
200 int des_key_sched(des_cblock *key,des_key_schedule schedule);
201 void des_string_to_key(char *str,des_cblock *key);
202 void des_string_to_2keys(char *str,des_cblock *key1,des_cblock *key2);
203 void des_cfb64_encrypt(unsigned char *in, unsigned char *out, long length,
204 	des_key_schedule schedule, des_cblock *ivec, int *num, int enc);
205 void des_ofb64_encrypt(unsigned char *in, unsigned char *out, long length,
206 	des_key_schedule schedule, des_cblock *ivec, int *num);
207 
208 /* Extra functions from Mark Murray <mark@grondar.za> */
209 /*
210 void des_cblock_print_file(des_cblock *cb, FILE *fp);
211 */
212 /* The following functions are not in the normal unix build or the
213  * SSLeay build.  When using the SSLeay build, use RAND_seed()
214  * and RAND_bytes() instead. */
215 int des_new_random_key(des_cblock *key);
216 void des_init_random_number_generator(des_cblock *key);
217 void des_set_random_generator_seed(des_cblock *key);
218 void des_set_sequence_number(des_cblock new_sequence_number);
219 void des_generate_random_block(des_cblock *block);
220 
221 #else
222 
223 char *des_options();
224 void des_ecb3_encrypt();
225 DES_LONG des_cbc_cksum();
226 void des_cbc_encrypt();
227 void des_ncbc_encrypt();
228 void des_xcbc_encrypt();
229 void des_3cbc_encrypt();
230 void des_cfb_encrypt();
231 void des_ede3_cfb64_encrypt();
232 void des_ede3_ofb64_encrypt();
233 void des_ecb_encrypt();
234 void des_encrypt();
235 void des_encrypt2();
236 void des_ede3_cbc_encrypt();
237 int des_enc_read();
238 int des_enc_write();
239 #ifdef PERL5
240 char *des_crypt();
241 #else
242 char *crypt();
243 #endif
244 void des_ofb_encrypt();
245 void des_pcbc_encrypt();
246 DES_LONG des_quad_cksum();
247 void des_random_seed();
248 void des_random_key();
249 int des_read_password();
250 int des_read_2passwords();
251 int des_read_pw_string();
252 void des_set_odd_parity();
253 int des_is_weak_key();
254 int des_set_key();
255 int des_key_sched();
256 void des_string_to_key();
257 void des_string_to_2keys();
258 void des_cfb64_encrypt();
259 void des_ofb64_encrypt();
260 
261 /* Extra functions from Mark Murray <mark@grondar.za> */
262 void des_cblock_print_file();
263 /* The following functions are not in the normal unix build or the
264  * SSLeay build.  When using the SSLeay build, use RAND_seed()
265  * and RAND_bytes() instead. */
266 #ifdef FreeBSD
267 int des_new_random_key();
268 void des_init_random_number_generator();
269 void des_set_random_generator_seed();
270 void des_set_sequence_number();
271 void des_generate_random_block();
272 #endif
273 
274 #endif
275 
276 #ifdef  __cplusplus
277 }
278 #endif
279 
280 #endif
281