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