Coverage Report

Created: 2026-09-12 06:55

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/openssl40/providers/implementations/ciphers/cipher_chacha20_poly1305.c
Line
Count
Source
1
/*
2
 * Copyright 2019-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
/* Dispatch functions for chacha20_poly1305 cipher */
11
12
#include <string.h>
13
#include <openssl/proverr.h>
14
#include "cipher_chacha20_poly1305.h"
15
#include "prov/implementations.h"
16
#include "prov/providercommon.h"
17
#include "providers/implementations/ciphers/cipher_chacha20_poly1305.inc"
18
19
156k
#define CHACHA20_POLY1305_KEYLEN CHACHA_KEY_SIZE
20
144k
#define CHACHA20_POLY1305_BLKLEN 1
21
2.11k
#define CHACHA20_POLY1305_MAX_IVLEN 12
22
7.69k
#define CHACHA20_POLY1305_MODE 0
23
144k
#define CHACHA20_POLY1305_FLAGS (PROV_CIPHER_FLAG_AEAD \
24
144k
    | PROV_CIPHER_FLAG_CUSTOM_IV)
25
26
static OSSL_FUNC_cipher_newctx_fn chacha20_poly1305_newctx;
27
static OSSL_FUNC_cipher_freectx_fn chacha20_poly1305_freectx;
28
static OSSL_FUNC_cipher_dupctx_fn chacha20_poly1305_dupctx;
29
static OSSL_FUNC_cipher_encrypt_init_fn chacha20_poly1305_einit;
30
static OSSL_FUNC_cipher_decrypt_init_fn chacha20_poly1305_dinit;
31
static OSSL_FUNC_cipher_get_params_fn chacha20_poly1305_get_params;
32
static OSSL_FUNC_cipher_get_ctx_params_fn chacha20_poly1305_get_ctx_params;
33
static OSSL_FUNC_cipher_set_ctx_params_fn chacha20_poly1305_set_ctx_params;
34
static OSSL_FUNC_cipher_cipher_fn chacha20_poly1305_cipher;
35
static OSSL_FUNC_cipher_final_fn chacha20_poly1305_final;
36
static OSSL_FUNC_cipher_gettable_ctx_params_fn chacha20_poly1305_gettable_ctx_params;
37
static OSSL_FUNC_cipher_settable_ctx_params_fn chacha20_poly1305_settable_ctx_params;
38
#define chacha20_poly1305_gettable_params ossl_cipher_generic_gettable_params
39
40
static void *chacha20_poly1305_newctx(void *provctx)
41
7.69k
{
42
7.69k
    PROV_CHACHA20_POLY1305_CTX *ctx;
43
44
7.69k
    if (!ossl_prov_is_running())
45
0
        return NULL;
46
47
7.69k
    ctx = OPENSSL_zalloc(sizeof(*ctx));
48
7.69k
    if (ctx != NULL) {
49
7.69k
        ossl_cipher_generic_initkey(&ctx->base, CHACHA20_POLY1305_KEYLEN * 8,
50
7.69k
            CHACHA20_POLY1305_BLKLEN * 8,
51
7.69k
            CHACHA20_POLY1305_IVLEN * 8,
52
7.69k
            CHACHA20_POLY1305_MODE,
53
7.69k
            CHACHA20_POLY1305_FLAGS,
54
7.69k
            ossl_prov_cipher_hw_chacha20_poly1305(
55
7.69k
                CHACHA20_POLY1305_KEYLEN * 8),
56
7.69k
            NULL);
57
7.69k
        ctx->tls_payload_length = NO_TLS_PAYLOAD_LENGTH;
58
7.69k
        ossl_chacha20_initctx(&ctx->chacha);
59
7.69k
    }
60
7.69k
    return ctx;
61
7.69k
}
62
63
static void *chacha20_poly1305_dupctx(void *provctx)
64
0
{
65
0
    PROV_CHACHA20_POLY1305_CTX *ctx = provctx;
66
0
    PROV_CHACHA20_POLY1305_CTX *dctx = NULL;
67
68
0
    if (ctx == NULL)
69
0
        return NULL;
70
0
    dctx = OPENSSL_memdup(ctx, sizeof(*ctx));
71
0
    if (dctx != NULL && dctx->base.tlsmac != NULL && dctx->base.alloced) {
72
0
        dctx->base.tlsmac = OPENSSL_memdup(dctx->base.tlsmac,
73
0
            dctx->base.tlsmacsize);
74
0
        if (dctx->base.tlsmac == NULL) {
75
0
            OPENSSL_free(dctx);
76
0
            dctx = NULL;
77
0
        }
78
0
    }
79
0
    return dctx;
80
0
}
81
82
static void chacha20_poly1305_freectx(void *vctx)
83
7.69k
{
84
7.69k
    PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
85
86
7.69k
    if (ctx != NULL) {
87
7.69k
        ossl_cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
88
7.69k
        OPENSSL_clear_free(ctx, sizeof(*ctx));
89
7.69k
    }
90
7.69k
}
91
92
static int chacha20_poly1305_get_params(OSSL_PARAM params[])
93
136k
{
94
136k
    return ossl_cipher_generic_get_params(params, 0, CHACHA20_POLY1305_FLAGS,
95
136k
        CHACHA20_POLY1305_KEYLEN * 8,
96
136k
        CHACHA20_POLY1305_BLKLEN * 8,
97
136k
        CHACHA20_POLY1305_IVLEN * 8);
98
136k
}
99
100
static int chacha20_poly1305_get_ctx_params(void *vctx, OSSL_PARAM params[])
101
57.9k
{
102
57.9k
    PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
103
57.9k
    struct chacha20_poly1305_get_ctx_params_st p;
104
105
57.9k
    if (ctx == NULL || !chacha20_poly1305_get_ctx_params_decoder(params, &p))
106
0
        return 0;
107
108
57.9k
    if (p.ivlen != NULL
109
3.89k
        && !OSSL_PARAM_set_size_t(p.ivlen, CHACHA20_POLY1305_IVLEN)) {
110
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
111
0
        return 0;
112
0
    }
113
114
57.9k
    if (p.keylen != NULL
115
4.31k
        && !OSSL_PARAM_set_size_t(p.keylen, CHACHA20_POLY1305_KEYLEN)) {
116
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
117
0
        return 0;
118
0
    }
119
120
57.9k
    if (p.taglen != NULL
121
0
        && !OSSL_PARAM_set_size_t(p.taglen, ctx->tag_len)) {
122
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
123
0
        return 0;
124
0
    }
125
126
57.9k
    if (p.pad != NULL
127
4.52k
        && !OSSL_PARAM_set_size_t(p.pad, ctx->tls_aad_pad_sz)) {
128
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
129
0
        return 0;
130
0
    }
131
132
57.9k
    if (p.tag != NULL) {
133
45.1k
        if (p.tag->data_type != OSSL_PARAM_OCTET_STRING) {
134
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
135
0
            return 0;
136
0
        }
137
45.1k
        if (!ctx->base.enc) {
138
0
            ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_SET);
139
0
            return 0;
140
0
        }
141
45.1k
        if (p.tag->data_size == 0 || p.tag->data_size > POLY1305_BLOCK_SIZE) {
142
0
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG_LENGTH);
143
0
            return 0;
144
0
        }
