Coverage Report

Created: 2025-06-13 06:58

/src/openssl31/providers/implementations/ciphers/cipher_chacha20_poly1305.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 2019-2024 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
43.7k
#define CHACHA20_POLY1305_KEYLEN CHACHA_KEY_SIZE
18
35.8k
#define CHACHA20_POLY1305_BLKLEN 1
19
2.18k
#define CHACHA20_POLY1305_MAX_IVLEN 12
20
4.78k
#define CHACHA20_POLY1305_MODE 0
21
35.8k
#define CHACHA20_POLY1305_FLAGS (PROV_CIPHER_FLAG_AEAD                         \
22
35.8k
                                 | 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
#define chacha20_poly1305_settable_ctx_params ossl_cipher_aead_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
4.78k
{
41
4.78k
    PROV_CHACHA20_POLY1305_CTX *ctx;
42
43
4.78k
    if (!ossl_prov_is_running())
44
0
        return NULL;
45
46
4.78k
    ctx = OPENSSL_zalloc(sizeof(*ctx));
47
4.78k
    if (ctx != NULL) {
48
4.78k
        ossl_cipher_generic_initkey(&ctx->base, CHACHA20_POLY1305_KEYLEN * 8,
49
4.78k
                                    CHACHA20_POLY1305_BLKLEN * 8,
50
4.78k
                                    CHACHA20_POLY1305_IVLEN * 8,
51
4.78k
                                    CHACHA20_POLY1305_MODE,
52
4.78k
                                    CHACHA20_POLY1305_FLAGS,
53
4.78k
                                    ossl_prov_cipher_hw_chacha20_poly1305(
54
4.78k
                                        CHACHA20_POLY1305_KEYLEN * 8),
55
4.78k
                                    NULL);
56
4.78k
        ctx->tls_payload_length = NO_TLS_PAYLOAD_LENGTH;
57
4.78k
        ossl_chacha20_initctx(&ctx->chacha);
58
4.78k
    }
59
4.78k
    return ctx;
60
4.78k
}
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
4.78k
{
83
4.78k
    PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
84
85
4.78k
    if (ctx != NULL) {
86
4.78k
        ossl_cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
87
4.78k
        OPENSSL_clear_free(ctx, sizeof(*ctx));
88
4.78k
    }
89
4.78k
}
90
91
static int chacha20_poly1305_get_params(OSSL_PARAM params[])
92
31.0k
{
93
31.0k
    return ossl_cipher_generic_get_params(params, 0, CHACHA20_POLY1305_FLAGS,
94
31.0k
                                          CHACHA20_POLY1305_KEYLEN * 8,
95
31.0k
                                          CHACHA20_POLY1305_BLKLEN * 8,
96
31.0k
                                          CHACHA20_POLY1305_IVLEN * 8);
97
31.0k
}
98
99
static int chacha20_poly1305_get_ctx_params(void *vctx, OSSL_PARAM params[])
100
41.7k
{
101
41.7k
    PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
102
41.7k
    OSSL_PARAM *p;
103
104
41.7k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
105
41.7k
    if (p != NULL) {
106
21.6k
        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
21.6k
    }
111
41.7k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
112
41.7k
    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
41.7k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAGLEN);
117
41.7k
    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
41.7k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD);
122
41.7k
    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
41.7k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD_TAG);
128
41.7k
    if (p != NULL) {
129
16.9k
        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
16.9k
        if (!ctx->base.enc) {
134
0
            ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_SET);
135
0
            return 0;
136
0
        }
137
16.9k
        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
16.9k
        memcpy(p->data, ctx->tag, p->data_size);
142
16.9k
    }
143
144
41.7k
    return 1;
145
41.7k
}
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
156
    (ossl_unused void *cctx, ossl_unused void *provctx)
157
25
{
158
25
    return chacha20_poly1305_known_gettable_ctx_params;
159
25
}
160
161
static int chacha20_poly1305_set_ctx_params(void *vctx,
162
                                            const OSSL_PARAM params[])
163
159k
{
164
159k
    const OSSL_PARAM *p;
165
159k
    size_t len;
166
159k
    PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
167
159k
    PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
168
159k
        (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->base.hw;
169
170
159k
    if (params == NULL)
171
89.7k
        return 1;
172
173
69.9k
    p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
174
69.9k
    if (p != NULL) {
175
0
        if (!OSSL_PARAM_get_size_t(p, &len)) {
176
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
177
0
            return 0;
178
0
        }
179
0
        if (len != CHACHA20_POLY1305_KEYLEN) {
180
0
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
181
0
            return 0;
182
0
        }
183
0
    }
184
69.9k
    p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_IVLEN);
185
69.9k
    if (p != NULL) {
186
2.18k
        if (!OSSL_PARAM_get_size_t(p, &len)) {
187
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
188
0
            return 0;
189
0
        }
190
2.18k
        if (len != CHACHA20_POLY1305_MAX_IVLEN) {
191
0
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
192
0
            return 0;
193
0
        }
194
2.18k
    }
195
196
69.9k
    p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TAG);
197
69.9k
    if (p != NULL) {
198
67.5k
        if (p->data_type != OSSL_PARAM_OCTET_STRING) {
199
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
200
0
            return 0;
201
0
        }
202
67.5k
        if (p->data_size == 0 || p->data_size > POLY1305_BLOCK_SIZE) {
203
0
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG_LENGTH);
204
0
            return 0;
205
0
        }
206
67.5k
        if (p->data != NULL) {
207
67.5k
            if (ctx->base.enc) {
208
0
                ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_NEEDED);
209
0
                return 0;
210
0
            }
