/src/openssl36/providers/implementations/macs/poly1305_prov.c

Source
/*
 * Copyright 2018-2025 The OpenSSL Project Authors. All Rights Reserved.
 *
 * Licensed under the Apache License 2.0 (the "License").  You may not use
 * this file except in compliance with the License.  You can obtain a copy
 * in the file LICENSE in the source distribution or at
 * https://www.openssl.org/source/license.html
 */


#include <string.h>

#include <openssl/core_dispatch.h>
#include <openssl/core_names.h>
#include <openssl/params.h>
#include <openssl/evp.h>
#include <openssl/err.h>
#include <openssl/proverr.h>

#include "internal/cryptlib.h"
#include "crypto/poly1305.h"

#include "prov/implementations.h"
#include "prov/providercommon.h"

/*
 * Forward declaration of everything implemented here.  This is not strictly
 * necessary for the compiler, but provides an assurance that the signatures
 * of the functions in the dispatch table are correct.
 */
static OSSL_FUNC_mac_newctx_fn poly1305_new;
static OSSL_FUNC_mac_dupctx_fn poly1305_dup;
static OSSL_FUNC_mac_freectx_fn poly1305_free;
static OSSL_FUNC_mac_gettable_params_fn poly1305_gettable_params;
static OSSL_FUNC_mac_get_params_fn poly1305_get_params;
static OSSL_FUNC_mac_settable_ctx_params_fn poly1305_settable_ctx_params;
static OSSL_FUNC_mac_set_ctx_params_fn poly1305_set_ctx_params;
static OSSL_FUNC_mac_init_fn poly1305_init;
static OSSL_FUNC_mac_update_fn poly1305_update;
static OSSL_FUNC_mac_final_fn poly1305_final;

struct poly1305_data_st {
    void *provctx;
    int updated;
    POLY1305 poly1305;           /* Poly1305 data */
};

static void *poly1305_new(void *provctx)
{
    struct poly1305_data_st *ctx;

    if (!ossl_prov_is_running())
        return NULL;
    ctx = OPENSSL_zalloc(sizeof(*ctx));
    if (ctx != NULL)
        ctx->provctx = provctx;
    return ctx;
}

static void poly1305_free(void *vmacctx)
{
    OPENSSL_free(vmacctx);
}

static void *poly1305_dup(void *vsrc)
{
    struct poly1305_data_st *src = vsrc;
    struct poly1305_data_st *dst;

    if (!ossl_prov_is_running())
        return NULL;
    dst = OPENSSL_malloc(sizeof(*dst));
    if (dst == NULL)
        return NULL;

    *dst = *src;
    return dst;
}

static size_t poly1305_size(void)
{
    return POLY1305_DIGEST_SIZE;
}

static int poly1305_setkey(struct poly1305_data_st *ctx,
                           const unsigned char *key, size_t keylen)
{
    if (keylen != POLY1305_KEY_SIZE) {
        ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
        return 0;
    }
    Poly1305_Init(&ctx->poly1305, key);
    ctx->updated = 0;
    return 1;
}

static int poly1305_init(void *vmacctx, const unsigned char *key,
                         size_t keylen, const OSSL_PARAM params[])
{
    struct poly1305_data_st *ctx = vmacctx;

    /* initialize the context in MAC_ctrl function */
    if (!ossl_prov_is_running() || !poly1305_set_ctx_params(ctx, params))
        return 0;
    if (key != NULL)
        return poly1305_setkey(ctx, key, keylen);
    /* no reinitialization of context with the same key is allowed */
    return ctx->updated == 0;
}

static int poly1305_update(void *vmacctx, const unsigned char *data,
                       size_t datalen)
{
    struct poly1305_data_st *ctx = vmacctx;

    ctx->updated = 1;
    if (datalen == 0)
        return 1;

    /* poly1305 has nothing to return in its update function */
    Poly1305_Update(&ctx->poly1305, data, datalen);
    return 1;
}

static int poly1305_final(void *vmacctx, unsigned char *out, size_t *outl,
                          size_t outsize)
{
    struct poly1305_data_st *ctx = vmacctx;

    if (!ossl_prov_is_running())
        return 0;
    ctx->updated = 1;
    Poly1305_Final(&ctx->poly1305, out);
    *outl = poly1305_size();
    return 1;
}

/* Machine generated by util/perl/OpenSSL/paramnames.pm */
#ifndef poly1305_get_params_list
static const OSSL_PARAM poly1305_get_params_list[] = {
    OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
    OSSL_PARAM_END
};
#endif

#ifndef poly1305_get_params_st
struct poly1305_get_params_st {
    OSSL_PARAM *size;
};
#endif

