des.h revision 76870
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 * $FreeBSD: head/crypto/openssl/crypto/des/des.h 76870 2001-05-20 03:17:35Z kris $
58 */
59
60#ifndef HEADER_DES_H
61#define HEADER_DES_H
62
63#ifdef NO_DES
64#error DES is disabled.
65#endif
66
67#ifdef _KERBEROS_DES_H
68#error <openssl/des.h> replaces <kerberos/des.h>.
69#endif
70
71#include <openssl/opensslconf.h> /* DES_LONG */
72#include <openssl/e_os2.h>	/* OPENSSL_EXTERN */
73
74#ifdef  __cplusplus
75extern "C" {
76#endif
77
78typedef unsigned char des_cblock[8];
79typedef /* 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
83typedef struct des_ks_struct
84	{
85	union	{
86		des_cblock cblock;
87		/* make sure things are correct size on machines with
88		 * 8 byte longs */
89		DES_LONG deslong[2];
90		} ks;
91	int weak_key;
92	} des_key_schedule[16];
93
94#define DES_KEY_SZ 	(sizeof(des_cblock))
95#define DES_SCHEDULE_SZ (sizeof(des_key_schedule))
96
97#define DES_ENCRYPT	1
98#define DES_DECRYPT	0
99
100#define DES_CBC_MODE	0
101#define DES_PCBC_MODE	1
102
103#define des_ecb2_encrypt(i,o,k1,k2,e) \
104	des_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))
105
106#define des_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
107	des_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))
108
109#define des_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
110	des_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))
111
112#define des_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
113	des_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))
114
115OPENSSL_EXTERN int des_check_key;	/* defaults to false */
116OPENSSL_EXTERN int des_rw_mode;		/* defaults to DES_PCBC_MODE */
117OPENSSL_EXTERN int des_set_weak_key_flag; /* set the weak key flag */
118
119const char *des_options(void);
120void des_ecb3_encrypt(const_des_cblock *input, des_cblock *output,
121		      des_key_schedule ks1,des_key_schedule ks2,
122		      des_key_schedule ks3, int enc);
123DES_LONG des_cbc_cksum(const unsigned char *input,des_cblock *output,
124		       long length,des_key_schedule schedule,
125		       const_des_cblock *ivec);
126/* des_cbc_encrypt does not update the IV!  Use des_ncbc_encrypt instead. */
127void des_cbc_encrypt(const unsigned char *input,unsigned char *output,
128		     long length,des_key_schedule schedule,des_cblock *ivec,
129		     int enc);
130void des_ncbc_encrypt(const unsigned char *input,unsigned char *output,
131		      long length,des_key_schedule schedule,des_cblock *ivec,
132		      int enc);
133void des_xcbc_encrypt(const unsigned char *input,unsigned char *output,
134		      long length,des_key_schedule schedule,des_cblock *ivec,
135		      const_des_cblock *inw,const_des_cblock *outw,int enc);
136void des_cfb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
137		     long length,des_key_schedule schedule,des_cblock *ivec,
138		     int enc);
139void des_ecb_encrypt(const_des_cblock *input,des_cblock *output,
140		     des_key_schedule ks,int enc);
141
142/* 	This is the DES encryption function that gets called by just about
143	every other DES routine in the library.  You should not use this
144	function except to implement 'modes' of DES.  I say this because the
145	functions that call this routine do the conversion from 'char *' to
146	long, and this needs to be done to make sure 'non-aligned' memory
147	access do not occur.  The characters are loaded 'little endian'.
148	Data is a pointer to 2 unsigned long's and ks is the
149	des_key_schedule to use.  enc, is non zero specifies encryption,
150	zero if decryption. */
151void des_encrypt1(DES_LONG *data,des_key_schedule ks, int enc);
152
153/* 	This functions is the same as des_encrypt1() except that the DES
154	initial permutation (IP) and final permutation (FP) have been left
155	out.  As for des_encrypt1(), you should not use this function.
156	It is used by the routines in the library that implement triple DES.
157	IP() des_encrypt2() des_encrypt2() des_encrypt2() FP() is the same
158	as des_encrypt1() des_encrypt1() des_encrypt1() except faster :-). */
159void des_encrypt2(DES_LONG *data,des_key_schedule ks, int enc);
160
161void des_encrypt3(DES_LONG *data, des_key_schedule ks1,
162	des_key_schedule ks2, des_key_schedule ks3);
163void des_decrypt3(DES_LONG *data, des_key_schedule ks1,
164	des_key_schedule ks2, des_key_schedule ks3);
165void des_ede3_cbc_encrypt(const unsigned char *input,unsigned char *output,
166			  long length,
167			  des_key_schedule ks1,des_key_schedule ks2,
168			  des_key_schedule ks3,des_cblock *ivec,int enc);
169void des_ede3_cbcm_encrypt(const unsigned char *in,unsigned char *out,
170			   long length,
171			   des_key_schedule ks1,des_key_schedule ks2,
172			   des_key_schedule ks3,
173			   des_cblock *ivec1,des_cblock *ivec2,
174			   int enc);
175void des_ede3_cfb64_encrypt(const unsigned char *in,unsigned char *out,
176			    long length,des_key_schedule ks1,
177			    des_key_schedule ks2,des_key_schedule ks3,
178			    des_cblock *ivec,int *num,int enc);
179void des_ede3_ofb64_encrypt(const unsigned char *in,unsigned char *out,
180			    long length,des_key_schedule ks1,
181			    des_key_schedule ks2,des_key_schedule ks3,
182			    des_cblock *ivec,int *num);
183
184void des_xwhite_in2out(const_des_cblock *des_key,const_des_cblock *in_white,
185		       des_cblock *out_white);
186
187int des_enc_read(int fd,void *buf,int len,des_key_schedule sched,
188		 des_cblock *iv);
189int des_enc_write(int fd,const void *buf,int len,des_key_schedule sched,
190		  des_cblock *iv);
191char *des_fcrypt(const char *buf,const char *salt, char *ret);
192char *des_crypt(const char *buf,const char *salt);
193#if !defined(PERL5) && !defined(__FreeBSD__) && !defined(NeXT)
194char *crypt(const char *buf,const char *salt);
195#endif
196void des_ofb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
197		     long length,des_key_schedule schedule,des_cblock *ivec);
198void des_pcbc_encrypt(const unsigned char *input,unsigned char *output,
199		      long length,des_key_schedule schedule,des_cblock *ivec,
200		      int enc);
201DES_LONG des_quad_cksum(const unsigned char *input,des_cblock output[],
202			long length,int out_count,des_cblock *seed);
203void des_random_seed(des_cblock *key);
204int des_new_random_key(des_cblock *key);
205void des_init_random_number_generator(des_cblock *seed);
206void des_rand_data(unsigned char *data, int size);
207int des_random_key(des_cblock *ret);
208int des_read_password(des_cblock *key,const char *prompt,int verify);
209int des_read_2passwords(des_cblock *key1,des_cblock *key2,
210			const char *prompt,int verify);
211int des_read_pw_string(char *buf,int length,const char *prompt,int verify);
212void des_set_odd_parity(des_cblock *key);
213int des_check_key_parity(const_des_cblock *key);
214int des_is_weak_key(const_des_cblock *key);
215/* des_set_key (= set_key = des_key_sched = key_sched) calls
216 * des_set_key_checked if global variable des_check_key is set,
217 * des_set_key_unchecked otherwise. */
218int des_set_key(const_des_cblock *key,des_key_schedule schedule);
219int des_key_sched(const_des_cblock *key,des_key_schedule schedule);
220int des_set_key_checked(const_des_cblock *key,des_key_schedule schedule);
221void des_set_key_unchecked(const_des_cblock *key,des_key_schedule schedule);
222void des_string_to_key(const char *str,des_cblock *key);
223void des_string_to_2keys(const char *str,des_cblock *key1,des_cblock *key2);
224void des_cfb64_encrypt(const unsigned char *in,unsigned char *out,long length,
225		       des_key_schedule schedule,des_cblock *ivec,int *num,
226		       int enc);
227void des_ofb64_encrypt(const unsigned char *in,unsigned char *out,long length,
228		       des_key_schedule schedule,des_cblock *ivec,int *num);
229int des_read_pw(char *buf,char *buff,int size,const char *prompt,int verify);
230
231/* The following definitions provide compatibility with the MIT Kerberos
232 * library. The des_key_schedule structure is not binary compatible. */
233
234#define _KERBEROS_DES_H
235
236#define KRBDES_ENCRYPT DES_ENCRYPT
237#define KRBDES_DECRYPT DES_DECRYPT
238
239#ifdef KERBEROS
240#  define ENCRYPT DES_ENCRYPT
241#  define DECRYPT DES_DECRYPT
242#endif
243
244#ifndef NCOMPAT
245#  define C_Block des_cblock
246#  define Key_schedule des_key_schedule
247#  define KEY_SZ DES_KEY_SZ
248#  define string_to_key des_string_to_key
249#  define read_pw_string des_read_pw_string
250#  define random_key des_random_key
251#  define pcbc_encrypt des_pcbc_encrypt
252#  define set_key des_set_key
253#  define key_sched des_key_sched
254#  define ecb_encrypt des_ecb_encrypt
255#  define cbc_encrypt des_cbc_encrypt
256#  define ncbc_encrypt des_ncbc_encrypt
257#  define xcbc_encrypt des_xcbc_encrypt
258#  define cbc_cksum des_cbc_cksum
259#  define quad_cksum des_quad_cksum
260#  define check_parity des_check_key_parity
261#endif
262
263typedef des_key_schedule bit_64;
264#define des_fixup_key_parity des_set_odd_parity
265
266#ifdef  __cplusplus
267}
268#endif
269
270#endif
271