Coverage Report

Created: 2025-08-28 07:07

/src/openssl35/providers/implementations/ciphers/ciphercommon.c
Line
Count
Source (jump to first uncovered line)
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
/*
11
 * Generic dispatch table functions for ciphers.
12
 */
13
14
/* For SSL3_VERSION */
15
#include <openssl/prov_ssl.h>
16
#include <openssl/proverr.h>
17
#include "ciphercommon_local.h"
18
#include "prov/provider_ctx.h"
19
#include "prov/providercommon.h"
20
#include "internal/skey.h"
21
#include "crypto/types.h"
22
23
/*-
24
 * Generic cipher functions for OSSL_PARAM gettables and settables
25
 */
26
static const OSSL_PARAM cipher_known_gettable_params[] = {
27
    OSSL_PARAM_uint(OSSL_CIPHER_PARAM_MODE, NULL),
28
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
29
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
30
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_BLOCK_SIZE, NULL),
31
    OSSL_PARAM_int(OSSL_CIPHER_PARAM_AEAD, NULL),
32
    OSSL_PARAM_int(OSSL_CIPHER_PARAM_CUSTOM_IV, NULL),
33
    OSSL_PARAM_int(OSSL_CIPHER_PARAM_CTS, NULL),
34
    OSSL_PARAM_int(OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK, NULL),
35
    OSSL_PARAM_int(OSSL_CIPHER_PARAM_HAS_RAND_KEY, NULL),
36
    OSSL_PARAM_END
37
};
38
const OSSL_PARAM *ossl_cipher_generic_gettable_params(ossl_unused void *provctx)
39
0
{
40
0
    return cipher_known_gettable_params;
41
0
}
42
43
int ossl_cipher_generic_get_params(OSSL_PARAM params[], unsigned int md,
44
                                   uint64_t flags,
45
                                   size_t kbits, size_t blkbits, size_t ivbits)
46
798k
{
47
798k
    OSSL_PARAM *p;
48
49
798k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_MODE);
50
798k
    if (p != NULL && !OSSL_PARAM_set_uint(p, md)) {
51
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
52
0
        return 0;
53
0
    }
54
798k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_AEAD);
55
798k
    if (p != NULL
56
798k
        && !OSSL_PARAM_set_int(p, (flags & PROV_CIPHER_FLAG_AEAD) != 0)) {
57
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
58
0
        return 0;
59
0
    }
60
798k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_CUSTOM_IV);
61
798k
    if (p != NULL
62
798k
        && !OSSL_PARAM_set_int(p, (flags & PROV_CIPHER_FLAG_CUSTOM_IV) != 0)) {
63
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
64
0
        return 0;
65
0
    }
66
798k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_CTS);
67
798k
    if (p != NULL
68
798k
        && !OSSL_PARAM_set_int(p, (flags & PROV_CIPHER_FLAG_CTS) != 0)) {
69
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
70
0
        return 0;
71
0
    }
72
798k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_TLS1_MULTIBLOCK);
73
798k
    if (p != NULL
74
798k
        && !OSSL_PARAM_set_int(p, (flags & PROV_CIPHER_FLAG_TLS1_MULTIBLOCK) != 0)) {
75
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
76
0
        return 0;
77
0
    }
78
798k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_HAS_RAND_KEY);
79
798k
    if (p != NULL
80
798k
        && !OSSL_PARAM_set_int(p, (flags & PROV_CIPHER_FLAG_RAND_KEY) != 0)) {
81
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
82
0
        return 0;
83
0
    }
84
798k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
85
798k
    if (p != NULL && !OSSL_PARAM_set_size_t(p, kbits / 8)) {
86
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
87
0
        return 0;
88
0
    }
89
798k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_BLOCK_SIZE);
90
798k
    if (p != NULL && !OSSL_PARAM_set_size_t(p, blkbits / 8)) {
91
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
92
0
        return 0;
93
0
    }
94
798k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
95
798k
    if (p != NULL && !OSSL_PARAM_set_size_t(p, ivbits / 8)) {
96
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
97
0
        return 0;
98
0
    }
99
798k
    return 1;
