providers/implementations/macs/poly1305_prov.c

   1 /*
   2  * Copyright 2018-2021 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 #include <openssl/core_dispatch.h>
  11 #include <openssl/core_names.h>
  12 #include <openssl/params.h>
  13 #include <openssl/evp.h>
  14 #include <openssl/err.h>
  15 #include <openssl/proverr.h>
  16
  17 #include "crypto/poly1305.h"
  18
  19 #include "prov/implementations.h"
  20 #include "prov/providercommon.h"
  21
  22 /*
  23  * Forward declaration of everything implemented here.  This is not strictly
  24  * necessary for the compiler, but provides an assurance that the signatures
  25  * of the functions in the dispatch table are correct.
  26  */
  27 static OSSL_FUNC_mac_newctx_fn poly1305_new;
  28 static OSSL_FUNC_mac_dupctx_fn poly1305_dup;
  29 static OSSL_FUNC_mac_freectx_fn poly1305_free;
  30 static OSSL_FUNC_mac_gettable_params_fn poly1305_gettable_params;
  31 static OSSL_FUNC_mac_get_params_fn poly1305_get_params;
  32 static OSSL_FUNC_mac_settable_ctx_params_fn poly1305_settable_ctx_params;
  33 static OSSL_FUNC_mac_set_ctx_params_fn poly1305_set_ctx_params;
  34 static OSSL_FUNC_mac_init_fn poly1305_init;
  35 static OSSL_FUNC_mac_update_fn poly1305_update;
  36 static OSSL_FUNC_mac_final_fn poly1305_final;
  37
  38 struct poly1305_data_st {
  39     void *provctx;
  40     POLY1305 poly1305;           /* Poly1305 data */
  41 };
  42
  43 static void *poly1305_new(void *provctx)
  44 {
  45     struct poly1305_data_st *ctx;
  46
  47     if (!ossl_prov_is_running())
  48         return NULL;
  49     ctx = OPENSSL_zalloc(sizeof(*ctx));
  50     if (ctx != NULL)
  51         ctx->provctx = provctx;
  52     return ctx;
  53 }
  54
  55 static void poly1305_free(void *vmacctx)
  56 {
  57     OPENSSL_free(vmacctx);
  58 }
  59
  60 static void *poly1305_dup(void *vsrc)
  61 {
  62     struct poly1305_data_st *src = vsrc;
  63     struct poly1305_data_st *dst;
  64
  65     if (!ossl_prov_is_running())
  66         return NULL;
  67     dst = poly1305_new(src->provctx);
  68     if (dst == NULL)
  69         return NULL;
  70
  71     dst->poly1305 = src->poly1305;
  72     return dst;
  73 }
  74
  75 static size_t poly1305_size(void)
  76 {
  77     return POLY1305_DIGEST_SIZE;
  78 }
  79
  80 static int poly1305_init(void *vmacctx)
  81 {
  82     /* initialize the context in MAC_ctrl function */
  83     return ossl_prov_is_running();
  84 }
  85
  86 static int poly1305_update(void *vmacctx, const unsigned char *data,
  87                        size_t datalen)
  88 {
  89     struct poly1305_data_st *ctx = vmacctx;
  90
  91     if (datalen == 0)
  92         return 1;
  93
  94     /* poly1305 has nothing to return in its update function */
  95     Poly1305_Update(&ctx->poly1305, data, datalen);
  96     return 1;
  97 }
  98
  99 static int poly1305_final(void *vmacctx, unsigned char *out, size_t *outl,
 100                           size_t outsize)
 101 {
 102     struct poly1305_data_st *ctx = vmacctx;
 103
 104     if (!ossl_prov_is_running())
 105         return 0;
 106     Poly1305_Final(&ctx->poly1305, out);
 107     *outl = poly1305_size();
 108     return 1;
 109 }
 110
 111 static const OSSL_PARAM known_gettable_params[] = {
 112     OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
 113     OSSL_PARAM_END
 114 };
 115 static const OSSL_PARAM *poly1305_gettable_params(void *provctx)
 116 {
 117     return known_gettable_params;
 118 }
 119
 120 static int poly1305_get_params(OSSL_PARAM params[])
 121 {
 122     OSSL_PARAM *p;
 123
 124     if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL)
 125         return OSSL_PARAM_set_size_t(p, poly1305_size());
 126
 127     return 1;
 128 }
 129
 130 static const OSSL_PARAM known_settable_ctx_params[] = {
 131     OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
 132     OSSL_PARAM_END
 133 };
 134 static const OSSL_PARAM *poly1305_settable_ctx_params(ossl_unused void *provctx)
 135 {
 136     return known_settable_ctx_params;
 137 }
 138
 139 static int poly1305_set_ctx_params(void *vmacctx, const OSSL_PARAM *params)
 140 {
 141     struct poly1305_data_st *ctx = vmacctx;
 142     const OSSL_PARAM *p = NULL;
 143
 144     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL) {
 145         if (p->data_type != OSSL_PARAM_OCTET_STRING
 146             || p->data_size != POLY1305_KEY_SIZE) {
 147             ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
 148             return 0;
 149         }
 150         Poly1305_Init(&ctx->poly1305, p->data);
 151     }
 152     return 1;
 153 }
 154
 155 const OSSL_DISPATCH ossl_poly1305_functions[] = {
 156     { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))poly1305_new },
 157     { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))poly1305_dup },
 158     { OSSL_FUNC_MAC_FREECTX, (void (*)(void))poly1305_free },
 159     { OSSL_FUNC_MAC_INIT, (void (*)(void))poly1305_init },
 160     { OSSL_FUNC_MAC_UPDATE, (void (*)(void))poly1305_update },
 161     { OSSL_FUNC_MAC_FINAL, (void (*)(void))poly1305_final },
 162     { OSSL_FUNC_MAC_GETTABLE_PARAMS, (void (*)(void))poly1305_gettable_params },
 163     { OSSL_FUNC_MAC_GET_PARAMS, (void (*)(void))poly1305_get_params },
 164     { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
 165       (void (*)(void))poly1305_settable_ctx_params },
 166     { OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))poly1305_set_ctx_params },
 167     { 0, NULL }
 168 };