providers/implementations/ciphers/cipher_chacha20.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 chacha20 cipher */
  11
  12 #include "cipher_chacha20.h"
  13 #include "prov/implementations.h"
  14 #include "prov/providercommon.h"
  15 #include "prov/providercommonerr.h"
  16
  17 #define CHACHA20_KEYLEN (CHACHA_KEY_SIZE)
  18 #define CHACHA20_BLKLEN (1)
  19 #define CHACHA20_IVLEN (CHACHA_CTR_SIZE)
  20 /* TODO(3.0) Figure out what flags are required */
  21 #define CHACHA20_FLAGS (EVP_CIPH_CUSTOM_IV | EVP_CIPH_ALWAYS_CALL_INIT)
  22
  23 static OSSL_FUNC_cipher_newctx_fn chacha20_newctx;
  24 static OSSL_FUNC_cipher_freectx_fn chacha20_freectx;
  25 static OSSL_FUNC_cipher_get_params_fn chacha20_get_params;
  26 static OSSL_FUNC_cipher_get_ctx_params_fn chacha20_get_ctx_params;
  27 static OSSL_FUNC_cipher_set_ctx_params_fn chacha20_set_ctx_params;
  28 static OSSL_FUNC_cipher_gettable_ctx_params_fn chacha20_gettable_ctx_params;
  29 static OSSL_FUNC_cipher_settable_ctx_params_fn chacha20_settable_ctx_params;
  30 #define chacha20_cipher ossl_cipher_generic_cipher
  31 #define chacha20_update ossl_cipher_generic_stream_update
  32 #define chacha20_final ossl_cipher_generic_stream_final
  33 #define chacha20_gettable_params ossl_cipher_generic_gettable_params
  34
  35 void chacha20_initctx(PROV_CHACHA20_CTX *ctx)
  36 {
  37     ossl_cipher_generic_initkey(ctx, CHACHA20_KEYLEN * 8,
  38                                 CHACHA20_BLKLEN * 8,
  39                                 CHACHA20_IVLEN * 8,
  40                                 0, CHACHA20_FLAGS,
  41                                 ossl_prov_cipher_hw_chacha20(CHACHA20_KEYLEN * 8),
  42                                 NULL);
  43 }
  44
  45 static void *chacha20_newctx(void *provctx)
  46 {
  47     PROV_CHACHA20_CTX *ctx;
  48
  49     if (!ossl_prov_is_running())
  50         return NULL;
  51
  52     ctx = OPENSSL_zalloc(sizeof(*ctx));
  53     if (ctx != NULL)
  54         chacha20_initctx(ctx);
  55     return ctx;
  56 }
  57
  58 static void chacha20_freectx(void *vctx)
  59 {
  60     PROV_CHACHA20_CTX *ctx = (PROV_CHACHA20_CTX *)vctx;
  61
  62     if (ctx != NULL) {
  63         ossl_cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
  64         OPENSSL_clear_free(ctx, sizeof(*ctx));
  65     }
  66 }
  67
  68 static int chacha20_get_params(OSSL_PARAM params[])
  69 {
  70     return ossl_cipher_generic_get_params(params, 0, CHACHA20_FLAGS,
  71                                           CHACHA20_KEYLEN * 8,
  72                                           CHACHA20_BLKLEN * 8,
  73                                           CHACHA20_IVLEN * 8);
  74 }
  75
  76 static int chacha20_get_ctx_params(void *vctx, OSSL_PARAM params[])
  77 {
  78     OSSL_PARAM *p;
  79
  80     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
  81     if (p != NULL && !OSSL_PARAM_set_size_t(p, CHACHA20_IVLEN)) {
  82         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
  83         return 0;
  84     }
  85     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
  86     if (p != NULL && !OSSL_PARAM_set_size_t(p, CHACHA20_KEYLEN)) {
  87         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
  88         return 0;
  89     }
  90
  91     return 1;
  92 }
  93
  94 static const OSSL_PARAM chacha20_known_gettable_ctx_params[] = {
  95     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
  96     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
  97     OSSL_PARAM_END
  98 };
  99 const OSSL_PARAM *chacha20_gettable_ctx_params(ossl_unused void *provctx)
 100 {
 101     return chacha20_known_gettable_ctx_params;
 102 }
 103
 104 static int chacha20_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 105 {
 106     const OSSL_PARAM *p;
 107     size_t len;
 108
 109     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
 110     if (p != NULL) {
 111         if (!OSSL_PARAM_get_size_t(p, &len)) {
 112             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 113             return 0;
 114         }
 115         if (len != CHACHA20_KEYLEN) {
 116             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
 117             return 0;
 118         }
 119     }
 120     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_IVLEN);
 121     if (p != NULL) {
 122         if (!OSSL_PARAM_get_size_t(p, &len)) {
 123             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 124             return 0;
 125         }
 126         if (len != CHACHA20_IVLEN) {
 127             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
 128             return 0;
 129         }
 130     }
 131     return 1;
 132 }
 133
 134 static const OSSL_PARAM chacha20_known_settable_ctx_params[] = {
 135     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
 136     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
 137     OSSL_PARAM_END
 138 };
 139 const OSSL_PARAM *chacha20_settable_ctx_params(ossl_unused void *provctx)
 140 {
 141     return chacha20_known_settable_ctx_params;
 142 }
 143
 144 int chacha20_einit(void *vctx, const unsigned char *key, size_t keylen,
 145                    const unsigned char *iv, size_t ivlen)
 146 {
 147     int ret;
 148
 149     /* The generic function checks for ossl_prov_is_running() */
 150     ret= ossl_cipher_generic_einit(vctx, key, keylen, iv, ivlen);
 151     if (ret && iv != NULL) {
 152         PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
 153         PROV_CIPHER_HW_CHACHA20 *hw = (PROV_CIPHER_HW_CHACHA20 *)ctx->hw;
 154
 155         hw->initiv(ctx);
 156     }
 157     return ret;
 158 }
 159
 160 int chacha20_dinit(void *vctx, const unsigned char *key, size_t keylen,
 161                    const unsigned char *iv, size_t ivlen)
 162 {
 163     int ret;
 164
 165     /* The generic function checks for ossl_prov_is_running() */
 166     ret= ossl_cipher_generic_dinit(vctx, key, keylen, iv, ivlen);
 167     if (ret && iv != NULL) {
 168         PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
 169         PROV_CIPHER_HW_CHACHA20 *hw = (PROV_CIPHER_HW_CHACHA20 *)ctx->hw;
 170
 171         hw->initiv(ctx);
 172     }
 173     return ret;
 174 }
 175
 176 /* ossl_chacha20_functions */
 177 const OSSL_DISPATCH ossl_chacha20_functions[] = {
 178     { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))chacha20_newctx },
 179     { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))chacha20_freectx },
 180     { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))chacha20_einit },
 181     { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))chacha20_dinit },
 182     { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))chacha20_update },
 183     { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))chacha20_final },
 184     { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))chacha20_cipher},
 185     { OSSL_FUNC_CIPHER_GET_PARAMS, (void (*)(void))chacha20_get_params },
 186     { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,(void (*)(void))chacha20_gettable_params },
 187     { OSSL_FUNC_CIPHER_GET_CTX_PARAMS, (void (*)(void))chacha20_get_ctx_params },
 188     { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,
 189         (void (*)(void))chacha20_gettable_ctx_params },
 190     { OSSL_FUNC_CIPHER_SET_CTX_PARAMS, (void (*)(void))chacha20_set_ctx_params },
 191     { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,
 192         (void (*)(void))chacha20_settable_ctx_params },
 193     { 0, NULL }
 194 };
 195