Coverage Report

Created: 2025-12-31 06:58

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