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