100
798k
}
101
102
CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_START(ossl_cipher_generic)
103
{ OSSL_CIPHER_PARAM_TLS_MAC, OSSL_PARAM_OCTET_PTR, NULL, 0, OSSL_PARAM_UNMODIFIED },
104
CIPHER_DEFAULT_GETTABLE_CTX_PARAMS_END(ossl_cipher_generic)
105
106
CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(ossl_cipher_generic)
107
OSSL_PARAM_uint(OSSL_CIPHER_PARAM_USE_BITS, NULL),
108
OSSL_PARAM_uint(OSSL_CIPHER_PARAM_TLS_VERSION, NULL),
109
OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_TLS_MAC_SIZE, NULL),
110
CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(ossl_cipher_generic)
111
112
/*
113
 * Variable key length cipher functions for OSSL_PARAM settables
114
 */
115
int ossl_cipher_var_keylen_set_ctx_params(void *vctx, const OSSL_PARAM params[])
116
0
{
117
0
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
118
0
    const OSSL_PARAM *p;
119
120
0
    if (ossl_param_is_empty(params))
121
0
        return 1;
122
123
0
    if (!ossl_cipher_generic_set_ctx_params(vctx, params))
124
0
        return 0;
125
0
    p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_KEYLEN);
126
0
    if (p != NULL) {
127
0
        size_t keylen;
128
129
0
        if (!OSSL_PARAM_get_size_t(p, &keylen)) {
130
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
131
0
            return 0;
132
0
        }
133
0
        if (ctx->keylen != keylen) {
134
0
            ctx->keylen = keylen;
135
0
            ctx->key_set = 0;
136
0
        }
137
0
    }
138
0
    return 1;
139
0
}
140
141
CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_START(ossl_cipher_var_keylen)
142
OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
143
CIPHER_DEFAULT_SETTABLE_CTX_PARAMS_END(ossl_cipher_var_keylen)
144
145
/*-
146
 * AEAD cipher functions for OSSL_PARAM gettables and settables
147
 */
148
static const OSSL_PARAM cipher_aead_known_gettable_ctx_params[] = {
149
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_KEYLEN, NULL),
150
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_IVLEN, NULL),
151
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TAGLEN, NULL),
152
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_IV, NULL, 0),
153
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_UPDATED_IV, NULL, 0),
154
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
155
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD_PAD, NULL),
156
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_GET_IV_GEN, NULL, 0),
157
    OSSL_PARAM_uint(OSSL_CIPHER_PARAM_AEAD_IV_GENERATED, NULL),
158
    OSSL_PARAM_END
159
};
160
const OSSL_PARAM *ossl_cipher_aead_gettable_ctx_params(
161
        ossl_unused void *cctx, ossl_unused void *provctx
162
    )
163
512
{
164
512
    return cipher_aead_known_gettable_ctx_params;
165
512
}
166
167
static const OSSL_PARAM cipher_aead_known_settable_ctx_params[] = {
168
    OSSL_PARAM_size_t(OSSL_CIPHER_PARAM_AEAD_IVLEN, NULL),
169
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TAG, NULL, 0),
170
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_AAD, NULL, 0),
171
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_IV_FIXED, NULL, 0),
172
    OSSL_PARAM_octet_string(OSSL_CIPHER_PARAM_AEAD_TLS1_SET_IV_INV, NULL, 0),
173
    OSSL_PARAM_END
174
};
175
const OSSL_PARAM *ossl_cipher_aead_settable_ctx_params(
176
        ossl_unused void *cctx, ossl_unused void *provctx
177
    )
178
15
{
179
15
    return cipher_aead_known_settable_ctx_params;
180
15
}
181
182
void ossl_cipher_generic_reset_ctx(PROV_CIPHER_CTX *ctx)
183
233k
{
184
233k
    if (ctx != NULL && ctx->alloced) {
185
3.41k
        OPENSSL_free(ctx->tlsmac);
186
3.41k
        ctx->alloced = 0;
187
3.41k
        ctx->tlsmac = NULL;
188
3.41k
    }
189
233k
}
190
191
static int cipher_generic_init_internal(PROV_CIPHER_CTX *ctx,
192
                                        const unsigned char *key, size_t keylen,
193
                                        const unsigned char *iv, size_t ivlen,
194
                                        const OSSL_PARAM params[], int enc)
