providers/implementations/ciphers/cipher_aes_siv.c

   1 /*
   2  * Copyright 2019 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 #include "cipher_aes_siv.h"
  13 #include "prov/implementations.h"
  14 #include "prov/providercommonerr.h"
  15 #include "prov/cipher_aead.h"
  16
  17 #define siv_stream_update siv_cipher
  18 #define SIV_FLAGS AEAD_FLAGS
  19
  20 static void *aes_siv_newctx(void *provctx, size_t keybits, unsigned int mode,
  21                             uint64_t flags)
  22 {
  23     PROV_AES_SIV_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));
  24
  25     if (ctx != NULL) {
  26         ctx->taglen = SIV_LEN;
  27         ctx->mode = mode;
  28         ctx->flags = flags;
  29         ctx->keylen = keybits / 8;
  30         ctx->hw = PROV_CIPHER_HW_aes_siv(keybits);
  31     }
  32     return ctx;
  33 }
  34
  35 static void aes_siv_freectx(void *vctx)
  36 {
  37     PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
  38
  39     if (ctx != NULL) {
  40         ctx->hw->cleanup(ctx);
  41         OPENSSL_clear_free(ctx,  sizeof(*ctx));
  42     }
  43 }
  44
  45 static int siv_init(void *vctx, const unsigned char *key, size_t keylen,
  46                     const unsigned char *iv, size_t ivlen, int enc)
  47 {
  48     PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
  49
  50     ctx->enc = enc;
  51
  52     if (iv != NULL)
  53         return 0;
  54
  55     if (key != NULL) {
  56         if (keylen != ctx->keylen) {
  57             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
  58             return 0;
  59         }
  60         return ctx->hw->initkey(ctx, key, ctx->keylen);
  61     }
  62     return 1;
  63 }
  64
  65 static int siv_einit(void *vctx, const unsigned char *key, size_t keylen,
  66                      const unsigned char *iv, size_t ivlen)
  67 {
  68     return siv_init(vctx, key, keylen, iv, ivlen, 1);
  69 }
  70
  71 static int siv_dinit(void *vctx, const unsigned char *key, size_t keylen,
  72                      const unsigned char *iv, size_t ivlen)
  73 {
  74     return siv_init(vctx, key, keylen, iv, ivlen, 0);
  75 }
  76
  77 static int siv_cipher(void *vctx, unsigned char *out, size_t *outl,
  78                       size_t outsize, const unsigned char *in, size_t inl)
  79 {
  80     PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
  81
  82     if (outsize < inl) {
  83         ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
  84         return 0;
  85     }
  86
  87     if (ctx->hw->cipher(ctx, out, in, inl) <= 0)
  88         return 0;
  89
  90     if (outl != NULL)
  91         *outl = inl;
  92     return 1;
  93 }
  94
  95 static int siv_stream_final(void *vctx, unsigned char *out, size_t *outl,
  96                             size_t outsize)
  97 {
  98     PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
  99
 100     if (!ctx->hw->cipher(vctx, out, NULL, 0))
 101         return 0;
 102
 103     if (outl != NULL)
 104         *outl = 0;
 105     return 1;
 106 }
 107
 108 static int aes_siv_get_ctx_params(void *vctx, OSSL_PARAM params[])
 109 {
 110     PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
 111     SIV128_CONTEXT *sctx = &ctx->siv;
 112     OSSL_PARAM *p;
 113
 114     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAG);
 115     if (p != NULL && p->data_type == OSSL_PARAM_OCTET_STRING) {
 116         if (!ctx->enc
 117             || p->data_size != ctx->taglen
 118             || !OSSL_PARAM_set_octet_string(p, &sctx->tag.byte, ctx->taglen)) {
 119             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 120             return 0;
 121         }
 122     }
 123     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAGLEN);
 124     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->taglen)) {
 125         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 126         return 0;
 127     }
 128     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
 129     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->keylen)) {
 130         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 131         return 0;
 132     }
 133     return 1;
 134 }
 135
 136 static const OSSL_PARAM aes_siv_known_gettable_ctx_params[] = {
 137     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
 138     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
 139     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_SPEED, NULL),
 140     OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
 141     OSSL_PARAM_END
 142 };
 143 static const OSSL_PARAM *aes_siv_gettable_ctx_params(void)
 144 {
 145     return aes_siv_known_gettable_ctx_params;
 146 }
 147
 148 static int aes_siv_set_ctx_params(void *vctx, const OSSL_PARAM params[])
 149 {
 150     PROV_AES_SIV_CTX *ctx = (PROV_AES_SIV_CTX *)vctx;
 151     const OSSL_PARAM *p;
 152     unsigned int speed = 0;
 153
 154     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TAG);
 155     if (p != NULL) {
 156         if (ctx->enc)
 157             return 1;
 158         if (p->data_type != OSSL_PARAM_OCTET_STRING
 159             || !ctx->hw->settag(ctx, p->data, p->data_size)) {
 160             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 161             return 0;
 162         }
 163     }
 164     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_SPEED);
 165     if (p != NULL) {
 166         if (!OSSL_PARAM_get_uint(p, &speed)) {
 167             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 168             return 0;
 169         }
 170         ctx->hw->setspeed(ctx, (int)speed);
 171     }
 172     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
 173     if (p != NULL) {
 174         size_t keylen;
 175
 176         if (!OSSL_PARAM_get_size_t(p, &keylen)) {
 177             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 178             return 0;
 179         }
 180         /* The key length can not be modified */
 181         if (keylen != ctx->keylen)
 182             return 0;
 183     }
 184     return 1;
 185 }
 186
 187 static const OSSL_PARAM aes_siv_known_settable_ctx_params[] = {
 188     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
 189     OSSL_PARAM_uint(OSSL_CIPHER_PARAM_SPEED, 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_settable_ctx_params(void)
 194 {
 195     return aes_siv_known_settable_ctx_params;
 196 }
 197
 198 #define IMPLEMENT_cipher(alg, lc, UCMODE, flags, kbits, blkbits, ivbits)       \
 199 static OSSL_OP_cipher_get_params_fn alg##_##kbits##_##lc##_get_params;         \
 200 static int alg##_##kbits##_##lc##_get_params(OSSL_PARAM params[])              \
 201 {                                                                              \
 202     return cipher_generic_get_params(params, EVP_CIPH_##UCMODE##_MODE,         \
 203                                      flags, 2*kbits, blkbits, ivbits);         \
 204 }                                                                              \
 205 static OSSL_OP_cipher_newctx_fn alg##kbits##lc##_newctx;                       \
 206 static void * alg##kbits##lc##_newctx(void *provctx)                           \
 207 {                                                                              \
 208     return alg##_##lc##_newctx(provctx, 2*kbits, EVP_CIPH_##UCMODE##_MODE,     \
 209                                flags);                                         \
 210 }                                                                              \
 211 const OSSL_DISPATCH alg##kbits##lc##_functions[] = {                           \
 212     { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))alg##kbits##lc##_newctx },      \
 213     { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))alg##_##lc##_freectx },        \
 214     { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void)) lc##_einit },            \
 215     { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void)) lc##_dinit },            \
 216     { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void)) lc##_stream_update },          \
 217     { OSSL_FUNC_CIPHER_FINAL, (void (*)(void)) lc##_stream_final },            \
 218     { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void)) lc##_cipher },                 \
 219     { OSSL_FUNC_CIPHER_GET_PARAMS,                                             \
 220       (void (*)(void)) alg##_##kbits##_##lc##_get_params },                    \
 221     { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,                                        \
 222       (void (*)(void))cipher_generic_gettable_params },                        \
 223     { OSSL_FUNC_CIPHER_GET_CTX_PARAMS,                                         \
 224       (void (*)(void)) alg##_##lc##_get_ctx_params },                          \
 225     { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,                                    \
 226       (void (*)(void)) alg##_##lc##_gettable_ctx_params },                     \
 227     { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,                                         \
 228       (void (*)(void)) alg##_##lc##_set_ctx_params },                          \
 229     { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,                                    \
 230       (void (*)(void)) alg##_##lc##_settable_ctx_params },                     \
 231     { 0, NULL }                                                                \
 232 };
 233
 234 IMPLEMENT_cipher(aes, siv, SIV, SIV_FLAGS, 128, 8, 0)
 235 IMPLEMENT_cipher(aes, siv, SIV, SIV_FLAGS, 192, 8, 0)
 236 IMPLEMENT_cipher(aes, siv, SIV, SIV_FLAGS, 256, 8, 0)