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

Source
/*
 * Copyright 2018-2026 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 <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 "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;
    int key_set;
    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;
    ctx->key_set = 1;
    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;
    if (!ctx->key_set) {
        ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
        return 0;
    }
    ctx->updated = 1;
    Poly1305_Final(&ctx->poly1305, out);
    *outl = poly1305_size();
    return 1;
}

static const OSSL_PARAM known_gettable_params[] = {
    OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
    OSSL_PARAM_END
};
static const OSSL_PARAM *poly1305_gettable_params(void *provctx)
{
    return known_gettable_params;
}

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

    if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL)
        return OSSL_PARAM_set_size_t(p, poly1305_size());

    return 1;
}

static const OSSL_PARAM known_settable_ctx_params[] = {
    OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
    OSSL_PARAM_END
};
static const OSSL_PARAM *poly1305_settable_ctx_params(ossl_unused void *ctx,
    ossl_unused void *provctx)
{
    return known_settable_ctx_params;
}

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

    if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL
        && !poly1305_setkey(ctx, p->data, p->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 },
    { 0, NULL }
};

Line	Count	Source
1		/*
2		* Copyright 2018-2026 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		int updated;
41		int key_set;
42		POLY1305 poly1305; /* Poly1305 data */
43		};
44
45		static void poly1305_new(void provctx)
46	63	{
47	63	struct poly1305_data_st *ctx;
48
49	63	if (!ossl_prov_is_running())
50	0	return NULL;
51	63	ctx = OPENSSL_zalloc(sizeof(*ctx));
52	63	if (ctx != NULL)
53	63	ctx->provctx = provctx;
54	63	return ctx;
55	63	}
56
57		static void poly1305_free(void *vmacctx)
58	63	{
59	63	OPENSSL_free(vmacctx);
60	63	}
61
62		static void poly1305_dup(void vsrc)
63	0	{
64	0	struct poly1305_data_st *src = vsrc;
65	0	struct poly1305_data_st *dst;
66
67	0	if (!ossl_prov_is_running())
68	0	return NULL;
69	0	dst = OPENSSL_malloc(sizeof(*dst));
70	0	if (dst == NULL)
71	0	return NULL;
72
73	0	dst = src;
74	0	return dst;
75	0	}
76
77		static size_t poly1305_size(void)
78	560	{
79	560	return POLY1305_DIGEST_SIZE;
80	560	}
81
82		static int poly1305_setkey(struct poly1305_data_st *ctx,
83		const unsigned char *key, size_t keylen)
84	345	{
85	345	if (keylen != POLY1305_KEY_SIZE) {
86	61	ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
87	61	return 0;
88	61	}
89	284	Poly1305_Init(&ctx->poly1305, key);
90	284	ctx->updated = 0;
91	284	ctx->key_set = 1;
92	284	return 1;
93	345	}
94
95		static int poly1305_init(void vmacctx, const unsigned char key,
96		size_t keylen, const OSSL_PARAM params[])
97	341	{
98	341	struct poly1305_data_st *ctx = vmacctx;
99
100		/* initialize the context in MAC_ctrl function */
101	341	if (!ossl_prov_is_running() \|\| !poly1305_set_ctx_params(ctx, params))
102	56	return 0;
103	285	if (key != NULL)
104	285	return poly1305_setkey(ctx, key, keylen);
105		/* no reinitialization of context with the same key is allowed */
106	0	return ctx->updated == 0;
107	285	}
108
109		static int poly1305_update(void vmacctx, const unsigned char data,
110		size_t datalen)
111	310	{
112	310	struct poly1305_data_st *ctx = vmacctx;
113
114	310	ctx->updated = 1;
115	310	if (datalen == 0)
116	0	return 1;
117
118		/* poly1305 has nothing to return in its update function */
119	310	Poly1305_Update(&ctx->poly1305, data, datalen);
120	310	return 1;
121	310	}
122
123		static int poly1305_final(void vmacctx, unsigned char out, size_t *outl,
124		size_t outsize)
125	280	{
126	280	struct poly1305_data_st *ctx = vmacctx;
127
128	280	if (!ossl_prov_is_running())
129	0	return 0;
130	280	if (!ctx->key_set) {
131	0	ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
132	0	return 0;
133	0	}
134	280	ctx->updated = 1;
135	280	Poly1305_Final(&ctx->poly1305, out);
136	280	*outl = poly1305_size();
137	280	return 1;
138	280	}
139
140		static const OSSL_PARAM known_gettable_params[] = {
141		OSSL_PARAM_size_t(OSSL_MAC_PARAM_SIZE, NULL),
142		OSSL_PARAM_END
143		};
144		static const OSSL_PARAM poly1305_gettable_params(void provctx)
145	0	{
146	0	return known_gettable_params;
147	0	}
148
149		static int poly1305_get_params(OSSL_PARAM params[])
150	280	{
151	280	OSSL_PARAM *p;
152
153	280	if ((p = OSSL_PARAM_locate(params, OSSL_MAC_PARAM_SIZE)) != NULL)
154	280	return OSSL_PARAM_set_size_t(p, poly1305_size());
155
156	0	return 1;
157	280	}
158
159		static const OSSL_PARAM known_settable_ctx_params[] = {
160		OSSL_PARAM_octet_string(OSSL_MAC_PARAM_KEY, NULL, 0),
161		OSSL_PARAM_END
162		};
163		static const OSSL_PARAM poly1305_settable_ctx_params(ossl_unused void ctx,
164		ossl_unused void *provctx)
165	72	{
166	72	return known_settable_ctx_params;
167	72	}
168
169		static int poly1305_set_ctx_params(void vmacctx, const OSSL_PARAM params)
170	317	{
171	317	struct poly1305_data_st *ctx = vmacctx;
172	317	const OSSL_PARAM *p;
173
174	317	if ((p = OSSL_PARAM_locate_const(params, OSSL_MAC_PARAM_KEY)) != NULL
175	33	&& !poly1305_setkey(ctx, p->data, p->data_size))
176	31	return 0;
177	286	return 1;
178	317	}
179
180		const OSSL_DISPATCH ossl_poly1305_functions[] = {
181		{ OSSL_FUNC_MAC_NEWCTX, (void (*)(void))poly1305_new },
182		{ OSSL_FUNC_MAC_DUPCTX, (void (*)(void))poly1305_dup },
183		{ OSSL_FUNC_MAC_FREECTX, (void (*)(void))poly1305_free },
184		{ OSSL_FUNC_MAC_INIT, (void (*)(void))poly1305_init },
185		{ OSSL_FUNC_MAC_UPDATE, (void (*)(void))poly1305_update },
186		{ OSSL_FUNC_MAC_FINAL, (void (*)(void))poly1305_final },
187		{ OSSL_FUNC_MAC_GETTABLE_PARAMS, (void (*)(void))poly1305_gettable_params },
188		{ OSSL_FUNC_MAC_GET_PARAMS, (void (*)(void))poly1305_get_params },
189		{ OSSL_FUNC_MAC_SETTABLE_CTX_PARAMS,
190		(void (*)(void))poly1305_settable_ctx_params },
191		{ OSSL_FUNC_MAC_SET_CTX_PARAMS, (void (*)(void))poly1305_set_ctx_params },
192		{ 0, NULL }
193		};

Coverage Report

Created: 2026-07-12 07:21