Coverage Report

Created: 2025-12-31 06:58

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