#ifndef poly1305_get_params_decoder
static int poly1305_get_params_decoder
    (const OSSL_PARAM *p, struct poly1305_get_params_st *r)
{
    const char *s;

    memset(r, 0, sizeof(*r));
    if (p != NULL)
        for (; (s = p->key) != NULL; p++)
            if (ossl_likely(strcmp("size", s + 0) == 0)) {
                /* OSSL_MAC_PARAM_SIZE */
                if (ossl_unlikely(r->size != NULL)) {
                    ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
                                   "param %s is repeated", s);
                    return 0;
                }
                r->size = (OSSL_PARAM *)p;
            }
    return 1;
}
#endif
/* End of machine generated */

static const OSSL_PARAM *poly1305_gettable_params(void *provctx)
{
    return poly1305_get_params_list;
}

static int poly1305_get_params(OSSL_PARAM params[])
{
    struct poly1305_get_params_st p;

    if (!poly1305_get_params_decoder(params, &p))
        return 0;

    if (p.size != NULL && !OSSL_PARAM_set_size_t(p.size, poly1305_size()))
        return 0;

    return 1;
}

/* Machine generated by util/perl/OpenSSL/paramnames.pm */
#ifndef poly1305_set_ctx_params_list
static const OSSL_PARAM poly1305_set_ctx_params_list[] = {
    OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
    OSSL_PARAM_END
};
#endif

#ifndef poly1305_set_ctx_params_st
struct poly1305_set_ctx_params_st {
    OSSL_PARAM *key;
};
#endif

#ifndef poly1305_set_ctx_params_decoder
static int poly1305_set_ctx_params_decoder
    (const OSSL_PARAM *p, struct poly1305_set_ctx_params_st *r)
{
    const char *s;

    memset(r, 0, sizeof(*r));
    if (p != NULL)
        for (; (s = p->key) != NULL; p++)
            if (ossl_likely(strcmp("key", s + 0) == 0)) {
                /* OSSL_MAC_PARAM_KEY */
                if (ossl_unlikely(r->key != NULL)) {
                    ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
                                   "param %s is repeated", s);
                    return 0;
                }
                r->key = (OSSL_PARAM *)p;
            }
    return 1;
}
#endif
/* End of machine generated */

static const OSSL_PARAM *poly1305_settable_ctx_params(ossl_unused void *ctx,
                                                      ossl_unused void *provctx)
{
    return poly1305_set_ctx_params_list;
}

static int poly1305_set_ctx_params(void *vmacctx, const OSSL_PARAM *params)
{
    struct poly1305_data_st *ctx = vmacctx;
    struct poly1305_set_ctx_params_st p;

    if (ctx == NULL || !poly1305_set_ctx_params_decoder(params, &p))
        return 0;

    if (p.key != NULL)
        if (p.key->data_type != OSSL_PARAM_OCTET_STRING
                || !poly1305_setkey(ctx, p.key->data, p.key->data_size))
            return 0;
    return 1;
}

const OSSL_DISPATCH ossl_poly1305_functions[] = {
    { OSSL_FUNC_MAC_NEWCTX, (void (*)(void))poly1305_new },
    { OSSL_FUNC_MAC_DUPCTX, (void (*)(void))poly1305_dup },
    { OSSL_FUNC_MAC_FREECTX, (void (*)(void))poly1305_free },
    { OSSL_FUNC_MAC_INIT, (void (*)(void))poly1305_init },
    { OSSL_FUNC_MAC_UPDATE, (void (*)(void))poly1305_update },
    { OSSL_FUNC_MAC_FINAL, (void (*)(void))poly1305_final },
    { OSSL_FUNC_MAC_GETTABLE_PARAMS, (void (*)(void))poly1305_gettable_params },
    { OSSL_FUNC_MAC_GET_PARAMS, (void (*)(void))poly1305_get_params },
    { OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
      (void (*)(void))poly1305_settable_ctx_params },
    { OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))poly1305_set_ctx_params },
    OSSL_DISPATCH_END
};

Coverage Report

Created: 2025-12-04 06:33