195
3.06M
{
196
3.06M
    ctx->num = 0;
197
3.06M
    ctx->bufsz = 0;
198
3.06M
    ctx->updated = 0;
199
3.06M
    ctx->enc = enc ? 1 : 0;
200
201
3.06M
    if (!ossl_prov_is_running())
202
0
        return 0;
203
204
3.06M
    if (iv != NULL && ctx->mode != EVP_CIPH_ECB_MODE) {
205
583k
        if (!ossl_cipher_generic_initiv(ctx, iv, ivlen))
206
0
            return 0;
207
583k
    }
208
3.06M
    if (iv == NULL && ctx->iv_set
209
3.06M
        && (ctx->mode == EVP_CIPH_CBC_MODE
210
79.5k
            || ctx->mode == EVP_CIPH_CFB_MODE
211
79.5k
            || ctx->mode == EVP_CIPH_OFB_MODE))
212
        /* reset IV for these modes to keep compatibility with 1.1.1 */
213
0
        memcpy(ctx->iv, ctx->oiv, ctx->ivlen);
214
215
3.06M
    if (key != NULL) {
216
397k
        if (ctx->variable_keylength == 0) {
217
397k
            if (keylen != ctx->keylen) {
218
0
                ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_KEY_LENGTH);
219
0
                return 0;
220
0
            }
221
397k
        } else {
222
0
            ctx->keylen = keylen;
223
0
        }
224
397k
        if (!ctx->hw->init(ctx, key, ctx->keylen))
225
0
            return 0;
226
397k
        ctx->key_set = 1;
227
397k
    }
228
3.06M
    return ossl_cipher_generic_set_ctx_params(ctx, params);
229
3.06M
}
230
231
int ossl_cipher_generic_einit(void *vctx, const unsigned char *key,
232
                              size_t keylen, const unsigned char *iv,
233
                              size_t ivlen, const OSSL_PARAM params[])
234
2.88M
{
235
2.88M
    return cipher_generic_init_internal((PROV_CIPHER_CTX *)vctx, key, keylen,
236
2.88M
                                        iv, ivlen, params, 1);
237
2.88M
}
238
239
int ossl_cipher_generic_dinit(void *vctx, const unsigned char *key,
240
                              size_t keylen, const unsigned char *iv,
241
                              size_t ivlen, const OSSL_PARAM params[])
242
179k
{
243
179k
    return cipher_generic_init_internal((PROV_CIPHER_CTX *)vctx, key, keylen,
244
179k
                                        iv, ivlen, params, 0);
245
179k
}
246
247
int ossl_cipher_generic_skey_einit(void *vctx, void *skeydata,
248
                                   const unsigned char *iv, size_t ivlen,
249
                                   const OSSL_PARAM params[])
250
0
{
251
0
    PROV_SKEY *key = skeydata;
252
253
0
    return cipher_generic_init_internal((PROV_CIPHER_CTX *)vctx,
254
0
                                        key->data, key->length,
255
0
                                        iv, ivlen, params, 1);
256
0
}
257
258
int ossl_cipher_generic_skey_dinit(void *vctx, void *skeydata,
259
                                   const unsigned char *iv, size_t ivlen,
260
                                   const OSSL_PARAM params[])
261
0
{
262
0
    PROV_SKEY *key = skeydata;
263
264
0
    return cipher_generic_init_internal((PROV_CIPHER_CTX *)vctx,
265
0
                                        key->data, key->length,
266
0
                                        iv, ivlen, params, 0);
267
0
}
268
269
/* Max padding including padding length byte */
270
4.02k
#define MAX_PADDING 256
271
272
int ossl_cipher_generic_block_update(void *vctx, unsigned char *out,
273
                                     size_t *outl, size_t outsize,
274
                                     const unsigned char *in, size_t inl)
