blob: 7f4c121492d5dffd04356956add9ddc4cc391ba3 [file] [log] [blame]
Jens Wiklander817466c2018-05-22 13:49:31 +02001/**
2 * \file cipher.c
3 *
Tom Van Eyckb0563632024-06-13 16:20:14 +02004 * \brief Generic cipher wrapper for Mbed TLS
Jens Wiklander817466c2018-05-22 13:49:31 +02005 *
6 * \author Adriaan de Jong <dejong@fox-it.com>
7 *
Jerome Forissier79013242021-07-28 10:24:04 +02008 * Copyright The Mbed TLS Contributors
Tom Van Eyckb0563632024-06-13 16:20:14 +02009 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Jens Wiklander817466c2018-05-22 13:49:31 +020010 */
11
Jerome Forissier79013242021-07-28 10:24:04 +020012#include "common.h"
Jens Wiklander817466c2018-05-22 13:49:31 +020013
14#if defined(MBEDTLS_CIPHER_C)
15
16#include "mbedtls/cipher.h"
Jens Wiklander32b31802023-10-06 16:59:46 +020017#include "cipher_wrap.h"
Jens Wiklander3d3b0592019-03-20 15:30:29 +010018#include "mbedtls/platform_util.h"
Jerome Forissier11fa71b2020-04-20 17:17:56 +020019#include "mbedtls/error.h"
Jerome Forissier039e02d2022-08-09 17:10:15 +020020#include "mbedtls/constant_time.h"
Tom Van Eyckb0563632024-06-13 16:20:14 +020021#include "constant_time_internal.h"
Jens Wiklander817466c2018-05-22 13:49:31 +020022
23#include <stdlib.h>
24#include <string.h>
25
Jens Wiklander3d3b0592019-03-20 15:30:29 +010026#if defined(MBEDTLS_CHACHAPOLY_C)
27#include "mbedtls/chachapoly.h"
28#endif
29
Jens Wiklander817466c2018-05-22 13:49:31 +020030#if defined(MBEDTLS_GCM_C)
31#include "mbedtls/gcm.h"
32#endif
33
34#if defined(MBEDTLS_CCM_C)
35#include "mbedtls/ccm.h"
36#endif
37
Jens Wiklander3d3b0592019-03-20 15:30:29 +010038#if defined(MBEDTLS_CHACHA20_C)
39#include "mbedtls/chacha20.h"
40#endif
41
Jens Wiklander817466c2018-05-22 13:49:31 +020042#if defined(MBEDTLS_CMAC_C)
43#include "mbedtls/cmac.h"
44#endif
45
Tom Van Eyckb0563632024-06-13 16:20:14 +020046#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerome Forissier11fa71b2020-04-20 17:17:56 +020047#include "psa/crypto.h"
Tom Van Eyckb0563632024-06-13 16:20:14 +020048#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jerome Forissier11fa71b2020-04-20 17:17:56 +020049
50#if defined(MBEDTLS_NIST_KW_C)
51#include "mbedtls/nist_kw.h"
52#endif
53
Jens Wiklander817466c2018-05-22 13:49:31 +020054#include "mbedtls/platform.h"
Jens Wiklander817466c2018-05-22 13:49:31 +020055
Jens Wiklander817466c2018-05-22 13:49:31 +020056static int supported_init = 0;
57
Tom Van Eyckb0563632024-06-13 16:20:14 +020058static inline const mbedtls_cipher_base_t *mbedtls_cipher_get_base(
59 const mbedtls_cipher_info_t *info)
60{
61 return mbedtls_cipher_base_lookup_table[info->base_idx];
62}
63
Jens Wiklander32b31802023-10-06 16:59:46 +020064const int *mbedtls_cipher_list(void)
Jens Wiklander817466c2018-05-22 13:49:31 +020065{
66 const mbedtls_cipher_definition_t *def;
67 int *type;
68
Jens Wiklander32b31802023-10-06 16:59:46 +020069 if (!supported_init) {
Jens Wiklander817466c2018-05-22 13:49:31 +020070 def = mbedtls_cipher_definitions;
71 type = mbedtls_cipher_supported;
72
Jens Wiklander32b31802023-10-06 16:59:46 +020073 while (def->type != 0) {
Jens Wiklander817466c2018-05-22 13:49:31 +020074 *type++ = (*def++).type;
Jens Wiklander32b31802023-10-06 16:59:46 +020075 }
Jens Wiklander817466c2018-05-22 13:49:31 +020076
77 *type = 0;
78
79 supported_init = 1;
80 }
81
Jens Wiklander32b31802023-10-06 16:59:46 +020082 return mbedtls_cipher_supported;
Jens Wiklander817466c2018-05-22 13:49:31 +020083}
84
Jerome Forissier11fa71b2020-04-20 17:17:56 +020085const mbedtls_cipher_info_t *mbedtls_cipher_info_from_type(
Jens Wiklander32b31802023-10-06 16:59:46 +020086 const mbedtls_cipher_type_t cipher_type)
Jens Wiklander817466c2018-05-22 13:49:31 +020087{
88 const mbedtls_cipher_definition_t *def;
89
Jens Wiklander32b31802023-10-06 16:59:46 +020090 for (def = mbedtls_cipher_definitions; def->info != NULL; def++) {
91 if (def->type == cipher_type) {
92 return def->info;
93 }
94 }
Jens Wiklander817466c2018-05-22 13:49:31 +020095
Jens Wiklander32b31802023-10-06 16:59:46 +020096 return NULL;
Jens Wiklander817466c2018-05-22 13:49:31 +020097}
98
Jerome Forissier11fa71b2020-04-20 17:17:56 +020099const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string(
Jens Wiklander32b31802023-10-06 16:59:46 +0200100 const char *cipher_name)
Jens Wiklander817466c2018-05-22 13:49:31 +0200101{
102 const mbedtls_cipher_definition_t *def;
103
Jens Wiklander32b31802023-10-06 16:59:46 +0200104 if (NULL == cipher_name) {
105 return NULL;
106 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200107
Jens Wiklander32b31802023-10-06 16:59:46 +0200108 for (def = mbedtls_cipher_definitions; def->info != NULL; def++) {
109 if (!strcmp(def->info->name, cipher_name)) {
110 return def->info;
111 }
112 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200113
Jens Wiklander32b31802023-10-06 16:59:46 +0200114 return NULL;
Jens Wiklander817466c2018-05-22 13:49:31 +0200115}
116
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200117const mbedtls_cipher_info_t *mbedtls_cipher_info_from_values(
118 const mbedtls_cipher_id_t cipher_id,
119 int key_bitlen,
Jens Wiklander32b31802023-10-06 16:59:46 +0200120 const mbedtls_cipher_mode_t mode)
Jens Wiklander817466c2018-05-22 13:49:31 +0200121{
122 const mbedtls_cipher_definition_t *def;
123
Jens Wiklander32b31802023-10-06 16:59:46 +0200124 for (def = mbedtls_cipher_definitions; def->info != NULL; def++) {
Tom Van Eyckb0563632024-06-13 16:20:14 +0200125 if (mbedtls_cipher_get_base(def->info)->cipher == cipher_id &&
126 mbedtls_cipher_info_get_key_bitlen(def->info) == (unsigned) key_bitlen &&
Jens Wiklander32b31802023-10-06 16:59:46 +0200127 def->info->mode == mode) {
128 return def->info;
129 }
130 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200131
Jens Wiklander32b31802023-10-06 16:59:46 +0200132 return NULL;
Jens Wiklander817466c2018-05-22 13:49:31 +0200133}
134
Tom Van Eyckb0563632024-06-13 16:20:14 +0200135#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
136static inline psa_key_type_t mbedtls_psa_translate_cipher_type(
137 mbedtls_cipher_type_t cipher)
138{
139 switch (cipher) {
140 case MBEDTLS_CIPHER_AES_128_CCM:
141 case MBEDTLS_CIPHER_AES_192_CCM:
142 case MBEDTLS_CIPHER_AES_256_CCM:
143 case MBEDTLS_CIPHER_AES_128_CCM_STAR_NO_TAG:
144 case MBEDTLS_CIPHER_AES_192_CCM_STAR_NO_TAG:
145 case MBEDTLS_CIPHER_AES_256_CCM_STAR_NO_TAG:
146 case MBEDTLS_CIPHER_AES_128_GCM:
147 case MBEDTLS_CIPHER_AES_192_GCM:
148 case MBEDTLS_CIPHER_AES_256_GCM:
149 case MBEDTLS_CIPHER_AES_128_CBC:
150 case MBEDTLS_CIPHER_AES_192_CBC:
151 case MBEDTLS_CIPHER_AES_256_CBC:
152 case MBEDTLS_CIPHER_AES_128_ECB:
153 case MBEDTLS_CIPHER_AES_192_ECB:
154 case MBEDTLS_CIPHER_AES_256_ECB:
155 return PSA_KEY_TYPE_AES;
156
157 /* ARIA not yet supported in PSA. */
158 /* case MBEDTLS_CIPHER_ARIA_128_CCM:
159 case MBEDTLS_CIPHER_ARIA_192_CCM:
160 case MBEDTLS_CIPHER_ARIA_256_CCM:
161 case MBEDTLS_CIPHER_ARIA_128_CCM_STAR_NO_TAG:
162 case MBEDTLS_CIPHER_ARIA_192_CCM_STAR_NO_TAG:
163 case MBEDTLS_CIPHER_ARIA_256_CCM_STAR_NO_TAG:
164 case MBEDTLS_CIPHER_ARIA_128_GCM:
165 case MBEDTLS_CIPHER_ARIA_192_GCM:
166 case MBEDTLS_CIPHER_ARIA_256_GCM:
167 case MBEDTLS_CIPHER_ARIA_128_CBC:
168 case MBEDTLS_CIPHER_ARIA_192_CBC:
169 case MBEDTLS_CIPHER_ARIA_256_CBC:
170 return( PSA_KEY_TYPE_ARIA ); */
171
172 default:
173 return 0;
174 }
175}
176
177static inline psa_algorithm_t mbedtls_psa_translate_cipher_mode(
178 mbedtls_cipher_mode_t mode, size_t taglen)
179{
180 switch (mode) {
181 case MBEDTLS_MODE_ECB:
182 return PSA_ALG_ECB_NO_PADDING;
183 case MBEDTLS_MODE_GCM:
184 return PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, taglen);
185 case MBEDTLS_MODE_CCM:
186 return PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen);
187 case MBEDTLS_MODE_CCM_STAR_NO_TAG:
188 return PSA_ALG_CCM_STAR_NO_TAG;
189 case MBEDTLS_MODE_CBC:
190 if (taglen == 0) {
191 return PSA_ALG_CBC_NO_PADDING;
192 } else {
193 return 0;
194 }
195 default:
196 return 0;
197 }
198}
199#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
200
Jens Wiklander32b31802023-10-06 16:59:46 +0200201void mbedtls_cipher_init(mbedtls_cipher_context_t *ctx)
Jens Wiklander817466c2018-05-22 13:49:31 +0200202{
Jens Wiklander32b31802023-10-06 16:59:46 +0200203 memset(ctx, 0, sizeof(mbedtls_cipher_context_t));
Jens Wiklander817466c2018-05-22 13:49:31 +0200204}
205
Jens Wiklander32b31802023-10-06 16:59:46 +0200206void mbedtls_cipher_free(mbedtls_cipher_context_t *ctx)
Jens Wiklander817466c2018-05-22 13:49:31 +0200207{
Jens Wiklander32b31802023-10-06 16:59:46 +0200208 if (ctx == NULL) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200209 return;
Jens Wiklander32b31802023-10-06 16:59:46 +0200210 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200211
Tom Van Eyckb0563632024-06-13 16:20:14 +0200212#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jens Wiklander32b31802023-10-06 16:59:46 +0200213 if (ctx->psa_enabled == 1) {
214 if (ctx->cipher_ctx != NULL) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200215 mbedtls_cipher_context_psa * const cipher_psa =
216 (mbedtls_cipher_context_psa *) ctx->cipher_ctx;
217
Jens Wiklander32b31802023-10-06 16:59:46 +0200218 if (cipher_psa->slot_state == MBEDTLS_CIPHER_PSA_KEY_OWNED) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200219 /* xxx_free() doesn't allow to return failures. */
Jens Wiklander32b31802023-10-06 16:59:46 +0200220 (void) psa_destroy_key(cipher_psa->slot);
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200221 }
222
Tom Van Eyckb0563632024-06-13 16:20:14 +0200223 mbedtls_zeroize_and_free(cipher_psa, sizeof(*cipher_psa));
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200224 }
225
Jens Wiklander32b31802023-10-06 16:59:46 +0200226 mbedtls_platform_zeroize(ctx, sizeof(mbedtls_cipher_context_t));
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200227 return;
228 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200229#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200230
Jens Wiklander817466c2018-05-22 13:49:31 +0200231#if defined(MBEDTLS_CMAC_C)
Jens Wiklander32b31802023-10-06 16:59:46 +0200232 if (ctx->cmac_ctx) {
Tom Van Eyckb0563632024-06-13 16:20:14 +0200233 mbedtls_zeroize_and_free(ctx->cmac_ctx,
Jens Wiklander32b31802023-10-06 16:59:46 +0200234 sizeof(mbedtls_cmac_context_t));
Jens Wiklander817466c2018-05-22 13:49:31 +0200235 }
236#endif
237
Jens Wiklander32b31802023-10-06 16:59:46 +0200238 if (ctx->cipher_ctx) {
Tom Van Eyckb0563632024-06-13 16:20:14 +0200239 mbedtls_cipher_get_base(ctx->cipher_info)->ctx_free_func(ctx->cipher_ctx);
Jens Wiklander32b31802023-10-06 16:59:46 +0200240 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200241
Jens Wiklander32b31802023-10-06 16:59:46 +0200242 mbedtls_platform_zeroize(ctx, sizeof(mbedtls_cipher_context_t));
Jens Wiklander817466c2018-05-22 13:49:31 +0200243}
244
Jens Wiklander32b31802023-10-06 16:59:46 +0200245int mbedtls_cipher_setup(mbedtls_cipher_context_t *ctx,
246 const mbedtls_cipher_info_t *cipher_info)
Jens Wiklander817466c2018-05-22 13:49:31 +0200247{
Jens Wiklander32b31802023-10-06 16:59:46 +0200248 if (cipher_info == NULL) {
249 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
250 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200251
Jens Wiklander32b31802023-10-06 16:59:46 +0200252 memset(ctx, 0, sizeof(mbedtls_cipher_context_t));
Jens Wiklander817466c2018-05-22 13:49:31 +0200253
Tom Van Eyckb0563632024-06-13 16:20:14 +0200254 if (mbedtls_cipher_get_base(cipher_info)->ctx_alloc_func != NULL) {
255 ctx->cipher_ctx = mbedtls_cipher_get_base(cipher_info)->ctx_alloc_func();
256 if (ctx->cipher_ctx == NULL) {
257 return MBEDTLS_ERR_CIPHER_ALLOC_FAILED;
258 }
Jens Wiklander32b31802023-10-06 16:59:46 +0200259 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200260
261 ctx->cipher_info = cipher_info;
262
Jens Wiklander32b31802023-10-06 16:59:46 +0200263 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200264}
265
Tom Van Eyckb0563632024-06-13 16:20:14 +0200266#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jens Wiklander32b31802023-10-06 16:59:46 +0200267int mbedtls_cipher_setup_psa(mbedtls_cipher_context_t *ctx,
268 const mbedtls_cipher_info_t *cipher_info,
269 size_t taglen)
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200270{
271 psa_algorithm_t alg;
272 mbedtls_cipher_context_psa *cipher_psa;
273
Jens Wiklander32b31802023-10-06 16:59:46 +0200274 if (NULL == cipher_info || NULL == ctx) {
275 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
276 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200277
278 /* Check that the underlying cipher mode and cipher type are
279 * supported by the underlying PSA Crypto implementation. */
Tom Van Eyckb0563632024-06-13 16:20:14 +0200280 alg = mbedtls_psa_translate_cipher_mode(((mbedtls_cipher_mode_t) cipher_info->mode), taglen);
Jens Wiklander32b31802023-10-06 16:59:46 +0200281 if (alg == 0) {
282 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
283 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200284 if (mbedtls_psa_translate_cipher_type(((mbedtls_cipher_type_t) cipher_info->type)) == 0) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200285 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
286 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200287
Jens Wiklander32b31802023-10-06 16:59:46 +0200288 memset(ctx, 0, sizeof(mbedtls_cipher_context_t));
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200289
Jens Wiklander32b31802023-10-06 16:59:46 +0200290 cipher_psa = mbedtls_calloc(1, sizeof(mbedtls_cipher_context_psa));
291 if (cipher_psa == NULL) {
292 return MBEDTLS_ERR_CIPHER_ALLOC_FAILED;
293 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200294 cipher_psa->alg = alg;
295 ctx->cipher_ctx = cipher_psa;
296 ctx->cipher_info = cipher_info;
297 ctx->psa_enabled = 1;
Jens Wiklander32b31802023-10-06 16:59:46 +0200298 return 0;
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200299}
Tom Van Eyckb0563632024-06-13 16:20:14 +0200300#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200301
Jens Wiklander32b31802023-10-06 16:59:46 +0200302int mbedtls_cipher_setkey(mbedtls_cipher_context_t *ctx,
303 const unsigned char *key,
304 int key_bitlen,
305 const mbedtls_operation_t operation)
Jens Wiklander817466c2018-05-22 13:49:31 +0200306{
Jens Wiklander32b31802023-10-06 16:59:46 +0200307 if (operation != MBEDTLS_ENCRYPT && operation != MBEDTLS_DECRYPT) {
308 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
309 }
310 if (ctx->cipher_info == NULL) {
311 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
312 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200313#if defined(MBEDTLS_BLOCK_CIPHER_NO_DECRYPT)
314 if (MBEDTLS_MODE_ECB == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) &&
315 MBEDTLS_DECRYPT == operation) {
316 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
317 }
318#endif
Jens Wiklander817466c2018-05-22 13:49:31 +0200319
Tom Van Eyckb0563632024-06-13 16:20:14 +0200320#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jens Wiklander32b31802023-10-06 16:59:46 +0200321 if (ctx->psa_enabled == 1) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200322 mbedtls_cipher_context_psa * const cipher_psa =
323 (mbedtls_cipher_context_psa *) ctx->cipher_ctx;
324
Jens Wiklander32b31802023-10-06 16:59:46 +0200325 size_t const key_bytelen = ((size_t) key_bitlen + 7) / 8;
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200326
327 psa_status_t status;
328 psa_key_type_t key_type;
329 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
330
331 /* PSA Crypto API only accepts byte-aligned keys. */
Jens Wiklander32b31802023-10-06 16:59:46 +0200332 if (key_bitlen % 8 != 0) {
333 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
334 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200335
336 /* Don't allow keys to be set multiple times. */
Jens Wiklander32b31802023-10-06 16:59:46 +0200337 if (cipher_psa->slot_state != MBEDTLS_CIPHER_PSA_KEY_UNSET) {
338 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
339 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200340
341 key_type = mbedtls_psa_translate_cipher_type(
Tom Van Eyckb0563632024-06-13 16:20:14 +0200342 ((mbedtls_cipher_type_t) ctx->cipher_info->type));
Jens Wiklander32b31802023-10-06 16:59:46 +0200343 if (key_type == 0) {
344 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
345 }
346 psa_set_key_type(&attributes, key_type);
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200347
348 /* Mbed TLS' cipher layer doesn't enforce the mode of operation
349 * (encrypt vs. decrypt): it is possible to setup a key for encryption
350 * and use it for AEAD decryption. Until tests relying on this
351 * are changed, allow any usage in PSA. */
Jens Wiklander32b31802023-10-06 16:59:46 +0200352 psa_set_key_usage_flags(&attributes,
Jens Wiklander32b31802023-10-06 16:59:46 +0200353 PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT);
354 psa_set_key_algorithm(&attributes, cipher_psa->alg);
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200355
Jens Wiklander32b31802023-10-06 16:59:46 +0200356 status = psa_import_key(&attributes, key, key_bytelen,
357 &cipher_psa->slot);
358 switch (status) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200359 case PSA_SUCCESS:
360 break;
361 case PSA_ERROR_INSUFFICIENT_MEMORY:
Jens Wiklander32b31802023-10-06 16:59:46 +0200362 return MBEDTLS_ERR_CIPHER_ALLOC_FAILED;
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200363 case PSA_ERROR_NOT_SUPPORTED:
Jens Wiklander32b31802023-10-06 16:59:46 +0200364 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200365 default:
Jens Wiklander32b31802023-10-06 16:59:46 +0200366 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200367 }
368 /* Indicate that we own the key slot and need to
369 * destroy it in mbedtls_cipher_free(). */
370 cipher_psa->slot_state = MBEDTLS_CIPHER_PSA_KEY_OWNED;
371
372 ctx->key_bitlen = key_bitlen;
373 ctx->operation = operation;
Jens Wiklander32b31802023-10-06 16:59:46 +0200374 return 0;
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200375 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200376#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200377
Jens Wiklander32b31802023-10-06 16:59:46 +0200378 if ((ctx->cipher_info->flags & MBEDTLS_CIPHER_VARIABLE_KEY_LEN) == 0 &&
Tom Van Eyckb0563632024-06-13 16:20:14 +0200379 (int) mbedtls_cipher_info_get_key_bitlen(ctx->cipher_info) != key_bitlen) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200380 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Jens Wiklander817466c2018-05-22 13:49:31 +0200381 }
382
383 ctx->key_bitlen = key_bitlen;
384 ctx->operation = operation;
385
Tom Van Eyckb0563632024-06-13 16:20:14 +0200386#if !defined(MBEDTLS_BLOCK_CIPHER_NO_DECRYPT)
Jens Wiklander817466c2018-05-22 13:49:31 +0200387 /*
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100388 * For OFB, CFB and CTR mode always use the encryption key schedule
Jens Wiklander817466c2018-05-22 13:49:31 +0200389 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200390 if (MBEDTLS_ENCRYPT == operation ||
Tom Van Eyckb0563632024-06-13 16:20:14 +0200391 MBEDTLS_MODE_CFB == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
392 MBEDTLS_MODE_OFB == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
393 MBEDTLS_MODE_CTR == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
394 return mbedtls_cipher_get_base(ctx->cipher_info)->setkey_enc_func(ctx->cipher_ctx, key,
395 ctx->key_bitlen);
Jens Wiklander817466c2018-05-22 13:49:31 +0200396 }
397
Jens Wiklander32b31802023-10-06 16:59:46 +0200398 if (MBEDTLS_DECRYPT == operation) {
Tom Van Eyckb0563632024-06-13 16:20:14 +0200399 return mbedtls_cipher_get_base(ctx->cipher_info)->setkey_dec_func(ctx->cipher_ctx, key,
400 ctx->key_bitlen);
Jens Wiklander32b31802023-10-06 16:59:46 +0200401 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200402#else
403 if (operation == MBEDTLS_ENCRYPT || operation == MBEDTLS_DECRYPT) {
404 return mbedtls_cipher_get_base(ctx->cipher_info)->setkey_enc_func(ctx->cipher_ctx, key,
405 ctx->key_bitlen);
406 }
407#endif
Jens Wiklander817466c2018-05-22 13:49:31 +0200408
Jens Wiklander32b31802023-10-06 16:59:46 +0200409 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Jens Wiklander817466c2018-05-22 13:49:31 +0200410}
411
Jens Wiklander32b31802023-10-06 16:59:46 +0200412int mbedtls_cipher_set_iv(mbedtls_cipher_context_t *ctx,
413 const unsigned char *iv,
414 size_t iv_len)
Jens Wiklander817466c2018-05-22 13:49:31 +0200415{
416 size_t actual_iv_size;
417
Jens Wiklander32b31802023-10-06 16:59:46 +0200418 if (ctx->cipher_info == NULL) {
419 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
420 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200421#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jens Wiklander32b31802023-10-06 16:59:46 +0200422 if (ctx->psa_enabled == 1) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200423 /* While PSA Crypto has an API for multipart
424 * operations, we currently don't make it
425 * accessible through the cipher layer. */
Jens Wiklander32b31802023-10-06 16:59:46 +0200426 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200427 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200428#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jens Wiklander817466c2018-05-22 13:49:31 +0200429
430 /* avoid buffer overflow in ctx->iv */
Jens Wiklander32b31802023-10-06 16:59:46 +0200431 if (iv_len > MBEDTLS_MAX_IV_LENGTH) {
432 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
433 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200434
Jens Wiklander32b31802023-10-06 16:59:46 +0200435 if ((ctx->cipher_info->flags & MBEDTLS_CIPHER_VARIABLE_IV_LEN) != 0) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200436 actual_iv_size = iv_len;
Jens Wiklander32b31802023-10-06 16:59:46 +0200437 } else {
Tom Van Eyckb0563632024-06-13 16:20:14 +0200438 actual_iv_size = mbedtls_cipher_info_get_iv_size(ctx->cipher_info);
Jens Wiklander817466c2018-05-22 13:49:31 +0200439
440 /* avoid reading past the end of input buffer */
Jens Wiklander32b31802023-10-06 16:59:46 +0200441 if (actual_iv_size > iv_len) {
442 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
443 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200444 }
445
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100446#if defined(MBEDTLS_CHACHA20_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200447 if (((mbedtls_cipher_type_t) ctx->cipher_info->type) == MBEDTLS_CIPHER_CHACHA20) {
Jerome Forissier039e02d2022-08-09 17:10:15 +0200448 /* Even though the actual_iv_size is overwritten with a correct value
449 * of 12 from the cipher info, return an error to indicate that
450 * the input iv_len is wrong. */
Jens Wiklander32b31802023-10-06 16:59:46 +0200451 if (iv_len != 12) {
452 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
453 }
Jerome Forissier039e02d2022-08-09 17:10:15 +0200454
Jens Wiklander32b31802023-10-06 16:59:46 +0200455 if (0 != mbedtls_chacha20_starts((mbedtls_chacha20_context *) ctx->cipher_ctx,
456 iv,
457 0U)) { /* Initial counter value */
458 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100459 }
460 }
Jerome Forissier039e02d2022-08-09 17:10:15 +0200461#if defined(MBEDTLS_CHACHAPOLY_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200462 if (((mbedtls_cipher_type_t) ctx->cipher_info->type) == MBEDTLS_CIPHER_CHACHA20_POLY1305 &&
Jens Wiklander32b31802023-10-06 16:59:46 +0200463 iv_len != 12) {
464 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
465 }
Jerome Forissier039e02d2022-08-09 17:10:15 +0200466#endif
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100467#endif
468
Jens Wiklander32b31802023-10-06 16:59:46 +0200469#if defined(MBEDTLS_GCM_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200470 if (MBEDTLS_MODE_GCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200471 return mbedtls_gcm_starts((mbedtls_gcm_context *) ctx->cipher_ctx,
472 ctx->operation,
473 iv, iv_len);
474 }
475#endif
476
477#if defined(MBEDTLS_CCM_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200478 if (MBEDTLS_MODE_CCM_STAR_NO_TAG == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200479 int set_lengths_result;
480 int ccm_star_mode;
481
482 set_lengths_result = mbedtls_ccm_set_lengths(
483 (mbedtls_ccm_context *) ctx->cipher_ctx,
484 0, 0, 0);
485 if (set_lengths_result != 0) {
486 return set_lengths_result;
487 }
488
489 if (ctx->operation == MBEDTLS_DECRYPT) {
490 ccm_star_mode = MBEDTLS_CCM_STAR_DECRYPT;
491 } else if (ctx->operation == MBEDTLS_ENCRYPT) {
492 ccm_star_mode = MBEDTLS_CCM_STAR_ENCRYPT;
493 } else {
494 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
495 }
496
497 return mbedtls_ccm_starts((mbedtls_ccm_context *) ctx->cipher_ctx,
498 ccm_star_mode,
499 iv, iv_len);
500 }
501#endif
502
503 if (actual_iv_size != 0) {
504 memcpy(ctx->iv, iv, actual_iv_size);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100505 ctx->iv_size = actual_iv_size;
506 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200507
Jens Wiklander32b31802023-10-06 16:59:46 +0200508 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200509}
510
Jens Wiklander32b31802023-10-06 16:59:46 +0200511int mbedtls_cipher_reset(mbedtls_cipher_context_t *ctx)
Jens Wiklander817466c2018-05-22 13:49:31 +0200512{
Jens Wiklander32b31802023-10-06 16:59:46 +0200513 if (ctx->cipher_info == NULL) {
514 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
515 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200516
Tom Van Eyckb0563632024-06-13 16:20:14 +0200517#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jens Wiklander32b31802023-10-06 16:59:46 +0200518 if (ctx->psa_enabled == 1) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200519 /* We don't support resetting PSA-based
520 * cipher contexts, yet. */
Jens Wiklander32b31802023-10-06 16:59:46 +0200521 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200522 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200523#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200524
Jens Wiklander817466c2018-05-22 13:49:31 +0200525 ctx->unprocessed_len = 0;
526
Jens Wiklander32b31802023-10-06 16:59:46 +0200527 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200528}
529
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100530#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
Jens Wiklander32b31802023-10-06 16:59:46 +0200531int mbedtls_cipher_update_ad(mbedtls_cipher_context_t *ctx,
532 const unsigned char *ad, size_t ad_len)
Jens Wiklander817466c2018-05-22 13:49:31 +0200533{
Jens Wiklander32b31802023-10-06 16:59:46 +0200534 if (ctx->cipher_info == NULL) {
535 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
536 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200537
Tom Van Eyckb0563632024-06-13 16:20:14 +0200538#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jens Wiklander32b31802023-10-06 16:59:46 +0200539 if (ctx->psa_enabled == 1) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200540 /* While PSA Crypto has an API for multipart
541 * operations, we currently don't make it
542 * accessible through the cipher layer. */
Jens Wiklander32b31802023-10-06 16:59:46 +0200543 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200544 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200545#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200546
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100547#if defined(MBEDTLS_GCM_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200548 if (MBEDTLS_MODE_GCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200549 return mbedtls_gcm_update_ad((mbedtls_gcm_context *) ctx->cipher_ctx,
550 ad, ad_len);
Jens Wiklander817466c2018-05-22 13:49:31 +0200551 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100552#endif
553
554#if defined(MBEDTLS_CHACHAPOLY_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200555 if (MBEDTLS_CIPHER_CHACHA20_POLY1305 == ((mbedtls_cipher_type_t) ctx->cipher_info->type)) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100556 int result;
557 mbedtls_chachapoly_mode_t mode;
558
Jens Wiklander32b31802023-10-06 16:59:46 +0200559 mode = (ctx->operation == MBEDTLS_ENCRYPT)
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100560 ? MBEDTLS_CHACHAPOLY_ENCRYPT
561 : MBEDTLS_CHACHAPOLY_DECRYPT;
562
Jens Wiklander32b31802023-10-06 16:59:46 +0200563 result = mbedtls_chachapoly_starts((mbedtls_chachapoly_context *) ctx->cipher_ctx,
564 ctx->iv,
565 mode);
566 if (result != 0) {
567 return result;
568 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100569
Jens Wiklander32b31802023-10-06 16:59:46 +0200570 return mbedtls_chachapoly_update_aad((mbedtls_chachapoly_context *) ctx->cipher_ctx,
571 ad, ad_len);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100572 }
573#endif
Jens Wiklander817466c2018-05-22 13:49:31 +0200574
Jens Wiklander32b31802023-10-06 16:59:46 +0200575 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jens Wiklander817466c2018-05-22 13:49:31 +0200576}
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100577#endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
Jens Wiklander817466c2018-05-22 13:49:31 +0200578
Jens Wiklander32b31802023-10-06 16:59:46 +0200579int mbedtls_cipher_update(mbedtls_cipher_context_t *ctx, const unsigned char *input,
580 size_t ilen, unsigned char *output, size_t *olen)
Jens Wiklander817466c2018-05-22 13:49:31 +0200581{
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200582 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100583 size_t block_size;
Jens Wiklander817466c2018-05-22 13:49:31 +0200584
Jens Wiklander32b31802023-10-06 16:59:46 +0200585 if (ctx->cipher_info == NULL) {
586 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
587 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200588
Tom Van Eyckb0563632024-06-13 16:20:14 +0200589#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jens Wiklander32b31802023-10-06 16:59:46 +0200590 if (ctx->psa_enabled == 1) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200591 /* While PSA Crypto has an API for multipart
592 * operations, we currently don't make it
593 * accessible through the cipher layer. */
Jens Wiklander32b31802023-10-06 16:59:46 +0200594 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200595 }
Tom Van Eyckb0563632024-06-13 16:20:14 +0200596#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jerome Forissier11fa71b2020-04-20 17:17:56 +0200597
Jens Wiklander817466c2018-05-22 13:49:31 +0200598 *olen = 0;
Jens Wiklander32b31802023-10-06 16:59:46 +0200599 block_size = mbedtls_cipher_get_block_size(ctx);
600 if (0 == block_size) {
601 return MBEDTLS_ERR_CIPHER_INVALID_CONTEXT;
Jerome Forissier5b25c762020-04-07 11:18:49 +0200602 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200603
Tom Van Eyckb0563632024-06-13 16:20:14 +0200604 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_ECB) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200605 if (ilen != block_size) {
606 return MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED;
607 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200608
609 *olen = ilen;
610
Tom Van Eyckb0563632024-06-13 16:20:14 +0200611 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->ecb_func(ctx->cipher_ctx,
612 ctx->operation, input,
613 output))) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200614 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200615 }
616
Jens Wiklander32b31802023-10-06 16:59:46 +0200617 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200618 }
619
620#if defined(MBEDTLS_GCM_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200621 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_GCM) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200622 return mbedtls_gcm_update((mbedtls_gcm_context *) ctx->cipher_ctx,
623 input, ilen,
624 output, ilen, olen);
625 }
626#endif
627
628#if defined(MBEDTLS_CCM_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200629 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_CCM_STAR_NO_TAG) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200630 return mbedtls_ccm_update((mbedtls_ccm_context *) ctx->cipher_ctx,
631 input, ilen,
632 output, ilen, olen);
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100633 }
634#endif
635
636#if defined(MBEDTLS_CHACHAPOLY_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200637 if (((mbedtls_cipher_type_t) ctx->cipher_info->type) == MBEDTLS_CIPHER_CHACHA20_POLY1305) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100638 *olen = ilen;
Jens Wiklander32b31802023-10-06 16:59:46 +0200639 return mbedtls_chachapoly_update((mbedtls_chachapoly_context *) ctx->cipher_ctx,
640 ilen, input, output);
Jens Wiklander817466c2018-05-22 13:49:31 +0200641 }
642#endif
643
Jens Wiklander32b31802023-10-06 16:59:46 +0200644 if (input == output &&
645 (ctx->unprocessed_len != 0 || ilen % block_size)) {
646 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Jens Wiklander817466c2018-05-22 13:49:31 +0200647 }
648
649#if defined(MBEDTLS_CIPHER_MODE_CBC)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200650 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_CBC) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200651 size_t copy_len = 0;
652
653 /*
654 * If there is not enough data for a full block, cache it.
655 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200656 if ((ctx->operation == MBEDTLS_DECRYPT && NULL != ctx->add_padding &&
657 ilen <= block_size - ctx->unprocessed_len) ||
658 (ctx->operation == MBEDTLS_DECRYPT && NULL == ctx->add_padding &&
659 ilen < block_size - ctx->unprocessed_len) ||
660 (ctx->operation == MBEDTLS_ENCRYPT &&
661 ilen < block_size - ctx->unprocessed_len)) {
662 memcpy(&(ctx->unprocessed_data[ctx->unprocessed_len]), input,
663 ilen);
Jens Wiklander817466c2018-05-22 13:49:31 +0200664
665 ctx->unprocessed_len += ilen;
Jens Wiklander32b31802023-10-06 16:59:46 +0200666 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200667 }
668
669 /*
670 * Process cached data first
671 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200672 if (0 != ctx->unprocessed_len) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200673 copy_len = block_size - ctx->unprocessed_len;
674
Jens Wiklander32b31802023-10-06 16:59:46 +0200675 memcpy(&(ctx->unprocessed_data[ctx->unprocessed_len]), input,
676 copy_len);
Jens Wiklander817466c2018-05-22 13:49:31 +0200677
Tom Van Eyckb0563632024-06-13 16:20:14 +0200678 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->cbc_func(ctx->cipher_ctx,
679 ctx->operation,
680 block_size, ctx->iv,
681 ctx->
682 unprocessed_data,
683 output))) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200684 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200685 }
686
687 *olen += block_size;
688 output += block_size;
689 ctx->unprocessed_len = 0;
690
691 input += copy_len;
692 ilen -= copy_len;
693 }
694
695 /*
696 * Cache final, incomplete block
697 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200698 if (0 != ilen) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100699 /* Encryption: only cache partial blocks
700 * Decryption w/ padding: always keep at least one whole block
701 * Decryption w/o padding: only cache partial blocks
702 */
Jens Wiklander817466c2018-05-22 13:49:31 +0200703 copy_len = ilen % block_size;
Jens Wiklander32b31802023-10-06 16:59:46 +0200704 if (copy_len == 0 &&
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100705 ctx->operation == MBEDTLS_DECRYPT &&
Jens Wiklander32b31802023-10-06 16:59:46 +0200706 NULL != ctx->add_padding) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200707 copy_len = block_size;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100708 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200709
Jens Wiklander32b31802023-10-06 16:59:46 +0200710 memcpy(ctx->unprocessed_data, &(input[ilen - copy_len]),
711 copy_len);
Jens Wiklander817466c2018-05-22 13:49:31 +0200712
713 ctx->unprocessed_len += copy_len;
714 ilen -= copy_len;
715 }
716
717 /*
718 * Process remaining full blocks
719 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200720 if (ilen) {
Tom Van Eyckb0563632024-06-13 16:20:14 +0200721 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->cbc_func(ctx->cipher_ctx,
722 ctx->operation,
723 ilen, ctx->iv,
724 input,
725 output))) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200726 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200727 }
728
729 *olen += ilen;
730 }
731
Jens Wiklander32b31802023-10-06 16:59:46 +0200732 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200733 }
734#endif /* MBEDTLS_CIPHER_MODE_CBC */
735
736#if defined(MBEDTLS_CIPHER_MODE_CFB)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200737 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_CFB) {
738 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->cfb_func(ctx->cipher_ctx,
739 ctx->operation, ilen,
740 &ctx->unprocessed_len,
741 ctx->iv,
742 input, output))) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200743 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200744 }
745
746 *olen = ilen;
747
Jens Wiklander32b31802023-10-06 16:59:46 +0200748 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200749 }
750#endif /* MBEDTLS_CIPHER_MODE_CFB */
751
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100752#if defined(MBEDTLS_CIPHER_MODE_OFB)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200753 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_OFB) {
754 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->ofb_func(ctx->cipher_ctx,
755 ilen,
756 &ctx->unprocessed_len,
757 ctx->iv,
758 input, output))) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200759 return ret;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100760 }
761
762 *olen = ilen;
763
Jens Wiklander32b31802023-10-06 16:59:46 +0200764 return 0;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100765 }
766#endif /* MBEDTLS_CIPHER_MODE_OFB */
767
Jens Wiklander817466c2018-05-22 13:49:31 +0200768#if defined(MBEDTLS_CIPHER_MODE_CTR)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200769 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_CTR) {
770 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->ctr_func(ctx->cipher_ctx,
771 ilen,
772 &ctx->unprocessed_len,
773 ctx->iv,
774 ctx->unprocessed_data,
775 input, output))) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200776 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200777 }
778
779 *olen = ilen;
780
Jens Wiklander32b31802023-10-06 16:59:46 +0200781 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200782 }
783#endif /* MBEDTLS_CIPHER_MODE_CTR */
784
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100785#if defined(MBEDTLS_CIPHER_MODE_XTS)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200786 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_XTS) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200787 if (ctx->unprocessed_len > 0) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100788 /* We can only process an entire data unit at a time. */
Jens Wiklander32b31802023-10-06 16:59:46 +0200789 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100790 }
791
Tom Van Eyckb0563632024-06-13 16:20:14 +0200792 ret = mbedtls_cipher_get_base(ctx->cipher_info)->xts_func(ctx->cipher_ctx,
793 ctx->operation,
794 ilen,
795 ctx->iv,
796 input,
797 output);
Jens Wiklander32b31802023-10-06 16:59:46 +0200798 if (ret != 0) {
799 return ret;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100800 }
801
802 *olen = ilen;
803
Jens Wiklander32b31802023-10-06 16:59:46 +0200804 return 0;
Jens Wiklander3d3b0592019-03-20 15:30:29 +0100805 }
806#endif /* MBEDTLS_CIPHER_MODE_XTS */
807
Jens Wiklander817466c2018-05-22 13:49:31 +0200808#if defined(MBEDTLS_CIPHER_MODE_STREAM)
Tom Van Eyckb0563632024-06-13 16:20:14 +0200809 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_STREAM) {
810 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->stream_func(ctx->cipher_ctx,
811 ilen, input,
812 output))) {
Jens Wiklander32b31802023-10-06 16:59:46 +0200813 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +0200814 }
815
816 *olen = ilen;
817
Jens Wiklander32b31802023-10-06 16:59:46 +0200818 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200819 }
820#endif /* MBEDTLS_CIPHER_MODE_STREAM */
821
Jens Wiklander32b31802023-10-06 16:59:46 +0200822 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jens Wiklander817466c2018-05-22 13:49:31 +0200823}
824
825#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
826#if defined(MBEDTLS_CIPHER_PADDING_PKCS7)
827/*
828 * PKCS7 (and PKCS5) padding: fill with ll bytes, with ll = padding_len
829 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200830static void add_pkcs_padding(unsigned char *output, size_t output_len,
831 size_t data_len)
Jens Wiklander817466c2018-05-22 13:49:31 +0200832{
833 size_t padding_len = output_len - data_len;
834 unsigned char i;
835
Jens Wiklander32b31802023-10-06 16:59:46 +0200836 for (i = 0; i < padding_len; i++) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200837 output[data_len + i] = (unsigned char) padding_len;
Jens Wiklander32b31802023-10-06 16:59:46 +0200838 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200839}
840
Jens Wiklander32b31802023-10-06 16:59:46 +0200841static int get_pkcs_padding(unsigned char *input, size_t input_len,
842 size_t *data_len)
Jens Wiklander817466c2018-05-22 13:49:31 +0200843{
844 size_t i, pad_idx;
Tom Van Eyckb0563632024-06-13 16:20:14 +0200845 unsigned char padding_len;
Jens Wiklander817466c2018-05-22 13:49:31 +0200846
Jens Wiklander32b31802023-10-06 16:59:46 +0200847 if (NULL == input || NULL == data_len) {
848 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
849 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200850
851 padding_len = input[input_len - 1];
Sungbae Yoo4d211f32024-11-19 02:47:55 +0000852 if (padding_len == 0 || padding_len > input_len) {
853 return MBEDTLS_ERR_CIPHER_INVALID_PADDING;
854 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200855 *data_len = input_len - padding_len;
856
Tom Van Eyckb0563632024-06-13 16:20:14 +0200857 mbedtls_ct_condition_t bad = mbedtls_ct_uint_gt(padding_len, input_len);
858 bad = mbedtls_ct_bool_or(bad, mbedtls_ct_uint_eq(padding_len, 0));
Jens Wiklander817466c2018-05-22 13:49:31 +0200859
860 /* The number of bytes checked must be independent of padding_len,
861 * so pick input_len, which is usually 8 or 16 (one block) */
862 pad_idx = input_len - padding_len;
Jens Wiklander32b31802023-10-06 16:59:46 +0200863 for (i = 0; i < input_len; i++) {
Tom Van Eyckb0563632024-06-13 16:20:14 +0200864 mbedtls_ct_condition_t in_padding = mbedtls_ct_uint_ge(i, pad_idx);
865 mbedtls_ct_condition_t different = mbedtls_ct_uint_ne(input[i], padding_len);
866 bad = mbedtls_ct_bool_or(bad, mbedtls_ct_bool_and(in_padding, different));
Jens Wiklander32b31802023-10-06 16:59:46 +0200867 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200868
Tom Van Eyckb0563632024-06-13 16:20:14 +0200869 return mbedtls_ct_error_if_else_0(bad, MBEDTLS_ERR_CIPHER_INVALID_PADDING);
Jens Wiklander817466c2018-05-22 13:49:31 +0200870}
871#endif /* MBEDTLS_CIPHER_PADDING_PKCS7 */
872
873#if defined(MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS)
874/*
875 * One and zeros padding: fill with 80 00 ... 00
876 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200877static void add_one_and_zeros_padding(unsigned char *output,
878 size_t output_len, size_t data_len)
Jens Wiklander817466c2018-05-22 13:49:31 +0200879{
880 size_t padding_len = output_len - data_len;
881 unsigned char i = 0;
882
883 output[data_len] = 0x80;
Jens Wiklander32b31802023-10-06 16:59:46 +0200884 for (i = 1; i < padding_len; i++) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200885 output[data_len + i] = 0x00;
Jens Wiklander32b31802023-10-06 16:59:46 +0200886 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200887}
888
Jens Wiklander32b31802023-10-06 16:59:46 +0200889static int get_one_and_zeros_padding(unsigned char *input, size_t input_len,
890 size_t *data_len)
Jens Wiklander817466c2018-05-22 13:49:31 +0200891{
Jens Wiklander32b31802023-10-06 16:59:46 +0200892 if (NULL == input || NULL == data_len) {
893 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
894 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200895
Tom Van Eyckb0563632024-06-13 16:20:14 +0200896 mbedtls_ct_condition_t in_padding = MBEDTLS_CT_TRUE;
897 mbedtls_ct_condition_t bad = MBEDTLS_CT_TRUE;
898
Jens Wiklander817466c2018-05-22 13:49:31 +0200899 *data_len = 0;
Tom Van Eyckb0563632024-06-13 16:20:14 +0200900
901 for (ptrdiff_t i = (ptrdiff_t) (input_len) - 1; i >= 0; i--) {
902 mbedtls_ct_condition_t is_nonzero = mbedtls_ct_bool(input[i]);
903
904 mbedtls_ct_condition_t hit_first_nonzero = mbedtls_ct_bool_and(is_nonzero, in_padding);
905
906 *data_len = mbedtls_ct_size_if(hit_first_nonzero, i, *data_len);
907
908 bad = mbedtls_ct_bool_if(hit_first_nonzero, mbedtls_ct_uint_ne(input[i], 0x80), bad);
909
910 in_padding = mbedtls_ct_bool_and(in_padding, mbedtls_ct_bool_not(is_nonzero));
Jens Wiklander817466c2018-05-22 13:49:31 +0200911 }
912
Tom Van Eyckb0563632024-06-13 16:20:14 +0200913 return mbedtls_ct_error_if_else_0(bad, MBEDTLS_ERR_CIPHER_INVALID_PADDING);
Jens Wiklander817466c2018-05-22 13:49:31 +0200914}
915#endif /* MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS */
916
917#if defined(MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN)
918/*
919 * Zeros and len padding: fill with 00 ... 00 ll, where ll is padding length
920 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200921static void add_zeros_and_len_padding(unsigned char *output,
922 size_t output_len, size_t data_len)
Jens Wiklander817466c2018-05-22 13:49:31 +0200923{
924 size_t padding_len = output_len - data_len;
925 unsigned char i = 0;
926
Jens Wiklander32b31802023-10-06 16:59:46 +0200927 for (i = 1; i < padding_len; i++) {
Jens Wiklander817466c2018-05-22 13:49:31 +0200928 output[data_len + i - 1] = 0x00;
Jens Wiklander32b31802023-10-06 16:59:46 +0200929 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200930 output[output_len - 1] = (unsigned char) padding_len;
931}
932
Jens Wiklander32b31802023-10-06 16:59:46 +0200933static int get_zeros_and_len_padding(unsigned char *input, size_t input_len,
934 size_t *data_len)
Jens Wiklander817466c2018-05-22 13:49:31 +0200935{
936 size_t i, pad_idx;
Tom Van Eyckb0563632024-06-13 16:20:14 +0200937 unsigned char padding_len;
938 mbedtls_ct_condition_t bad;
Jens Wiklander817466c2018-05-22 13:49:31 +0200939
Jens Wiklander32b31802023-10-06 16:59:46 +0200940 if (NULL == input || NULL == data_len) {
941 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
942 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200943
944 padding_len = input[input_len - 1];
945 *data_len = input_len - padding_len;
946
947 /* Avoid logical || since it results in a branch */
Tom Van Eyckb0563632024-06-13 16:20:14 +0200948 bad = mbedtls_ct_uint_gt(padding_len, input_len);
949 bad = mbedtls_ct_bool_or(bad, mbedtls_ct_uint_eq(padding_len, 0));
Jens Wiklander817466c2018-05-22 13:49:31 +0200950
951 /* The number of bytes checked must be independent of padding_len */
952 pad_idx = input_len - padding_len;
Jens Wiklander32b31802023-10-06 16:59:46 +0200953 for (i = 0; i < input_len - 1; i++) {
Tom Van Eyckb0563632024-06-13 16:20:14 +0200954 mbedtls_ct_condition_t is_padding = mbedtls_ct_uint_ge(i, pad_idx);
955 mbedtls_ct_condition_t nonzero_pad_byte;
956 nonzero_pad_byte = mbedtls_ct_bool_if_else_0(is_padding, mbedtls_ct_bool(input[i]));
957 bad = mbedtls_ct_bool_or(bad, nonzero_pad_byte);
Jens Wiklander32b31802023-10-06 16:59:46 +0200958 }
Jens Wiklander817466c2018-05-22 13:49:31 +0200959
Tom Van Eyckb0563632024-06-13 16:20:14 +0200960 return mbedtls_ct_error_if_else_0(bad, MBEDTLS_ERR_CIPHER_INVALID_PADDING);
Jens Wiklander817466c2018-05-22 13:49:31 +0200961}
962#endif /* MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN */
963
964#if defined(MBEDTLS_CIPHER_PADDING_ZEROS)
965/*
966 * Zero padding: fill with 00 ... 00
967 */
Jens Wiklander32b31802023-10-06 16:59:46 +0200968static void add_zeros_padding(unsigned char *output,
969 size_t output_len, size_t data_len)
Jens Wiklander817466c2018-05-22 13:49:31 +0200970{
Tom Van Eyckb0563632024-06-13 16:20:14 +0200971 memset(output + data_len, 0, output_len - data_len);
Jens Wiklander817466c2018-05-22 13:49:31 +0200972}
973
Jens Wiklander32b31802023-10-06 16:59:46 +0200974static int get_zeros_padding(unsigned char *input, size_t input_len,
975 size_t *data_len)
Jens Wiklander817466c2018-05-22 13:49:31 +0200976{
977 size_t i;
Tom Van Eyckb0563632024-06-13 16:20:14 +0200978 mbedtls_ct_condition_t done = MBEDTLS_CT_FALSE, prev_done;
Jens Wiklander817466c2018-05-22 13:49:31 +0200979
Jens Wiklander32b31802023-10-06 16:59:46 +0200980 if (NULL == input || NULL == data_len) {
981 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Jens Wiklander817466c2018-05-22 13:49:31 +0200982 }
983
Jens Wiklander32b31802023-10-06 16:59:46 +0200984 *data_len = 0;
985 for (i = input_len; i > 0; i--) {
986 prev_done = done;
Tom Van Eyckb0563632024-06-13 16:20:14 +0200987 done = mbedtls_ct_bool_or(done, mbedtls_ct_uint_ne(input[i-1], 0));
988 *data_len = mbedtls_ct_size_if(mbedtls_ct_bool_ne(done, prev_done), i, *data_len);
Jens Wiklander32b31802023-10-06 16:59:46 +0200989 }
990
991 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +0200992}
993#endif /* MBEDTLS_CIPHER_PADDING_ZEROS */
994
995/*
996 * No padding: don't pad :)
997 *
998 * There is no add_padding function (check for NULL in mbedtls_cipher_finish)
999 * but a trivial get_padding function
1000 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001001static int get_no_padding(unsigned char *input, size_t input_len,
1002 size_t *data_len)
Jens Wiklander817466c2018-05-22 13:49:31 +02001003{
Jens Wiklander32b31802023-10-06 16:59:46 +02001004 if (NULL == input || NULL == data_len) {
1005 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1006 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001007
1008 *data_len = input_len;
1009
Jens Wiklander32b31802023-10-06 16:59:46 +02001010 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +02001011}
1012#endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
1013
Jens Wiklander32b31802023-10-06 16:59:46 +02001014int mbedtls_cipher_finish(mbedtls_cipher_context_t *ctx,
1015 unsigned char *output, size_t *olen)
Jens Wiklander817466c2018-05-22 13:49:31 +02001016{
Jens Wiklander32b31802023-10-06 16:59:46 +02001017 if (ctx->cipher_info == NULL) {
1018 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1019 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001020
Tom Van Eyckb0563632024-06-13 16:20:14 +02001021#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jens Wiklander32b31802023-10-06 16:59:46 +02001022 if (ctx->psa_enabled == 1) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001023 /* While PSA Crypto has an API for multipart
1024 * operations, we currently don't make it
1025 * accessible through the cipher layer. */
Jens Wiklander32b31802023-10-06 16:59:46 +02001026 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001027 }
Tom Van Eyckb0563632024-06-13 16:20:14 +02001028#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001029
Jens Wiklander817466c2018-05-22 13:49:31 +02001030 *olen = 0;
1031
Tom Van Eyckb0563632024-06-13 16:20:14 +02001032#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
1033 /* CBC mode requires padding so we make sure a call to
1034 * mbedtls_cipher_set_padding_mode has been done successfully. */
1035 if (MBEDTLS_MODE_CBC == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
1036 if (ctx->get_padding == NULL) {
1037 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1038 }
1039 }
1040#endif
1041
1042 if (MBEDTLS_MODE_CFB == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1043 MBEDTLS_MODE_OFB == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1044 MBEDTLS_MODE_CTR == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1045 MBEDTLS_MODE_GCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1046 MBEDTLS_MODE_CCM_STAR_NO_TAG == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1047 MBEDTLS_MODE_XTS == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1048 MBEDTLS_MODE_STREAM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Jens Wiklander32b31802023-10-06 16:59:46 +02001049 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +02001050 }
1051
Tom Van Eyckb0563632024-06-13 16:20:14 +02001052 if ((MBEDTLS_CIPHER_CHACHA20 == ((mbedtls_cipher_type_t) ctx->cipher_info->type)) ||
1053 (MBEDTLS_CIPHER_CHACHA20_POLY1305 == ((mbedtls_cipher_type_t) ctx->cipher_info->type))) {
Jens Wiklander32b31802023-10-06 16:59:46 +02001054 return 0;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001055 }
1056
Tom Van Eyckb0563632024-06-13 16:20:14 +02001057 if (MBEDTLS_MODE_ECB == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Jens Wiklander32b31802023-10-06 16:59:46 +02001058 if (ctx->unprocessed_len != 0) {
1059 return MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED;
1060 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001061
Jens Wiklander32b31802023-10-06 16:59:46 +02001062 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +02001063 }
1064
1065#if defined(MBEDTLS_CIPHER_MODE_CBC)
Tom Van Eyckb0563632024-06-13 16:20:14 +02001066 if (MBEDTLS_MODE_CBC == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001067 int ret = 0;
1068
Jens Wiklander32b31802023-10-06 16:59:46 +02001069 if (MBEDTLS_ENCRYPT == ctx->operation) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001070 /* check for 'no padding' mode */
Jens Wiklander32b31802023-10-06 16:59:46 +02001071 if (NULL == ctx->add_padding) {
1072 if (0 != ctx->unprocessed_len) {
1073 return MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED;
1074 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001075
Jens Wiklander32b31802023-10-06 16:59:46 +02001076 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +02001077 }
1078
Jens Wiklander32b31802023-10-06 16:59:46 +02001079 ctx->add_padding(ctx->unprocessed_data, mbedtls_cipher_get_iv_size(ctx),
1080 ctx->unprocessed_len);
1081 } else if (mbedtls_cipher_get_block_size(ctx) != ctx->unprocessed_len) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001082 /*
1083 * For decrypt operations, expect a full block,
1084 * or an empty block if no padding
1085 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001086 if (NULL == ctx->add_padding && 0 == ctx->unprocessed_len) {
1087 return 0;
1088 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001089
Jens Wiklander32b31802023-10-06 16:59:46 +02001090 return MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02001091 }
1092
1093 /* cipher block */
Tom Van Eyckb0563632024-06-13 16:20:14 +02001094 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->cbc_func(ctx->cipher_ctx,
1095 ctx->operation,
1096 mbedtls_cipher_get_block_size(
1097 ctx),
1098 ctx->iv,
1099 ctx->unprocessed_data,
1100 output))) {
Jens Wiklander32b31802023-10-06 16:59:46 +02001101 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02001102 }
1103
1104 /* Set output size for decryption */
Jens Wiklander32b31802023-10-06 16:59:46 +02001105 if (MBEDTLS_DECRYPT == ctx->operation) {
1106 return ctx->get_padding(output, mbedtls_cipher_get_block_size(ctx),
1107 olen);
1108 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001109
1110 /* Set output size for encryption */
Jens Wiklander32b31802023-10-06 16:59:46 +02001111 *olen = mbedtls_cipher_get_block_size(ctx);
1112 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +02001113 }
1114#else
1115 ((void) output);
1116#endif /* MBEDTLS_CIPHER_MODE_CBC */
1117
Jens Wiklander32b31802023-10-06 16:59:46 +02001118 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jens Wiklander817466c2018-05-22 13:49:31 +02001119}
1120
1121#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Jens Wiklander32b31802023-10-06 16:59:46 +02001122int mbedtls_cipher_set_padding_mode(mbedtls_cipher_context_t *ctx,
1123 mbedtls_cipher_padding_t mode)
Jens Wiklander817466c2018-05-22 13:49:31 +02001124{
Tom Van Eyckb0563632024-06-13 16:20:14 +02001125 if (NULL == ctx->cipher_info ||
1126 MBEDTLS_MODE_CBC != ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Jens Wiklander32b31802023-10-06 16:59:46 +02001127 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Jens Wiklander817466c2018-05-22 13:49:31 +02001128 }
1129
Tom Van Eyckb0563632024-06-13 16:20:14 +02001130#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jens Wiklander32b31802023-10-06 16:59:46 +02001131 if (ctx->psa_enabled == 1) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001132 /* While PSA Crypto knows about CBC padding
1133 * schemes, we currently don't make them
1134 * accessible through the cipher layer. */
Jens Wiklander32b31802023-10-06 16:59:46 +02001135 if (mode != MBEDTLS_PADDING_NONE) {
1136 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
1137 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001138
Jens Wiklander32b31802023-10-06 16:59:46 +02001139 return 0;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001140 }
Tom Van Eyckb0563632024-06-13 16:20:14 +02001141#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001142
Jens Wiklander32b31802023-10-06 16:59:46 +02001143 switch (mode) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001144#if defined(MBEDTLS_CIPHER_PADDING_PKCS7)
Jens Wiklander32b31802023-10-06 16:59:46 +02001145 case MBEDTLS_PADDING_PKCS7:
1146 ctx->add_padding = add_pkcs_padding;
1147 ctx->get_padding = get_pkcs_padding;
1148 break;
Jens Wiklander817466c2018-05-22 13:49:31 +02001149#endif
1150#if defined(MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS)
Jens Wiklander32b31802023-10-06 16:59:46 +02001151 case MBEDTLS_PADDING_ONE_AND_ZEROS:
1152 ctx->add_padding = add_one_and_zeros_padding;
1153 ctx->get_padding = get_one_and_zeros_padding;
1154 break;
Jens Wiklander817466c2018-05-22 13:49:31 +02001155#endif
1156#if defined(MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN)
Jens Wiklander32b31802023-10-06 16:59:46 +02001157 case MBEDTLS_PADDING_ZEROS_AND_LEN:
1158 ctx->add_padding = add_zeros_and_len_padding;
1159 ctx->get_padding = get_zeros_and_len_padding;
1160 break;
Jens Wiklander817466c2018-05-22 13:49:31 +02001161#endif
1162#if defined(MBEDTLS_CIPHER_PADDING_ZEROS)
Jens Wiklander32b31802023-10-06 16:59:46 +02001163 case MBEDTLS_PADDING_ZEROS:
1164 ctx->add_padding = add_zeros_padding;
1165 ctx->get_padding = get_zeros_padding;
1166 break;
Jens Wiklander817466c2018-05-22 13:49:31 +02001167#endif
Jens Wiklander32b31802023-10-06 16:59:46 +02001168 case MBEDTLS_PADDING_NONE:
1169 ctx->add_padding = NULL;
1170 ctx->get_padding = get_no_padding;
1171 break;
Jens Wiklander817466c2018-05-22 13:49:31 +02001172
Jens Wiklander32b31802023-10-06 16:59:46 +02001173 default:
1174 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jens Wiklander817466c2018-05-22 13:49:31 +02001175 }
1176
Jens Wiklander32b31802023-10-06 16:59:46 +02001177 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +02001178}
1179#endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
1180
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001181#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
Jens Wiklander32b31802023-10-06 16:59:46 +02001182int mbedtls_cipher_write_tag(mbedtls_cipher_context_t *ctx,
1183 unsigned char *tag, size_t tag_len)
Jens Wiklander817466c2018-05-22 13:49:31 +02001184{
Jens Wiklander32b31802023-10-06 16:59:46 +02001185 if (ctx->cipher_info == NULL) {
1186 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1187 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001188
Jens Wiklander32b31802023-10-06 16:59:46 +02001189 if (MBEDTLS_ENCRYPT != ctx->operation) {
1190 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1191 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001192
Tom Van Eyckb0563632024-06-13 16:20:14 +02001193#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jens Wiklander32b31802023-10-06 16:59:46 +02001194 if (ctx->psa_enabled == 1) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001195 /* While PSA Crypto has an API for multipart
1196 * operations, we currently don't make it
1197 * accessible through the cipher layer. */
Jens Wiklander32b31802023-10-06 16:59:46 +02001198 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001199 }
Tom Van Eyckb0563632024-06-13 16:20:14 +02001200#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001201
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001202#if defined(MBEDTLS_GCM_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +02001203 if (MBEDTLS_MODE_GCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Jens Wiklander32b31802023-10-06 16:59:46 +02001204 size_t output_length;
1205 /* The code here doesn't yet support alternative implementations
1206 * that can delay up to a block of output. */
1207 return mbedtls_gcm_finish((mbedtls_gcm_context *) ctx->cipher_ctx,
1208 NULL, 0, &output_length,
1209 tag, tag_len);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001210 }
1211#endif
Jens Wiklander817466c2018-05-22 13:49:31 +02001212
Jens Wiklander32b31802023-10-06 16:59:46 +02001213#if defined(MBEDTLS_CHACHAPOLY_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +02001214 if (MBEDTLS_CIPHER_CHACHA20_POLY1305 == ((mbedtls_cipher_type_t) ctx->cipher_info->type)) {
Jens Wiklander32b31802023-10-06 16:59:46 +02001215 /* Don't allow truncated MAC for Poly1305 */
1216 if (tag_len != 16U) {
1217 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1218 }
1219
1220 return mbedtls_chachapoly_finish(
1221 (mbedtls_chachapoly_context *) ctx->cipher_ctx, tag);
1222 }
1223#endif
1224
1225 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jens Wiklander817466c2018-05-22 13:49:31 +02001226}
1227
Jens Wiklander32b31802023-10-06 16:59:46 +02001228int mbedtls_cipher_check_tag(mbedtls_cipher_context_t *ctx,
1229 const unsigned char *tag, size_t tag_len)
Jens Wiklander817466c2018-05-22 13:49:31 +02001230{
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001231 unsigned char check_tag[16];
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001232 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02001233
Jens Wiklander32b31802023-10-06 16:59:46 +02001234 if (ctx->cipher_info == NULL) {
1235 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1236 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001237
Jens Wiklander32b31802023-10-06 16:59:46 +02001238 if (MBEDTLS_DECRYPT != ctx->operation) {
1239 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Jens Wiklander817466c2018-05-22 13:49:31 +02001240 }
1241
Tom Van Eyckb0563632024-06-13 16:20:14 +02001242#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jens Wiklander32b31802023-10-06 16:59:46 +02001243 if (ctx->psa_enabled == 1) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001244 /* While PSA Crypto has an API for multipart
1245 * operations, we currently don't make it
1246 * accessible through the cipher layer. */
Jens Wiklander32b31802023-10-06 16:59:46 +02001247 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001248 }
Tom Van Eyckb0563632024-06-13 16:20:14 +02001249#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001250
Jens Wiklander32b31802023-10-06 16:59:46 +02001251 /* Status to return on a non-authenticated algorithm. */
1252 ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jerome Forissier039e02d2022-08-09 17:10:15 +02001253
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001254#if defined(MBEDTLS_GCM_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +02001255 if (MBEDTLS_MODE_GCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Jens Wiklander32b31802023-10-06 16:59:46 +02001256 size_t output_length;
1257 /* The code here doesn't yet support alternative implementations
1258 * that can delay up to a block of output. */
Jens Wiklander817466c2018-05-22 13:49:31 +02001259
Jens Wiklander32b31802023-10-06 16:59:46 +02001260 if (tag_len > sizeof(check_tag)) {
1261 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1262 }
1263
1264 if (0 != (ret = mbedtls_gcm_finish(
1265 (mbedtls_gcm_context *) ctx->cipher_ctx,
1266 NULL, 0, &output_length,
1267 check_tag, tag_len))) {
1268 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02001269 }
1270
1271 /* Check the tag in "constant-time" */
Jens Wiklander32b31802023-10-06 16:59:46 +02001272 if (mbedtls_ct_memcmp(tag, check_tag, tag_len) != 0) {
Jerome Forissier039e02d2022-08-09 17:10:15 +02001273 ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;
1274 goto exit;
1275 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001276 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001277#endif /* MBEDTLS_GCM_C */
1278
1279#if defined(MBEDTLS_CHACHAPOLY_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +02001280 if (MBEDTLS_CIPHER_CHACHA20_POLY1305 == ((mbedtls_cipher_type_t) ctx->cipher_info->type)) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001281 /* Don't allow truncated MAC for Poly1305 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001282 if (tag_len != sizeof(check_tag)) {
1283 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1284 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001285
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001286 ret = mbedtls_chachapoly_finish(
Jens Wiklander32b31802023-10-06 16:59:46 +02001287 (mbedtls_chachapoly_context *) ctx->cipher_ctx, check_tag);
1288 if (ret != 0) {
1289 return ret;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001290 }
1291
1292 /* Check the tag in "constant-time" */
Jens Wiklander32b31802023-10-06 16:59:46 +02001293 if (mbedtls_ct_memcmp(tag, check_tag, tag_len) != 0) {
Jerome Forissier039e02d2022-08-09 17:10:15 +02001294 ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;
1295 goto exit;
1296 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001297 }
1298#endif /* MBEDTLS_CHACHAPOLY_C */
Jens Wiklander817466c2018-05-22 13:49:31 +02001299
Jerome Forissier039e02d2022-08-09 17:10:15 +02001300exit:
Jens Wiklander32b31802023-10-06 16:59:46 +02001301 mbedtls_platform_zeroize(check_tag, tag_len);
1302 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02001303}
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001304#endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
Jens Wiklander817466c2018-05-22 13:49:31 +02001305
1306/*
1307 * Packet-oriented wrapper for non-AEAD modes
1308 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001309int mbedtls_cipher_crypt(mbedtls_cipher_context_t *ctx,
1310 const unsigned char *iv, size_t iv_len,
1311 const unsigned char *input, size_t ilen,
1312 unsigned char *output, size_t *olen)
Jens Wiklander817466c2018-05-22 13:49:31 +02001313{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001314 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02001315 size_t finish_olen;
1316
Tom Van Eyckb0563632024-06-13 16:20:14 +02001317#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jens Wiklander32b31802023-10-06 16:59:46 +02001318 if (ctx->psa_enabled == 1) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001319 /* As in the non-PSA case, we don't check that
1320 * a key has been set. If not, the key slot will
1321 * still be in its default state of 0, which is
1322 * guaranteed to be invalid, hence the PSA-call
1323 * below will gracefully fail. */
1324 mbedtls_cipher_context_psa * const cipher_psa =
1325 (mbedtls_cipher_context_psa *) ctx->cipher_ctx;
1326
1327 psa_status_t status;
1328 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
1329 size_t part_len;
1330
Jens Wiklander32b31802023-10-06 16:59:46 +02001331 if (ctx->operation == MBEDTLS_DECRYPT) {
1332 status = psa_cipher_decrypt_setup(&cipher_op,
1333 cipher_psa->slot,
1334 cipher_psa->alg);
1335 } else if (ctx->operation == MBEDTLS_ENCRYPT) {
1336 status = psa_cipher_encrypt_setup(&cipher_op,
1337 cipher_psa->slot,
1338 cipher_psa->alg);
1339 } else {
1340 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001341 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001342
1343 /* In the following, we can immediately return on an error,
1344 * because the PSA Crypto API guarantees that cipher operations
1345 * are terminated by unsuccessful calls to psa_cipher_update(),
1346 * and by any call to psa_cipher_finish(). */
Jens Wiklander32b31802023-10-06 16:59:46 +02001347 if (status != PSA_SUCCESS) {
1348 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Jerome Forissier039e02d2022-08-09 17:10:15 +02001349 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001350
Tom Van Eyckb0563632024-06-13 16:20:14 +02001351 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) != MBEDTLS_MODE_ECB) {
Jens Wiklander32b31802023-10-06 16:59:46 +02001352 status = psa_cipher_set_iv(&cipher_op, iv, iv_len);
1353 if (status != PSA_SUCCESS) {
1354 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
1355 }
1356 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001357
Jens Wiklander32b31802023-10-06 16:59:46 +02001358 status = psa_cipher_update(&cipher_op,
1359 input, ilen,
1360 output, ilen, olen);
1361 if (status != PSA_SUCCESS) {
1362 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
1363 }
1364
1365 status = psa_cipher_finish(&cipher_op,
1366 output + *olen, ilen - *olen,
1367 &part_len);
1368 if (status != PSA_SUCCESS) {
1369 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
1370 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001371
1372 *olen += part_len;
Jens Wiklander32b31802023-10-06 16:59:46 +02001373 return 0;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001374 }
Tom Van Eyckb0563632024-06-13 16:20:14 +02001375#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001376
Jens Wiklander32b31802023-10-06 16:59:46 +02001377 if ((ret = mbedtls_cipher_set_iv(ctx, iv, iv_len)) != 0) {
1378 return ret;
1379 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001380
Jens Wiklander32b31802023-10-06 16:59:46 +02001381 if ((ret = mbedtls_cipher_reset(ctx)) != 0) {
1382 return ret;
1383 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001384
Jens Wiklander32b31802023-10-06 16:59:46 +02001385 if ((ret = mbedtls_cipher_update(ctx, input, ilen,
1386 output, olen)) != 0) {
1387 return ret;
1388 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001389
Jens Wiklander32b31802023-10-06 16:59:46 +02001390 if ((ret = mbedtls_cipher_finish(ctx, output + *olen,
1391 &finish_olen)) != 0) {
1392 return ret;
1393 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001394
1395 *olen += finish_olen;
1396
Jens Wiklander32b31802023-10-06 16:59:46 +02001397 return 0;
Jens Wiklander817466c2018-05-22 13:49:31 +02001398}
1399
1400#if defined(MBEDTLS_CIPHER_MODE_AEAD)
1401/*
Jens Wiklander32b31802023-10-06 16:59:46 +02001402 * Packet-oriented encryption for AEAD modes: internal function used by
1403 * mbedtls_cipher_auth_encrypt_ext().
Jens Wiklander817466c2018-05-22 13:49:31 +02001404 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001405static int mbedtls_cipher_aead_encrypt(mbedtls_cipher_context_t *ctx,
1406 const unsigned char *iv, size_t iv_len,
1407 const unsigned char *ad, size_t ad_len,
1408 const unsigned char *input, size_t ilen,
1409 unsigned char *output, size_t *olen,
1410 unsigned char *tag, size_t tag_len)
Jens Wiklander817466c2018-05-22 13:49:31 +02001411{
Tom Van Eyckb0563632024-06-13 16:20:14 +02001412#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jens Wiklander32b31802023-10-06 16:59:46 +02001413 if (ctx->psa_enabled == 1) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001414 /* As in the non-PSA case, we don't check that
1415 * a key has been set. If not, the key slot will
1416 * still be in its default state of 0, which is
1417 * guaranteed to be invalid, hence the PSA-call
1418 * below will gracefully fail. */
1419 mbedtls_cipher_context_psa * const cipher_psa =
1420 (mbedtls_cipher_context_psa *) ctx->cipher_ctx;
1421
1422 psa_status_t status;
1423
1424 /* PSA Crypto API always writes the authentication tag
1425 * at the end of the encrypted message. */
Jens Wiklander32b31802023-10-06 16:59:46 +02001426 if (output == NULL || tag != output + ilen) {
1427 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
1428 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001429
Jens Wiklander32b31802023-10-06 16:59:46 +02001430 status = psa_aead_encrypt(cipher_psa->slot,
1431 cipher_psa->alg,
1432 iv, iv_len,
1433 ad, ad_len,
1434 input, ilen,
1435 output, ilen + tag_len, olen);
1436 if (status != PSA_SUCCESS) {
1437 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
1438 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001439
1440 *olen -= tag_len;
Jens Wiklander32b31802023-10-06 16:59:46 +02001441 return 0;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001442 }
Tom Van Eyckb0563632024-06-13 16:20:14 +02001443#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001444
Jens Wiklander817466c2018-05-22 13:49:31 +02001445#if defined(MBEDTLS_GCM_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +02001446 if (MBEDTLS_MODE_GCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001447 *olen = ilen;
Jens Wiklander32b31802023-10-06 16:59:46 +02001448 return mbedtls_gcm_crypt_and_tag(ctx->cipher_ctx, MBEDTLS_GCM_ENCRYPT,
1449 ilen, iv, iv_len, ad, ad_len,
1450 input, output, tag_len, tag);
Jens Wiklander817466c2018-05-22 13:49:31 +02001451 }
1452#endif /* MBEDTLS_GCM_C */
1453#if defined(MBEDTLS_CCM_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +02001454 if (MBEDTLS_MODE_CCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001455 *olen = ilen;
Jens Wiklander32b31802023-10-06 16:59:46 +02001456 return mbedtls_ccm_encrypt_and_tag(ctx->cipher_ctx, ilen,
1457 iv, iv_len, ad, ad_len, input, output,
1458 tag, tag_len);
Jens Wiklander817466c2018-05-22 13:49:31 +02001459 }
1460#endif /* MBEDTLS_CCM_C */
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001461#if defined(MBEDTLS_CHACHAPOLY_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +02001462 if (MBEDTLS_CIPHER_CHACHA20_POLY1305 == ((mbedtls_cipher_type_t) ctx->cipher_info->type)) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001463 /* ChachaPoly has fixed length nonce and MAC (tag) */
Tom Van Eyckb0563632024-06-13 16:20:14 +02001464 if ((iv_len != mbedtls_cipher_info_get_iv_size(ctx->cipher_info)) ||
Jens Wiklander32b31802023-10-06 16:59:46 +02001465 (tag_len != 16U)) {
1466 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001467 }
1468
1469 *olen = ilen;
Jens Wiklander32b31802023-10-06 16:59:46 +02001470 return mbedtls_chachapoly_encrypt_and_tag(ctx->cipher_ctx,
1471 ilen, iv, ad, ad_len, input, output, tag);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001472 }
1473#endif /* MBEDTLS_CHACHAPOLY_C */
Jens Wiklander817466c2018-05-22 13:49:31 +02001474
Jens Wiklander32b31802023-10-06 16:59:46 +02001475 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jens Wiklander817466c2018-05-22 13:49:31 +02001476}
1477
1478/*
Jens Wiklander32b31802023-10-06 16:59:46 +02001479 * Packet-oriented encryption for AEAD modes: internal function used by
1480 * mbedtls_cipher_auth_encrypt_ext().
Jens Wiklander817466c2018-05-22 13:49:31 +02001481 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001482static int mbedtls_cipher_aead_decrypt(mbedtls_cipher_context_t *ctx,
1483 const unsigned char *iv, size_t iv_len,
1484 const unsigned char *ad, size_t ad_len,
1485 const unsigned char *input, size_t ilen,
1486 unsigned char *output, size_t *olen,
1487 const unsigned char *tag, size_t tag_len)
Jens Wiklander817466c2018-05-22 13:49:31 +02001488{
Tom Van Eyckb0563632024-06-13 16:20:14 +02001489#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jens Wiklander32b31802023-10-06 16:59:46 +02001490 if (ctx->psa_enabled == 1) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001491 /* As in the non-PSA case, we don't check that
1492 * a key has been set. If not, the key slot will
1493 * still be in its default state of 0, which is
1494 * guaranteed to be invalid, hence the PSA-call
1495 * below will gracefully fail. */
1496 mbedtls_cipher_context_psa * const cipher_psa =
1497 (mbedtls_cipher_context_psa *) ctx->cipher_ctx;
1498
1499 psa_status_t status;
1500
1501 /* PSA Crypto API always writes the authentication tag
1502 * at the end of the encrypted message. */
Jens Wiklander32b31802023-10-06 16:59:46 +02001503 if (input == NULL || tag != input + ilen) {
1504 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
1505 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001506
Jens Wiklander32b31802023-10-06 16:59:46 +02001507 status = psa_aead_decrypt(cipher_psa->slot,
1508 cipher_psa->alg,
1509 iv, iv_len,
1510 ad, ad_len,
1511 input, ilen + tag_len,
1512 output, ilen, olen);
1513 if (status == PSA_ERROR_INVALID_SIGNATURE) {
1514 return MBEDTLS_ERR_CIPHER_AUTH_FAILED;
1515 } else if (status != PSA_SUCCESS) {
1516 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
1517 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001518
Jens Wiklander32b31802023-10-06 16:59:46 +02001519 return 0;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001520 }
Tom Van Eyckb0563632024-06-13 16:20:14 +02001521#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001522
Jens Wiklander817466c2018-05-22 13:49:31 +02001523#if defined(MBEDTLS_GCM_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +02001524 if (MBEDTLS_MODE_GCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001525 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02001526
1527 *olen = ilen;
Jens Wiklander32b31802023-10-06 16:59:46 +02001528 ret = mbedtls_gcm_auth_decrypt(ctx->cipher_ctx, ilen,
1529 iv, iv_len, ad, ad_len,
1530 tag, tag_len, input, output);
Jens Wiklander817466c2018-05-22 13:49:31 +02001531
Jens Wiklander32b31802023-10-06 16:59:46 +02001532 if (ret == MBEDTLS_ERR_GCM_AUTH_FAILED) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001533 ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001534 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001535
Jens Wiklander32b31802023-10-06 16:59:46 +02001536 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02001537 }
1538#endif /* MBEDTLS_GCM_C */
1539#if defined(MBEDTLS_CCM_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +02001540 if (MBEDTLS_MODE_CCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001541 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander817466c2018-05-22 13:49:31 +02001542
1543 *olen = ilen;
Jens Wiklander32b31802023-10-06 16:59:46 +02001544 ret = mbedtls_ccm_auth_decrypt(ctx->cipher_ctx, ilen,
1545 iv, iv_len, ad, ad_len,
1546 input, output, tag, tag_len);
Jens Wiklander817466c2018-05-22 13:49:31 +02001547
Jens Wiklander32b31802023-10-06 16:59:46 +02001548 if (ret == MBEDTLS_ERR_CCM_AUTH_FAILED) {
Jens Wiklander817466c2018-05-22 13:49:31 +02001549 ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001550 }
Jens Wiklander817466c2018-05-22 13:49:31 +02001551
Jens Wiklander32b31802023-10-06 16:59:46 +02001552 return ret;
Jens Wiklander817466c2018-05-22 13:49:31 +02001553 }
1554#endif /* MBEDTLS_CCM_C */
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001555#if defined(MBEDTLS_CHACHAPOLY_C)
Tom Van Eyckb0563632024-06-13 16:20:14 +02001556 if (MBEDTLS_CIPHER_CHACHA20_POLY1305 == ((mbedtls_cipher_type_t) ctx->cipher_info->type)) {
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001557 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001558
1559 /* ChachaPoly has fixed length nonce and MAC (tag) */
Tom Van Eyckb0563632024-06-13 16:20:14 +02001560 if ((iv_len != mbedtls_cipher_info_get_iv_size(ctx->cipher_info)) ||
Jens Wiklander32b31802023-10-06 16:59:46 +02001561 (tag_len != 16U)) {
1562 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001563 }
1564
1565 *olen = ilen;
Jens Wiklander32b31802023-10-06 16:59:46 +02001566 ret = mbedtls_chachapoly_auth_decrypt(ctx->cipher_ctx, ilen,
1567 iv, ad, ad_len, tag, input, output);
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001568
Jens Wiklander32b31802023-10-06 16:59:46 +02001569 if (ret == MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED) {
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001570 ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;
Jens Wiklander32b31802023-10-06 16:59:46 +02001571 }
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001572
Jens Wiklander32b31802023-10-06 16:59:46 +02001573 return ret;
Jens Wiklander3d3b0592019-03-20 15:30:29 +01001574 }
1575#endif /* MBEDTLS_CHACHAPOLY_C */
Jerome Forissier79013242021-07-28 10:24:04 +02001576
Jens Wiklander32b31802023-10-06 16:59:46 +02001577 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02001578}
Jerome Forissier79013242021-07-28 10:24:04 +02001579#endif /* MBEDTLS_CIPHER_MODE_AEAD */
1580
1581#if defined(MBEDTLS_CIPHER_MODE_AEAD) || defined(MBEDTLS_NIST_KW_C)
1582/*
1583 * Packet-oriented encryption for AEAD/NIST_KW: public function.
1584 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001585int mbedtls_cipher_auth_encrypt_ext(mbedtls_cipher_context_t *ctx,
1586 const unsigned char *iv, size_t iv_len,
1587 const unsigned char *ad, size_t ad_len,
1588 const unsigned char *input, size_t ilen,
1589 unsigned char *output, size_t output_len,
1590 size_t *olen, size_t tag_len)
Jerome Forissier79013242021-07-28 10:24:04 +02001591{
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001592#if defined(MBEDTLS_NIST_KW_C)
Jens Wiklander32b31802023-10-06 16:59:46 +02001593 if (
Tom Van Eyckb0563632024-06-13 16:20:14 +02001594#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerome Forissier79013242021-07-28 10:24:04 +02001595 ctx->psa_enabled == 0 &&
1596#endif
Tom Van Eyckb0563632024-06-13 16:20:14 +02001597 (MBEDTLS_MODE_KW == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1598 MBEDTLS_MODE_KWP == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode))) {
1599 mbedtls_nist_kw_mode_t mode =
1600 (MBEDTLS_MODE_KW == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) ?
1601 MBEDTLS_KW_MODE_KW : MBEDTLS_KW_MODE_KWP;
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001602
Jerome Forissier79013242021-07-28 10:24:04 +02001603 /* There is no iv, tag or ad associated with KW and KWP,
1604 * so these length should be 0 as documented. */
Jens Wiklander32b31802023-10-06 16:59:46 +02001605 if (iv_len != 0 || tag_len != 0 || ad_len != 0) {
1606 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1607 }
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001608
Jerome Forissier79013242021-07-28 10:24:04 +02001609 (void) iv;
1610 (void) ad;
1611
Jens Wiklander32b31802023-10-06 16:59:46 +02001612 return mbedtls_nist_kw_wrap(ctx->cipher_ctx, mode, input, ilen,
1613 output, olen, output_len);
Jerome Forissier11fa71b2020-04-20 17:17:56 +02001614 }
1615#endif /* MBEDTLS_NIST_KW_C */
Jens Wiklander817466c2018-05-22 13:49:31 +02001616
Jerome Forissier79013242021-07-28 10:24:04 +02001617#if defined(MBEDTLS_CIPHER_MODE_AEAD)
1618 /* AEAD case: check length before passing on to shared function */
Jens Wiklander32b31802023-10-06 16:59:46 +02001619 if (output_len < ilen + tag_len) {
1620 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1621 }
Jerome Forissier79013242021-07-28 10:24:04 +02001622
Jens Wiklander32b31802023-10-06 16:59:46 +02001623 int ret = mbedtls_cipher_aead_encrypt(ctx, iv, iv_len, ad, ad_len,
1624 input, ilen, output, olen,
1625 output + ilen, tag_len);
Jerome Forissier79013242021-07-28 10:24:04 +02001626 *olen += tag_len;
Jens Wiklander32b31802023-10-06 16:59:46 +02001627 return ret;
Jerome Forissier79013242021-07-28 10:24:04 +02001628#else
Jens Wiklander32b31802023-10-06 16:59:46 +02001629 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jens Wiklander817466c2018-05-22 13:49:31 +02001630#endif /* MBEDTLS_CIPHER_MODE_AEAD */
Jerome Forissier79013242021-07-28 10:24:04 +02001631}
1632
1633/*
1634 * Packet-oriented decryption for AEAD/NIST_KW: public function.
1635 */
Jens Wiklander32b31802023-10-06 16:59:46 +02001636int mbedtls_cipher_auth_decrypt_ext(mbedtls_cipher_context_t *ctx,
1637 const unsigned char *iv, size_t iv_len,
1638 const unsigned char *ad, size_t ad_len,
1639 const unsigned char *input, size_t ilen,
1640 unsigned char *output, size_t output_len,
1641 size_t *olen, size_t tag_len)
Jerome Forissier79013242021-07-28 10:24:04 +02001642{
Jerome Forissier79013242021-07-28 10:24:04 +02001643#if defined(MBEDTLS_NIST_KW_C)
Jens Wiklander32b31802023-10-06 16:59:46 +02001644 if (
Tom Van Eyckb0563632024-06-13 16:20:14 +02001645#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerome Forissier79013242021-07-28 10:24:04 +02001646 ctx->psa_enabled == 0 &&
1647#endif
Tom Van Eyckb0563632024-06-13 16:20:14 +02001648 (MBEDTLS_MODE_KW == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1649 MBEDTLS_MODE_KWP == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode))) {
1650 mbedtls_nist_kw_mode_t mode =
1651 (MBEDTLS_MODE_KW == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) ?
1652 MBEDTLS_KW_MODE_KW : MBEDTLS_KW_MODE_KWP;
Jerome Forissier79013242021-07-28 10:24:04 +02001653
1654 /* There is no iv, tag or ad associated with KW and KWP,
1655 * so these length should be 0 as documented. */
Jens Wiklander32b31802023-10-06 16:59:46 +02001656 if (iv_len != 0 || tag_len != 0 || ad_len != 0) {
1657 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1658 }
Jerome Forissier79013242021-07-28 10:24:04 +02001659
1660 (void) iv;
1661 (void) ad;
1662
Jens Wiklander32b31802023-10-06 16:59:46 +02001663 return mbedtls_nist_kw_unwrap(ctx->cipher_ctx, mode, input, ilen,
1664 output, olen, output_len);
Jerome Forissier79013242021-07-28 10:24:04 +02001665 }
1666#endif /* MBEDTLS_NIST_KW_C */
1667
1668#if defined(MBEDTLS_CIPHER_MODE_AEAD)
1669 /* AEAD case: check length before passing on to shared function */
Jens Wiklander32b31802023-10-06 16:59:46 +02001670 if (ilen < tag_len || output_len < ilen - tag_len) {
1671 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1672 }
Jerome Forissier79013242021-07-28 10:24:04 +02001673
Jens Wiklander32b31802023-10-06 16:59:46 +02001674 return mbedtls_cipher_aead_decrypt(ctx, iv, iv_len, ad, ad_len,
1675 input, ilen - tag_len, output, olen,
1676 input + ilen - tag_len, tag_len);
Jerome Forissier79013242021-07-28 10:24:04 +02001677#else
Jens Wiklander32b31802023-10-06 16:59:46 +02001678 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jerome Forissier79013242021-07-28 10:24:04 +02001679#endif /* MBEDTLS_CIPHER_MODE_AEAD */
1680}
1681#endif /* MBEDTLS_CIPHER_MODE_AEAD || MBEDTLS_NIST_KW_C */
Jens Wiklander817466c2018-05-22 13:49:31 +02001682
1683#endif /* MBEDTLS_CIPHER_C */