145
45.1k
        memcpy(p.tag->data, ctx->tag, p.tag->data_size);
146
45.1k
    }
147
57.9k
    return 1;
148
57.9k
}
149
150
static const OSSL_PARAM *chacha20_poly1305_gettable_ctx_params(ossl_unused void *cctx, ossl_unused void *provctx)
151
70
{
152
70
    return chacha20_poly1305_get_ctx_params_list;
153
70
}
154
155
static const OSSL_PARAM *chacha20_poly1305_settable_ctx_params(
156
    ossl_unused void *cctx, ossl_unused void *provctx)
157
13
{
158
13
    return chacha20_poly1305_set_ctx_params_list;
159
13
}
160
161
static int chacha20_poly1305_set_ctx_params(void *vctx,
162
    const OSSL_PARAM params[])
163
131k
{
164
131k
    size_t len;
165
131k
    PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
166
131k
    PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->base.hw;
167
131k
    struct chacha20_poly1305_set_ctx_params_st p;
168
169
131k
    if (!chacha20_poly1305_set_ctx_params_decoder(params, &p))
170
0
        return 0;
171
172
131k
    if (p.keylen != NULL) {
173
9
        if (!OSSL_PARAM_get_size_t(p.keylen, &len)) {
174
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
175
0
            return 0;
176
0
        }
177
9
        if (len != CHACHA20_POLY1305_KEYLEN) {
178
3
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
179
3
            return 0;
180
3
        }
181
9
    }
182
183
131k
    if (p.ivlen != NULL) {
184
2.11k
        if (!OSSL_PARAM_get_size_t(p.ivlen, &len)) {
185
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
186
0
            return 0;
187
0
        }
188
2.11k
        if (len != CHACHA20_POLY1305_MAX_IVLEN) {
189
2
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
190
2
            return 0;
191
2
        }
192
2.11k
        ctx->iv_state = IV_STATE_UNINITIALISED;
193
2.11k
    }
194
195
131k
    if (p.tag != NULL) {
196
36.6k
        if (p.tag->data_type != OSSL_PARAM_OCTET_STRING) {
197
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
198
0
            return 0;
199
0
        }
200
36.6k
        if (p.tag->data_size == 0 || p.tag->data_size > POLY1305_BLOCK_SIZE) {
201
2
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG_LENGTH);
202
2
            return 0;
203
2
        }
204
36.6k
        if (p.tag->data != NULL) {
205
36.6k
            if (ctx->base.enc) {
206
2
                ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_NEEDED);
207
2
                return 0;
208
2
            }
209
36.6k
            memcpy(ctx->tag, p.tag->data, p.tag->data_size);
210
36.6k
        }
