Coverage Report

Created: 2025-06-13 06:36

/src/openssl/providers/implementations/ciphers/cipher_chacha20_poly1305.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright 2019-2023 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
/* Dispatch functions for chacha20_poly1305 cipher */
12
13
#include <string.h>
14
#include <openssl/proverr.h>
15
#include "cipher_chacha20_poly1305.h"
16
#include "prov/implementations.h"
17
#include "prov/providercommon.h"
18
#include "internal/param_names.h"
19
20
1
#define CHACHA20_POLY1305_KEYLEN CHACHA_KEY_SIZE
21
1
#define CHACHA20_POLY1305_BLKLEN 1
22
0
#define CHACHA20_POLY1305_MAX_IVLEN 12
23
0
#define CHACHA20_POLY1305_MODE 0
24
1
#define CHACHA20_POLY1305_FLAGS (PROV_CIPHER_FLAG_AEAD                         \
25
1
                                 | PROV_CIPHER_FLAG_CUSTOM_IV)
26
27
static OSSL_FUNC_cipher_newctx_fn chacha20_poly1305_newctx;
28
static OSSL_FUNC_cipher_freectx_fn chacha20_poly1305_freectx;
29
static OSSL_FUNC_cipher_dupctx_fn chacha20_poly1305_dupctx;
30
static OSSL_FUNC_cipher_encrypt_init_fn chacha20_poly1305_einit;
31
static OSSL_FUNC_cipher_decrypt_init_fn chacha20_poly1305_dinit;
32
static OSSL_FUNC_cipher_get_params_fn chacha20_poly1305_get_params;
33
static OSSL_FUNC_cipher_get_ctx_params_fn chacha20_poly1305_get_ctx_params;
34
static OSSL_FUNC_cipher_set_ctx_params_fn chacha20_poly1305_set_ctx_params;
35
static OSSL_FUNC_cipher_cipher_fn chacha20_poly1305_cipher;
36
static OSSL_FUNC_cipher_final_fn chacha20_poly1305_final;
37
static OSSL_FUNC_cipher_gettable_ctx_params_fn chacha20_poly1305_gettable_ctx_params;
38
static OSSL_FUNC_cipher_settable_ctx_params_fn chacha20_poly1305_settable_ctx_params;
39
#define chacha20_poly1305_gettable_params ossl_cipher_generic_gettable_params
40
#define chacha20_poly1305_update chacha20_poly1305_cipher
41
42
static int chacha20_poly1305_get_ctx_params_find_pidx(const char *);
43
44
static void *chacha20_poly1305_newctx(void *provctx)
45
0
{
46
0
    PROV_CHACHA20_POLY1305_CTX *ctx;
47
48
0
    if (!ossl_prov_is_running())
49
0
        return NULL;
50
51
0
    ctx = OPENSSL_zalloc(sizeof(*ctx));
52
0
    if (ctx != NULL) {
53
0
        ossl_cipher_generic_initkey(&ctx->base, CHACHA20_POLY1305_KEYLEN * 8,
54
0
                                    CHACHA20_POLY1305_BLKLEN * 8,
55
0
                                    CHACHA20_POLY1305_IVLEN * 8,
56
0
                                    CHACHA20_POLY1305_MODE,
57
0
                                    CHACHA20_POLY1305_FLAGS,
58
0
                                    ossl_prov_cipher_hw_chacha20_poly1305(
59
0
                                        CHACHA20_POLY1305_KEYLEN * 8),
60
0
                                    NULL);
61
0
        ctx->tls_payload_length = NO_TLS_PAYLOAD_LENGTH;
62
0
        ossl_chacha20_initctx(&ctx->chacha);
63
0
    }
64
0
    return ctx;
65
0
}
66
67
static void *chacha20_poly1305_dupctx(void *provctx)
68
0
{
69
0
    PROV_CHACHA20_POLY1305_CTX *ctx = provctx;
70
0
    PROV_CHACHA20_POLY1305_CTX *dctx = NULL;
71
72
0
    if (ctx == NULL)
73
0
        return NULL;
74
0
    dctx = OPENSSL_memdup(ctx, sizeof(*ctx));
75
0
    if (dctx != NULL && dctx->base.tlsmac != NULL && dctx->base.alloced) {
76
0
        dctx->base.tlsmac = OPENSSL_memdup(dctx->base.tlsmac,
77
0
                                           dctx->base.tlsmacsize);
78
0
        if (dctx->base.tlsmac == NULL) {
79
0
            OPENSSL_free(dctx);
80
0
            dctx = NULL;
81
0
        }
82
0
    }
83
0
    return dctx;
84
0
}
85
86
static void chacha20_poly1305_freectx(void *vctx)
87
0
{
88
0
    PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
89
90
0
    if (ctx != NULL) {
91
0
        ossl_cipher_generic_reset_ctx((PROV_CIPHER_CTX *)vctx);
92
0
        OPENSSL_clear_free(ctx, sizeof(*ctx));
93
0
    }
94
0
}
95
96
static int chacha20_poly1305_get_params(OSSL_PARAM params[])
97
1
{
98
1
    return ossl_cipher_generic_get_params(params, 0, CHACHA20_POLY1305_FLAGS,
99
1
                                          CHACHA20_POLY1305_KEYLEN * 8,
100
1
                                          CHACHA20_POLY1305_BLKLEN * 8,
101
1
                                          CHACHA20_POLY1305_IVLEN * 8);
102
1
}
103
104
static int chacha20_poly1305_get_ctx_params(void *vctx, OSSL_PARAM params[])
105
0
{
106
0
    PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
107
0
    OSSL_PARAM *p;
108
109
0
    for (p = params; p->key != NULL; p++)
110
0
        switch (chacha20_poly1305_get_ctx_params_find_pidx(p->key)) {
111
0
        default:
112
0
            break;
113
114
0
        case PIDX_CIPHER_PARAM_IVLEN:
115
0
            if (!OSSL_PARAM_set_size_t(p, CHACHA20_POLY1305_IVLEN)) {
116
0
                ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
117
0
                return 0;
118
0
            }
119
0
            break;
120
121
0
        case PIDX_CIPHER_PARAM_KEYLEN:
122
0
            if (!OSSL_PARAM_set_size_t(p, CHACHA20_POLY1305_KEYLEN)) {
123
0
                ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
124
0
                return 0;
125
0
            }
126
0
            break;
127
128
0
        case PIDX_CIPHER_PARAM_AEAD_TAGLEN:
129
0
            if (!OSSL_PARAM_set_size_t(p, ctx->tag_len)) {
130
0
                ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
131
0
                return 0;
132
0
            }
133
0
            break;
134
135
0
        case PIDX_CIPHER_PARAM_AEAD_TLS1_AAD_PAD:
136
0
            if (!OSSL_PARAM_set_size_t(p, ctx->tls_aad_pad_sz)) {
137
0
                ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
138
0
                return 0;
139
0
            }
140
0
            break;
141
142
0
        case PIDX_CIPHER_PARAM_AEAD_TAG:
143
0
            if (p->data_type != OSSL_PARAM_OCTET_STRING) {
144
0
                ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
145
0
                return 0;
146
0
            }
147
0
            if (!ctx->base.enc) {
148
0
                ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_SET);
149
0
                return 0;
150
0
            }
151
0
            if (p->data_size == 0 || p->data_size > POLY1305_BLOCK_SIZE) {
152
0
                ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG_LENGTH);
153
0
                return 0;
154
0
            }
