1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2  * All rights reserved.
3  *
4  * This package is an SSL implementation written
5  * by Eric Young (eay@cryptsoft.com).
6  * The implementation was written so as to conform with Netscapes SSL.
7  *
8  * This library is free for commercial and non-commercial use as long as
9  * the following conditions are aheared to.  The following conditions
10  * apply to all code found in this distribution, be it the RC4, RSA,
11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
12  * included with this distribution is covered by the same copyright terms
13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
14  *
15  * Copyright remains Eric Young's, and as such any Copyright notices in
16  * the code are not to be removed.
17  * If this package is used in a product, Eric Young should be given attribution
18  * as the author of the parts of the library used.
19  * This can be in the form of a textual message at program startup or
20  * in documentation (online or textual) provided with the package.
21  *
22  * Redistribution and use in source and binary forms, with or without
23  * modification, are permitted provided that the following conditions
24  * are met:
25  * 1. Redistributions of source code must retain the copyright
26  *    notice, this list of conditions and the following disclaimer.
27  * 2. Redistributions in binary form must reproduce the above copyright
28  *    notice, this list of conditions and the following disclaimer in the
29  *    documentation and/or other materials provided with the distribution.
30  * 3. All advertising materials mentioning features or use of this software
31  *    must display the following acknowledgement:
32  *    "This product includes cryptographic software written by
33  *     Eric Young (eay@cryptsoft.com)"
34  *    The word 'cryptographic' can be left out if the rouines from the library
35  *    being used are not cryptographic related :-).
36  * 4. If you include any Windows specific code (or a derivative thereof) from
37  *    the apps directory (application code) you must include an acknowledgement:
38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
39  *
40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50  * SUCH DAMAGE.
51  *
52  * The licence and distribution terms for any publically available version or
53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
54  * copied and put under another distribution licence
55  * [including the GNU Public Licence.] */
56 
57 #ifndef OPENSSL_HEADER_DES_H
58 #define OPENSSL_HEADER_DES_H
59 
60 #include <openssl/base.h>
61 
62 #if defined(__cplusplus)
63 extern "C" {
64 #endif
65 
66 
67 /* DES. */
68 
69 
70 typedef struct DES_cblock_st {
71   uint8_t bytes[8];
72 } DES_cblock;
73 
74 typedef struct DES_ks {
75   union {
76     DES_cblock cblock;
77     /* make sure things are correct size on machines with
78      * 8 byte longs */
79     uint32_t deslong[2];
80   } ks[16];
81 } DES_key_schedule;
82 
83 
84 #define DES_KEY_SZ (sizeof(DES_cblock))
85 #define DES_SCHEDULE_SZ (sizeof(DES_key_schedule))
86 
87 #define DES_ENCRYPT 1
88 #define DES_DECRYPT 0
89 
90 #define DES_CBC_MODE 0
91 #define DES_PCBC_MODE 1
92 
93 /* DES_set_key performs a key schedule and initialises |schedule| with |key|. */
94 OPENSSL_EXPORT void DES_set_key(const DES_cblock *key,
95                                 DES_key_schedule *schedule);
96 
97 /* DES_set_odd_parity sets the parity bits (the least-significant bits in each
98  * byte) of |key| given the other bits in each byte. */
99 OPENSSL_EXPORT void DES_set_odd_parity(DES_cblock *key);
100 
101 /* DES_ecb_encrypt encrypts (or decrypts, if |is_encrypt| is |DES_DECRYPT|) a
102  * single DES block (8 bytes) from in to out, using the key configured in
103  * |schedule|. */
104 OPENSSL_EXPORT void DES_ecb_encrypt(const DES_cblock *in, DES_cblock *out,
105                                     const DES_key_schedule *schedule,
106                                     int is_encrypt);
107 
108 /* DES_ncbc_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) |len|
109  * bytes from |in| to |out| with DES in CBC mode. */
110 OPENSSL_EXPORT void DES_ncbc_encrypt(const uint8_t *in, uint8_t *out,
111                                      size_t len,
112                                      const DES_key_schedule *schedule,
113                                      DES_cblock *ivec, int enc);
114 
115 /* DES_ecb3_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) a single
116  * block (8 bytes) of data from |input| to |output| using 3DES. */
117 OPENSSL_EXPORT void DES_ecb3_encrypt(const DES_cblock *input,
118                                      DES_cblock *output,
119                                      const DES_key_schedule *ks1,
120                                      const DES_key_schedule *ks2,
121                                      const DES_key_schedule *ks3,
122                                      int enc);
123 
124 /* DES_ede3_cbc_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) |len|
125  * bytes from |in| to |out| with 3DES in CBC mode. 3DES uses three keys, thus
126  * the function takes three different |DES_key_schedule|s. */
127 OPENSSL_EXPORT void DES_ede3_cbc_encrypt(const uint8_t *in, uint8_t *out,
128                                          size_t len,
129                                          const DES_key_schedule *ks1,
130                                          const DES_key_schedule *ks2,
131                                          const DES_key_schedule *ks3,
132                                          DES_cblock *ivec, int enc);
133 
134 /* DES_ede2_cbc_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) |len|
135  * bytes from |in| to |out| with 3DES in CBC mode. With this keying option, the
136  * first and third 3DES keys are identical. Thus, this function takes only two
137  * different |DES_key_schedule|s. */
138 OPENSSL_EXPORT void DES_ede2_cbc_encrypt(const uint8_t *in, uint8_t *out,
139                                          size_t len,
140                                          const DES_key_schedule *ks1,
141                                          const DES_key_schedule *ks2,
142                                          DES_cblock *ivec, int enc);
143 
144 
145 #if defined(__cplusplus)
146 }  /* extern C */
147 #endif
148 
149 #endif  /* OPENSSL_HEADER_DES_H */
150