providers/implementations/ciphers/cipher_des.c

   1 /*
   2  * Copyright 2019 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 "prov/ciphercommon.h"
  17 #include "cipher_des.h"
  18 #include <openssl/rand.h>
  19 #include "prov/implementations.h"
  20 #include "prov/providercommonerr.h"
  21
  22 /* TODO(3.0) Figure out what flags need to be here */
  23 #define DES_FLAGS (EVP_CIPH_RAND_KEY)
  24
  25 static OSSL_OP_cipher_freectx_fn des_freectx;
  26 static OSSL_OP_cipher_encrypt_init_fn des_einit;
  27 static OSSL_OP_cipher_decrypt_init_fn des_dinit;
  28 static OSSL_OP_cipher_get_ctx_params_fn des_get_ctx_params;
  29 static OSSL_OP_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 = OPENSSL_zalloc(sizeof(*ctx));
  36
  37     if (ctx != NULL)
  38         cipher_generic_initkey(ctx, kbits, blkbits, ivbits, mode, flags, hw,
  39                                provctx);
  40     return ctx;
  41 }
  42
  43 static void des_freectx(void *vctx)
  44 {
  45     PROV_DES_CTX *ctx = (PROV_DES_CTX *)vctx;
  46
  47     OPENSSL_clear_free(ctx,  sizeof(*ctx));
  48 }
  49
  50 static int des_init(void *vctx, const unsigned char *key, size_t keylen,
  51                     const unsigned char *iv, size_t ivlen, int enc)
  52 {
  53     PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
  54
  55     ctx->enc = enc;
  56
  57     if (iv != NULL) {
  58         if (!cipher_generic_initiv(ctx, iv, ivlen))
  59             return 0;
  60     }
  61
  62     if (key != NULL) {
  63         if (keylen != ctx->keylen) {
  64             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEYLEN);
  65             return 0;
  66         }
  67         return ctx->hw->init(ctx, key, keylen);
  68     }
  69     return 1;
  70 }
  71
  72 static int des_einit(void *vctx, const unsigned char *key, size_t keylen,
  73                      const unsigned char *iv, size_t ivlen)
  74 {
  75     return des_init(vctx, key, keylen, iv, ivlen, 1);
  76 }
  77
  78 static int des_dinit(void *vctx, const unsigned char *key, size_t keylen,
  79                      const unsigned char *iv, size_t ivlen)
  80 {
  81     return des_init(vctx, key, keylen, iv, ivlen, 0);
  82 }
  83
  84 static int des_generatekey(PROV_CIPHER_CTX *ctx, void *ptr)
  85 {
  86
  87     DES_cblock *deskey = ptr;
  88     size_t kl = ctx->keylen;
  89
  90     if (kl == 0 || RAND_priv_bytes_ex(ctx->libctx, ptr, kl) <= 0)
  91         return 0;
  92     DES_set_odd_parity(deskey);
  93     return 1;
  94 }
  95
  96 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(des)
  97     OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_RANDOM_KEY, NULL, 0),
  98 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(des)
  99
 100 static int des_get_ctx_params(void *vctx, OSSL_PARAM params[])
 101 {
 102     PROV_CIPHER_CTX  *ctx = (PROV_CIPHER_CTX *)vctx;
 103     OSSL_PARAM *p;
 104
 105     if (!cipher_generic_get_ctx_params(vctx, params))
 106         return 0;
 107
 108     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_RANDOM_KEY);
 109     if (p != NULL && !des_generatekey(ctx, p->data)) {
 110         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GENERATE_KEY);
 111         return 0;
 112     }
 113     return 1;
 114 }
 115
 116 #define IMPLEMENT_des_cipher(type, lcmode, UCMODE, flags,                      \
 117                              kbits, blkbits, ivbits, block)                    \
 118 static OSSL_OP_cipher_newctx_fn type##_##lcmode##_newctx;                      \
 119 static void *des_##lcmode##_newctx(void *provctx)                              \
 120 {                                                                              \
 121     return des_newctx(provctx, kbits, blkbits, ivbits,                         \
 122                       EVP_CIPH_##UCMODE##_MODE, flags,                         \
 123                       PROV_CIPHER_HW_des_##lcmode());                          \
 124 }                                                                              \
 125 static OSSL_OP_cipher_get_params_fn des_##lcmode##_get_params;                 \
 126 static int des_##lcmode##_get_params(OSSL_PARAM params[])                      \
 127 {                                                                              \
 128     return cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, flags,  \
 129                                      kbits, blkbits, ivbits);                  \
 130 }                                                                              \
 131 const OSSL_DISPATCH des_##lcmode##_functions[] = {                             \
 132     { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))des_einit },              \
 133     { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))des_dinit },              \
 134     { OSSL_FUNC_CIPHER_UPDATE,                                                 \
 135       (void (*)(void))cipher_generic_##block##_update },                       \
 136     { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))cipher_generic_##block##_final },\
 137     { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))cipher_generic_cipher },        \
 138     { OSSL_FUNC_CIPHER_NEWCTX,                                                 \
 139       (void (*)(void))des_##lcmode##_newctx },                                 \
 140     { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))des_freectx },                 \
 141     { OSSL_FUNC_CIPHER_GET_PARAMS,                                             \
 142       (void (*)(void))des_##lcmode##_get_params },                             \
 143     { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,                                        \
 144       (void (*)(void))cipher_generic_gettable_params },                        \
 145     { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, (void (*)(void))des_get_ctx_params },   \
 146     { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,                                    \
 147       (void (*)(void))des_gettable_ctx_params },                               \
 148     { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,                                         \
 149      (void (*)(void))cipher_generic_set_ctx_params },                          \
 150     { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,                                    \
 151      (void (*)(void))cipher_generic_settable_ctx_params },                     \
 152     { 0, NULL }                                                                \
 153 }
 154
 155 /* des_ecb_functions */
 156 IMPLEMENT_des_cipher(des, ecb, ECB, DES_FLAGS, 64, 64, 0, block);
 157 /* des_cbc_functions */
 158 IMPLEMENT_des_cipher(des, cbc, CBC, DES_FLAGS, 64, 64, 64, block);
 159 /* des_ofb64_functions */
 160 IMPLEMENT_des_cipher(des, ofb64, OFB, DES_FLAGS, 64, 8, 64, stream);
 161 /* des_cfb64_functions */
 162 IMPLEMENT_des_cipher(des, cfb64, CFB, DES_FLAGS, 64, 8, 64, stream);
 163 /* des_cfb1_functions */
 164 IMPLEMENT_des_cipher(des, cfb1, CFB, DES_FLAGS, 64, 8, 64, stream);
 165 /* des_cfb8_functions */
 166 IMPLEMENT_des_cipher(des, cfb8, CFB, DES_FLAGS, 64, 8, 64, stream);