155
0
            memcpy(p->data, ctx->tag, p->data_size);
156
0
            break;
157
0
        }
158
0
    return 1;
159
0
}
160
161
162
/* Machine generated by util/perl/OpenSSL/paramnames.pm */
163
static const OSSL_PARAM chacha20_poly1305_known_gettable_ctx_params[] = {
164
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
165
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
166
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
167
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
168
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, NULL),
169
    OSSL_PARAM_END
170
};
171
172
static int chacha20_poly1305_get_ctx_params_find_pidx(const char *s)
173
0
{
174
0
    switch(s[0]) {
175
0
    default:
176
0
        break;
177
0
    case 'i':
178
0
        if (strcmp("vlen", s + 1) == 0)
179
0
            return PIDX_CIPHER_PARAM_IVLEN;
180
0
        break;
181
0
    case 'k':
182
0
        if (strcmp("eylen", s + 1) == 0)
183
0
            return PIDX_CIPHER_PARAM_KEYLEN;
184
0
        break;
185
0
    case 't':
186
0
        switch(s[1]) {
187
0
        default:
188
0
            break;
189
0
        case 'a':
190
0
            switch(s[2]) {
191
0
            default:
192
0
                break;
193
0
            case 'g':
194
0
                switch(s[3]) {
195
0
                default:
196
0
                    break;
197
0
                case 'l':
198
0
                    if (strcmp("en", s + 4) == 0)
199
0
                        return PIDX_CIPHER_PARAM_AEAD_TAGLEN;
200
0
                    break;
201
0
                case '\0':
202
0
                    return PIDX_CIPHER_PARAM_AEAD_TAG;
203
0
                }
204
0
            }
205
0
            break;
206
0
        case 'l':
207
0
            if (strcmp("saadpad", s + 2) == 0)
208
0
                return PIDX_CIPHER_PARAM_AEAD_TLS1_AAD_PAD;
209
0
        }
210
0
    }
211
0
    return -1;
212
0
}
213
214
/* End of machine generated */
215
216
static const OSSL_PARAM *chacha20_poly1305_gettable_ctx_params
217
    (ossl_unused void *cctx, ossl_unused void *provctx)
