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