275
5.37M
{
276
5.37M
    size_t outlint = 0;
277
5.37M
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
278
5.37M
    size_t blksz = ctx->blocksize;
279
5.37M
    size_t nextblocks;
280
281
5.37M
    if (!ctx->key_set) {
282
0
        ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
283
0
        return 0;
284
0
    }
285
286
5.37M
    if (ctx->tlsversion > 0) {
287
        /*
288
         * Each update call corresponds to a TLS record and is individually
289
         * padded
290
         */
291
292
        /* Sanity check inputs */
293
170k
        if (in == NULL
294
170k
                || in != out
295
170k
                || outsize < inl
296
170k
                || !ctx->pad) {
297
0
            ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
298
0
            return 0;
299
0
        }
300
301
170k
        if (ctx->enc) {
302
4.02k
            unsigned char padval;
303
4.02k
            size_t padnum, loop;
304
305
            /* Add padding */
306
307
4.02k
            padnum = blksz - (inl % blksz);
308
309
4.02k
            if (outsize < inl + padnum) {
310
0
                ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
311
0
                return 0;
312
0
            }
313
314
4.02k
            if (padnum > MAX_PADDING) {
315
0
                ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
316
0
                return 0;
317
0
            }
318
4.02k
            padval = (unsigned char)(padnum - 1);
319
4.02k
            if (ctx->tlsversion == SSL3_VERSION) {
320
1.04k
                if (padnum > 1)
321
1.04k
                    memset(out + inl, 0, padnum - 1);
322
1.04k
                *(out + inl + padnum - 1) = padval;
323
2.97k
            } else {
324
                /* we need to add 'padnum' padding bytes of value padval */
325
32.3k
                for (loop = inl; loop < inl + padnum; loop++)
326
29.3k
                    out[loop] = padval;
327
2.97k
            }
328
4.02k
            inl += padnum;
329
4.02k
        }
330
331
170k
        if ((inl % blksz) != 0) {
332
0
            ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
333
0
            return 0;
334
0
        }
335
336
337
        /* Shouldn't normally fail */
338
170k
        if (!ctx->hw->cipher(ctx, out, in, inl)) {
339
0
            ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
340
0
            return 0;
341
0
        }
342
343
170k
        if (ctx->alloced) {
344
141k
            OPENSSL_free(ctx->tlsmac);
345
141k
            ctx->alloced = 0;
346
141k
            ctx->tlsmac = NULL;
347
141k
        }
348
349
        /* This only fails if padding is publicly invalid */
350
170k
        *outl = inl;
351
170k
        if (!ctx->enc
352
170k
            && !ossl_cipher_tlsunpadblock(ctx->libctx, ctx->tlsversion,
353
166k
                                          out, outl,
354
166k
                                          blksz, &ctx->tlsmac, &ctx->alloced,
355
166k
                                          ctx->tlsmacsize, 0)) {
356
21.2k
            ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
357
21.2k
            return 0;
358
21.2k
        }
359
148k
        return 1;
360
170k
    }
361
362
5.20M
    if (ctx->bufsz != 0)
363
0
        nextblocks = ossl_cipher_fillblock(ctx->buf, &ctx->bufsz, blksz,
364
0
                                           &in, &inl);
365
5.20M
    else
366
5.20M
        nextblocks = inl & ~(blksz-1);
367
368
    /*
369
     * If we're decrypting and we end an update on a block boundary we hold
370
     * the last block back in case this is the last update call and the last
371
     * block is padded.
372
     */
373
5.20M
    if (ctx->bufsz == blksz && (ctx->enc || inl > 0 || !ctx->pad)) {
374
0
        if (outsize < blksz) {
375
0
            ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
376
0
            return 0;
377
0
        }
378
0
        if (!ctx->hw->cipher(ctx, out, ctx->buf, blksz)) {
379
0
            ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
380
0
            return 0;
381
0
        }
382
0
        ctx->bufsz = 0;
383
0
        outlint = blksz;
384
0
        out += blksz;
385
0
    }
386
5.20M
    if (nextblocks > 0) {
387
5.20M
        if (!ctx->enc && ctx->pad && nextblocks == inl) {
388
1.02k
            if (!ossl_assert(inl >= blksz)) {
389
0
                ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
390
0
                return 0;
391
0
            }
392
1.02k
            nextblocks -= blksz;
393
1.02k
        }
394
5.20M
        outlint += nextblocks;
395
5.20M
        if (outsize < outlint) {
396
0
            ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
397
0
            return 0;
398
0
        }
399
5.20M
    }
400
5.20M
    if (nextblocks > 0) {
401
5.20M
        if (!ctx->hw->cipher(ctx, out, in, nextblocks)) {
402
0
            ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
403
0
            return 0;
404
0
        }
405
5.20M
        in += nextblocks;
406
5.20M
        inl -= nextblocks;
407
5.20M
    }
408
5.20M
    if (inl != 0
409
5.20M
        && !ossl_cipher_trailingdata(ctx->buf, &ctx->bufsz, blksz, &in, &inl)) {
410
        /* ERR_raise already called */
411
0
        return 0;
412
0
    }
413
414
5.20M
    *outl = outlint;
415
5.20M
    return inl == 0;
416
5.20M
}
417
418
int ossl_cipher_generic_block_final(void *vctx, unsigned char *out,
419
                                    size_t *outl, size_t outsize)