218
1
{
219
1
    return chacha20_poly1305_known_gettable_ctx_params;
220
1
}
221
222
/* Machine generated by util/perl/OpenSSL/paramnames.pm */
223
static const OSSL_PARAM chacha20_poly1305_known_settable_ctx_params[] = {
224
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
225
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
226
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
227
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD, NULL, 0),
228
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED, NULL, 0),
229
    OSSL_PARAM_END
230
};
231
232
static int chacha20_poly1305_set_ctx_params_find_pidx(const char *s)
233
0
{
234
0
    switch(s[0]) {
235
0
    default:
236
0
        break;
237
0
    case 'i':
238
0
        if (strcmp("vlen", s + 1) == 0)
239
0
            return PIDX_CIPHER_PARAM_IVLEN;
240
0
        break;
241
0
    case 'k':
242
0
        if (strcmp("eylen", s + 1) == 0)
243
0
            return PIDX_CIPHER_PARAM_KEYLEN;
244
0
        break;
245
0
    case 't':
246
0
        switch(s[1]) {
247
0
        default:
248
0
            break;
249
0
        case 'a':
250
0
            if (strcmp("g", s + 2) == 0)
251
0
                return PIDX_CIPHER_PARAM_AEAD_TAG;
252
0
            break;
253
0
        case 'l':
254
0
            switch(s[2]) {
255
0
            default:
256
0
                break;
257
0
            case 's':
258
0
                switch(s[3]) {
259
0
                default:
260
0
                    break;
261
0
                case 'a':
262
0
                    if (strcmp("ad", s + 4) == 0)
263
0
                        return PIDX_CIPHER_PARAM_AEAD_TLS1_AAD;
264
0
                    break;
265
0
                case 'i':
266
0
                    if (strcmp("vfixed", s + 4) == 0)
267
0
                        return PIDX_CIPHER_PARAM_AEAD_TLS1_IV_FIXED;
268
0
                }
269
0
            }
270
0
        }
271
0
    }
272
0
    return -1;
273
0
}
274
275
/* End of machine generated */
276
277
static const OSSL_PARAM *chacha20_poly1305_settable_ctx_params(
278
        ossl_unused void *cctx, ossl_unused void *provctx
279
    )
280
0
{
281
0
    return chacha20_poly1305_known_settable_ctx_params;
282
0
}
283
284
static int chacha20_poly1305_set_ctx_params(void *vctx,
285
                                            const OSSL_PARAM params[])
