providers/implementations/ciphers/cipher_rc5.c

   1 /*
   2  * Copyright 2019-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 /* Dispatch functions for RC5 cipher modes ecb, cbc, ofb, cfb */
  11
  12 /*
  13  * RC5 low level APIs are deprecated for public use, but still ok for internal
  14  * use.
  15  */
  16 #include "internal/deprecated.h"
  17
  18 #include "cipher_rc5.h"
  19 #include "prov/implementations.h"
  20 #include "prov/providercommonerr.h"
  21
  22 static OSSL_FUNC_cipher_freectx_fn rc5_freectx;
  23 static OSSL_FUNC_cipher_dupctx_fn rc5_dupctx;
  24 OSSL_FUNC_cipher_gettable_ctx_params_fn rc5_gettable_ctx_params;
  25 OSSL_FUNC_cipher_settable_ctx_params_fn rc5_settable_ctx_params;
  26
  27 static void rc5_freectx(void *vctx)
  28 {
  29     PROV_RC5_CTX *ctx = (PROV_RC5_CTX *)vctx;
  30
  31     cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
  32     OPENSSL_clear_free(ctx,  sizeof(*ctx));
  33 }
  34
  35 static void *rc5_dupctx(void *ctx)
  36 {
  37     PROV_RC5_CTX *in = (PROV_RC5_CTX *)ctx;
  38     PROV_RC5_CTX *ret = OPENSSL_malloc(sizeof(*ret));
  39
  40     if (ret == NULL) {
  41         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
  42         return NULL;
  43     }
  44     *ret = *in;
  45
  46     return ret;
  47 }
  48
  49 static int rc5_set_ctx_params(void *vctx, const OSSL_PARAM params[])
  50 {
  51     PROV_RC5_CTX *ctx = (PROV_RC5_CTX *)vctx;
  52     const OSSL_PARAM *p;
  53
  54     if (!cipher_var_keylen_set_ctx_params(vctx, params))
  55         return 0;
  56
  57     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_ROUNDS);
  58     if (p != NULL) {
  59         unsigned int rounds;
  60
  61         if (!OSSL_PARAM_get_uint(p, &rounds)) {
  62             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
  63             return 0;
  64         }
  65         if (rounds != RC5_8_ROUNDS
  66             && rounds != RC5_12_ROUNDS
  67             && rounds != RC5_16_ROUNDS) {
  68             ERR_raise(ERR_LIB_PROV, PROV_R_UNSUPPORTED_NUMBER_OF_ROUNDS);
  69             return 0;
  70         }
  71         ctx->rounds = rounds;
  72     }
  73     return 1;
  74 }
  75
  76 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(rc5)
  77     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_ROUNDS, NULL),
  78 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(rc5)
  79
  80 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(rc5)
  81     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
  82     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_ROUNDS, NULL),
  83 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(rc5)
  84
  85
  86 static int rc5_get_ctx_params(void *vctx, OSSL_PARAM params[])
  87 {
  88     PROV_RC5_CTX *ctx = (PROV_RC5_CTX *)vctx;
  89     OSSL_PARAM *p;
  90
  91     if (!cipher_generic_get_ctx_params(vctx, params))
  92         return 0;
  93     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_ROUNDS);
  94     if (p != NULL && !OSSL_PARAM_set_uint(p, ctx->rounds)) {
  95         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
  96         return 0;
  97     }
  98     return 1;
  99 }
 100
 101 #define IMPLEMENT_cipher(alg, UCALG, lcmode, UCMODE, flags, kbits,             \
 102                          blkbits, ivbits, typ)                                 \
 103 static OSSL_FUNC_cipher_get_params_fn alg##_##kbits##_##lcmode##_get_params;   \
 104 static int alg##_##kbits##_##lcmode##_get_params(OSSL_PARAM params[])          \
 105 {                                                                              \
 106     return cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, flags,  \
 107                                      kbits, blkbits, ivbits);                  \
 108 }                                                                              \
 109 static OSSL_FUNC_cipher_newctx_fn alg##_##kbits##_##lcmode##_newctx;           \
 110 static void * alg##_##kbits##_##lcmode##_newctx(void *provctx)                 \
 111 {                                                                              \
 112      PROV_##UCALG##_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));                   \
 113      if (ctx != NULL) {                                                        \
 114          cipher_generic_initkey(ctx, kbits, blkbits, ivbits,                   \
 115                                 EVP_CIPH_##UCMODE##_MODE, flags,               \
 116                                 PROV_CIPHER_HW_##alg##_##lcmode(kbits), NULL); \
 117          ctx->rounds = RC5_12_ROUNDS;                                          \
 118      }                                                                         \
 119      return ctx;                                                               \
 120 }                                                                              \
 121 const OSSL_DISPATCH alg##kbits##lcmode##_functions[] = {                       \
 122     { OSSL_FUNC_CIPHER_NEWCTX,                                                 \
 123       (void (*)(void)) alg##_##kbits##_##lcmode##_newctx },                    \
 124     { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void)) alg##_freectx },              \
 125     { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) alg##_dupctx },                \
 126     { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))cipher_generic_einit },   \
 127     { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))cipher_generic_dinit },   \
 128     { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))cipher_generic_##typ##_update },\
 129     { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))cipher_generic_##typ##_final },  \
 130     { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))cipher_generic_cipher },        \
 131     { OSSL_FUNC_CIPHER_GET_PARAMS,                                             \
 132       (void (*)(void)) alg##_##kbits##_##lcmode##_get_params },                \
 133     { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,                                        \
 134       (void (*)(void))cipher_generic_gettable_params },                        \
 135     { OSSL_FUNC_CIPHER_GET_CTX_PARAMS,                                         \
 136       (void (*)(void))rc5_get_ctx_params },                                    \
 137     { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,                                    \
 138       (void (*)(void))rc5_gettable_ctx_params },                               \
 139     { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,                                         \
 140       (void (*)(void))rc5_set_ctx_params },                                    \
 141     { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,                                    \
 142      (void (*)(void))rc5_settable_ctx_params },                                \
 143     { 0, NULL }                                                                \
 144 };
 145
 146 /* rc5128ecb_functions */
 147 IMPLEMENT_cipher(rc5, RC5, ecb, ECB, EVP_CIPH_VARIABLE_LENGTH, 128, 64, 0, block)
 148 /* rc5128cbc_functions */
 149 IMPLEMENT_cipher(rc5, RC5, cbc, CBC, EVP_CIPH_VARIABLE_LENGTH, 128, 64, 64, block)
 150 /* rc5128ofb64_functions */
 151 IMPLEMENT_cipher(rc5, RC5, ofb64, OFB, EVP_CIPH_VARIABLE_LENGTH, 128, 8, 64, stream)
 152 /* rc5128cfb64_functions */
 153 IMPLEMENT_cipher(rc5, RC5, cfb64,  CFB, EVP_CIPH_VARIABLE_LENGTH, 128, 8, 64, stream)