420
1.17k
{
421
1.17k
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
422
1.17k
    size_t blksz = ctx->blocksize;
423
424
1.17k
    if (!ossl_prov_is_running())
425
0
        return 0;
426
427
1.17k
    if (!ctx->key_set) {
428
0
        ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
429
0
        return 0;
430
0
    }
431
432
1.17k
    if (ctx->tlsversion > 0) {
433
        /* We never finalize TLS, so this is an error */
434
0
        ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
435
0
        return 0;
436
0
    }
437
438
1.17k
    if (ctx->enc) {
439
128
        if (ctx->pad) {
440
106
            ossl_cipher_padblock(ctx->buf, &ctx->bufsz, blksz);
441
106
        } else if (ctx->bufsz == 0) {
442
22
            *outl = 0;
443
22
            return 1;
444
22
        } else if (ctx->bufsz != blksz) {
445
0
            ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
446
0
            return 0;
447
0
        }
448
449
106
        if (outsize < blksz) {
450
0
            ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
451
0
            return 0;
452
0
        }
453
106
        if (!ctx->hw->cipher(ctx, out, ctx->buf, blksz)) {
454
0
            ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
455
0
            return 0;
456
0
        }
457
106
        ctx->bufsz = 0;
458
106
        *outl = blksz;
459
106
        return 1;
460
106
    }
461
462
    /* Decrypting */
463
1.05k
    if (ctx->bufsz != blksz) {
464
29
        if (ctx->bufsz == 0 && !ctx->pad) {
465
0
            *outl = 0;
466
0
            return 1;
467
0
        }
468
29
        ERR_raise(ERR_LIB_PROV, PROV_R_WRONG_FINAL_BLOCK_LENGTH);
469
29
        return 0;
470
29
    }
471
472
1.02k
    if (!ctx->hw->cipher(ctx, ctx->buf, ctx->buf, blksz)) {
473
0
        ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
474
0
        return 0;
475
0
    }
476
477
1.02k
    if (ctx->pad && !ossl_cipher_unpadblock(ctx->buf, &ctx->bufsz, blksz)) {
478
        /* ERR_raise already called */
479
43
        return 0;
480
43
    }
481
482
979
    if (outsize < ctx->bufsz) {
483
0
        ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
484
0
        return 0;
485
0
    }
486
979
    memcpy(out, ctx->buf, ctx->bufsz);
487
979
    *outl = ctx->bufsz;
488
979
    ctx->bufsz = 0;
489
979
    return 1;
490
979
}
491
492
int ossl_cipher_generic_stream_update(void *vctx, unsigned char *out,
493
                                      size_t *outl, size_t outsize,
494
                                      const unsigned char *in, size_t inl)