286
0
{
287
0
    const OSSL_PARAM *p;
288
0
    size_t len;
289
0
    PROV_CHACHA20_POLY1305_CTX *ctx = (PROV_CHACHA20_POLY1305_CTX *)vctx;
290
0
    PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
291
0
        (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->base.hw;
292
293
0
    if (ossl_param_is_empty(params))
294
0
        return 1;
295
296
0
    for (p = params; p->key != NULL; p++)
297
0
        switch (chacha20_poly1305_set_ctx_params_find_pidx(p->key)) {
298
0
        default:
299
0
            break;
300
301
0
        case PIDX_CIPHER_PARAM_KEYLEN:
302
0
            if (!OSSL_PARAM_get_size_t(p, &len)) {
303
0
                ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
304
0
                return 0;
305
0
            }
306
0
            if (len != CHACHA20_POLY1305_KEYLEN) {
307
0
                ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
308
0
                return 0;
309
0
            }
310
0
            break;
311
312
0
        case PIDX_CIPHER_PARAM_IVLEN:
313
0
            if (!OSSL_PARAM_get_size_t(p, &len)) {
314
0
                ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
315
0
                return 0;
316
0
            }
317
0
            if (len != CHACHA20_POLY1305_MAX_IVLEN) {
318
0
                ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
319
0
                return 0;
320
0
            }
321
0
            break;
322
323
0
        case PIDX_CIPHER_PARAM_AEAD_TAG:
324
0
            if (p->data_type != OSSL_PARAM_OCTET_STRING) {
325
0
                ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
326
0
                return 0;
327
0
            }
328
0
            if (p->data_size == 0 || p->data_size > POLY1305_BLOCK_SIZE) {
329
0
                ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_TAG_LENGTH);
330
0
                return 0;
331
0
            }
332
0
            if (p->data != NULL) {
333
0
                if (ctx->base.enc) {
334
0
                    ERR_raise(ERR_LIB_PROV, PROV_R_TAG_NOT_NEEDED);
335
0
                    return 0;
336
0
                }
337
0
                memcpy(ctx->tag, p->data, p->data_size);
338
0
            }
339
0
            ctx->tag_len = p->data_size;
340
0
            break;
341
342
0
        case PIDX_CIPHER_PARAM_AEAD_TLS1_AAD:
343
0
            if (p->data_type != OSSL_PARAM_OCTET_STRING) {
344
0
                ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
345
0
                return 0;
346
0
            }
347
0
            len = hw->tls_init(&ctx->base, p->data, p->data_size);
348
0
            if (len == 0) {
349
0
                ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_DATA);
350
0
                return 0;
351
0
            }
352
0
            ctx->tls_aad_pad_sz = len;
353
0
            break;
354
355
0
        case PIDX_CIPHER_PARAM_AEAD_TLS1_IV_FIXED:
356
0
            if (p->data_type != OSSL_PARAM_OCTET_STRING) {
357
0
                ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
358
0
                return 0;
359
0
            }
360
0
            if (hw->tls_iv_set_fixed(&ctx->base, p->data, p->data_size) == 0) {
361
0
                ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
362
0
                return 0;
363
0
            }
364
0
            break;
365
0
        }
366
0
    return 1;
367
0
}
368
369
static int chacha20_poly1305_einit(void *vctx, const unsigned char *key,
370
                                  size_t keylen, const unsigned char *iv,
371
                                  size_t ivlen, const OSSL_PARAM params[])
