include/openssl/des.h

   1 /*
   2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #ifndef OPENSSL_DES_H
  11 # define OPENSSL_DES_H
  12 # pragma once
  13
  14 # include <openssl/macros.h>
  15 # ifndef OPENSSL_NO_DEPRECATED_3_0
  16 #  define HEADER_DES_H
  17 # endif
  18
  19 # include <openssl/opensslconf.h>
  20
  21 # ifndef OPENSSL_NO_DES
  22 #  ifdef  __cplusplus
  23 extern "C" {
  24 #  endif
  25 #  include <openssl/e_os2.h>
  26
  27 #  ifndef OPENSSL_NO_DEPRECATED_3_0
  28 typedef unsigned int DES_LONG;
  29
  30 #   ifdef OPENSSL_BUILD_SHLIBCRYPTO
  31 #    undef OPENSSL_EXTERN
  32 #    define OPENSSL_EXTERN OPENSSL_EXPORT
  33 #   endif
  34
  35 typedef unsigned char DES_cblock[8];
  36 typedef /* const */ unsigned char const_DES_cblock[8];
  37 /*
  38  * With "const", gcc 2.8.1 on Solaris thinks that DES_cblock * and
  39  * const_DES_cblock * are incompatible pointer types.
  40  */
  41
  42 typedef struct DES_ks {
  43     union {
  44         DES_cblock cblock;
  45         /*
  46          * make sure things are correct size on machines with 8 byte longs
  47          */
  48         DES_LONG deslong[2];
  49     } ks[16];
  50 } DES_key_schedule;
  51
  52 #   define DES_KEY_SZ      (sizeof(DES_cblock))
  53 #   define DES_SCHEDULE_SZ (sizeof(DES_key_schedule))
  54
  55 #   define DES_ENCRYPT     1
  56 #   define DES_DECRYPT     0
  57
  58 #   define DES_CBC_MODE    0
  59 #   define DES_PCBC_MODE   1
  60
  61 #   define DES_ecb2_encrypt(i,o,k1,k2,e) \
  62         DES_ecb3_encrypt((i),(o),(k1),(k2),(k1),(e))
  63
  64 #   define DES_ede2_cbc_encrypt(i,o,l,k1,k2,iv,e) \
  65         DES_ede3_cbc_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(e))
  66
  67 #   define DES_ede2_cfb64_encrypt(i,o,l,k1,k2,iv,n,e) \
  68         DES_ede3_cfb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n),(e))
  69
  70 #   define DES_ede2_ofb64_encrypt(i,o,l,k1,k2,iv,n) \
  71         DES_ede3_ofb64_encrypt((i),(o),(l),(k1),(k2),(k1),(iv),(n))
  72
  73 #   define DES_fixup_key_parity DES_set_odd_parity
  74 #  endif
  75
  76 DEPRECATEDIN_3_0(const char *DES_options(void))
  77 DEPRECATEDIN_3_0(void DES_ecb3_encrypt(const_DES_cblock *input,
  78                                        DES_cblock *output,
  79                                        DES_key_schedule *ks1,
  80                                        DES_key_schedule *ks2,
  81                                        DES_key_schedule *ks3, int enc))
  82 DEPRECATEDIN_3_0(DES_LONG DES_cbc_cksum(const unsigned char *input,
  83                                         DES_cblock *output, long length,
  84                                         DES_key_schedule *schedule,
  85                                         const_DES_cblock *ivec))
  86 /* DES_cbc_encrypt does not update the IV!  Use DES_ncbc_encrypt instead. */
  87 DEPRECATEDIN_3_0(void DES_cbc_encrypt(const unsigned char *input,
  88                                       unsigned char *output, long length,
  89                                       DES_key_schedule *schedule,
  90                                       DES_cblock *ivec, int enc))
  91 DEPRECATEDIN_3_0(void DES_ncbc_encrypt(const unsigned char *input,
  92                                        unsigned char *output, long length,
  93                                        DES_key_schedule *schedule,
  94                                        DES_cblock *ivec, int enc))
  95 DEPRECATEDIN_3_0(void DES_xcbc_encrypt(const unsigned char *input,
  96                                        unsigned char *output, long length,
  97                                        DES_key_schedule *schedule,
  98                                        DES_cblock *ivec, const_DES_cblock *inw,
  99                                        const_DES_cblock *outw, int enc))
 100 DEPRECATEDIN_3_0(void DES_cfb_encrypt(const unsigned char *in,
 101                                       unsigned char *out, int numbits,
 102                                       long length, DES_key_schedule *schedule,
 103                                       DES_cblock *ivec, int enc))
 104 DEPRECATEDIN_3_0(void DES_ecb_encrypt(const_DES_cblock *input,
 105                                       DES_cblock *output, DES_key_schedule *ks,
 106                                       int enc))
 107
 108 /*
 109  * This is the DES encryption function that gets called by just about every
 110  * other DES routine in the library.  You should not use this function except
 111  * to implement 'modes' of DES.  I say this because the functions that call
 112  * this routine do the conversion from 'char *' to long, and this needs to be
 113  * done to make sure 'non-aligned' memory access do not occur.  The
 114  * characters are loaded 'little endian'. Data is a pointer to 2 unsigned
 115  * long's and ks is the DES_key_schedule to use.  enc, is non zero specifies
 116  * encryption, zero if decryption.
 117  */
 118 DEPRECATEDIN_3_0(void DES_encrypt1(DES_LONG *data, DES_key_schedule *ks,
 119                                    int enc))
 120
 121 /*
 122  * This functions is the same as DES_encrypt1() except that the DES initial
 123  * permutation (IP) and final permutation (FP) have been left out.  As for
 124  * DES_encrypt1(), you should not use this function. It is used by the
 125  * routines in the library that implement triple DES. IP() DES_encrypt2()
 126  * DES_encrypt2() DES_encrypt2() FP() is the same as DES_encrypt1()
 127  * DES_encrypt1() DES_encrypt1() except faster :-).
 128  */
 129 DEPRECATEDIN_3_0(void DES_encrypt2(DES_LONG *data, DES_key_schedule *ks,
 130                                    int enc))
 131
 132 DEPRECATEDIN_3_0(void DES_encrypt3(DES_LONG *data, DES_key_schedule *ks1,
 133                   DES_key_schedule *ks2, DES_key_schedule *ks3))
 134 DEPRECATEDIN_3_0(void DES_decrypt3(DES_LONG *data, DES_key_schedule *ks1,
 135                   DES_key_schedule *ks2, DES_key_schedule *ks3))
 136 DEPRECATEDIN_3_0(void DES_ede3_cbc_encrypt(const unsigned char *input,
 137                                            unsigned char *output, long length,
 138                                            DES_key_schedule *ks1,
 139                                            DES_key_schedule *ks2,
 140                                            DES_key_schedule *ks3,
 141                                            DES_cblock *ivec, int enc))
 142 DEPRECATEDIN_3_0(void DES_ede3_cfb64_encrypt(const unsigned char *in,
 143                                              unsigned char *out, long length,
 144                                              DES_key_schedule *ks1,
 145                                              DES_key_schedule *ks2,
 146                                              DES_key_schedule *ks3,
 147                                              DES_cblock *ivec, int *num,
 148                                              int enc))
 149 DEPRECATEDIN_3_0(void DES_ede3_cfb_encrypt(const unsigned char *in,
 150                                            unsigned char *out, int numbits,
 151                                            long length, DES_key_schedule *ks1,
 152                                            DES_key_schedule *ks2,
 153                                            DES_key_schedule *ks3,
 154                                            DES_cblock *ivec, int enc))
 155 DEPRECATEDIN_3_0(void DES_ede3_ofb64_encrypt(const unsigned char *in,
 156                                              unsigned char *out, long length,
 157                                              DES_key_schedule *ks1,
 158                                              DES_key_schedule *ks2,
 159                                              DES_key_schedule *ks3,
 160                                              DES_cblock *ivec, int *num))
 161 DEPRECATEDIN_3_0(char *DES_fcrypt(const char *buf, const char *salt, char *ret))
 162 DEPRECATEDIN_3_0(char *DES_crypt(const char *buf, const char *salt))
 163 DEPRECATEDIN_3_0(void DES_ofb_encrypt(const unsigned char *in,
 164                                       unsigned char *out, int numbits,
 165                                       long length, DES_key_schedule *schedule,
 166                                       DES_cblock *ivec))
 167 DEPRECATEDIN_3_0(void DES_pcbc_encrypt(const unsigned char *input,
 168                                        unsigned char *output, long length,
 169                                        DES_key_schedule *schedule,
 170                                        DES_cblock *ivec, int enc))
 171 DEPRECATEDIN_3_0(DES_LONG DES_quad_cksum(const unsigned char *input,
 172                                          DES_cblock output[], long length,
 173                                          int out_count, DES_cblock *seed))
 174 DEPRECATEDIN_3_0(int DES_random_key(DES_cblock *ret))
 175 DEPRECATEDIN_3_0(void DES_set_odd_parity(DES_cblock *key))
 176 DEPRECATEDIN_3_0(int DES_check_key_parity(const_DES_cblock *key))
 177 DEPRECATEDIN_3_0(int DES_is_weak_key(const_DES_cblock *key))
 178 /*
 179  * DES_set_key (= set_key = DES_key_sched = key_sched) calls
 180  * DES_set_key_checked
 181  */
 182 DEPRECATEDIN_3_0(int DES_set_key(const_DES_cblock *key,
 183                                  DES_key_schedule *schedule))
 184 DEPRECATEDIN_3_0(int DES_key_sched(const_DES_cblock *key,
 185                                    DES_key_schedule *schedule))
 186 DEPRECATEDIN_3_0(int DES_set_key_checked(const_DES_cblock *key,
 187                                          DES_key_schedule *schedule))
 188 DEPRECATEDIN_3_0(void DES_set_key_unchecked(const_DES_cblock *key,
 189                                             DES_key_schedule *schedule))
 190 DEPRECATEDIN_3_0(void DES_string_to_key(const char *str, DES_cblock *key))
 191 DEPRECATEDIN_3_0(void DES_string_to_2keys(const char *str, DES_cblock *key1,
 192                                           DES_cblock *key2))
 193 DEPRECATEDIN_3_0(void DES_cfb64_encrypt(const unsigned char *in,
 194                                         unsigned char *out, long length,
 195                                         DES_key_schedule *schedule,
 196                                         DES_cblock *ivec, int *num, int enc))
 197 DEPRECATEDIN_3_0(void DES_ofb64_encrypt(const unsigned char *in,
 198                                         unsigned char *out, long length,
 199                                         DES_key_schedule *schedule,
 200                                         DES_cblock *ivec, int *num))
 201
 202 #  ifdef  __cplusplus
 203 }
 204 #  endif
 205 # endif
 206
 207 #endif