providers/implementations/ciphers/cipher_chacha20_poly1305.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_poly1305 cipher */
  11
  12 #include "cipher_chacha20_poly1305.h"
  13 #include "prov/implementations.h"
  14 #include "prov/providercommonerr.h"
  15
  16
  17 #define CHACHA20_POLY1305_KEYLEN CHACHA_KEY_SIZE
  18 #define CHACHA20_POLY1305_BLKLEN 1
  19 #define CHACHA20_POLY1305_MAX_IVLEN 12
  20 #define CHACHA20_POLY1305_MODE 0
  21 /* TODO(3.0) Figure out what flags are required */
  22 #define CHACHA20_POLY1305_FLAGS (EVP_CIPH_FLAG_AEAD_CIPHER                     \
  23                                 | EVP_CIPH_ALWAYS_CALL_INIT                    \
  24                                 | EVP_CIPH_CTRL_INIT                           \
  25                                 | EVP_CIPH_CUSTOM_COPY                         \
  26                                 | EVP_CIPH_FLAG_CUSTOM_CIPHER                  \
  27                                 | EVP_CIPH_CUSTOM_IV                           \
  28                                 | EVP_CIPH_CUSTOM_IV_LENGTH)
  29
  30 static OSSL_FUNC_cipher_newctx_fn chacha20_poly1305_newctx;
  31 static OSSL_FUNC_cipher_freectx_fn chacha20_poly1305_freectx;
  32 static OSSL_FUNC_cipher_encrypt_init_fn chacha20_poly1305_einit;
  33 static OSSL_FUNC_cipher_decrypt_init_fn chacha20_poly1305_dinit;
  34 static OSSL_FUNC_cipher_get_params_fn chacha20_poly1305_get_params;
  35 static OSSL_FUNC_cipher_get_ctx_params_fn chacha20_poly1305_get_ctx_params;
  36 static OSSL_FUNC_cipher_set_ctx_params_fn chacha20_poly1305_set_ctx_params;
  37 static OSSL_FUNC_cipher_cipher_fn chacha20_poly1305_cipher;
  38 static OSSL_FUNC_cipher_final_fn chacha20_poly1305_final;
  39 static OSSL_FUNC_cipher_gettable_ctx_params_fn chacha20_poly1305_gettable_ctx_params;
  40 #define chacha20_poly1305_settable_ctx_params cipher_aead_settable_ctx_params
  41 #define chacha20_poly1305_gettable_params cipher_generic_gettable_params
  42 #define chacha20_poly1305_update chacha20_poly1305_cipher
  43
  44 static void *chacha20_poly1305_newctx(void *provctx)
  45 {
  46     PROV_CHACHA20_POLY1305_CTX *ctx = OPENSSL_zalloc(sizeof(*ctx));
  47
  48     if (ctx != NULL) {
  49         cipher_generic_initkey(&ctx->base, CHACHA20_POLY1305_KEYLEN * 8,
  50                                CHACHA20_POLY1305_BLKLEN * 8,
  51                                CHACHA20_POLY1305_IVLEN * 8,
  52                                CHACHA20_POLY1305_MODE,
  53                                CHACHA20_POLY1305_FLAGS,
  54                                PROV_CIPHER_HW_chacha20_poly1305(
  55                                    CHACHA20_POLY1305_KEYLEN * 8),
  56                                NULL);
  57         ctx->nonce_len = CHACHA20_POLY1305_IVLEN;
  58         ctx->tls_payload_length = NO_TLS_PAYLOAD_LENGTH;
  59         chacha20_initctx(&ctx->chacha);
  60     }
  61     return ctx;
  62 }
  63
  64 static void chacha20_poly1305_freectx(void *vctx)
  65 {
  66     PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
  67
  68     if (ctx != NULL) {
  69         cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
  70         OPENSSL_clear_free(ctx, sizeof(*ctx));
  71     }
  72 }
  73
  74 static int chacha20_poly1305_get_params(OSSL_PARAM params[])
  75 {
  76     return cipher_generic_get_params(params, 0, CHACHA20_POLY1305_FLAGS,
  77                                      CHACHA20_POLY1305_KEYLEN * 8,
  78                                      CHACHA20_POLY1305_BLKLEN * 8,
  79                                      CHACHA20_POLY1305_IVLEN * 8);
  80 }
  81
  82 static int chacha20_poly1305_get_ctx_params(void *vctx, OSSL_PARAM params[])
  83 {
  84     PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
  85     OSSL_PARAM *p;
  86
  87     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
  88     if (p != NULL) {
  89         if (!OSSL_PARAM_set_size_t(p, ctx->nonce_len)) {
  90             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
  91             return 0;
  92         }
  93     }
  94     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
  95     if (p != NULL && !OSSL_PARAM_set_size_t(p, CHACHA20_POLY1305_KEYLEN)) {
  96         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
  97         return 0;
  98     }
  99     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAGLEN);
 100     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->tag_len)) {
 101         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 102         return 0;
 103     }
 104     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD);
 105     if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->tls_aad_pad_sz)) {
 106         ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 107         return 0;
 108     }
 109
 110     p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAG);
 111     if (p != NULL) {
 112         if (p->data_type != OSSL_PARAM_OCTET_STRING) {
 113             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
 114             return 0;
 115         }
 116         if (!ctx->base.enc) {
 117             ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOTSET);
 118             return 0;
 119         }
 120         if (p->data_size == 0 || p->data_size > POLY1305_BLOCK_SIZE) {
 121             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAGLEN);
 122             return 0;
 123         }
 124         memcpy(p->data, ctx->tag, p->data_size);
 125     }
 126
 127     return 1;
 128 }
 129
 130 static const OSSL_PARAM chacha20_poly1305_known_gettable_ctx_params[] = {
 131     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
 132     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
 133     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
 134     OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
 135     OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, NULL),
 136     OSSL_PARAM_END
 137 };
 138 static const OSSL_PARAM *chacha20_poly1305_gettable_ctx_params(void)
 139 {
 140     return chacha20_poly1305_known_gettable_ctx_params;
 141 }
 142
 143 static int chacha20_poly1305_set_ctx_params(void *vctx,
 144                                             const OSSL_PARAM params[])
 145 {
 146     const OSSL_PARAM *p;
 147     size_t len;
 148     PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
 149     PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
 150         (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->base.hw;
 151
 152     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
 153     if (p != NULL) {
 154         if (!OSSL_PARAM_get_size_t(p, &len)) {
 155             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 156             return 0;
 157         }
 158         if (len != CHACHA20_POLY1305_KEYLEN) {
 159             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
 160             return 0;
 161         }
 162     }
 163     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_IVLEN);
 164     if (p != NULL) {
 165         if (!OSSL_PARAM_get_size_t(p, &len)) {
 166             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 167             return 0;
 168         }
 169         if (len == 0 || len > CHACHA20_POLY1305_MAX_IVLEN) {
 170             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
 171             return 0;
 172         }
 173         ctx->nonce_len = len;
 174     }
 175
 176     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TAG);
 177     if (p != NULL) {
 178         if (p->data_type != OSSL_PARAM_OCTET_STRING) {
 179             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 180             return 0;
 181         }
 182         if (p->data_size == 0 || p->data_size > POLY1305_BLOCK_SIZE) {
 183             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAGLEN);
 184             return 0;
 185         }
 186         if (p->data != NULL) {
 187             if (ctx->base.enc) {
 188                 ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_NEEDED);
 189                 return 0;
 190             }
 191             memcpy(ctx->tag, p->data, p->data_size);
 192         }
 193         ctx->tag_len = p->data_size;
 194     }
 195
 196     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TLS1_AAD);
 197     if (p != NULL) {
 198         if (p->data_type != OSSL_PARAM_OCTET_STRING) {
 199             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 200             return 0;
 201         }
 202         len = hw->tls_init(&ctx->base, p->data, p->data_size);
 203         if (len == 0) {
 204             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DATA);
 205             return 0;
 206         }
 207         ctx->tls_aad_pad_sz = len;
 208     }
 209
 210     p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED);
 211     if (p != NULL) {
 212         if (p->data_type != OSSL_PARAM_OCTET_STRING) {
 213             ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
 214             return 0;
 215         }
 216         if (hw->tls_iv_set_fixed(&ctx->base, p->data, p->data_size) == 0) {
 217             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IVLEN);
 218             return 0;
 219         }
 220     }
 221     /* ignore OSSL_CIPHER_PARAM_AEAD_MAC_KEY */
 222     return 1;
 223 }
 224
 225 static int chacha20_poly1305_einit(void *vctx, const unsigned char *key,
 226                                   size_t keylen, const unsigned char *iv,
 227                                   size_t ivlen)
 228 {
 229     int ret;
 230
 231     ret = cipher_generic_einit(vctx, key, keylen, iv, ivlen);
 232     if (ret && iv != NULL) {
 233         PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
 234         PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
 235             (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
 236
 237         hw->initiv(ctx);
 238     }
 239     return ret;
 240 }
 241
 242 static int chacha20_poly1305_dinit(void *vctx, const unsigned char *key,
 243                                   size_t keylen, const unsigned char *iv,
 244                                   size_t ivlen)
 245 {
 246     int ret;
 247
 248     ret = cipher_generic_dinit(vctx, key, keylen, iv, ivlen);
 249     if (ret && iv != NULL) {
 250         PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
 251         PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
 252             (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
 253
 254         hw->initiv(ctx);
 255     }
 256     return ret;
 257 }
 258
 259 static int chacha20_poly1305_cipher(void *vctx, unsigned char *out,
 260                                     size_t *outl, size_t outsize,
 261                                     const unsigned char *in, size_t inl)
 262 {
 263     PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
 264     PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
 265         (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
 266
 267     if (inl == 0) {
 268         *outl = 0;
 269         return 1;
 270     }
 271
 272     if (outsize < inl) {
 273         ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
 274         return 0;
 275     }
 276
 277     if (!hw->aead_cipher(ctx, out, outl, in, inl))
 278         return 0;
 279
 280     return 1;
 281 }
 282
 283 static int chacha20_poly1305_final(void *vctx, unsigned char *out, size_t *outl,
 284                                    size_t outsize)
 285 {
 286     PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
 287     PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
 288         (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
 289
 290     if (hw->aead_cipher(ctx, out, outl, NULL, 0) <= 0)
 291         return 0;
 292
 293     *outl = 0;
 294     return 1;
 295 }
 296
 297 /* chacha20_poly1305_functions */
 298 const OSSL_DISPATCH chacha20_poly1305_functions[] = {
 299     { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))chacha20_poly1305_newctx },
 300     { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))chacha20_poly1305_freectx },
 301     { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))chacha20_poly1305_einit },
 302     { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))chacha20_poly1305_dinit },
 303     { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))chacha20_poly1305_update },
 304     { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))chacha20_poly1305_final },
 305     { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))chacha20_poly1305_cipher },
 306     { OSSL_FUNC_CIPHER_GET_PARAMS,
 307         (void (*)(void))chacha20_poly1305_get_params },
 308     { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,
 309         (void (*)(void))chacha20_poly1305_gettable_params },
 310     { OSSL_FUNC_CIPHER_GET_CTX_PARAMS,
 311          (void (*)(void))chacha20_poly1305_get_ctx_params },
 312     { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,
 313         (void (*)(void))chacha20_poly1305_gettable_ctx_params },
 314     { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,
 315         (void (*)(void))chacha20_poly1305_set_ctx_params },
 316     { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,
 317         (void (*)(void))chacha20_poly1305_settable_ctx_params },
 318     { 0, NULL }
 319 };
 320