providers/implementations/macs/poly1305_prov.c

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