211
36.6k
        ctx->tag_len = p.tag->data_size;
212
36.6k
    }
213
214
131k
    if (p.aad != NULL) {
215
4.54k
        if (p.aad->data_type != OSSL_PARAM_OCTET_STRING) {
216
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
217
0
            return 0;
218
0
        }
219
4.54k
        len = hw->tls_init(&ctx->base, p.aad->data, p.aad->data_size);
220
4.54k
        if (len == 0) {
221
20
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DATA);
222
20
            return 0;
223
20
        }
224
4.52k
        ctx->tls_aad_pad_sz = len;
225
4.52k
    }
226
227
131k
    if (p.fixed != NULL) {
228
0
        if (p.fixed->data_type != OSSL_PARAM_OCTET_STRING) {
229
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
230
0
            return 0;
231
0
        }
232
0
        if (hw->tls_iv_set_fixed(&ctx->base, p.fixed->data,
233
0
                p.fixed->data_size)
234
0
            == 0) {
235
0
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
236
0
            return 0;
237
0
        }
238
0
    }
239
131k
    return 1;
240
131k
}
241
242
static int chacha20_poly1305_einit(void *vctx, const unsigned char *key,
243
    size_t keylen, const unsigned char *iv,
244
    size_t ivlen, const OSSL_PARAM params[])
245
100k
{
246
100k
    int ret;
247
248
    /* The generic function checks for ossl_prov_is_running() */
249
100k
    ret = ossl_cipher_generic_einit(vctx, key, keylen, iv, ivlen, NULL);
250
100k
    if (ret && iv != NULL) {
251
96.3k
        PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
252
96.3k
        PROV_CHACHA20_POLY1305_CTX *cctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
253
96.3k
        PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
254
255
96.3k
        hw->initiv(ctx);
256
96.3k
        cctx->iv_state = IV_STATE_BUFFERED;
257
96.3k
    }
258
100k
    if (ret && !chacha20_poly1305_set_ctx_params(vctx, params))
259
0
        ret = 0;
260
100k
    return ret;
261
100k
}
262
263
static int chacha20_poly1305_dinit(void *vctx, const unsigned char *key,
264
    size_t keylen, const unsigned char *iv,
265
    size_t ivlen, const OSSL_PARAM params[])
