providers/implementations/ciphers/cipher_rc4.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 RC4 ciphers */
  11
  12 /*
  13  * RC4 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_rc4.h"
  19 #include "prov/implementations.h"
  20
  21 /* TODO (3.0) Figure out what flags are required */
  22 #define RC4_FLAGS EVP_CIPH_FLAG_DEFAULT_ASN1
  23
  24 static OSSL_FUNC_cipher_freectx_fn rc4_freectx;
  25 static OSSL_FUNC_cipher_dupctx_fn rc4_dupctx;
  26
  27 static void rc4_freectx(void *vctx)
  28 {
  29     PROV_RC4_CTX *ctx = (PROV_RC4_CTX *)vctx;
  30
  31     cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
  32     OPENSSL_clear_free(ctx,  sizeof(*ctx));
  33 }
  34
  35 static void *rc4_dupctx(void *ctx)
  36 {
  37     PROV_RC4_CTX *in = (PROV_RC4_CTX *)ctx;
  38     PROV_RC4_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 #define IMPLEMENT_cipher(alg, UCALG, flags, kbits, blkbits, ivbits, typ)       \
  50 static OSSL_FUNC_cipher_get_params_fn alg##_##kbits##_get_params;              \
  51 static int alg##_##kbits##_get_params(OSSL_PARAM params[])                     \
  52 {                                                                              \
  53     return cipher_generic_get_params(params, 0, flags,                         \
  54                                      kbits, blkbits, ivbits);                  \
  55 }                                                                              \
  56 static OSSL_FUNC_cipher_newctx_fn alg##_##kbits##_newctx;                      \
  57 static void * alg##_##kbits##_newctx(void *provctx)                            \
  58 {                                                                              \
  59      PROV_##UCALG##_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));                   \
  60      if (ctx != NULL) {                                                        \
  61          cipher_generic_initkey(ctx, kbits, blkbits, ivbits, 0, flags,         \
  62                                 PROV_CIPHER_HW_##alg(kbits), NULL);            \
  63      }                                                                         \
  64      return ctx;                                                               \
  65 }                                                                              \
  66 const OSSL_DISPATCH alg##kbits##_functions[] = {                               \
  67     { OSSL_FUNC_CIPHER_NEWCTX,                                                 \
  68       (void (*)(void)) alg##_##kbits##_newctx },                               \
  69     { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void)) alg##_freectx },              \
  70     { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) alg##_dupctx },                \
  71     { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))cipher_generic_einit },   \
  72     { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))cipher_generic_dinit },   \
  73     { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))cipher_generic_##typ##_update },\
  74     { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))cipher_generic_##typ##_final },  \
  75     { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))cipher_generic_cipher },        \
  76     { OSSL_FUNC_CIPHER_GET_PARAMS,                                             \
  77       (void (*)(void)) alg##_##kbits##_get_params },                           \
  78     { OSSL_FUNC_CIPHER_GET_CTX_PARAMS,                                         \
  79       (void (*)(void))cipher_generic_get_ctx_params },                         \
  80     { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,                                         \
  81       (void (*)(void))cipher_var_keylen_set_ctx_params },                      \
  82     { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,                                        \
  83       (void (*)(void))cipher_generic_gettable_params },                        \
  84     { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,                                    \
  85       (void (*)(void))cipher_generic_gettable_ctx_params },                    \
  86     { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,                                    \
  87      (void (*)(void))cipher_var_keylen_settable_ctx_params },                  \
  88     { 0, NULL }                                                                \
  89 };
  90
  91 /* rc440_functions */
  92 IMPLEMENT_cipher(rc4, RC4, EVP_CIPH_VARIABLE_LENGTH, 40, 8, 0, stream)
  93 /* rc4128_functions */
  94 IMPLEMENT_cipher(rc4, RC4, EVP_CIPH_VARIABLE_LENGTH, 128, 8, 0, stream)