Coverage Report

Created: 2024-05-21 06:33

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