Coverage Report

Created: 2025-12-31 06:58

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