Home | History | Annotate | Download | only in openssl
      1 /* Copyright (C) 1995-1998 Eric Young (eay (at) cryptsoft.com)
      2  * All rights reserved.
      3  *
      4  * This package is an SSL implementation written
      5  * by Eric Young (eay (at) 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 (at) 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 (at) 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 (at) 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   uint32_t subkeys[16][2];
     76 } DES_key_schedule;
     77 
     78 
     79 #define DES_KEY_SZ (sizeof(DES_cblock))
     80 #define DES_SCHEDULE_SZ (sizeof(DES_key_schedule))
     81 
     82 #define DES_ENCRYPT 1
     83 #define DES_DECRYPT 0
     84 
     85 #define DES_CBC_MODE 0
     86 #define DES_PCBC_MODE 1
     87 
     88 /* DES_set_key performs a key schedule and initialises |schedule| with |key|. */
     89 OPENSSL_EXPORT void DES_set_key(const DES_cblock *key,
     90                                 DES_key_schedule *schedule);
     91 
     92 /* DES_set_odd_parity sets the parity bits (the least-significant bits in each
     93  * byte) of |key| given the other bits in each byte. */
     94 OPENSSL_EXPORT void DES_set_odd_parity(DES_cblock *key);
     95 
     96 /* DES_ecb_encrypt encrypts (or decrypts, if |is_encrypt| is |DES_DECRYPT|) a
     97  * single DES block (8 bytes) from in to out, using the key configured in
     98  * |schedule|. */
     99 OPENSSL_EXPORT void DES_ecb_encrypt(const DES_cblock *in, DES_cblock *out,
    100                                     const DES_key_schedule *schedule,
    101                                     int is_encrypt);
    102 
    103 /* DES_ncbc_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) |len|
    104  * bytes from |in| to |out| with DES in CBC mode. */
    105 OPENSSL_EXPORT void DES_ncbc_encrypt(const uint8_t *in, uint8_t *out,
    106                                      size_t len,
    107                                      const DES_key_schedule *schedule,
    108                                      DES_cblock *ivec, int enc);
    109 
    110 /* DES_ecb3_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) a single
    111  * block (8 bytes) of data from |input| to |output| using 3DES. */
    112 OPENSSL_EXPORT void DES_ecb3_encrypt(const DES_cblock *input,
    113                                      DES_cblock *output,
    114                                      const DES_key_schedule *ks1,
    115                                      const DES_key_schedule *ks2,
    116                                      const DES_key_schedule *ks3,
    117                                      int enc);
    118 
    119 /* DES_ede3_cbc_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) |len|
    120  * bytes from |in| to |out| with 3DES in CBC mode. 3DES uses three keys, thus
    121  * the function takes three different |DES_key_schedule|s. */
    122 OPENSSL_EXPORT void DES_ede3_cbc_encrypt(const uint8_t *in, uint8_t *out,
    123                                          size_t len,
    124                                          const DES_key_schedule *ks1,
    125                                          const DES_key_schedule *ks2,
    126                                          const DES_key_schedule *ks3,
    127                                          DES_cblock *ivec, int enc);
    128 
    129 /* DES_ede2_cbc_encrypt encrypts (or decrypts, if |enc| is |DES_DECRYPT|) |len|
    130  * bytes from |in| to |out| with 3DES in CBC mode. With this keying option, the
    131  * first and third 3DES keys are identical. Thus, this function takes only two
    132  * different |DES_key_schedule|s. */
    133 OPENSSL_EXPORT void DES_ede2_cbc_encrypt(const uint8_t *in, uint8_t *out,
    134                                          size_t len,
    135                                          const DES_key_schedule *ks1,
    136                                          const DES_key_schedule *ks2,
    137                                          DES_cblock *ivec, int enc);
    138 
    139 
    140 /* Deprecated functions. */
    141 
    142 /* DES_set_key_unchecked calls |DES_set_key|. */
    143 OPENSSL_EXPORT void DES_set_key_unchecked(const DES_cblock *key,
    144                                           DES_key_schedule *schedule);
    145 
    146 OPENSSL_EXPORT void DES_ede3_cfb64_encrypt(const uint8_t *in, uint8_t *out,
    147                                            long length, DES_key_schedule *ks1,
    148                                            DES_key_schedule *ks2,
    149                                            DES_key_schedule *ks3,
    150                                            DES_cblock *ivec, int *num, int enc);
    151 
    152 OPENSSL_EXPORT void DES_ede3_cfb_encrypt(const uint8_t *in, uint8_t *out,
    153                                          int numbits, long length,
    154                                          DES_key_schedule *ks1,
    155                                          DES_key_schedule *ks2,
    156                                          DES_key_schedule *ks3,
    157                                          DES_cblock *ivec, int enc);
    158 
    159 
    160 /* Private functions.
    161  *
    162  * These functions are only exported for use in |decrepit|. */
    163 
    164 OPENSSL_EXPORT void DES_decrypt3(uint32_t *data, const DES_key_schedule *ks1,
    165                                  const DES_key_schedule *ks2,
    166                                  const DES_key_schedule *ks3);
    167 
    168 OPENSSL_EXPORT void DES_encrypt3(uint32_t *data, const DES_key_schedule *ks1,
    169                                  const DES_key_schedule *ks2,
    170                                  const DES_key_schedule *ks3);
    171 
    172 
    173 #if defined(__cplusplus)
    174 }  /* extern C */
    175 #endif
    176 
    177 #endif  /* OPENSSL_HEADER_DES_H */
    178