providers/implementations/ciphers/cipher_rc2.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 RC2 cipher modes ecb, cbc, ofb, cfb */
  11
  12 /*
  13  * RC2 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_rc2.h"
  19 #include "prov/implementations.h"
  20 #include "prov/providercommonerr.h"
  21
  22 #define RC2_40_MAGIC    0xa0
  23 #define RC2_64_MAGIC    0x78
  24 #define RC2_128_MAGIC   0x3a
  25
  26 static OSSL_FUNC_cipher_freectx_fn rc2_freectx;
  27 static OSSL_FUNC_cipher_dupctx_fn rc2_dupctx;
  28 static OSSL_FUNC_cipher_gettable_ctx_params_fn rc2_gettable_ctx_params;
  29 static OSSL_FUNC_cipher_settable_ctx_params_fn rc2_settable_ctx_params;
  30
  31 static void rc2_freectx(void *vctx)
  32 {
  33     PROV_RC2_CTX *ctx = (PROV_RC2_CTX *)vctx;
  34
  35     cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
  36     OPENSSL_clear_free(ctx,  sizeof(*ctx));
  37 }
  38
  39 static void *rc2_dupctx(void *ctx)
  40 {
  41     PROV_RC2_CTX *in = (PROV_RC2_CTX *)ctx;
  42     PROV_RC2_CTX *ret = OPENSSL_malloc(sizeof(*ret));
  43
  44     if (ret == NULL) {
  45         ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
  46         return NULL;
  47     }
  48     *ret = *in;
  49
  50     return ret;
  51 }
  52
  53 static int rc2_keybits_to_magic(int keybits)
  54 {
  55     switch (keybits) {
  56     case 128:
  57         return RC2_128_MAGIC;
  58     case 64:
  59         return RC2_64_MAGIC;
  60     case 40:
  61         return RC2_40_MAGIC;
  62     }
  63     ERR_raise(ERR_LIB_PROV, PROV_R_UNSUPPORTED_KEY_SIZE);
  64     return 0;
  65 }
  66
  67 static int rc2_magic_to_keybits(int magic)
  68 {
  69     switch (magic) {
  70     case RC2_128_MAGIC:
  71         return 128;
  72     case RC2_64_MAGIC:
  73         return 64;
  74     case RC2_40_MAGIC:
  75         return 40;
  76     }
  77     ERR_raise(ERR_LIB_PROV, PROV_R_UNSUPPORTED_KEY_SIZE);
  78     return 0;
  79 }
  80
  81 static int rc2_get_ctx_params(void *vctx, OSSL_PARAM params[])
  82 {
  83     PROV_RC2_CTX *ctx = (PROV_RC2_CTX *)vctx;
  84     OSSL_PARAM *p;
  85
  86     if (!cipher_generic_get_ctx_params(vctx, params))
  87         return 0;
  88     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_RC2_KEYBITS);
  89     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->key_bits)) {
  90         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
  91         return 0;
  92     }
  93     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_ALG_ID);
  94     if (p != NULL) {
  95         long num;
  96         int i;
  97         ASN1_TYPE *type;
  98         unsigned char *d = p->data;
  99         unsigned char **dd = d == NULL ? NULL : &d;
 100
 101         if (p->data_type != OSSL_PARAM_OCTET_STRING) {
 102             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 103             return 0;
 104         }
 105         if ((type = ASN1_TYPE_new()) == NULL) {
 106             ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
 107             return 0;
 108         }
 109
 110         /* Is this the original IV or the running IV? */
 111         num = rc2_keybits_to_magic(ctx->key_bits);
 112         if (!ASN1_TYPE_set_int_octetstring(type, num,
 113                                            ctx->base.iv, ctx->base.ivlen)) {
 114             ASN1_TYPE_free(type);
 115             ERR_raise(ERR_LIB_PROV, ERR_R_MALLOC_FAILURE);
 116             return 0;
 117         }
 118         /*
 119          * IF the caller has a buffer, we pray to the gods they got the
 120          * size right.  There's no way to tell the i2d functions...
 121          */
 122         i = i2d_ASN1_TYPE(type, dd);
 123         if (i >= 0)
 124             p->return_size = (size_t)i;
 125
 126         ASN1_TYPE_free(type);
 127         if (i < 0) {
 128             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 129             return 0;
 130         }
 131     }
 132     return 1;
 133 }
 134
 135 static int rc2_set_ctx_params(void *vctx, OSSL_PARAM params[])
 136 {
 137     PROV_RC2_CTX *ctx = (PROV_RC2_CTX *)vctx;
 138     const OSSL_PARAM *p;
 139
 140     if (!cipher_var_keylen_set_ctx_params(vctx, params))
 141         return 0;
 142     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_RC2_KEYBITS);
 143     if (p != NULL) {
 144          if (!OSSL_PARAM_get_size_t(p, &ctx->key_bits)) {
 145             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 146             return 0;
 147         }
 148     }
 149     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_ALG_ID);
 150     if (p != NULL) {
 151         ASN1_TYPE *type = NULL;
 152         long num = 0;
 153         const unsigned char *d = p->data;
 154         int ret = 1;
 155         unsigned char iv[16];
 156
 157         if (p->data_type != OSSL_PARAM_OCTET_STRING
 158             || ctx->base.ivlen > sizeof(iv)
 159             || (type = d2i_ASN1_TYPE(NULL, &d, p->data_size)) == NULL
 160             || ((size_t)ASN1_TYPE_get_int_octetstring(type, &num, iv,
 161                                                       ctx->base.ivlen)
 162                 != ctx->base.ivlen)
 163             || !cipher_generic_initiv(&ctx->base, iv, ctx->base.ivlen)
 164             || (ctx->key_bits = rc2_magic_to_keybits(num)) == 0) {
 165             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 166             ret = 0;
 167         }
 168         ASN1_TYPE_free(type);
 169         if (ret == 0)
 170             return 0;
 171         /*
 172          * This code assumes that the caller will call
 173          * EVP_CipherInit_ex() with a non NULL key in order to setup a key that
 174          * uses the keylen and keybits that were set here.
 175          */
 176         ctx->base.keylen = ctx->key_bits / 8;
 177     }
 178     return 1;
 179 }
 180
 181 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(rc2)
 182 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_RC2_KEYBITS, NULL),
 183 CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(rc2)
 184
 185 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(rc2)
 186 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
 187 OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_RC2_KEYBITS, NULL),
 188 CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(rc2)
 189
 190 #define IMPLEMENT_cipher(alg, UCALG, lcmode, UCMODE, flags, kbits, blkbits,    \
 191                          ivbits, typ)                                          \
 192 static OSSL_FUNC_cipher_get_params_fn alg##_##kbits##_##lcmode##_get_params;   \
 193 static int alg##_##kbits##_##lcmode##_get_params(OSSL_PARAM params[])          \
 194 {                                                                              \
 195     return cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE, flags,  \
 196                                      kbits, blkbits, ivbits);                  \
 197 }                                                                              \
 198 static OSSL_FUNC_cipher_newctx_fn alg##_##kbits##_##lcmode##_newctx;           \
 199 static void * alg##_##kbits##_##lcmode##_newctx(void *provctx)                 \
 200 {                                                                              \
 201      PROV_##UCALG##_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));                   \
 202      if (ctx != NULL) {                                                        \
 203          cipher_generic_initkey(ctx, kbits, blkbits, ivbits,                   \
 204                                 EVP_CIPH_##UCMODE##_MODE, flags,               \
 205                                 PROV_CIPHER_HW_##alg##_##lcmode(kbits), NULL); \
 206          ctx->key_bits = kbits;                                                \
 207      }                                                                         \
 208      return ctx;                                                               \
 209 }                                                                              \
 210 const OSSL_DISPATCH alg##kbits##lcmode##_functions[] = {                       \
 211     { OSSL_FUNC_CIPHER_NEWCTX,                                                 \
 212       (void (*)(void)) alg##_##kbits##_##lcmode##_newctx },                    \
 213     { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void)) alg##_freectx },              \
 214     { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) alg##_dupctx },                \
 215     { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))cipher_generic_einit },   \
 216     { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))cipher_generic_dinit },   \
 217     { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))cipher_generic_##typ##_update },\
 218     { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))cipher_generic_##typ##_final },  \
 219     { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))cipher_generic_cipher },        \
 220     { OSSL_FUNC_CIPHER_GET_PARAMS,                                             \
 221       (void (*)(void)) alg##_##kbits##_##lcmode##_get_params },                \
 222     { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,                                        \
 223       (void (*)(void))cipher_generic_gettable_params },                        \
 224     { OSSL_FUNC_CIPHER_GET_CTX_PARAMS,                                         \
 225       (void (*)(void))rc2_get_ctx_params },                                    \
 226     { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,                                    \
 227       (void (*)(void))rc2_gettable_ctx_params },                               \
 228     { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,                                         \
 229       (void (*)(void))rc2_set_ctx_params },                                    \
 230     { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,                                    \
 231      (void (*)(void))rc2_settable_ctx_params },                                \
 232     { 0, NULL }                                                                \
 233 };
 234
 235 /* rc2128ecb_functions */
 236 IMPLEMENT_cipher(rc2, RC2, ecb, ECB, EVP_CIPH_VARIABLE_LENGTH, 128, 64, 0, block)
 237 /* rc2128cbc_functions */
 238 IMPLEMENT_cipher(rc2, RC2, cbc, CBC, EVP_CIPH_VARIABLE_LENGTH, 128, 64, 64, block)
 239 /* rc240cbc_functions */
 240 IMPLEMENT_cipher(rc2, RC2, cbc, CBC, EVP_CIPH_VARIABLE_LENGTH, 40, 64, 64, block)
 241 /* rc264cbc_functions */
 242 IMPLEMENT_cipher(rc2, RC2, cbc, CBC, EVP_CIPH_VARIABLE_LENGTH, 64, 64, 64, block)
 243
 244 /* rc2128ofb128_functions */
 245 IMPLEMENT_cipher(rc2, RC2, ofb128, OFB, EVP_CIPH_VARIABLE_LENGTH, 128, 8, 64, stream)
 246 /* rc2128cfb128_functions */
 247 IMPLEMENT_cipher(rc2, RC2, cfb128, CFB, EVP_CIPH_VARIABLE_LENGTH, 128, 8, 64, stream)