Change the default MANSUFFIX
[openssl.git] / 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_setkey(struct poly1305_data_st *ctx,
81                            const unsigned char *key, size_t keylen)
82 {
83     if (keylen != POLY1305_KEY_SIZE) {
84         ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
85         return 0;
86     }
87     Poly1305_Init(&ctx->poly1305, key);
88     return 1;
89 }
90
91 static int poly1305_init(void *vmacctx, const unsigned char *key,
92                          size_t keylen, const OSSL_PARAM params[])
93 {
94     struct poly1305_data_st *ctx = vmacctx;
95
96     /* initialize the context in MAC_ctrl function */
97     if (!ossl_prov_is_running() || !poly1305_set_ctx_params(ctx, params))
98         return 0;
99     if (key != NULL)
100         return poly1305_setkey(ctx, key, keylen);
101     return 1;
102 }
103
104 static int poly1305_update(void *vmacctx, const unsigned char *data,
105                        size_t datalen)
106 {
107     struct poly1305_data_st *ctx = vmacctx;
108
109     if (datalen == 0)
110         return 1;
111
112     /* poly1305 has nothing to return in its update function */
113     Poly1305_Update(&ctx->poly1305, data, datalen);
114     return 1;
115 }
116
117 static int poly1305_final(void *vmacctx, unsigned char *out, size_t *outl,
118                           size_t outsize)
119 {
120     struct poly1305_data_st *ctx = vmacctx;
121
122     if (!ossl_prov_is_running())
123         return 0;
124     Poly1305_Final(&ctx->poly1305, out);
125     *outl = poly1305_size();
126     return 1;
127 }
128
129 static const OSSL_PARAM known_gettable_params[] = {
130     OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
131     OSSL_PARAM_END
132 };
133 static const OSSL_PARAM *poly1305_gettable_params(void *provctx)
134 {
135     return known_gettable_params;
136 }
137
138 static int poly1305_get_params(OSSL_PARAM params[])
139 {
140     OSSL_PARAM *p;
141
142     if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL)
143         return OSSL_PARAM_set_size_t(p, poly1305_size());
144
145     return 1;
146 }
147
148 static const OSSL_PARAM known_settable_ctx_params[] = {
149     OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
150     OSSL_PARAM_END
151 };
152 static const OSSL_PARAM *poly1305_settable_ctx_params(ossl_unused void *ctx,
153                                                       ossl_unused void *provctx)
154 {
155     return known_settable_ctx_params;
156 }
157
158 static int poly1305_set_ctx_params(void *vmacctx, const OSSL_PARAM *params)
159 {
160     struct poly1305_data_st *ctx = vmacctx;
161     const OSSL_PARAM *p;
162
163     if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL
164             && !poly1305_setkey(ctx, p->data, p->data_size))
165         return 0;
166     return 1;
167 }
168
169 const OSSL_DISPATCH ossl_poly1305_functions[] = {
170     { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))poly1305_new },
171     { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))poly1305_dup },
172     { OSSL_FUNC_MAC_FREECTX, (void (*)(void))poly1305_free },
173     { OSSL_FUNC_MAC_INIT, (void (*)(void))poly1305_init },
174     { OSSL_FUNC_MAC_UPDATE, (void (*)(void))poly1305_update },
175     { OSSL_FUNC_MAC_FINAL, (void (*)(void))poly1305_final },
176     { OSSL_FUNC_MAC_GETTABLE_PARAMS, (void (*)(void))poly1305_gettable_params },
177     { OSSL_FUNC_MAC_GET_PARAMS, (void (*)(void))poly1305_get_params },
178     { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
179       (void (*)(void))poly1305_settable_ctx_params },
180     { OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))poly1305_set_ctx_params },
181     { 0, NULL }
182 };