211
67.5k
            memcpy(ctx->tag, p->data, p->data_size);
212
67.5k
        }
213
67.5k
        ctx->tag_len = p->data_size;
214
67.5k
    }
215
216
69.9k
    p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TLS1_AAD);
217
69.9k
    if (p != NULL) {
218
98
        if (p->data_type != OSSL_PARAM_OCTET_STRING) {
219
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
220
0
            return 0;
221
0
        }
222
98
        len = hw->tls_init(&ctx->base, p->data, p->data_size);
223
98
        if (len == 0) {
224
10
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DATA);
225
10
            return 0;
226
10
        }
227
88
        ctx->tls_aad_pad_sz = len;
228
88
    }
229
230
69.9k
    p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED);
231
69.9k
    if (p != NULL) {
232
0
        if (p->data_type != OSSL_PARAM_OCTET_STRING) {
233
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
234
0
            return 0;
235
0
        }
236
0
        if (hw->tls_iv_set_fixed(&ctx->base, p->data, p->data_size) == 0) {
237
0
            ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
238
0
            return 0;
239
0
        }
240
0
    }
241
    /* ignore OSSL_CIPHER_PARAM_AEAD_MAC_KEY */
242
69.9k
    return 1;
243
69.9k
}
244
245
static int chacha20_poly1305_einit(void *vctx, const unsigned char *key,
246
                                  size_t keylen, const unsigned char *iv,
247
                                  size_t ivlen, const OSSL_PARAM params[])
248
49.8k
{
249
49.8k
    int ret;
250
251
    /* The generic function checks for ossl_prov_is_running() */
252
49.8k
    ret = ossl_cipher_generic_einit(vctx, key, keylen, iv, ivlen, NULL);
253
49.8k
    if (ret && iv != NULL) {
254
46.2k
        PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
255
46.2k
        PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
256
46.2k
            (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
257
258
46.2k
        hw->initiv(ctx);
259
46.2k
    }
260
49.8k
    if (ret && !chacha20_poly1305_set_ctx_params(vctx, params))
261
0
        ret = 0;
262
49.8k
    return ret;
263
49.8k
}
264
265
static int chacha20_poly1305_dinit(void *vctx, const unsigned char *key,
266
                                  size_t keylen, const unsigned char *iv,
267
                                  size_t ivlen, const OSSL_PARAM params[])
268
80.5k
{
269
80.5k
    int ret;
270
271
    /* The generic function checks for ossl_prov_is_running() */
272
80.5k
    ret = ossl_cipher_generic_dinit(vctx, key, keylen, iv, ivlen, NULL);
273
80.5k
    if (ret && iv != NULL) {
274
78.4k
        PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
275
78.4k
        PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
276
78.4k
            (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
277
278
78.4k
        hw->initiv(ctx);
279
78.4k
    }
280
80.5k
    if (ret && !chacha20_poly1305_set_ctx_params(vctx, params))
281
0
        ret = 0;
282
80.5k
    return ret;
283
80.5k
}
284
285
static int chacha20_poly1305_cipher(void *vctx, unsigned char *out,
286
                                    size_t *outl, size_t outsize,
287
                                    const unsigned char *in, size_t inl)
288
248k
{
289
248k
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
290
248k
    PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
291
248k
        (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
292
293
248k
    if (!ossl_prov_is_running())
294
0
        return 0;
295
296
248k
    if (inl == 0) {
297
0
        *outl = 0;
298
0
        return 1;
299
0
    }
300
301
248k
    if (outsize < inl) {
302
0
        ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
303
0
        return 0;
304
0
    }
305
306
248k
    if (!hw->aead_cipher(ctx, out, outl, in, inl))
307
2.91k
        return 0;
308
309
245k
    return 1;
310
248k
}
311
312
static int chacha20_poly1305_final(void *vctx, unsigned char *out, size_t *outl,
313
                                   size_t outsize)
314
122k
{
315
122k
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
316
122k
    PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
317
122k
        (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
318
319
122k
    if (!ossl_prov_is_running())
320
0
        return 0;
321
322
122k
    if (hw->aead_cipher(ctx, out, outl, NULL, 0) <= 0)
323
75.5k
        return 0;
324
325
47.2k
    *outl = 0;
326
47.2k
    return 1;
327
122k
}
328
329
/* ossl_chacha20_ossl_poly1305_functions */
330
const OSSL_DISPATCH ossl_chacha20_ossl_poly1305_functions[] = {
331
    { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))chacha20_poly1305_newctx },
332
    { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))chacha20_poly1305_freectx },
333
    { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))chacha20_poly1305_dupctx },
334
    { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))chacha20_poly1305_einit },
335
    { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))chacha20_poly1305_dinit },
336
    { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))chacha20_poly1305_update },
337
    { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))chacha20_poly1305_final },
338
    { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))chacha20_poly1305_cipher },
339
    { OSSL_FUNC_CIPHER_GET_PARAMS,
340
        (void (*)(void))chacha20_poly1305_get_params },
341
    { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,
342
        (void (*)(void))chacha20_poly1305_gettable_params },
343
    { OSSL_FUNC_CIPHER_GET_CTX_PARAMS,
344
         (void (*)(void))chacha20_poly1305_get_ctx_params },
345
    { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,
346
        (void (*)(void))chacha20_poly1305_gettable_ctx_params },
347
    { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,
348
        (void (*)(void))chacha20_poly1305_set_ctx_params },
349
    { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,
350
        (void (*)(void))chacha20_poly1305_settable_ctx_params },
351
    { 0, NULL }
352
};
353