266
68.1k
{
267
68.1k
    int ret;
268
269
    /* The generic function checks for ossl_prov_is_running() */
270
68.1k
    ret = ossl_cipher_generic_dinit(vctx, key, keylen, iv, ivlen, NULL);
271
68.1k
    if (ret && iv != NULL) {
272
65.5k
        PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
273
65.5k
        PROV_CHACHA20_POLY1305_CTX *cctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
274
65.5k
        PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
275
276
65.5k
        hw->initiv(ctx);
277
65.5k
        cctx->iv_state = IV_STATE_BUFFERED;
278
65.5k
    }
279
68.1k
    if (ret && !chacha20_poly1305_set_ctx_params(vctx, params))
280
0
        ret = 0;
281
68.1k
    return ret;
282
68.1k
}
283
284
static int chacha20_poly1305_cipher(void *vctx, unsigned char *out,
285
    size_t *outl, size_t outsize,
286
    const unsigned char *in, size_t inl)
287
323k
{
288
323k
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
289
323k
    PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
290
291
323k
    if (!ossl_prov_is_running())
292
0
        return 0;
293
294
323k
    if (outsize < inl) {
295
0
        ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
296
0
        return 0;
297
0
    }
298
299
323k
    if (!hw->aead_cipher(ctx, out, outl, in, inl))
300
7.81k
        return 0;
301
302
316k
    return 1;
303
323k
}
304
305
static int chacha20_poly1305_update(void *vctx, unsigned char *out,
306
    size_t *outl, size_t outsize,
307
    const unsigned char *in, size_t inl)
308
127k
{
309
127k
    PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
310
311
127k
    if (ctx->iv_state == IV_STATE_FINISHED)
312
0
        return 0;
313
314
    /*
315
     * a zero-length update is a nop, ALWAYS SUCCEED via early exit
316
     * NB: ONLY EVP_Cipher() / final produce or check the tag
317
     */
318
127k
    if (inl == 0) {
319
0
        *outl = 0;
320
0
        return 1;
321
0
    }
322
323
127k
    return chacha20_poly1305_cipher(vctx, out, outl, outsize, in, inl);
324
127k
}
325
326
static int chacha20_poly1305_final(void *vctx, unsigned char *out, size_t *outl,
327
    size_t outsize)
328
62.9k
{
329
62.9k
    PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
330
62.9k
    PROV_CIPHER_HW_CHACHA20_POLY1305 *hw = (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->base.hw;
331
332
62.9k
    if (!ossl_prov_is_running())
333
0
        return 0;
334
335
    /* The tag must be set before actually decrypting data */
336
62.9k
    if (!ctx->base.enc && ctx->tag_len == 0) {
337
0
        ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_SET);
338
0
        return 0;
339
0
    }
340
341
62.9k
    if (hw->aead_cipher((PROV_CIPHER_CTX *)ctx, out, outl, NULL, 0) <= 0)
342
23.0k
        return 0;
343
344
39.8k
    *outl = 0;
345
346
    /* Don't reuse the IV */
347
39.8k
    ctx->iv_state = IV_STATE_FINISHED;
348
39.8k
    return 1;
349
62.9k
}
350
351
/* ossl_chacha20_ossl_poly1305_functions */
352
const OSSL_DISPATCH ossl_chacha20_ossl_poly1305_functions[] = {
353
    { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))chacha20_poly1305_newctx },
354
    { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))chacha20_poly1305_freectx },
355
    { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))chacha20_poly1305_dupctx },
356
    { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))chacha20_poly1305_einit },
357
    { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))chacha20_poly1305_dinit },
358
    { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))chacha20_poly1305_update },
359
    { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))chacha20_poly1305_final },
360
    { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))chacha20_poly1305_cipher },
361
    { OSSL_FUNC_CIPHER_GET_PARAMS,
362
        (void (*)(void))chacha20_poly1305_get_params },
363
    { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,
364
        (void (*)(void))chacha20_poly1305_gettable_params },
365
    { OSSL_FUNC_CIPHER_GET_CTX_PARAMS,
366
        (void (*)(void))chacha20_poly1305_get_ctx_params },
367
    { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,
368
        (void (*)(void))chacha20_poly1305_gettable_ctx_params },
369
    { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,
370
        (void (*)(void))chacha20_poly1305_set_ctx_params },
371
    { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,
372
        (void (*)(void))chacha20_poly1305_settable_ctx_params },
373
    OSSL_DISPATCH_END
374
};