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