495
199k
{
496
199k
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
497
498
199k
    if (!ctx->key_set) {
499
0
        ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
500
0
        return 0;
501
0
    }
502
503
199k
    if (inl == 0) {
504
0
        *outl = 0;
505
0
        return 1;
506
0
    }
507
508
199k
    if (outsize < inl) {
509
0
        ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
510
0
        return 0;
511
0
    }
512
513
199k
    if (!ctx->hw->cipher(ctx, out, in, inl)) {
514
455
        ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
515
455
        return 0;
516
455
    }
517
518
199k
    *outl = inl;
519
199k
    if (!ctx->enc && ctx->tlsversion > 0) {
520
        /*
521
        * Remove any TLS padding. Only used by cipher_aes_cbc_hmac_sha1_hw.c and
522
        * cipher_aes_cbc_hmac_sha256_hw.c
523
        */
524
0
        if (ctx->removetlspad) {
525
            /*
526
             * We should have already failed in the cipher() call above if this
527
             * isn't true.
528
             */
529
0
            if (!ossl_assert(*outl >= (size_t)(out[inl - 1] + 1)))
530
0
                return 0;
531
            /* The actual padding length */
532
0
            *outl -= out[inl - 1] + 1;
533
0
        }
534
535
        /* TLS MAC and explicit IV if relevant. We should have already failed
536
         * in the cipher() call above if *outl is too short.
537
         */
538
0
        if (!ossl_assert(*outl >= ctx->removetlsfixed))
539
0
            return 0;
540
0
        *outl -= ctx->removetlsfixed;
541
542
        /* Extract the MAC if there is one */
543
0
        if (ctx->tlsmacsize > 0) {
544
0
            if (*outl < ctx->tlsmacsize)
545
0
                return 0;
546
547
0
            ctx->tlsmac = out + *outl - ctx->tlsmacsize;
548
0
            *outl -= ctx->tlsmacsize;
549
0
        }
550
0
    }
551
552
199k
    return 1;
553
199k
}
554
int ossl_cipher_generic_stream_final(void *vctx, unsigned char *out,
555
                                     size_t *outl, size_t outsize)
556
320
{
557
320
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
558
559
320
    if (!ossl_prov_is_running())
560
0
        return 0;
561
562
320
    if (!ctx->key_set) {
563
0
        ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
564
0
        return 0;
565
0
    }
566
567
320
    *outl = 0;
568
320
    return 1;
569
320
}
570
571
int ossl_cipher_generic_cipher(void *vctx, unsigned char *out, size_t *outl,
572
                               size_t outsize, const unsigned char *in,
573
                               size_t inl)
574
21
{
575
21
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
576
577
21
    if (!ossl_prov_is_running())
578
0
        return 0;
579
580
21
    if (!ctx->key_set) {
581
0
        ERR_raise(ERR_LIB_PROV, PROV_R_NO_KEY_SET);
582
0
        return 0;
583
0
    }
584
585
21
    if (outsize < inl) {
586
0
        ERR_raise(ERR_LIB_PROV, PROV_R_OUTPUT_BUFFER_TOO_SMALL);
587
0
        return 0;
588
0
    }
589
590
21
    if (!ctx->hw->cipher(ctx, out, in, inl)) {
591
0
        ERR_raise(ERR_LIB_PROV, PROV_R_CIPHER_OPERATION_FAILED);
592
0
        return 0;
593
0
    }
594
595
21
    *outl = inl;
596
21
    return 1;
597
21
}
598
599
int ossl_cipher_generic_get_ctx_params(void *vctx, OSSL_PARAM params[])
600
334k
{
601
334k
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
602
334k
    OSSL_PARAM *p;
603
604
334k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IVLEN);
605
334k
    if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->ivlen)) {
606
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
607
0
        return 0;
608
0
    }
609
334k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_PADDING);
610
334k
    if (p != NULL && !OSSL_PARAM_set_uint(p, ctx->pad)) {
611
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
612
0
        return 0;
613
0
    }
614
334k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_IV);
615
334k
    if (p != NULL
616
334k
        && !OSSL_PARAM_set_octet_ptr(p, &ctx->oiv, ctx->ivlen)
617
334k
        && !OSSL_PARAM_set_octet_string(p, &ctx->oiv, ctx->ivlen)) {
618
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
619
0
        return 0;
620
0
    }
621
334k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_UPDATED_IV);
622
334k
    if (p != NULL
623
334k
        && !OSSL_PARAM_set_octet_ptr(p, &ctx->iv, ctx->ivlen)
624
334k
        && !OSSL_PARAM_set_octet_string(p, &ctx->iv, ctx->ivlen)) {
625
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
626
0
        return 0;
627
0
    }
628
334k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_NUM);
629
334k
    if (p != NULL && !OSSL_PARAM_set_uint(p, ctx->num)) {
630
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
631
0
        return 0;
632
0
    }
633
334k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_KEYLEN);
634
334k
    if (p != NULL && !OSSL_PARAM_set_size_t(p, ctx->keylen)) {
635
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
636
0
        return 0;
637
0
    }
638
334k
    p = OSSL_PARAM_locate(params, OSSL_CIPHER_PARAM_TLS_MAC);