Line	Count	Source
1		/*
2		* Copyright 2018-2025 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
11		#include <string.h>
12
13		#include <openssl/core_dispatch.h>
14		#include <openssl/core_names.h>
15		#include <openssl/params.h>
16		#include <openssl/evp.h>
17		#include <openssl/err.h>
18		#include <openssl/proverr.h>
19
20		#include "internal/cryptlib.h"
21		#include "crypto/poly1305.h"
22
23		#include "prov/implementations.h"
24		#include "prov/providercommon.h"
25
26		/*
27		* Forward declaration of everything implemented here. This is not strictly
28		* necessary for the compiler, but provides an assurance that the signatures
29		* of the functions in the dispatch table are correct.
30		*/
31		static OSSL_FUNC_mac_newctx_fn poly1305_new;
32		static OSSL_FUNC_mac_dupctx_fn poly1305_dup;
33		static OSSL_FUNC_mac_freectx_fn poly1305_free;
34		static OSSL_FUNC_mac_gettable_params_fn poly1305_gettable_params;
35		static OSSL_FUNC_mac_get_params_fn poly1305_get_params;
36		static OSSL_FUNC_mac_settable_ctx_params_fn poly1305_settable_ctx_params;
37		static OSSL_FUNC_mac_set_ctx_params_fn poly1305_set_ctx_params;
38		static OSSL_FUNC_mac_init_fn poly1305_init;
39		static OSSL_FUNC_mac_update_fn poly1305_update;
40		static OSSL_FUNC_mac_final_fn poly1305_final;
41
42		struct poly1305_data_st {
43		void *provctx;
44		int updated;
45		POLY1305 poly1305; /* Poly1305 data */
46		};
47
48		static void poly1305_new(void provctx)
49	70	{
50	70	struct poly1305_data_st *ctx;
51
52	70	if (!ossl_prov_is_running())
53	0	return NULL;
54	70	ctx = OPENSSL_zalloc(sizeof(*ctx));
55	70	if (ctx != NULL)
56	70	ctx->provctx = provctx;
57	70	return ctx;
58	70	}
59
60		static void poly1305_free(void *vmacctx)
61	70	{
62	70	OPENSSL_free(vmacctx);
63	70	}
64
65		static void poly1305_dup(void vsrc)
66	0	{
67	0	struct poly1305_data_st *src = vsrc;
68	0	struct poly1305_data_st *dst;
69
70	0	if (!ossl_prov_is_running())
71	0	return NULL;
72	0	dst = OPENSSL_malloc(sizeof(*dst));
73	0	if (dst == NULL)
74	0	return NULL;
75
76	0	dst = src;
77	0	return dst;
78	0	}
79
80		static size_t poly1305_size(void)
81	560	{
82	560	return POLY1305_DIGEST_SIZE;
83	560	}
84
85		static int poly1305_setkey(struct poly1305_data_st *ctx,
86		const unsigned char *key, size_t keylen)
87	352	{
88	352	if (keylen != POLY1305_KEY_SIZE) {
89	68	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
90	68	return 0;
91	68	}
92	284	Poly1305_Init(&ctx->poly1305, key);
93	284	ctx->updated = 0;
94	284	return 1;
95	352	}
96
97		static int poly1305_init(void vmacctx, const unsigned char key,
98		size_t keylen, const OSSL_PARAM params[])
99	348	{
100	348	struct poly1305_data_st *ctx = vmacctx;
101
102		/* initialize the context in MAC_ctrl function */
103	348	if (!ossl_prov_is_running() \|\| !poly1305_set_ctx_params(ctx, params))
104	63	return 0;
105	285	if (key != NULL)
106	285	return poly1305_setkey(ctx, key, keylen);
107		/* no reinitialization of context with the same key is allowed */
108	0	return ctx->updated == 0;
109	285	}
110
111		static int poly1305_update(void vmacctx, const unsigned char data,
112		size_t datalen)
113	310	{
114	310	struct poly1305_data_st *ctx = vmacctx;
115
116	310	ctx->updated = 1;
117	310	if (datalen == 0)
118	0	return 1;
119
120		/* poly1305 has nothing to return in its update function */
121	310	Poly1305_Update(&ctx->poly1305, data, datalen);
122	310	return 1;
123	310	}
124
125		static int poly1305_final(void vmacctx, unsigned char out, size_t *outl,
126		size_t outsize)
127	280	{
128	280	struct poly1305_data_st *ctx = vmacctx;
129
130	280	if (!ossl_prov_is_running())
131	0	return 0;
132	280	ctx->updated = 1;
133	280	Poly1305_Final(&ctx->poly1305, out);
134	280	*outl = poly1305_size();
135	280	return 1;
136	280	}
137
138		/* Machine generated by util/perl/OpenSSL/paramnames.pm */
139		#ifndef poly1305_get_params_list
140		static const OSSL_PARAM poly1305_get_params_list[] = {
141		OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
142		OSSL_PARAM_END
143		};
144		#endif
145
146		#ifndef poly1305_get_params_st
147		struct poly1305_get_params_st {
148		OSSL_PARAM *size;
149		};
150		#endif
151
152		#ifndef poly1305_get_params_decoder
153		static int poly1305_get_params_decoder
154		(const OSSL_PARAM p, struct poly1305_get_params_st r)
155	0	{
156	0	const char *s;
157
158	0	memset(r, 0, sizeof(*r));
159	0	if (p != NULL)
160	0	for (; (s = p->key) != NULL; p++)
161	0	if (ossl_likely(strcmp("size", s + 0) == 0)) {
162		/* OSSL_MAC_PARAM_SIZE */
163	0	if (ossl_unlikely(r->size != NULL)) {
164	0	ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
165	0	"param %s is repeated", s);
166	0	return 0;
167	0	}
168	0	r->size = (OSSL_PARAM *)p;
169	0	}
170	0	return 1;
171	0	}
172		#endif
173		/* End of machine generated */
174
175		static const OSSL_PARAM poly1305_gettable_params(void provctx)
176	0	{
177	0	return poly1305_get_params_list;
178	0	}
179
180		static int poly1305_get_params(OSSL_PARAM params[])
181	0	{
182	0	struct poly1305_get_params_st p;
183
184	0	if (!poly1305_get_params_decoder(params, &p))
185	0	return 0;
186
187	0	if (p.size != NULL && !OSSL_PARAM_set_size_t(p.size, poly1305_size()))
188	0	return 0;
189
190	0	return 1;
191	0	}
192
193		/* Machine generated by util/perl/OpenSSL/paramnames.pm */
194		#ifndef poly1305_set_ctx_params_list
195		static const OSSL_PARAM poly1305_set_ctx_params_list[] = {
196		OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
197		OSSL_PARAM_END
198		};
199		#endif
200
201		#ifndef poly1305_set_ctx_params_st
202		struct poly1305_set_ctx_params_st {
203		OSSL_PARAM *key;
204		};
205		#endif
206
207		#ifndef poly1305_set_ctx_params_decoder
208		static int poly1305_set_ctx_params_decoder
209		(const OSSL_PARAM p, struct poly1305_set_ctx_params_st r)
210	28	{
211	28	const char *s;
212
213	28	memset(r, 0, sizeof(*r));
214	28	if (p != NULL)
215	56	for (; (s = p->key) != NULL; p++)
216	28	if (ossl_likely(strcmp("key", s + 0) == 0)) {
217		/* OSSL_MAC_PARAM_KEY */
218	28	if (ossl_unlikely(r->key != NULL)) {
219	0	ERR_raise_data(ERR_LIB_PROV, PROV_R_REPEATED_PARAMETER,
220	0	"param %s is repeated", s);
221	0	return 0;
222	0	}
223	28	r->key = (OSSL_PARAM *)p;
224	28	}
225	28	return 1;
226	28	}
227		#endif
228		/* End of machine generated */
229
230		static const OSSL_PARAM poly1305_settable_ctx_params(ossl_unused void ctx,
231		ossl_unused void *provctx)
232	76	{
233	76	return poly1305_set_ctx_params_list;
234	76	}
235
236		static int poly1305_set_ctx_params(void vmacctx, const OSSL_PARAM params)
237	28	{
238	28	struct poly1305_data_st *ctx = vmacctx;
239	28	struct poly1305_set_ctx_params_st p;
240
241	28	if (ctx == NULL \|\| !poly1305_set_ctx_params_decoder(params, &p))
242	0	return 0;
243
244	28	if (p.key != NULL)
245	28	if (p.key->data_type != OSSL_PARAM_OCTET_STRING
246	28	\|\| !poly1305_setkey(ctx, p.key->data, p.key->data_size))
247	26	return 0;
248	2	return 1;
249	28	}
250
251		const OSSL_DISPATCH ossl_poly1305_functions[] = {
252		{ OSSL_FUNC_MAC_NEWCTX, (void (*)(void))poly1305_new },
253		{ OSSL_FUNC_MAC_DUPCTX, (void (*)(void))poly1305_dup },
254		{ OSSL_FUNC_MAC_FREECTX, (void (*)(void))poly1305_free },
255		{ OSSL_FUNC_MAC_INIT, (void (*)(void))poly1305_init },
256		{ OSSL_FUNC_MAC_UPDATE, (void (*)(void))poly1305_update },
257		{ OSSL_FUNC_MAC_FINAL, (void (*)(void))poly1305_final },
258		{ OSSL_FUNC_MAC_GETTABLE_PARAMS, (void (*)(void))poly1305_gettable_params },
259		{ OSSL_FUNC_MAC_GET_PARAMS, (void (*)(void))poly1305_get_params },
260		{ OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
261		(void (*)(void))poly1305_settable_ctx_params },
262		{ OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))poly1305_set_ctx_params },
263		OSSL_DISPATCH_END
264		};