Fix strange formatting by indent
[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_NEW_DES_H
60 #define HEADER_NEW_DES_H
61
62 #include <openssl/e_os2.h>      /* OPENSSL_EXTERN, OPENSSL_NO_DES,
63                                    DES_LONG (via openssl/opensslconf.h */
64
65 #ifdef OPENSSL_NO_DES
66 #error DES is disabled.
67 #endif
68
69 #ifdef OPENSSL_BUILD_SHLIBCRYPTO
70 # undef OPENSSL_EXTERN
71 # define OPENSSL_EXTERN OPENSSL_EXPORT
72 #endif
73
74 #ifdef  __cplusplus
75 extern "C" {
76 #endif
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
83 typedef struct DES_ks
84     {
85     union
86         {
87         DES_cblock cblock;
88         /* make sure things are correct size on machines with
89          * 8 byte longs */
90         DES_LONG deslong[2];
91         } ks[16];
92     } DES_key_schedule;
93
94 #ifndef OPENSSL_DISABLE_OLD_DES_SUPPORT
95 # ifndef OPENSSL_ENABLE_OLD_DES_SUPPORT
96 #  define OPENSSL_ENABLE_OLD_DES_SUPPORT
97 # endif
98 #endif
99
100 #ifdef OPENSSL_ENABLE_OLD_DES_SUPPORT
101 # include <openssl/des_old.h>
102 #endif
103
104 #define DES_KEY_SZ      (sizeof(DES_cblock))
105 #define DES_SCHEDULE_SZ (sizeof(DES_key_schedule))
106
107 #define DES_ENCRYPT     1
108 #define DES_DECRYPT     0
109
110 #define DES_CBC_MODE    0
111 #define DES_PCBC_MODE   1
112
113 #define DES_ecb2_encrypt(i,o,k1,k2,e) \
114         DES_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))
115
116 #define DES_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
117         DES_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))
118
119 #define DES_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
120         DES_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))
121
122 #define DES_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
123         DES_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))
124
125 OPENSSL_DECLARE_GLOBAL(int,DES_check_key);      /* defaults to false */
126 #define DES_check_key OPENSSL_GLOBAL_REF(DES_check_key)
127 OPENSSL_DECLARE_GLOBAL(int,DES_rw_mode);        /* defaults to DES_PCBC_MODE */
128 #define DES_rw_mode OPENSSL_GLOBAL_REF(DES_rw_mode)
129
130 const char *DES_options(void);
131 void DES_ecb3_encrypt(const_DES_cblock *input, DES_cblock *output,
132                       DES_key_schedule *ks1,DES_key_schedule *ks2,
133                       DES_key_schedule *ks3, int enc);
134 DES_LONG DES_cbc_cksum(const unsigned char *input,DES_cblock *output,
135                        long length,DES_key_schedule *schedule,
136                        const_DES_cblock *ivec);
137 /* DES_cbc_encrypt does not update the IV!  Use DES_ncbc_encrypt instead. */
138 void DES_cbc_encrypt(const unsigned char *input,unsigned char *output,
139                      long length,DES_key_schedule *schedule,DES_cblock *ivec,
140                      int enc);
141 void DES_ncbc_encrypt(const unsigned char *input,unsigned char *output,
142                       long length,DES_key_schedule *schedule,DES_cblock *ivec,
143                       int enc);
144 void DES_xcbc_encrypt(const unsigned char *input,unsigned char *output,
145                       long length,DES_key_schedule *schedule,DES_cblock *ivec,
146                       const_DES_cblock *inw,const_DES_cblock *outw,int enc);
147 void DES_cfb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
148                      long length,DES_key_schedule *schedule,DES_cblock *ivec,
149                      int enc);
150 void DES_ecb_encrypt(const_DES_cblock *input,DES_cblock *output,
151                      DES_key_schedule *ks,int enc);
152
153 /*      This is the DES encryption function that gets called by just about
154         every other DES routine in the library.  You should not use this
155         function except to implement 'modes' of DES.  I say this because the
156         functions that call this routine do the conversion from 'char *' to
157         long, and this needs to be done to make sure 'non-aligned' memory
158         access do not occur.  The characters are loaded 'little endian'.
159         Data is a pointer to 2 unsigned long's and ks is the
160         DES_key_schedule to use.  enc, is non zero specifies encryption,
161         zero if decryption. */
162 void DES_encrypt1(DES_LONG *data,DES_key_schedule *ks, int enc);
163
164 /*      This functions is the same as DES_encrypt1() except that the DES
165         initial permutation (IP) and final permutation (FP) have been left
166         out.  As for DES_encrypt1(), you should not use this function.
167         It is used by the routines in the library that implement triple DES.
168         IP() DES_encrypt2() DES_encrypt2() DES_encrypt2() FP() is the same
169         as DES_encrypt1() DES_encrypt1() DES_encrypt1() except faster :-). */
170 void DES_encrypt2(DES_LONG *data,DES_key_schedule *ks, int enc);
171
172 void DES_encrypt3(DES_LONG *data, DES_key_schedule *ks1,
173                   DES_key_schedule *ks2, DES_key_schedule *ks3);
174 void DES_decrypt3(DES_LONG *data, DES_key_schedule *ks1,
175                   DES_key_schedule *ks2, DES_key_schedule *ks3);
176 void DES_ede3_cbc_encrypt(const unsigned char *input,unsigned char *output, 
177                           long length,
178                           DES_key_schedule *ks1,DES_key_schedule *ks2,
179                           DES_key_schedule *ks3,DES_cblock *ivec,int enc);
180 void DES_ede3_cbcm_encrypt(const unsigned char *in,unsigned char *out,
181                            long length,
182                            DES_key_schedule *ks1,DES_key_schedule *ks2,
183                            DES_key_schedule *ks3,
184                            DES_cblock *ivec1,DES_cblock *ivec2,
185                            int enc);
186 void DES_ede3_cfb64_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,int enc);
190 void DES_ede3_cfb_encrypt(const unsigned char *in,unsigned char *out,
191                           int numbits,long length,DES_key_schedule *ks1,
192                           DES_key_schedule *ks2,DES_key_schedule *ks3,
193                           DES_cblock *ivec,int enc);
194 void DES_ede3_ofb64_encrypt(const unsigned char *in,unsigned char *out,
195                             long length,DES_key_schedule *ks1,
196                             DES_key_schedule *ks2,DES_key_schedule *ks3,
197                             DES_cblock *ivec,int *num);
198 #if 0
199 void DES_xwhite_in2out(const_DES_cblock *DES_key,const_DES_cblock *in_white,
200                        DES_cblock *out_white);
201 #endif
202
203 int DES_enc_read(int fd,void *buf,int len,DES_key_schedule *sched,
204                  DES_cblock *iv);
205 int DES_enc_write(int fd,const void *buf,int len,DES_key_schedule *sched,
206                   DES_cblock *iv);
207 char *DES_fcrypt(const char *buf,const char *salt, char *ret);
208 char *DES_crypt(const char *buf,const char *salt);
209 void DES_ofb_encrypt(const unsigned char *in,unsigned char *out,int numbits,
210                      long length,DES_key_schedule *schedule,DES_cblock *ivec);
211 void DES_pcbc_encrypt(const unsigned char *input,unsigned char *output,
212                       long length,DES_key_schedule *schedule,DES_cblock *ivec,
213                       int enc);
214 DES_LONG DES_quad_cksum(const unsigned char *input,DES_cblock output[],
215                         long length,int out_count,DES_cblock *seed);
216 int DES_random_key(DES_cblock *ret);
217 void DES_set_odd_parity(DES_cblock *key);
218 int DES_check_key_parity(const_DES_cblock *key);
219 int DES_is_weak_key(const_DES_cblock *key);
220 /* DES_set_key (= set_key = DES_key_sched = key_sched) calls
221  * DES_set_key_checked if global variable DES_check_key is set,
222  * DES_set_key_unchecked otherwise. */
223 int DES_set_key(const_DES_cblock *key,DES_key_schedule *schedule);
224 int DES_key_sched(const_DES_cblock *key,DES_key_schedule *schedule);
225 int DES_set_key_checked(const_DES_cblock *key,DES_key_schedule *schedule);
226 void DES_set_key_unchecked(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
235 int DES_read_password(DES_cblock *key, const char *prompt, int verify);
236 int DES_read_2passwords(DES_cblock *key1, DES_cblock *key2, const char *prompt,
237         int verify);
238
239 #define DES_fixup_key_parity DES_set_odd_parity
240
241 #ifdef  __cplusplus
242 }
243 #endif
244
245 #endif