providers/implementations/ciphers/cipher_des.c

   1 /*
   2  * Copyright 2019-2023 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 /*
  11  * DES low level APIs are deprecated for public use, but still ok for internal
  12  * use.
  13  */
  14 #include "internal/deprecated.h"
  15
  16 #include <openssl/rand.h>
  17 #include <openssl/proverr.h>
  18 #include "prov/ciphercommon.h"
  19 #include "cipher_des.h"
  20 #include "prov/implementations.h"
  21 #include "prov/providercommon.h"
  22
  23 #define DES_FLAGS PROV_CIPHER_FLAG_RAND_KEY
  24
  25 static OSSL_FUNC_cipher_freectx_fn des_freectx;
  26 static OSSL_FUNC_cipher_encrypt_init_fn des_einit;
  27 static OSSL_FUNC_cipher_decrypt_init_fn des_dinit;
  28 static OSSL_FUNC_cipher_get_ctx_params_fn des_get_ctx_params;
  29 static OSSL_FUNC_cipher_gettable_ctx_params_fn des_gettable_ctx_params;
  30
  31 static void *des_newctx(void *provctx, size_t kbits, size_t blkbits,
  32                         size_t ivbits, unsigned int mode, uint64_t flags,
  33                         const PROV_CIPHER_HW *hw)
  34 {
  35     PROV_DES_CTX *ctx;
  36
  37     if (!ossl_prov_is_running())
  38         return NULL;
  39
  40     ctx = OPENSSL_zalloc(sizeof(*ctx));
  41     if (ctx != NULL)
  42         ossl_cipher_generic_initkey(ctx, kbits, blkbits, ivbits, mode, flags,
  43                                     hw, provctx);
  44     return ctx;
  45 }
  46
  47 static void *des_dupctx(void *ctx)
  48 {
  49     PROV_DES_CTX *in = (PROV_DES_CTX *)ctx;
  50     PROV_DES_CTX *ret;
  51
  52     if (!ossl_prov_is_running())
  53         return NULL;
  54
  55     ret = OPENSSL_malloc(sizeof(*ret));
  56     if (ret == NULL)
  57         return NULL;
  58     in->base.hw->copyctx(&ret->base, &in->base);
  59
  60     return ret;
  61 }
  62
  63 static void des_freectx(void *vctx)
  64 {
  65     PROV_DES_CTX *ctx = (PROV_DES_CTX *)vctx;
  66
  67     ossl_cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
  68     OPENSSL_clear_free(ctx,  sizeof(*ctx));
  69 }
  70
  71 static int des_init(void *vctx, const unsigned char *key, size_t keylen,
  72                     const unsigned char *iv, size_t ivlen,
  73                     const OSSL_PARAM params[], int enc)
  74 {
  75     PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
  76
  77     if (!ossl_prov_is_running())
  78         return 0;
  79
  80     ctx->num = 0;
  81     ctx->bufsz = 0;
  82     ctx->enc = enc;
  83
  84     if (iv != NULL) {
  85         if (!ossl_cipher_generic_initiv(ctx, iv, ivlen))
  86             return 0;
  87     } else if (ctx->iv_set) {
  88         /* reset IV to keep compatibility with 1.1.1 */
  89         memcpy(ctx->iv, ctx->oiv, ctx->ivlen);
  90     }
  91
  92     if (key != NULL) {
  93         if (keylen != ctx->keylen) {
  94             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
  95             return 0;
  96         }
  97         if (!ctx->hw->init(ctx, key, keylen))
  98             return 0;
  99     }
 100     return ossl_cipher_generic_set_ctx_params(ctx, params);
 101 }
 102
 103 static int des_einit(void *vctx, const unsigned char *key, size_t keylen,
 104                      const unsigned char *iv, size_t ivlen,
 105                      const OSSL_PARAM params[])
 106 {
 107     return des_init(vctx, key, keylen, iv, ivlen, params, 1);
 108 }
 109
 110 static int des_dinit(void *vctx, const unsigned char *key, size_t keylen,
 111                      const unsigned char *iv, size_t ivlen,
 112                      const OSSL_PARAM params[])
 113 {
 114     return des_init(vctx, key, keylen, iv, ivlen, params, 0);
 115 }
 116
 117 static int des_generatekey(PROV_CIPHER_CTX *ctx, void *ptr)
 118 {
 119
 120     DES_cblock *deskey = ptr;
 121     size_t kl = ctx->keylen;
 122
 123     if (kl == 0 || RAND_priv_bytes_ex(ctx->libctx, ptr, kl, 0) <= 0)
 124         return 0;
 125     DES_set_odd_parity(deskey);
 126     return 1;
 127 }
 128
 129 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(des)
 130     OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY, NULL, 0),
 131 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(des)
 132
 133 static int des_get_ctx_params(void *vctx, OSSL_PARAM params[])
 134 {
 135     PROV_CIPHER_CTX  *ctx = (PROV_CIPHER_CTX *)vctx;
 136     OSSL_PARAM *p;
 137
 138     if (!ossl_cipher_generic_get_ctx_params(vctx, params))
 139         return 0;
 140
 141     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_RANDOM_KEY);
 142     if (p != NULL && !des_generatekey(ctx, p->data)) {
 143         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GENERATE_KEY);
 144         return 0;
 145     }
 146     return 1;
 147 }
 148
 149 #define IMPLEMENT_des_cipher(type, lcmode, UCMODE, flags,                      \
 150                              kbits, blkbits, ivbits, block)                    \
 151 static OSSL_FUNC_cipher_newctx_fn type##_##lcmode##_newctx;                    \
 152 static void *des_##lcmode##_newctx(void *provctx)                              \
 153 {                                                                              \
 154     return des_newctx(provctx, kbits, blkbits, ivbits,                         \
 155                       EVP_CIPH_##UCMODE##_MODE, flags,                         \
 156                       ossl_prov_cipher_hw_des_##lcmode());                          \
 157 }                                                                              \
 158 static OSSL_FUNC_cipher_get_params_fn des_##lcmode##_get_params;               \
 159 static int des_##lcmode##_get_params(OSSL_PARAM params[])                      \
 160 {                                                                              \
 161     return ossl_cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE,    \
 162                                           flags, kbits, blkbits, ivbits);      \
 163 }                                                                              \
 164 const OSSL_DISPATCH ossl_##des_##lcmode##_functions[] = {                      \
 165     { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))des_einit },              \
 166     { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))des_dinit },              \
 167     { OSSL_FUNC_CIPHER_UPDATE,                                                 \
 168       (void (*)(void))ossl_cipher_generic_##block##_update },                  \
 169     { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))ossl_cipher_generic_##block##_final },\
 170     { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))ossl_cipher_generic_cipher },   \
 171     { OSSL_FUNC_CIPHER_NEWCTX,                                                 \
 172       (void (*)(void))des_##lcmode##_newctx },                                 \
 173     { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))des_dupctx },                   \
 174     { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))des_freectx },                 \
 175     { OSSL_FUNC_CIPHER_GET_PARAMS,                                             \
 176       (void (*)(void))des_##lcmode##_get_params },                             \
 177     { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,                                        \
 178       (void (*)(void))ossl_cipher_generic_gettable_params },                   \
 179     { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, (void (*)(void))des_get_ctx_params },   \
 180     { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,                                    \
 181       (void (*)(void))des_gettable_ctx_params },                               \
 182     { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,                                         \
 183      (void (*)(void))ossl_cipher_generic_set_ctx_params },                     \
 184     { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,                                    \
 185      (void (*)(void))ossl_cipher_generic_settable_ctx_params },                \
 186     OSSL_DISPATCH_END                                                          \
 187 }
 188
 189 /* ossl_des_ecb_functions */
 190 IMPLEMENT_des_cipher(des, ecb, ECB, DES_FLAGS, 64, 64, 0, block);
 191 /* ossl_des_cbc_functions */
 192 IMPLEMENT_des_cipher(des, cbc, CBC, DES_FLAGS, 64, 64, 64, block);
 193 /* ossl_des_ofb64_functions */
 194 IMPLEMENT_des_cipher(des, ofb64, OFB, DES_FLAGS, 64, 8, 64, stream);
 195 /* ossl_des_cfb64_functions */
 196 IMPLEMENT_des_cipher(des, cfb64, CFB, DES_FLAGS, 64, 8, 64, stream);
 197 /* ossl_des_cfb1_functions */
 198 IMPLEMENT_des_cipher(des, cfb1, CFB, DES_FLAGS, 64, 8, 64, stream);
 199 /* ossl_des_cfb8_functions */
 200 IMPLEMENT_des_cipher(des, cfb8, CFB, DES_FLAGS, 64, 8, 64, stream);