providers/implementations/ciphers/cipher_aes_siv.c

   1 /*
   2  * Copyright 2019-2023 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 AES SIV mode */
  11
  12 /*
  13  * This file uses the low level AES functions (which are deprecated for
  14  * non-internal use) in order to implement provider AES ciphers.
  15  */
  16 #include "internal/deprecated.h"
  17
  18 #include <openssl/proverr.h>
  19 #include "cipher_aes_siv.h"
  20 #include "prov/implementations.h"
  21 #include "prov/providercommon.h"
  22 #include "prov/ciphercommon_aead.h"
  23 #include "prov/provider_ctx.h"
  24
  25 #define siv_stream_update siv_cipher
  26 #define SIV_FLAGS AEAD_FLAGS
  27
  28 static OSSL_FUNC_cipher_set_ctx_params_fn aes_siv_set_ctx_params;
  29
  30 static void *aes_siv_newctx(void *provctx, size_t keybits, unsigned int mode,
  31                             uint64_t flags)
  32 {
  33     PROV_AES_SIV_CTX *ctx;
  34
  35     if (!ossl_prov_is_running())
  36         return NULL;
  37
  38     ctx = OPENSSL_zalloc(sizeof(*ctx));
  39     if (ctx != NULL) {
  40         ctx->taglen = SIV_LEN;
  41         ctx->mode = mode;
  42         ctx->keylen = keybits / 8;
  43         ctx->hw = ossl_prov_cipher_hw_aes_siv(keybits);
  44         ctx->libctx = PROV_LIBCTX_OF(provctx);
  45     }
  46     return ctx;
  47 }
  48
  49 static void aes_siv_freectx(void *vctx)
  50 {
  51     PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
  52
  53     if (ctx != NULL) {
  54         ctx->hw->cleanup(ctx);
  55         OPENSSL_clear_free(ctx,  sizeof(*ctx));
  56     }
  57 }
  58
  59 static void *siv_dupctx(void *vctx)
  60 {
  61     PROV_AES_SIV_CTX *in = (PROV_AES_SIV_CTX *)vctx;
  62     PROV_AES_SIV_CTX *ret;
  63
  64     if (!ossl_prov_is_running())
  65         return NULL;
  66
  67     ret = OPENSSL_malloc(sizeof(*ret));
  68     if (ret == NULL)
  69         return NULL;
  70     if (!in->hw->dupctx(in, ret)) {
  71         OPENSSL_free(ret);
  72         ret = NULL;
  73     }
  74     return ret;
  75 }
  76
  77 static int siv_init(void *vctx, const unsigned char *key, size_t keylen,
  78                     const unsigned char *iv, size_t ivlen,
  79                     const OSSL_PARAM params[], int enc)
  80 {
  81     PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
  82
  83     if (!ossl_prov_is_running())
  84         return 0;
  85
  86     ctx->enc = enc;
  87
  88     if (key != NULL) {
  89         if (keylen != ctx->keylen) {
  90             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
  91             return 0;
  92         }
  93         if (!ctx->hw->initkey(ctx, key, ctx->keylen))
  94             return 0;
  95     }
  96     return aes_siv_set_ctx_params(ctx, params);
  97 }
  98
  99 static int siv_einit(void *vctx, const unsigned char *key, size_t keylen,
 100                      const unsigned char *iv, size_t ivlen,
 101                      const OSSL_PARAM params[])
 102 {
 103     return siv_init(vctx, key, keylen, iv, ivlen, params, 1);
 104 }
 105
 106 static int siv_dinit(void *vctx, const unsigned char *key, size_t keylen,
 107                      const unsigned char *iv, size_t ivlen,
 108                      const OSSL_PARAM params[])
 109 {
 110     return siv_init(vctx, key, keylen, iv, ivlen, params, 0);
 111 }
 112
 113 static int siv_cipher(void *vctx, unsigned char *out, size_t *outl,
 114                       size_t outsize, const unsigned char *in, size_t inl)
 115 {
 116     PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
 117
 118     if (!ossl_prov_is_running())
 119         return 0;
 120
 121     /* Ignore just empty encryption/decryption call and not AAD. */
 122     if (out != NULL) {
 123         if (inl == 0) {
 124             if (outl != NULL)
 125                 *outl = 0;
 126             return 1;
 127         }
 128
 129         if (outsize < inl) {
 130             ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 131             return 0;
 132         }
 133     }
 134
 135     if (ctx->hw->cipher(ctx, out, in, inl) <= 0)
 136         return 0;
 137
 138     if (outl != NULL)
 139         *outl = inl;
 140     return 1;
 141 }
 142
 143 static int siv_stream_final(void *vctx, unsigned char *out, size_t *outl,
 144                             size_t outsize)
 145 {
 146     PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
 147
 148     if (!ossl_prov_is_running())
 149         return 0;
 150
 151     if (!ctx->hw->cipher(vctx, out, NULL, 0))
 152         return 0;
 153
 154     if (outl != NULL)
 155         *outl = 0;
 156     return 1;
 157 }
 158
 159 static int aes_siv_get_ctx_params(void *vctx, OSSL_PARAM params[])
 160 {
 161     PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
 162     SIV128_CONTEXT *sctx = &ctx->siv;
 163     OSSL_PARAM *p;
 164
 165     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAG);
 166     if (p != NULL && p->data_type == OSSL_PARAM_OCTET_STRING) {
 167         if (!ctx->enc
 168             || p->data_size != ctx->taglen
 169             || !OSSL_PARAM_set_octet_string(p, &sctx->tag.byte, ctx->taglen)) {
 170             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 171             return 0;
 172         }
 173     }
 174     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAGLEN);
 175     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->taglen)) {
 176         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 177         return 0;
 178     }
 179     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
 180     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->keylen)) {
 181         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 182         return 0;
 183     }
 184     return 1;
 185 }
 186
 187 static const OSSL_PARAM aes_siv_known_gettable_ctx_params[] = {
 188     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
 189     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
 190     OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
 191     OSSL_PARAM_END
 192 };
 193 static const OSSL_PARAM *aes_siv_gettable_ctx_params(ossl_unused void *cctx,
 194                                                      ossl_unused void *provctx)
 195 {
 196     return aes_siv_known_gettable_ctx_params;
 197 }
 198
 199 static int aes_siv_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 200 {
 201     PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
 202     const OSSL_PARAM *p;
 203     unsigned int speed = 0;
 204
 205     if (params == NULL)
 206         return 1;
 207
 208     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TAG);
 209     if (p != NULL) {
 210         if (ctx->enc)
 211             return 1;
 212         if (p->data_type != OSSL_PARAM_OCTET_STRING
 213             || !ctx->hw->settag(ctx, p->data, p->data_size)) {
 214             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 215             return 0;
 216         }
 217     }
 218     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_SPEED);
 219     if (p != NULL) {
 220         if (!OSSL_PARAM_get_uint(p, &speed)) {
 221             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 222             return 0;
 223         }
 224         ctx->hw->setspeed(ctx, (int)speed);
 225     }
 226     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
 227     if (p != NULL) {
 228         size_t keylen;
 229
 230         if (!OSSL_PARAM_get_size_t(p, &keylen)) {
 231             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 232             return 0;
 233         }
 234         /* The key length can not be modified */
 235         if (keylen != ctx->keylen)
 236             return 0;
 237     }
 238     return 1;
 239 }
 240
 241 static const OSSL_PARAM aes_siv_known_settable_ctx_params[] = {
 242     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
 243     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_SPEED, NULL),
 244     OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
 245     OSSL_PARAM_END
 246 };
 247 static const OSSL_PARAM *aes_siv_settable_ctx_params(ossl_unused void *cctx,
 248                                                      ossl_unused void *provctx)
 249 {
 250     return aes_siv_known_settable_ctx_params;
 251 }
 252
 253 #define IMPLEMENT_cipher(alg, lc, UCMODE, flags, kbits, blkbits, ivbits)       \
 254 static OSSL_FUNC_cipher_newctx_fn alg##kbits##lc##_newctx;                     \
 255 static OSSL_FUNC_cipher_freectx_fn alg##_##lc##_freectx;                       \
 256 static OSSL_FUNC_cipher_dupctx_fn lc##_dupctx;                                 \
 257 static OSSL_FUNC_cipher_encrypt_init_fn lc##_einit;                            \
 258 static OSSL_FUNC_cipher_decrypt_init_fn lc##_dinit;                            \
 259 static OSSL_FUNC_cipher_update_fn lc##_stream_update;                          \
 260 static OSSL_FUNC_cipher_final_fn lc##_stream_final;                            \
 261 static OSSL_FUNC_cipher_cipher_fn lc##_cipher;                                 \
 262 static OSSL_FUNC_cipher_get_params_fn alg##_##kbits##_##lc##_get_params;       \
 263 static OSSL_FUNC_cipher_get_ctx_params_fn alg##_##lc##_get_ctx_params;         \
 264 static OSSL_FUNC_cipher_gettable_ctx_params_fn                                 \
 265             alg##_##lc##_gettable_ctx_params;                                  \
 266 static OSSL_FUNC_cipher_set_ctx_params_fn alg##_##lc##_set_ctx_params;         \
 267 static OSSL_FUNC_cipher_settable_ctx_params_fn                                 \
 268             alg##_##lc##_settable_ctx_params;                                  \
 269 static int alg##_##kbits##_##lc##_get_params(OSSL_PARAM params[])              \
 270 {                                                                              \
 271     return ossl_cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE,    \
 272                                           flags, 2*kbits, blkbits, ivbits);    \
 273 }                                                                              \
 274 static void *alg##kbits##lc##_newctx(void *provctx)                            \
 275 {                                                                              \
 276     return alg##_##lc##_newctx(provctx, 2*kbits, EVP_CIPH_##UCMODE##_MODE,     \
 277                                flags);                                         \
 278 }                                                                              \
 279 const OSSL_DISPATCH ossl_##alg##kbits##lc##_functions[] = {                    \
 280     { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))alg##kbits##lc##_newctx },      \
 281     { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))alg##_##lc##_freectx },        \
 282     { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void)) lc##_dupctx },                 \
 283     { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void)) lc##_einit },            \
 284     { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void)) lc##_dinit },            \
 285     { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void)) lc##_stream_update },          \
 286     { OSSL_FUNC_CIPHER_FINAL, (void (*)(void)) lc##_stream_final },            \
 287     { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void)) lc##_cipher },                 \
 288     { OSSL_FUNC_CIPHER_GET_PARAMS,                                             \
 289       (void (*)(void)) alg##_##kbits##_##lc##_get_params },                    \
 290     { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,                                        \
 291       (void (*)(void))ossl_cipher_generic_gettable_params },                   \
 292     { OSSL_FUNC_CIPHER_GET_CTX_PARAMS,                                         \
 293       (void (*)(void)) alg##_##lc##_get_ctx_params },                          \
 294     { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,                                    \
 295       (void (*)(void)) alg##_##lc##_gettable_ctx_params },                     \
 296     { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,                                         \
 297       (void (*)(void)) alg##_##lc##_set_ctx_params },                          \
 298     { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,                                    \
 299       (void (*)(void)) alg##_##lc##_settable_ctx_params },                     \
 300     OSSL_DISPATCH_END                                                          \
 301 };
 302
 303 IMPLEMENT_cipher(aes, siv, SIV, SIV_FLAGS, 128, 8, 0)
 304 IMPLEMENT_cipher(aes, siv, SIV, SIV_FLAGS, 192, 8, 0)
 305 IMPLEMENT_cipher(aes, siv, SIV, SIV_FLAGS, 256, 8, 0)