Coverage Report

Created: 2025-12-31 06:58

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