639
334k
    if (p != NULL
640
334k
        && !OSSL_PARAM_set_octet_ptr(p, ctx->tlsmac, ctx->tlsmacsize)) {
641
0
        ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_SET_PARAMETER);
642
0
        return 0;
643
0
    }
644
334k
    return 1;
645
334k
}
646
647
int ossl_cipher_generic_set_ctx_params(void *vctx, const OSSL_PARAM params[])
648
412k
{
649
412k
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
650
412k
    const OSSL_PARAM *p;
651
652
412k
    if (ossl_param_is_empty(params))
653
410k
        return 1;
654
655
2.09k
    p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_PADDING);
656
2.09k
    if (p != NULL) {
657
0
        unsigned int pad;
658
659
0
        if (!OSSL_PARAM_get_uint(p, &pad)) {
660
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
661
0
            return 0;
662
0
        }
663
0
        ctx->pad = pad ? 1 : 0;
664
0
    }
665
2.09k
    p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_USE_BITS);
666
2.09k
    if (p != NULL) {
667
0
        unsigned int bits;
668
669
0
        if (!OSSL_PARAM_get_uint(p, &bits)) {
670
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
671
0
            return 0;
672
0
        }
673
0
        ctx->use_bits = bits ? 1 : 0;
674
0
    }
675
2.09k
    p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_TLS_VERSION);
676
2.09k
    if (p != NULL) {
677
2.09k
        if (!OSSL_PARAM_get_uint(p, &ctx->tlsversion)) {
678
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
679
0
            return 0;
680
0
        }
681
2.09k
    }
682
2.09k
    p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_TLS_MAC_SIZE);
683
2.09k
    if (p != NULL) {
684
2.09k
        if (!OSSL_PARAM_get_size_t(p, &ctx->tlsmacsize)) {
685
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
686
0
            return 0;
687
0
        }
688
2.09k
    }
689
2.09k
    p = OSSL_PARAM_locate_const(params, OSSL_CIPHER_PARAM_NUM);
690
2.09k
    if (p != NULL) {
691
0
        unsigned int num;
692
693
0
        if (!OSSL_PARAM_get_uint(p, &num)) {
694
0
            ERR_raise(ERR_LIB_PROV, PROV_R_FAILED_TO_GET_PARAMETER);
695
0
            return 0;
696
0
        }
697
0
        ctx->num = num;
698
0
    }
699
2.09k
    return 1;
700
2.09k
}
701
702
int ossl_cipher_generic_initiv(PROV_CIPHER_CTX *ctx, const unsigned char *iv,
703
                               size_t ivlen)
704
587k
{
705
587k
    if (ivlen != ctx->ivlen
706
587k
        || ivlen > sizeof(ctx->iv)) {
707
0
        ERR_raise(ERR_LIB_PROV, PROV_R_INVALID_IV_LENGTH);
708
0
        return 0;
709
0
    }
710
587k
    ctx->iv_set = 1;
711
587k
    memcpy(ctx->iv, iv, ivlen);
712
587k
    memcpy(ctx->oiv, iv, ivlen);
713
587k
    return 1;
714
587k
}
715
716
void ossl_cipher_generic_initkey(void *vctx, size_t kbits, size_t blkbits,
717
                                 size_t ivbits, unsigned int mode,
718
                                 uint64_t flags, const PROV_CIPHER_HW *hw,
719
                                 void *provctx)
720
242k
{
721
242k
    PROV_CIPHER_CTX *ctx = (PROV_CIPHER_CTX *)vctx;
722
723
242k
    if ((flags & PROV_CIPHER_FLAG_INVERSE_CIPHER) != 0)
724
0
        ctx->inverse_cipher = 1;
725
242k
    if ((flags & PROV_CIPHER_FLAG_VARIABLE_LENGTH) != 0)
726
0
        ctx->variable_keylength = 1;
727
728
242k
    ctx->pad = 1;
729
242k
    ctx->keylen = ((kbits) / 8);
730
242k
    ctx->ivlen = ((ivbits) / 8);
731
242k
    ctx->hw = hw;
732
242k
    ctx->mode = mode;
733
242k
    ctx->blocksize = blkbits / 8;
734
242k
    if (provctx != NULL)
735
221k
        ctx->libctx = PROV_LIBCTX_OF(provctx); /* used for rand */
736
242k
}