372
0
{
373
0
    int ret;
374
375
    /* The generic function checks for ossl_prov_is_running() */
376
0
    ret = ossl_cipher_generic_einit(vctx, key, keylen, iv, ivlen, NULL);
377
0
    if (ret && iv != NULL) {
378
0
        PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
379
0
        PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
380
0
            (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
381
382
0
        hw->initiv(ctx);
383
0
    }
384
0
    if (ret && !chacha20_poly1305_set_ctx_params(vctx, params))
385
0
        ret = 0;
386
0
    return ret;
387
0
}
388
389
static int chacha20_poly1305_dinit(void *vctx, const unsigned char *key,
390
                                  size_t keylen, const unsigned char *iv,
391
                                  size_t ivlen, const OSSL_PARAM params[])
392
0
{
393
0
    int ret;
394
395
    /* The generic function checks for ossl_prov_is_running() */
396
0
    ret = ossl_cipher_generic_dinit(vctx, key, keylen, iv, ivlen, NULL);
397
0
    if (ret && iv != NULL) {
398
0
        PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
399
0
        PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
400
0
            (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
401
402
0
        hw->initiv(ctx);
403
0
    }
404
0
    if (ret && !chacha20_poly1305_set_ctx_params(vctx, params))
405
0
        ret = 0;
406
0
    return ret;
407
0
}
408
409
static int chacha20_poly1305_cipher(void *vctx, unsigned char *out,
410
                                    size_t *outl, size_t outsize,
411
                                    const unsigned char *in, size_t inl)
412
0
{
413
0
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
414
0
    PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
415
0
        (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
416
417
0
    if (!ossl_prov_is_running())
418
0
        return 0;
419
420
0
    if (inl == 0) {
421
0
        *outl = 0;
422
0
        return 1;
423
0
    }
424
425
0
    if (outsize < inl) {
426
0
        ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
427
0
        return 0;
428
0
    }
429
430
0
    if (!hw->aead_cipher(ctx, out, outl, in, inl))
431
0
        return 0;
432
433
0
    return 1;
434
0
}
435
436
static int chacha20_poly1305_final(void *vctx, unsigned char *out, size_t *outl,
437
                                   size_t outsize)
438
0
{
439
0
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
440
0
    PROV_CIPHER_HW_CHACHA20_POLY1305 *hw =
441
0
        (PROV_CIPHER_HW_CHACHA20_POLY1305 *)ctx->hw;
442
443
0
    if (!ossl_prov_is_running())
444
0
        return 0;
445
446
0
    if (hw->aead_cipher(ctx, out, outl, NULL, 0) <= 0)
447
0
        return 0;
448
449
0
    *outl = 0;
450
0
    return 1;
451
0
}
452
453
/* ossl_chacha20_ossl_poly1305_functions */
454
const OSSL_DISPATCH ossl_chacha20_ossl_poly1305_functions[] = {
455
    { OSSL_FUNC_CIPHER_NEWCTX, (void (*)(void))chacha20_poly1305_newctx },
456
    { OSSL_FUNC_CIPHER_FREECTX, (void (*)(void))chacha20_poly1305_freectx },
457
    { OSSL_FUNC_CIPHER_DUPCTX, (void (*)(void))chacha20_poly1305_dupctx },
458
    { OSSL_FUNC_CIPHER_ENCRYPT_INIT, (void (*)(void))chacha20_poly1305_einit },
459
    { OSSL_FUNC_CIPHER_DECRYPT_INIT, (void (*)(void))chacha20_poly1305_dinit },
460
    { OSSL_FUNC_CIPHER_UPDATE, (void (*)(void))chacha20_poly1305_update },
461
    { OSSL_FUNC_CIPHER_FINAL, (void (*)(void))chacha20_poly1305_final },
462
    { OSSL_FUNC_CIPHER_CIPHER, (void (*)(void))chacha20_poly1305_cipher },
463
    { OSSL_FUNC_CIPHER_GET_PARAMS,
464
        (void (*)(void))chacha20_poly1305_get_params },
465
    { OSSL_FUNC_CIPHER_GETTABLE_PARAMS,
466
        (void (*)(void))chacha20_poly1305_gettable_params },
467
    { OSSL_FUNC_CIPHER_GET_CTX_PARAMS,
468
         (void (*)(void))chacha20_poly1305_get_ctx_params },
469
    { OSSL_FUNC_CIPHER_GETTABLE_CTX_PARAMS,
470
        (void (*)(void))chacha20_poly1305_gettable_ctx_params },
471
    { OSSL_FUNC_CIPHER_SET_CTX_PARAMS,
472
        (void (*)(void))chacha20_poly1305_set_ctx_params },
473
    { OSSL_FUNC_CIPHER_SETTABLE_CTX_PARAMS,
474
        (void (*)(void))chacha20_poly1305_settable_ctx_params },
475
    OSSL_DISPATCH_END
476
};
477