blob: d0ba01ea017d7d625e0b2d87b07291886f02b493 [file] [log] [blame]
Paul Bakker8123e9d2011-01-06 15:37:30 +00001/**
2 * \file cipher.c
Paul Bakker7dc4c442014-02-01 22:50:26 +01003 *
Gilles Peskinee820c0a2023-08-03 17:45:20 +02004 * \brief Generic cipher wrapper for Mbed TLS
Paul Bakker8123e9d2011-01-06 15:37:30 +00005 *
6 * \author Adriaan de Jong <dejong@fox-it.com>
7 *
Bence Szépkúti1e148272020-08-07 13:07:28 +02008 * Copyright The Mbed TLS Contributors
Dave Rodgman16799db2023-11-02 19:47:20 +00009 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker8123e9d2011-01-06 15:37:30 +000010 */
11
Gilles Peskinedb09ef62020-06-03 01:43:33 +020012#include "common.h"
Paul Bakker8123e9d2011-01-06 15:37:30 +000013
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020014#if defined(MBEDTLS_CIPHER_C)
Paul Bakker8123e9d2011-01-06 15:37:30 +000015
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000016#include "mbedtls/cipher.h"
David Horstmannd37e0c42025-01-16 16:24:35 +000017#include "cipher_invasive.h"
Chris Jonesdaacb592021-03-09 17:03:29 +000018#include "cipher_wrap.h"
Andres Amaya Garcia1f6301b2018-04-17 09:51:09 -050019#include "mbedtls/platform_util.h"
Janos Follath24eed8d2019-11-22 13:21:35 +000020#include "mbedtls/error.h"
Gabor Mezei765862c2021-10-19 12:22:25 +020021#include "mbedtls/constant_time.h"
Dave Rodgman6b7e2a52023-09-18 19:00:44 +010022#include "constant_time_internal.h"
Paul Bakker8123e9d2011-01-06 15:37:30 +000023
Rich Evans00ab4702015-02-06 13:43:58 +000024#include <stdlib.h>
25#include <string.h>
26
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +020027#if defined(MBEDTLS_CHACHAPOLY_C)
28#include "mbedtls/chachapoly.h"
Daniel King8fe47012016-05-17 20:33:28 -030029#endif
30
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020031#if defined(MBEDTLS_GCM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000032#include "mbedtls/gcm.h"
Manuel Pégourié-Gonnard07f8fa52013-08-30 18:34:08 +020033#endif
34
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020035#if defined(MBEDTLS_CCM_C)
Manuel Pégourié-Gonnard7f809972015-03-09 17:05:11 +000036#include "mbedtls/ccm.h"
Manuel Pégourié-Gonnard41936952014-05-13 13:18:17 +020037#endif
38
Daniel Kingbd920622016-05-15 19:56:20 -030039#if defined(MBEDTLS_CHACHA20_C)
40#include "mbedtls/chacha20.h"
41#endif
42
Simon Butcher327398a2016-10-05 14:09:11 +010043#if defined(MBEDTLS_CMAC_C)
44#include "mbedtls/cmac.h"
45#endif
46
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +020047#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Hanno Becker4ccfc402018-11-09 16:10:57 +000048#include "psa/crypto.h"
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +020049#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker4ccfc402018-11-09 16:10:57 +000050
Jack Lloydffdf2882019-03-07 17:00:32 -050051#if defined(MBEDTLS_NIST_KW_C)
52#include "mbedtls/nist_kw.h"
53#endif
54
Simon Butcher327398a2016-10-05 14:09:11 +010055#include "mbedtls/platform.h"
Simon Butcher327398a2016-10-05 14:09:11 +010056
Manuel Pégourié-Gonnarddace82f2013-09-18 15:12:07 +020057static int supported_init = 0;
Paul Bakker72f62662011-01-16 21:27:44 +000058
Dave Rodgman3b46b772023-06-24 13:25:06 +010059static inline const mbedtls_cipher_base_t *mbedtls_cipher_get_base(
60 const mbedtls_cipher_info_t *info)
61{
Dave Rodgmande3de772023-06-24 12:51:06 +010062 return mbedtls_cipher_base_lookup_table[info->base_idx];
63}
64
Gilles Peskine449bd832023-01-11 14:50:10 +010065const int *mbedtls_cipher_list(void)
Paul Bakker72f62662011-01-16 21:27:44 +000066{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020067 const mbedtls_cipher_definition_t *def;
Manuel Pégourié-Gonnarddace82f2013-09-18 15:12:07 +020068 int *type;
69
Gilles Peskine449bd832023-01-11 14:50:10 +010070 if (!supported_init) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020071 def = mbedtls_cipher_definitions;
72 type = mbedtls_cipher_supported;
Manuel Pégourié-Gonnarddace82f2013-09-18 15:12:07 +020073
Gilles Peskine449bd832023-01-11 14:50:10 +010074 while (def->type != 0) {
Manuel Pégourié-Gonnarddace82f2013-09-18 15:12:07 +020075 *type++ = (*def++).type;
Gilles Peskine449bd832023-01-11 14:50:10 +010076 }
Manuel Pégourié-Gonnarddace82f2013-09-18 15:12:07 +020077
78 *type = 0;
79
80 supported_init = 1;
81 }
82
Gilles Peskine449bd832023-01-11 14:50:10 +010083 return mbedtls_cipher_supported;
Paul Bakker72f62662011-01-16 21:27:44 +000084}
85
Hanno Becker18597cd2018-11-09 16:36:33 +000086const mbedtls_cipher_info_t *mbedtls_cipher_info_from_type(
Gilles Peskine449bd832023-01-11 14:50:10 +010087 const mbedtls_cipher_type_t cipher_type)
Paul Bakker8123e9d2011-01-06 15:37:30 +000088{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020089 const mbedtls_cipher_definition_t *def;
Paul Bakker5e0efa72013-09-08 23:04:04 +020090
Gilles Peskine449bd832023-01-11 14:50:10 +010091 for (def = mbedtls_cipher_definitions; def->info != NULL; def++) {
92 if (def->type == cipher_type) {
93 return def->info;
94 }
95 }
Paul Bakker343a8702011-06-09 14:27:58 +000096
Gilles Peskine449bd832023-01-11 14:50:10 +010097 return NULL;
Paul Bakker8123e9d2011-01-06 15:37:30 +000098}
99
Hanno Becker18597cd2018-11-09 16:36:33 +0000100const mbedtls_cipher_info_t *mbedtls_cipher_info_from_string(
Gilles Peskine449bd832023-01-11 14:50:10 +0100101 const char *cipher_name)
Paul Bakker8123e9d2011-01-06 15:37:30 +0000102{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103 const mbedtls_cipher_definition_t *def;
Manuel Pégourié-Gonnarddace82f2013-09-18 15:12:07 +0200104
Gilles Peskine449bd832023-01-11 14:50:10 +0100105 if (NULL == cipher_name) {
106 return NULL;
107 }
Paul Bakker8123e9d2011-01-06 15:37:30 +0000108
Gilles Peskine449bd832023-01-11 14:50:10 +0100109 for (def = mbedtls_cipher_definitions; def->info != NULL; def++) {
110 if (!strcmp(def->info->name, cipher_name)) {
111 return def->info;
112 }
113 }
Paul Bakkerfab5c822012-02-06 16:45:10 +0000114
Gilles Peskine449bd832023-01-11 14:50:10 +0100115 return NULL;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000116}
117
Hanno Becker18597cd2018-11-09 16:36:33 +0000118const mbedtls_cipher_info_t *mbedtls_cipher_info_from_values(
119 const mbedtls_cipher_id_t cipher_id,
120 int key_bitlen,
Gilles Peskine449bd832023-01-11 14:50:10 +0100121 const mbedtls_cipher_mode_t mode)
Paul Bakkerf46b6952013-09-09 00:08:26 +0200122{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200123 const mbedtls_cipher_definition_t *def;
Paul Bakkerf46b6952013-09-09 00:08:26 +0200124
Gilles Peskine449bd832023-01-11 14:50:10 +0100125 for (def = mbedtls_cipher_definitions; def->info != NULL; def++) {
Dave Rodgmande3de772023-06-24 12:51:06 +0100126 if (mbedtls_cipher_get_base(def->info)->cipher == cipher_id &&
Dave Rodgman9282d4f2023-06-24 11:03:04 +0100127 mbedtls_cipher_info_get_key_bitlen(def->info) == (unsigned) key_bitlen &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100128 def->info->mode == mode) {
129 return def->info;
130 }
131 }
Paul Bakkerf46b6952013-09-09 00:08:26 +0200132
Gilles Peskine449bd832023-01-11 14:50:10 +0100133 return NULL;
Paul Bakkerf46b6952013-09-09 00:08:26 +0200134}
135
Manuel Pégourié-Gonnardefcc1f22023-06-07 13:20:24 +0200136#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
137static inline psa_key_type_t mbedtls_psa_translate_cipher_type(
138 mbedtls_cipher_type_t cipher)
139{
140 switch (cipher) {
141 case MBEDTLS_CIPHER_AES_128_CCM:
142 case MBEDTLS_CIPHER_AES_192_CCM:
143 case MBEDTLS_CIPHER_AES_256_CCM:
144 case MBEDTLS_CIPHER_AES_128_CCM_STAR_NO_TAG:
145 case MBEDTLS_CIPHER_AES_192_CCM_STAR_NO_TAG:
146 case MBEDTLS_CIPHER_AES_256_CCM_STAR_NO_TAG:
147 case MBEDTLS_CIPHER_AES_128_GCM:
148 case MBEDTLS_CIPHER_AES_192_GCM:
149 case MBEDTLS_CIPHER_AES_256_GCM:
150 case MBEDTLS_CIPHER_AES_128_CBC:
151 case MBEDTLS_CIPHER_AES_192_CBC:
152 case MBEDTLS_CIPHER_AES_256_CBC:
153 case MBEDTLS_CIPHER_AES_128_ECB:
154 case MBEDTLS_CIPHER_AES_192_ECB:
155 case MBEDTLS_CIPHER_AES_256_ECB:
156 return PSA_KEY_TYPE_AES;
157
158 /* ARIA not yet supported in PSA. */
159 /* case MBEDTLS_CIPHER_ARIA_128_CCM:
160 case MBEDTLS_CIPHER_ARIA_192_CCM:
161 case MBEDTLS_CIPHER_ARIA_256_CCM:
162 case MBEDTLS_CIPHER_ARIA_128_CCM_STAR_NO_TAG:
163 case MBEDTLS_CIPHER_ARIA_192_CCM_STAR_NO_TAG:
164 case MBEDTLS_CIPHER_ARIA_256_CCM_STAR_NO_TAG:
165 case MBEDTLS_CIPHER_ARIA_128_GCM:
166 case MBEDTLS_CIPHER_ARIA_192_GCM:
167 case MBEDTLS_CIPHER_ARIA_256_GCM:
168 case MBEDTLS_CIPHER_ARIA_128_CBC:
169 case MBEDTLS_CIPHER_ARIA_192_CBC:
170 case MBEDTLS_CIPHER_ARIA_256_CBC:
171 return( PSA_KEY_TYPE_ARIA ); */
172
173 default:
174 return 0;
175 }
176}
177
178static inline psa_algorithm_t mbedtls_psa_translate_cipher_mode(
179 mbedtls_cipher_mode_t mode, size_t taglen)
180{
181 switch (mode) {
182 case MBEDTLS_MODE_ECB:
183 return PSA_ALG_ECB_NO_PADDING;
184 case MBEDTLS_MODE_GCM:
185 return PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_GCM, taglen);
186 case MBEDTLS_MODE_CCM:
187 return PSA_ALG_AEAD_WITH_SHORTENED_TAG(PSA_ALG_CCM, taglen);
188 case MBEDTLS_MODE_CCM_STAR_NO_TAG:
189 return PSA_ALG_CCM_STAR_NO_TAG;
190 case MBEDTLS_MODE_CBC:
191 if (taglen == 0) {
192 return PSA_ALG_CBC_NO_PADDING;
193 } else {
194 return 0;
195 }
196 default:
197 return 0;
198 }
199}
Manuel Pégourié-Gonnardefcc1f22023-06-07 13:20:24 +0200200#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
201
Gilles Peskine449bd832023-01-11 14:50:10 +0100202void mbedtls_cipher_init(mbedtls_cipher_context_t *ctx)
Paul Bakker84bbeb52014-07-01 14:53:22 +0200203{
Gilles Peskine449bd832023-01-11 14:50:10 +0100204 memset(ctx, 0, sizeof(mbedtls_cipher_context_t));
Paul Bakker84bbeb52014-07-01 14:53:22 +0200205}
206
Gilles Peskine449bd832023-01-11 14:50:10 +0100207void mbedtls_cipher_free(mbedtls_cipher_context_t *ctx)
Paul Bakker84bbeb52014-07-01 14:53:22 +0200208{
Gilles Peskine449bd832023-01-11 14:50:10 +0100209 if (ctx == NULL) {
Paul Bakker84bbeb52014-07-01 14:53:22 +0200210 return;
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 }
Paul Bakker84bbeb52014-07-01 14:53:22 +0200212
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +0200213#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100214 if (ctx->psa_enabled == 1) {
215 if (ctx->cipher_ctx != NULL) {
Hanno Becker6118e432018-11-09 16:47:20 +0000216 mbedtls_cipher_context_psa * const cipher_psa =
217 (mbedtls_cipher_context_psa *) ctx->cipher_ctx;
218
Gilles Peskine449bd832023-01-11 14:50:10 +0100219 if (cipher_psa->slot_state == MBEDTLS_CIPHER_PSA_KEY_OWNED) {
Hanno Beckeredda8b82018-11-12 11:59:30 +0000220 /* xxx_free() doesn't allow to return failures. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100221 (void) psa_destroy_key(cipher_psa->slot);
Hanno Becker6118e432018-11-09 16:47:20 +0000222 }
223
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100224 mbedtls_zeroize_and_free(cipher_psa, sizeof(*cipher_psa));
Hanno Becker6118e432018-11-09 16:47:20 +0000225 }
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000226
Gilles Peskine449bd832023-01-11 14:50:10 +0100227 mbedtls_platform_zeroize(ctx, sizeof(mbedtls_cipher_context_t));
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000228 return;
229 }
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +0200230#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000231
Simon Butcher327398a2016-10-05 14:09:11 +0100232#if defined(MBEDTLS_CMAC_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100233 if (ctx->cmac_ctx) {
Tom Cosgroveca8c61b2023-07-17 15:17:40 +0100234 mbedtls_zeroize_and_free(ctx->cmac_ctx,
Gilles Peskine449bd832023-01-11 14:50:10 +0100235 sizeof(mbedtls_cmac_context_t));
Simon Butcher327398a2016-10-05 14:09:11 +0100236 }
237#endif
238
Gilles Peskine449bd832023-01-11 14:50:10 +0100239 if (ctx->cipher_ctx) {
Dave Rodgmande3de772023-06-24 12:51:06 +0100240 mbedtls_cipher_get_base(ctx->cipher_info)->ctx_free_func(ctx->cipher_ctx);
Gilles Peskine449bd832023-01-11 14:50:10 +0100241 }
Paul Bakker84bbeb52014-07-01 14:53:22 +0200242
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 mbedtls_platform_zeroize(ctx, sizeof(mbedtls_cipher_context_t));
Paul Bakker84bbeb52014-07-01 14:53:22 +0200244}
245
Gilles Peskine449bd832023-01-11 14:50:10 +0100246int mbedtls_cipher_setup(mbedtls_cipher_context_t *ctx,
247 const mbedtls_cipher_info_t *cipher_info)
Paul Bakker8123e9d2011-01-06 15:37:30 +0000248{
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 if (cipher_info == NULL) {
250 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
251 }
Paul Bakker8123e9d2011-01-06 15:37:30 +0000252
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 memset(ctx, 0, sizeof(mbedtls_cipher_context_t));
Paul Bakker8123e9d2011-01-06 15:37:30 +0000254
Valerio Settibbc46b42023-10-26 09:00:21 +0200255 if (mbedtls_cipher_get_base(cipher_info)->ctx_alloc_func != NULL) {
256 ctx->cipher_ctx = mbedtls_cipher_get_base(cipher_info)->ctx_alloc_func();
257 if (ctx->cipher_ctx == NULL) {
258 return MBEDTLS_ERR_CIPHER_ALLOC_FAILED;
259 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100260 }
Paul Bakker8123e9d2011-01-06 15:37:30 +0000261
262 ctx->cipher_info = cipher_info;
263
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 return 0;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000265}
266
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +0200267#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100268int mbedtls_cipher_setup_psa(mbedtls_cipher_context_t *ctx,
269 const mbedtls_cipher_info_t *cipher_info,
270 size_t taglen)
Hanno Becker4ccfc402018-11-09 16:10:57 +0000271{
Hanno Beckeredda8b82018-11-12 11:59:30 +0000272 psa_algorithm_t alg;
273 mbedtls_cipher_context_psa *cipher_psa;
274
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 if (NULL == cipher_info || NULL == ctx) {
276 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
277 }
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000278
Hanno Becker4ee7e762018-11-17 22:00:38 +0000279 /* Check that the underlying cipher mode and cipher type are
280 * supported by the underlying PSA Crypto implementation. */
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100281 alg = mbedtls_psa_translate_cipher_mode(((mbedtls_cipher_mode_t) cipher_info->mode), taglen);
Gilles Peskine449bd832023-01-11 14:50:10 +0100282 if (alg == 0) {
283 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
284 }
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100285 if (mbedtls_psa_translate_cipher_type(((mbedtls_cipher_type_t) cipher_info->type)) == 0) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100286 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
287 }
Hanno Becker6118e432018-11-09 16:47:20 +0000288
Gilles Peskine449bd832023-01-11 14:50:10 +0100289 memset(ctx, 0, sizeof(mbedtls_cipher_context_t));
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000290
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 cipher_psa = mbedtls_calloc(1, sizeof(mbedtls_cipher_context_psa));
292 if (cipher_psa == NULL) {
293 return MBEDTLS_ERR_CIPHER_ALLOC_FAILED;
294 }
Hanno Beckeredda8b82018-11-12 11:59:30 +0000295 cipher_psa->alg = alg;
296 ctx->cipher_ctx = cipher_psa;
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000297 ctx->cipher_info = cipher_info;
298 ctx->psa_enabled = 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 return 0;
Hanno Becker4ccfc402018-11-09 16:10:57 +0000300}
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +0200301#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Becker4ccfc402018-11-09 16:10:57 +0000302
Gilles Peskine449bd832023-01-11 14:50:10 +0100303int mbedtls_cipher_setkey(mbedtls_cipher_context_t *ctx,
304 const unsigned char *key,
305 int key_bitlen,
306 const mbedtls_operation_t operation)
Paul Bakker8123e9d2011-01-06 15:37:30 +0000307{
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 if (operation != MBEDTLS_ENCRYPT && operation != MBEDTLS_DECRYPT) {
Tuvshinzaya Erdenekhuu80a6af62022-08-05 15:31:57 +0100309 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 }
311 if (ctx->cipher_info == NULL) {
312 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
313 }
Yanray Wang0d76b6e2023-11-02 11:54:39 +0800314#if defined(MBEDTLS_BLOCK_CIPHER_NO_DECRYPT)
Yanray Wang4995e0c2023-11-07 17:50:52 +0800315 if (MBEDTLS_MODE_ECB == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) &&
316 MBEDTLS_DECRYPT == operation) {
317 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
318 }
Yanray Wang0d76b6e2023-11-02 11:54:39 +0800319#endif
Paul Bakker8123e9d2011-01-06 15:37:30 +0000320
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +0200321#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100322 if (ctx->psa_enabled == 1) {
Hanno Beckeredda8b82018-11-12 11:59:30 +0000323 mbedtls_cipher_context_psa * const cipher_psa =
324 (mbedtls_cipher_context_psa *) ctx->cipher_ctx;
325
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 size_t const key_bytelen = ((size_t) key_bitlen + 7) / 8;
Hanno Beckeredda8b82018-11-12 11:59:30 +0000327
328 psa_status_t status;
329 psa_key_type_t key_type;
Gilles Peskined2d45c12019-05-27 14:53:13 +0200330 psa_key_attributes_t attributes = PSA_KEY_ATTRIBUTES_INIT;
Hanno Beckeredda8b82018-11-12 11:59:30 +0000331
332 /* PSA Crypto API only accepts byte-aligned keys. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100333 if (key_bitlen % 8 != 0) {
334 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
335 }
Hanno Beckeredda8b82018-11-12 11:59:30 +0000336
337 /* Don't allow keys to be set multiple times. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 if (cipher_psa->slot_state != MBEDTLS_CIPHER_PSA_KEY_UNSET) {
339 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
340 }
Hanno Beckeredda8b82018-11-12 11:59:30 +0000341
Andrzej Kurekc7509322019-01-08 09:36:01 -0500342 key_type = mbedtls_psa_translate_cipher_type(
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100343 ((mbedtls_cipher_type_t) ctx->cipher_info->type));
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 if (key_type == 0) {
345 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
346 }
347 psa_set_key_type(&attributes, key_type);
Hanno Beckera395d8f2018-11-12 13:33:16 +0000348
349 /* Mbed TLS' cipher layer doesn't enforce the mode of operation
Andrzej Kurekf410a5c2019-01-15 03:33:35 -0500350 * (encrypt vs. decrypt): it is possible to setup a key for encryption
351 * and use it for AEAD decryption. Until tests relying on this
352 * are changed, allow any usage in PSA. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 psa_set_key_usage_flags(&attributes,
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 PSA_KEY_USAGE_ENCRYPT | PSA_KEY_USAGE_DECRYPT);
355 psa_set_key_algorithm(&attributes, cipher_psa->alg);
Hanno Beckeredda8b82018-11-12 11:59:30 +0000356
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 status = psa_import_key(&attributes, key, key_bytelen,
358 &cipher_psa->slot);
359 switch (status) {
Gilles Peskined2d45c12019-05-27 14:53:13 +0200360 case PSA_SUCCESS:
361 break;
362 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 return MBEDTLS_ERR_CIPHER_ALLOC_FAILED;
Gilles Peskined2d45c12019-05-27 14:53:13 +0200364 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskined2d45c12019-05-27 14:53:13 +0200366 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Gilles Peskined2d45c12019-05-27 14:53:13 +0200368 }
369 /* Indicate that we own the key slot and need to
370 * destroy it in mbedtls_cipher_free(). */
371 cipher_psa->slot_state = MBEDTLS_CIPHER_PSA_KEY_OWNED;
Hanno Beckeredda8b82018-11-12 11:59:30 +0000372
373 ctx->key_bitlen = key_bitlen;
374 ctx->operation = operation;
Gilles Peskine449bd832023-01-11 14:50:10 +0100375 return 0;
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000376 }
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +0200377#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000378
Gilles Peskine449bd832023-01-11 14:50:10 +0100379 if ((ctx->cipher_info->flags & MBEDTLS_CIPHER_VARIABLE_KEY_LEN) == 0 &&
Dave Rodgman9282d4f2023-06-24 11:03:04 +0100380 (int) mbedtls_cipher_info_get_key_bitlen(ctx->cipher_info) != key_bitlen) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard398c57b2014-06-23 12:10:59 +0200382 }
Manuel Pégourié-Gonnarddd0f57f2013-09-16 11:47:43 +0200383
Manuel Pégourié-Gonnard898e0aa2015-06-18 15:28:12 +0200384 ctx->key_bitlen = key_bitlen;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000385 ctx->operation = operation;
386
Yanray Wangb67b4742023-10-31 17:10:32 +0800387#if !defined(MBEDTLS_BLOCK_CIPHER_NO_DECRYPT)
Paul Bakker343a8702011-06-09 14:27:58 +0000388 /*
Simon Butcher8c0fd1e2018-04-22 22:58:07 +0100389 * For OFB, CFB and CTR mode always use the encryption key schedule
Paul Bakker343a8702011-06-09 14:27:58 +0000390 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100391 if (MBEDTLS_ENCRYPT == operation ||
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100392 MBEDTLS_MODE_CFB == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
393 MBEDTLS_MODE_OFB == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
394 MBEDTLS_MODE_CTR == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Dave Rodgmande3de772023-06-24 12:51:06 +0100395 return mbedtls_cipher_get_base(ctx->cipher_info)->setkey_enc_func(ctx->cipher_ctx, key,
Dave Rodgman3b46b772023-06-24 13:25:06 +0100396 ctx->key_bitlen);
Paul Bakker343a8702011-06-09 14:27:58 +0000397 }
Paul Bakker8123e9d2011-01-06 15:37:30 +0000398
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 if (MBEDTLS_DECRYPT == operation) {
Dave Rodgmande3de772023-06-24 12:51:06 +0100400 return mbedtls_cipher_get_base(ctx->cipher_info)->setkey_dec_func(ctx->cipher_ctx, key,
Dave Rodgman3b46b772023-06-24 13:25:06 +0100401 ctx->key_bitlen);
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 }
Yanray Wang0d76b6e2023-11-02 11:54:39 +0800403#else
404 if (operation == MBEDTLS_ENCRYPT || operation == MBEDTLS_DECRYPT) {
405 return mbedtls_cipher_get_base(ctx->cipher_info)->setkey_enc_func(ctx->cipher_ctx, key,
406 ctx->key_bitlen);
407 }
408#endif
Paul Bakker8123e9d2011-01-06 15:37:30 +0000409
Gilles Peskine449bd832023-01-11 14:50:10 +0100410 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000411}
412
Gilles Peskine449bd832023-01-11 14:50:10 +0100413int mbedtls_cipher_set_iv(mbedtls_cipher_context_t *ctx,
414 const unsigned char *iv,
415 size_t iv_len)
Paul Bakker8123e9d2011-01-06 15:37:30 +0000416{
Manuel Pégourié-Gonnarda235b5b2013-09-03 13:25:52 +0200417 size_t actual_iv_size;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000418
Gilles Peskine449bd832023-01-11 14:50:10 +0100419 if (ctx->cipher_info == NULL) {
420 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
421 }
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +0200422#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100423 if (ctx->psa_enabled == 1) {
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000424 /* While PSA Crypto has an API for multipart
425 * operations, we currently don't make it
426 * accessible through the cipher layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000428 }
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +0200429#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000430
Manuel Pégourié-Gonnarde0dca4a2013-10-24 16:54:25 +0200431 /* avoid buffer overflow in ctx->iv */
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 if (iv_len > MBEDTLS_MAX_IV_LENGTH) {
433 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
434 }
Manuel Pégourié-Gonnarde0dca4a2013-10-24 16:54:25 +0200435
Gilles Peskine449bd832023-01-11 14:50:10 +0100436 if ((ctx->cipher_info->flags & MBEDTLS_CIPHER_VARIABLE_IV_LEN) != 0) {
Manuel Pégourié-Gonnarda235b5b2013-09-03 13:25:52 +0200437 actual_iv_size = iv_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100438 } else {
Dave Rodgmanbb521fd2023-06-24 11:21:25 +0100439 actual_iv_size = mbedtls_cipher_info_get_iv_size(ctx->cipher_info);
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200440
Manuel Pégourié-Gonnarde0dca4a2013-10-24 16:54:25 +0200441 /* avoid reading past the end of input buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 if (actual_iv_size > iv_len) {
443 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
444 }
Manuel Pégourié-Gonnarde0dca4a2013-10-24 16:54:25 +0200445 }
446
Daniel Kingbd920622016-05-15 19:56:20 -0300447#if defined(MBEDTLS_CHACHA20_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100448 if (((mbedtls_cipher_type_t) ctx->cipher_info->type) == MBEDTLS_CIPHER_CHACHA20) {
Andrzej Kurek33ca6af2021-12-01 21:58:05 +0100449 /* Even though the actual_iv_size is overwritten with a correct value
450 * of 12 from the cipher info, return an error to indicate that
451 * the input iv_len is wrong. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 if (iv_len != 12) {
453 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
454 }
Andrzej Kurek33ca6af2021-12-01 21:58:05 +0100455
Gilles Peskine449bd832023-01-11 14:50:10 +0100456 if (0 != mbedtls_chacha20_starts((mbedtls_chacha20_context *) ctx->cipher_ctx,
457 iv,
458 0U)) { /* Initial counter value */
459 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Daniel Kingbd920622016-05-15 19:56:20 -0300460 }
461 }
Andrzej Kurek63439ed2021-12-01 22:19:33 +0100462#if defined(MBEDTLS_CHACHAPOLY_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100463 if (((mbedtls_cipher_type_t) ctx->cipher_info->type) == MBEDTLS_CIPHER_CHACHA20_POLY1305 &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100464 iv_len != 12) {
465 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
466 }
Andrzej Kurek63439ed2021-12-01 22:19:33 +0100467#endif
Daniel Kingbd920622016-05-15 19:56:20 -0300468#endif
469
Gilles Peskine295fc132021-04-15 18:32:23 +0200470#if defined(MBEDTLS_GCM_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100471 if (MBEDTLS_MODE_GCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 return mbedtls_gcm_starts((mbedtls_gcm_context *) ctx->cipher_ctx,
473 ctx->operation,
474 iv, iv_len);
Gilles Peskine295fc132021-04-15 18:32:23 +0200475 }
476#endif
477
Mateusz Starzyk594215b2021-10-14 12:23:06 +0200478#if defined(MBEDTLS_CCM_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100479 if (MBEDTLS_MODE_CCM_STAR_NO_TAG == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +0200480 int set_lengths_result;
481 int ccm_star_mode;
482
483 set_lengths_result = mbedtls_ccm_set_lengths(
Gilles Peskine449bd832023-01-11 14:50:10 +0100484 (mbedtls_ccm_context *) ctx->cipher_ctx,
485 0, 0, 0);
486 if (set_lengths_result != 0) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +0200487 return set_lengths_result;
Gilles Peskine449bd832023-01-11 14:50:10 +0100488 }
Mateusz Starzyk594215b2021-10-14 12:23:06 +0200489
Gilles Peskine449bd832023-01-11 14:50:10 +0100490 if (ctx->operation == MBEDTLS_DECRYPT) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +0200491 ccm_star_mode = MBEDTLS_CCM_STAR_DECRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100492 } else if (ctx->operation == MBEDTLS_ENCRYPT) {
Mateusz Starzyk594215b2021-10-14 12:23:06 +0200493 ccm_star_mode = MBEDTLS_CCM_STAR_ENCRYPT;
Gilles Peskine449bd832023-01-11 14:50:10 +0100494 } else {
Mateusz Starzyk594215b2021-10-14 12:23:06 +0200495 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Gilles Peskine449bd832023-01-11 14:50:10 +0100496 }
Mateusz Starzyk594215b2021-10-14 12:23:06 +0200497
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 return mbedtls_ccm_starts((mbedtls_ccm_context *) ctx->cipher_ctx,
499 ccm_star_mode,
500 iv, iv_len);
Mateusz Starzyk594215b2021-10-14 12:23:06 +0200501 }
502#endif
503
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 if (actual_iv_size != 0) {
505 memcpy(ctx->iv, iv, actual_iv_size);
Ron Eldor4e64e0b2017-09-25 18:22:32 +0300506 ctx->iv_size = actual_iv_size;
507 }
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200508
Gilles Peskine449bd832023-01-11 14:50:10 +0100509 return 0;
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200510}
511
Gilles Peskine449bd832023-01-11 14:50:10 +0100512int mbedtls_cipher_reset(mbedtls_cipher_context_t *ctx)
Manuel Pégourié-Gonnard9c853b92013-09-03 13:04:44 +0200513{
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 if (ctx->cipher_info == NULL) {
515 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
516 }
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200517
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +0200518#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 if (ctx->psa_enabled == 1) {
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000520 /* We don't support resetting PSA-based
521 * cipher contexts, yet. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000523 }
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +0200524#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000525
Paul Bakker8123e9d2011-01-06 15:37:30 +0000526 ctx->unprocessed_len = 0;
527
Gilles Peskine449bd832023-01-11 14:50:10 +0100528 return 0;
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200529}
530
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +0200531#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +0100532int mbedtls_cipher_update_ad(mbedtls_cipher_context_t *ctx,
533 const unsigned char *ad, size_t ad_len)
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200534{
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 if (ctx->cipher_info == NULL) {
536 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
537 }
Manuel Pégourié-Gonnard2adc40c2013-09-03 13:54:12 +0200538
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +0200539#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 if (ctx->psa_enabled == 1) {
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000541 /* While PSA Crypto has an API for multipart
542 * operations, we currently don't make it
543 * accessible through the cipher layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000545 }
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +0200546#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000547
Daniel King8fe47012016-05-17 20:33:28 -0300548#if defined(MBEDTLS_GCM_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100549 if (MBEDTLS_MODE_GCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 return mbedtls_gcm_update_ad((mbedtls_gcm_context *) ctx->cipher_ctx,
551 ad, ad_len);
Manuel Pégourié-Gonnard07f8fa52013-08-30 18:34:08 +0200552 }
Daniel King8fe47012016-05-17 20:33:28 -0300553#endif
554
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +0200555#if defined(MBEDTLS_CHACHAPOLY_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100556 if (MBEDTLS_CIPHER_CHACHA20_POLY1305 == ((mbedtls_cipher_type_t) ctx->cipher_info->type)) {
Daniel King8fe47012016-05-17 20:33:28 -0300557 int result;
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +0200558 mbedtls_chachapoly_mode_t mode;
Daniel King8fe47012016-05-17 20:33:28 -0300559
Gilles Peskine449bd832023-01-11 14:50:10 +0100560 mode = (ctx->operation == MBEDTLS_ENCRYPT)
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +0200561 ? MBEDTLS_CHACHAPOLY_ENCRYPT
562 : MBEDTLS_CHACHAPOLY_DECRYPT;
Daniel King8fe47012016-05-17 20:33:28 -0300563
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 result = mbedtls_chachapoly_starts((mbedtls_chachapoly_context *) ctx->cipher_ctx,
565 ctx->iv,
566 mode);
567 if (result != 0) {
568 return result;
569 }
Daniel King8fe47012016-05-17 20:33:28 -0300570
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 return mbedtls_chachapoly_update_aad((mbedtls_chachapoly_context *) ctx->cipher_ctx,
572 ad, ad_len);
Daniel King8fe47012016-05-17 20:33:28 -0300573 }
574#endif
Manuel Pégourié-Gonnard07f8fa52013-08-30 18:34:08 +0200575
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000577}
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +0200578#endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000579
Gilles Peskine449bd832023-01-11 14:50:10 +0100580int mbedtls_cipher_update(mbedtls_cipher_context_t *ctx, const unsigned char *input,
581 size_t ilen, unsigned char *output, size_t *olen)
Paul Bakker8123e9d2011-01-06 15:37:30 +0000582{
Janos Follath24eed8d2019-11-22 13:21:35 +0000583 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500584 size_t block_size;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000585
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 if (ctx->cipher_info == NULL) {
587 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
588 }
Paul Bakker8123e9d2011-01-06 15:37:30 +0000589
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +0200590#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 if (ctx->psa_enabled == 1) {
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000592 /* While PSA Crypto has an API for multipart
593 * operations, we currently don't make it
594 * accessible through the cipher layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100595 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000596 }
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +0200597#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckerce1ddee2018-11-09 16:20:29 +0000598
Paul Bakker6c212762013-12-16 15:24:50 +0100599 *olen = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 block_size = mbedtls_cipher_get_block_size(ctx);
601 if (0 == block_size) {
602 return MBEDTLS_ERR_CIPHER_INVALID_CONTEXT;
Gilles Peskinea2bdcb92020-01-21 15:02:14 +0100603 }
Paul Bakker6c212762013-12-16 15:24:50 +0100604
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100605 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_ECB) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 if (ilen != block_size) {
607 return MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED;
608 }
Paul Bakker5e0efa72013-09-08 23:04:04 +0200609
610 *olen = ilen;
611
Dave Rodgmande3de772023-06-24 12:51:06 +0100612 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->ecb_func(ctx->cipher_ctx,
Dave Rodgman3b46b772023-06-24 13:25:06 +0100613 ctx->operation, input,
614 output))) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100615 return ret;
Paul Bakker5e0efa72013-09-08 23:04:04 +0200616 }
617
Gilles Peskine449bd832023-01-11 14:50:10 +0100618 return 0;
Paul Bakker5e0efa72013-09-08 23:04:04 +0200619 }
620
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200621#if defined(MBEDTLS_GCM_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100622 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_GCM) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 return mbedtls_gcm_update((mbedtls_gcm_context *) ctx->cipher_ctx,
624 input, ilen,
625 output, ilen, olen);
Manuel Pégourié-Gonnardb8bd5932013-09-05 13:38:15 +0200626 }
627#endif
628
Mateusz Starzyk594215b2021-10-14 12:23:06 +0200629#if defined(MBEDTLS_CCM_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100630 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_CCM_STAR_NO_TAG) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100631 return mbedtls_ccm_update((mbedtls_ccm_context *) ctx->cipher_ctx,
632 input, ilen,
633 output, ilen, olen);
Mateusz Starzyk594215b2021-10-14 12:23:06 +0200634 }
635#endif
636
Manuel Pégourié-Gonnard32902e62018-05-10 12:30:19 +0200637#if defined(MBEDTLS_CHACHAPOLY_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100638 if (((mbedtls_cipher_type_t) ctx->cipher_info->type) == MBEDTLS_CIPHER_CHACHA20_POLY1305) {
Manuel Pégourié-Gonnard32902e62018-05-10 12:30:19 +0200639 *olen = ilen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100640 return mbedtls_chachapoly_update((mbedtls_chachapoly_context *) ctx->cipher_ctx,
641 ilen, input, output);
Manuel Pégourié-Gonnard32902e62018-05-10 12:30:19 +0200642 }
643#endif
644
Gilles Peskine449bd832023-01-11 14:50:10 +0100645 if (input == output &&
646 (ctx->unprocessed_len != 0 || ilen % block_size)) {
647 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Paul Bakker68884e32013-01-07 18:20:04 +0100648 }
Paul Bakker8123e9d2011-01-06 15:37:30 +0000649
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200650#if defined(MBEDTLS_CIPHER_MODE_CBC)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100651 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_CBC) {
Manuel Pégourié-Gonnard989ed382013-09-13 14:41:45 +0200652 size_t copy_len = 0;
653
Paul Bakker8123e9d2011-01-06 15:37:30 +0000654 /*
655 * If there is not enough data for a full block, cache it.
656 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100657 if ((ctx->operation == MBEDTLS_DECRYPT && NULL != ctx->add_padding &&
658 ilen <= block_size - ctx->unprocessed_len) ||
659 (ctx->operation == MBEDTLS_DECRYPT && NULL == ctx->add_padding &&
660 ilen < block_size - ctx->unprocessed_len) ||
661 (ctx->operation == MBEDTLS_ENCRYPT &&
662 ilen < block_size - ctx->unprocessed_len)) {
663 memcpy(&(ctx->unprocessed_data[ctx->unprocessed_len]), input,
664 ilen);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000665
666 ctx->unprocessed_len += ilen;
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 return 0;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000668 }
669
670 /*
671 * Process cached data first
672 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 if (0 != ctx->unprocessed_len) {
Janos Follath98e28a72016-05-31 14:03:54 +0100674 copy_len = block_size - ctx->unprocessed_len;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000675
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 memcpy(&(ctx->unprocessed_data[ctx->unprocessed_len]), input,
677 copy_len);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000678
Dave Rodgmande3de772023-06-24 12:51:06 +0100679 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->cbc_func(ctx->cipher_ctx,
Dave Rodgman3b46b772023-06-24 13:25:06 +0100680 ctx->operation,
681 block_size, ctx->iv,
682 ctx->
683 unprocessed_data,
684 output))) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 return ret;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000686 }
687
Janos Follath98e28a72016-05-31 14:03:54 +0100688 *olen += block_size;
689 output += block_size;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000690 ctx->unprocessed_len = 0;
691
692 input += copy_len;
693 ilen -= copy_len;
694 }
695
696 /*
697 * Cache final, incomplete block
698 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 if (0 != ilen) {
Andy Leiserson79e77892017-04-28 20:01:49 -0700700 /* Encryption: only cache partial blocks
701 * Decryption w/ padding: always keep at least one whole block
702 * Decryption w/o padding: only cache partial blocks
703 */
Janos Follath98e28a72016-05-31 14:03:54 +0100704 copy_len = ilen % block_size;
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 if (copy_len == 0 &&
Andy Leiserson79e77892017-04-28 20:01:49 -0700706 ctx->operation == MBEDTLS_DECRYPT &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 NULL != ctx->add_padding) {
Janos Follath98e28a72016-05-31 14:03:54 +0100708 copy_len = block_size;
Andy Leiserson79e77892017-04-28 20:01:49 -0700709 }
Paul Bakker8123e9d2011-01-06 15:37:30 +0000710
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 memcpy(ctx->unprocessed_data, &(input[ilen - copy_len]),
712 copy_len);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000713
714 ctx->unprocessed_len += copy_len;
715 ilen -= copy_len;
716 }
717
718 /*
719 * Process remaining full blocks
720 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 if (ilen) {
Dave Rodgmande3de772023-06-24 12:51:06 +0100722 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->cbc_func(ctx->cipher_ctx,
Dave Rodgman3b46b772023-06-24 13:25:06 +0100723 ctx->operation,
724 ilen, ctx->iv,
725 input,
726 output))) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100727 return ret;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000728 }
Manuel Pégourié-Gonnard07f8fa52013-08-30 18:34:08 +0200729
Paul Bakker8123e9d2011-01-06 15:37:30 +0000730 *olen += ilen;
731 }
732
Gilles Peskine449bd832023-01-11 14:50:10 +0100733 return 0;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000734 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200735#endif /* MBEDTLS_CIPHER_MODE_CBC */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000736
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200737#if defined(MBEDTLS_CIPHER_MODE_CFB)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100738 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_CFB) {
Dave Rodgmande3de772023-06-24 12:51:06 +0100739 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->cfb_func(ctx->cipher_ctx,
Dave Rodgman3b46b772023-06-24 13:25:06 +0100740 ctx->operation, ilen,
741 &ctx->unprocessed_len,
742 ctx->iv,
743 input, output))) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100744 return ret;
Paul Bakker343a8702011-06-09 14:27:58 +0000745 }
746
747 *olen = ilen;
748
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 return 0;
Paul Bakker343a8702011-06-09 14:27:58 +0000750 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200751#endif /* MBEDTLS_CIPHER_MODE_CFB */
Paul Bakker343a8702011-06-09 14:27:58 +0000752
Simon Butcher8c0fd1e2018-04-22 22:58:07 +0100753#if defined(MBEDTLS_CIPHER_MODE_OFB)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100754 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_OFB) {
Dave Rodgmande3de772023-06-24 12:51:06 +0100755 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->ofb_func(ctx->cipher_ctx,
Dave Rodgman3b46b772023-06-24 13:25:06 +0100756 ilen,
757 &ctx->unprocessed_len,
758 ctx->iv,
759 input, output))) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 return ret;
Simon Butcher8c0fd1e2018-04-22 22:58:07 +0100761 }
762
763 *olen = ilen;
764
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 return 0;
Simon Butcher8c0fd1e2018-04-22 22:58:07 +0100766 }
767#endif /* MBEDTLS_CIPHER_MODE_OFB */
768
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200769#if defined(MBEDTLS_CIPHER_MODE_CTR)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100770 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_CTR) {
Dave Rodgmande3de772023-06-24 12:51:06 +0100771 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->ctr_func(ctx->cipher_ctx,
Dave Rodgman3b46b772023-06-24 13:25:06 +0100772 ilen,
773 &ctx->unprocessed_len,
774 ctx->iv,
775 ctx->unprocessed_data,
776 input, output))) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100777 return ret;
Paul Bakker343a8702011-06-09 14:27:58 +0000778 }
779
780 *olen = ilen;
781
Gilles Peskine449bd832023-01-11 14:50:10 +0100782 return 0;
Paul Bakker343a8702011-06-09 14:27:58 +0000783 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200784#endif /* MBEDTLS_CIPHER_MODE_CTR */
Paul Bakker343a8702011-06-09 14:27:58 +0000785
Jaeden Ameroc6539902018-04-30 17:17:41 +0100786#if defined(MBEDTLS_CIPHER_MODE_XTS)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100787 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_XTS) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 if (ctx->unprocessed_len > 0) {
Jaeden Ameroc6539902018-04-30 17:17:41 +0100789 /* We can only process an entire data unit at a time. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Jaeden Ameroc6539902018-04-30 17:17:41 +0100791 }
792
Dave Rodgmande3de772023-06-24 12:51:06 +0100793 ret = mbedtls_cipher_get_base(ctx->cipher_info)->xts_func(ctx->cipher_ctx,
Dave Rodgman3b46b772023-06-24 13:25:06 +0100794 ctx->operation,
795 ilen,
796 ctx->iv,
797 input,
798 output);
Gilles Peskine449bd832023-01-11 14:50:10 +0100799 if (ret != 0) {
800 return ret;
Jaeden Ameroc6539902018-04-30 17:17:41 +0100801 }
802
803 *olen = ilen;
804
Gilles Peskine449bd832023-01-11 14:50:10 +0100805 return 0;
Jaeden Ameroc6539902018-04-30 17:17:41 +0100806 }
807#endif /* MBEDTLS_CIPHER_MODE_XTS */
808
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200809#if defined(MBEDTLS_CIPHER_MODE_STREAM)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +0100810 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) == MBEDTLS_MODE_STREAM) {
Dave Rodgmande3de772023-06-24 12:51:06 +0100811 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->stream_func(ctx->cipher_ctx,
Dave Rodgman3b46b772023-06-24 13:25:06 +0100812 ilen, input,
813 output))) {
Gilles Peskine449bd832023-01-11 14:50:10 +0100814 return ret;
Manuel Pégourié-Gonnard37e230c2013-08-28 13:50:42 +0200815 }
816
817 *olen = ilen;
818
Gilles Peskine449bd832023-01-11 14:50:10 +0100819 return 0;
Manuel Pégourié-Gonnard37e230c2013-08-28 13:50:42 +0200820 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200821#endif /* MBEDTLS_CIPHER_MODE_STREAM */
Manuel Pégourié-Gonnard37e230c2013-08-28 13:50:42 +0200822
Gilles Peskine449bd832023-01-11 14:50:10 +0100823 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000824}
825
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200826#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
827#if defined(MBEDTLS_CIPHER_PADDING_PKCS7)
Manuel Pégourié-Gonnard679f9e92013-07-26 12:46:02 +0200828/*
829 * PKCS7 (and PKCS5) padding: fill with ll bytes, with ll = padding_len
830 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100831static void add_pkcs_padding(unsigned char *output, size_t output_len,
832 size_t data_len)
Paul Bakker8123e9d2011-01-06 15:37:30 +0000833{
Paul Bakker23986e52011-04-24 08:57:21 +0000834 size_t padding_len = output_len - data_len;
Manuel Pégourié-Gonnardf8ab0692013-10-27 17:21:14 +0100835 unsigned char i;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000836
Gilles Peskine449bd832023-01-11 14:50:10 +0100837 for (i = 0; i < padding_len; i++) {
Paul Bakker23986e52011-04-24 08:57:21 +0000838 output[data_len + i] = (unsigned char) padding_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100839 }
Paul Bakker8123e9d2011-01-06 15:37:30 +0000840}
841
David Horstmannab7bb572025-03-05 18:05:04 +0000842MBEDTLS_STATIC_TESTABLE int mbedtls_get_pkcs_padding(unsigned char *input,
843 size_t input_len,
844 size_t *data_len)
Paul Bakker8123e9d2011-01-06 15:37:30 +0000845{
Manuel Pégourié-Gonnardf8ab0692013-10-27 17:21:14 +0100846 size_t i, pad_idx;
Dave Rodgman6b7e2a52023-09-18 19:00:44 +0100847 unsigned char padding_len;
Paul Bakker8123e9d2011-01-06 15:37:30 +0000848
Gilles Peskine449bd832023-01-11 14:50:10 +0100849 if (NULL == input || NULL == data_len) {
850 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
851 }
Paul Bakker8123e9d2011-01-06 15:37:30 +0000852
853 padding_len = input[input_len - 1];
Paul Bakker8123e9d2011-01-06 15:37:30 +0000854
Dave Rodgmane834d6c2023-09-20 19:06:53 +0100855 mbedtls_ct_condition_t bad = mbedtls_ct_uint_gt(padding_len, input_len);
Dave Rodgman6b7e2a52023-09-18 19:00:44 +0100856 bad = mbedtls_ct_bool_or(bad, mbedtls_ct_uint_eq(padding_len, 0));
Manuel Pégourié-Gonnardf8ab0692013-10-27 17:21:14 +0100857
858 /* The number of bytes checked must be independent of padding_len,
859 * so pick input_len, which is usually 8 or 16 (one block) */
860 pad_idx = input_len - padding_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100861 for (i = 0; i < input_len; i++) {
Dave Rodgmanc43a0a42023-09-20 19:07:22 +0100862 mbedtls_ct_condition_t in_padding = mbedtls_ct_uint_ge(i, pad_idx);
863 mbedtls_ct_condition_t different = mbedtls_ct_uint_ne(input[i], padding_len);
864 bad = mbedtls_ct_bool_or(bad, mbedtls_ct_bool_and(in_padding, different));
Gilles Peskine449bd832023-01-11 14:50:10 +0100865 }
Manuel Pégourié-Gonnardf8ab0692013-10-27 17:21:14 +0100866
David Horstmann652ea212025-01-20 17:44:00 +0000867 /* If the padding is invalid, set the output length to 0 */
868 *data_len = mbedtls_ct_if(bad, 0, input_len - padding_len);
869
Dave Rodgmand03f4832023-09-22 09:52:15 +0100870 return mbedtls_ct_error_if_else_0(bad, MBEDTLS_ERR_CIPHER_INVALID_PADDING);
Paul Bakker8123e9d2011-01-06 15:37:30 +0000871}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872#endif /* MBEDTLS_CIPHER_PADDING_PKCS7 */
Paul Bakker8123e9d2011-01-06 15:37:30 +0000873
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200874#if defined(MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS)
Manuel Pégourié-Gonnard679f9e92013-07-26 12:46:02 +0200875/*
876 * One and zeros padding: fill with 80 00 ... 00
877 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100878static void add_one_and_zeros_padding(unsigned char *output,
879 size_t output_len, size_t data_len)
Manuel Pégourié-Gonnard679f9e92013-07-26 12:46:02 +0200880{
881 size_t padding_len = output_len - data_len;
882 unsigned char i = 0;
883
884 output[data_len] = 0x80;
Gilles Peskine449bd832023-01-11 14:50:10 +0100885 for (i = 1; i < padding_len; i++) {
Manuel Pégourié-Gonnard679f9e92013-07-26 12:46:02 +0200886 output[data_len + i] = 0x00;
Gilles Peskine449bd832023-01-11 14:50:10 +0100887 }
Manuel Pégourié-Gonnard679f9e92013-07-26 12:46:02 +0200888}
889
Gilles Peskine449bd832023-01-11 14:50:10 +0100890static int get_one_and_zeros_padding(unsigned char *input, size_t input_len,
891 size_t *data_len)
Manuel Pégourié-Gonnard679f9e92013-07-26 12:46:02 +0200892{
Gilles Peskine449bd832023-01-11 14:50:10 +0100893 if (NULL == input || NULL == data_len) {
894 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
895 }
Manuel Pégourié-Gonnard679f9e92013-07-26 12:46:02 +0200896
Dave Rodgman89a9bd52023-09-19 14:37:50 +0100897 mbedtls_ct_condition_t in_padding = MBEDTLS_CT_TRUE;
898 mbedtls_ct_condition_t bad = MBEDTLS_CT_TRUE;
899
Manuel Pégourié-Gonnard6c329902013-10-27 18:25:03 +0100900 *data_len = 0;
Dave Rodgman89a9bd52023-09-19 14:37:50 +0100901
Dave Rodgman437500c2023-09-19 21:36:43 +0100902 for (ptrdiff_t i = (ptrdiff_t) (input_len) - 1; i >= 0; i--) {
Dave Rodgman89a9bd52023-09-19 14:37:50 +0100903 mbedtls_ct_condition_t is_nonzero = mbedtls_ct_bool(input[i]);
904
905 mbedtls_ct_condition_t hit_first_nonzero = mbedtls_ct_bool_and(is_nonzero, in_padding);
906
907 *data_len = mbedtls_ct_size_if(hit_first_nonzero, i, *data_len);
908
Dave Rodgmanfd965792023-09-19 21:51:50 +0100909 bad = mbedtls_ct_bool_if(hit_first_nonzero, mbedtls_ct_uint_ne(input[i], 0x80), bad);
Dave Rodgman89a9bd52023-09-19 14:37:50 +0100910
911 in_padding = mbedtls_ct_bool_and(in_padding, mbedtls_ct_bool_not(is_nonzero));
Manuel Pégourié-Gonnard6c329902013-10-27 18:25:03 +0100912 }
Manuel Pégourié-Gonnard679f9e92013-07-26 12:46:02 +0200913
Dave Rodgmand03f4832023-09-22 09:52:15 +0100914 return mbedtls_ct_error_if_else_0(bad, MBEDTLS_ERR_CIPHER_INVALID_PADDING);
Manuel Pégourié-Gonnard679f9e92013-07-26 12:46:02 +0200915}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200916#endif /* MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS */
Manuel Pégourié-Gonnard679f9e92013-07-26 12:46:02 +0200917
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200918#if defined(MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN)
Manuel Pégourié-Gonnard8d4291b2013-07-26 14:55:18 +0200919/*
920 * Zeros and len padding: fill with 00 ... 00 ll, where ll is padding length
921 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100922static void add_zeros_and_len_padding(unsigned char *output,
923 size_t output_len, size_t data_len)
Manuel Pégourié-Gonnard8d4291b2013-07-26 14:55:18 +0200924{
925 size_t padding_len = output_len - data_len;
926 unsigned char i = 0;
927
Gilles Peskine449bd832023-01-11 14:50:10 +0100928 for (i = 1; i < padding_len; i++) {
Manuel Pégourié-Gonnard8d4291b2013-07-26 14:55:18 +0200929 output[data_len + i - 1] = 0x00;
Gilles Peskine449bd832023-01-11 14:50:10 +0100930 }
Manuel Pégourié-Gonnard8d4291b2013-07-26 14:55:18 +0200931 output[output_len - 1] = (unsigned char) padding_len;
932}
933
Gilles Peskine449bd832023-01-11 14:50:10 +0100934static int get_zeros_and_len_padding(unsigned char *input, size_t input_len,
935 size_t *data_len)
Manuel Pégourié-Gonnard8d4291b2013-07-26 14:55:18 +0200936{
Manuel Pégourié-Gonnardd17df512013-10-27 17:32:43 +0100937 size_t i, pad_idx;
Dave Rodgman6cec41c2023-09-18 21:51:55 +0100938 unsigned char padding_len;
939 mbedtls_ct_condition_t bad;
Manuel Pégourié-Gonnard8d4291b2013-07-26 14:55:18 +0200940
Gilles Peskine449bd832023-01-11 14:50:10 +0100941 if (NULL == input || NULL == data_len) {
942 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
943 }
Manuel Pégourié-Gonnard8d4291b2013-07-26 14:55:18 +0200944
945 padding_len = input[input_len - 1];
Manuel Pégourié-Gonnard8d4291b2013-07-26 14:55:18 +0200946 *data_len = input_len - padding_len;
947
Manuel Pégourié-Gonnardd17df512013-10-27 17:32:43 +0100948 /* Avoid logical || since it results in a branch */
Dave Rodgman6cec41c2023-09-18 21:51:55 +0100949 bad = mbedtls_ct_uint_gt(padding_len, input_len);
950 bad = mbedtls_ct_bool_or(bad, mbedtls_ct_uint_eq(padding_len, 0));
Manuel Pégourié-Gonnardd17df512013-10-27 17:32:43 +0100951
952 /* The number of bytes checked must be independent of padding_len */
953 pad_idx = input_len - padding_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100954 for (i = 0; i < input_len - 1; i++) {
Dave Rodgman6cec41c2023-09-18 21:51:55 +0100955 mbedtls_ct_condition_t is_padding = mbedtls_ct_uint_ge(i, pad_idx);
Dave Rodgman6be4bcf2023-09-19 19:47:51 +0100956 mbedtls_ct_condition_t nonzero_pad_byte;
Dave Rodgmanfd965792023-09-19 21:51:50 +0100957 nonzero_pad_byte = mbedtls_ct_bool_if_else_0(is_padding, mbedtls_ct_bool(input[i]));
Dave Rodgman6cec41c2023-09-18 21:51:55 +0100958 bad = mbedtls_ct_bool_or(bad, nonzero_pad_byte);
Gilles Peskine449bd832023-01-11 14:50:10 +0100959 }
Manuel Pégourié-Gonnardd17df512013-10-27 17:32:43 +0100960
Dave Rodgmand03f4832023-09-22 09:52:15 +0100961 return mbedtls_ct_error_if_else_0(bad, MBEDTLS_ERR_CIPHER_INVALID_PADDING);
Manuel Pégourié-Gonnard8d4291b2013-07-26 14:55:18 +0200962}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200963#endif /* MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN */
Manuel Pégourié-Gonnard8d4291b2013-07-26 14:55:18 +0200964
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200965#if defined(MBEDTLS_CIPHER_PADDING_ZEROS)
Manuel Pégourié-Gonnard0e7d2c02013-07-26 16:05:14 +0200966/*
967 * Zero padding: fill with 00 ... 00
968 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100969static void add_zeros_padding(unsigned char *output,
970 size_t output_len, size_t data_len)
Manuel Pégourié-Gonnard0e7d2c02013-07-26 16:05:14 +0200971{
Dave Rodgmanf8182d92023-09-19 16:25:17 +0100972 memset(output + data_len, 0, output_len - data_len);
Manuel Pégourié-Gonnard0e7d2c02013-07-26 16:05:14 +0200973}
974
Gilles Peskine449bd832023-01-11 14:50:10 +0100975static int get_zeros_padding(unsigned char *input, size_t input_len,
976 size_t *data_len)
Manuel Pégourié-Gonnard0e7d2c02013-07-26 16:05:14 +0200977{
Manuel Pégourié-Gonnarde68bf172013-10-27 18:26:39 +0100978 size_t i;
Dave Rodgmand8c68a92023-09-19 16:19:38 +0100979 mbedtls_ct_condition_t done = MBEDTLS_CT_FALSE, prev_done;
Manuel Pégourié-Gonnarde68bf172013-10-27 18:26:39 +0100980
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 if (NULL == input || NULL == data_len) {
982 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Manuel Pégourié-Gonnarde68bf172013-10-27 18:26:39 +0100983 }
Manuel Pégourié-Gonnard0e7d2c02013-07-26 16:05:14 +0200984
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 *data_len = 0;
986 for (i = input_len; i > 0; i--) {
987 prev_done = done;
Dave Rodgmand8c68a92023-09-19 16:19:38 +0100988 done = mbedtls_ct_bool_or(done, mbedtls_ct_uint_ne(input[i-1], 0));
989 *data_len = mbedtls_ct_size_if(mbedtls_ct_bool_ne(done, prev_done), i, *data_len);
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 }
991
992 return 0;
Manuel Pégourié-Gonnard0e7d2c02013-07-26 16:05:14 +0200993}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994#endif /* MBEDTLS_CIPHER_PADDING_ZEROS */
Manuel Pégourié-Gonnard0e7d2c02013-07-26 16:05:14 +0200995
Manuel Pégourié-Gonnardebdc4132013-07-26 16:50:44 +0200996/*
997 * No padding: don't pad :)
998 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200999 * There is no add_padding function (check for NULL in mbedtls_cipher_finish)
Manuel Pégourié-Gonnardebdc4132013-07-26 16:50:44 +02001000 * but a trivial get_padding function
1001 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001002static int get_no_padding(unsigned char *input, size_t input_len,
1003 size_t *data_len)
Manuel Pégourié-Gonnardebdc4132013-07-26 16:50:44 +02001004{
Gilles Peskine449bd832023-01-11 14:50:10 +01001005 if (NULL == input || NULL == data_len) {
1006 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1007 }
Manuel Pégourié-Gonnardebdc4132013-07-26 16:50:44 +02001008
1009 *data_len = input_len;
1010
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 return 0;
Manuel Pégourié-Gonnardebdc4132013-07-26 16:50:44 +02001012}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013#endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
Manuel Pégourié-Gonnardebdc4132013-07-26 16:50:44 +02001014
Gilles Peskine449bd832023-01-11 14:50:10 +01001015int mbedtls_cipher_finish(mbedtls_cipher_context_t *ctx,
1016 unsigned char *output, size_t *olen)
Paul Bakker8123e9d2011-01-06 15:37:30 +00001017{
Gilles Peskine449bd832023-01-11 14:50:10 +01001018 if (ctx->cipher_info == NULL) {
1019 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1020 }
Paul Bakker8123e9d2011-01-06 15:37:30 +00001021
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001022#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 if (ctx->psa_enabled == 1) {
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001024 /* While PSA Crypto has an API for multipart
1025 * operations, we currently don't make it
1026 * accessible through the cipher layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001027 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001028 }
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001029#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001030
Paul Bakker8123e9d2011-01-06 15:37:30 +00001031 *olen = 0;
1032
Waleed Elmelegya7d206f2023-09-07 17:54:46 +01001033#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
1034 /* CBC mode requires padding so we make sure a call to
1035 * mbedtls_cipher_set_padding_mode has been done successfully. */
1036 if (MBEDTLS_MODE_CBC == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
1037 if (ctx->get_padding == NULL) {
1038 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1039 }
1040 }
1041#endif
1042
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001043 if (MBEDTLS_MODE_CFB == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1044 MBEDTLS_MODE_OFB == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1045 MBEDTLS_MODE_CTR == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1046 MBEDTLS_MODE_GCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1047 MBEDTLS_MODE_CCM_STAR_NO_TAG == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1048 MBEDTLS_MODE_XTS == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1049 MBEDTLS_MODE_STREAM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001050 return 0;
Paul Bakker343a8702011-06-09 14:27:58 +00001051 }
1052
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001053 if ((MBEDTLS_CIPHER_CHACHA20 == ((mbedtls_cipher_type_t) ctx->cipher_info->type)) ||
1054 (MBEDTLS_CIPHER_CHACHA20_POLY1305 == ((mbedtls_cipher_type_t) ctx->cipher_info->type))) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 return 0;
Daniel Kingbd920622016-05-15 19:56:20 -03001056 }
1057
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001058 if (MBEDTLS_MODE_ECB == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ctx->unprocessed_len != 0) {
1060 return MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED;
1061 }
Paul Bakker5e0efa72013-09-08 23:04:04 +02001062
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 return 0;
Paul Bakker5e0efa72013-09-08 23:04:04 +02001064 }
1065
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066#if defined(MBEDTLS_CIPHER_MODE_CBC)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001067 if (MBEDTLS_MODE_CBC == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Manuel Pégourié-Gonnard989ed382013-09-13 14:41:45 +02001068 int ret = 0;
1069
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 if (MBEDTLS_ENCRYPT == ctx->operation) {
Manuel Pégourié-Gonnardebdc4132013-07-26 16:50:44 +02001071 /* check for 'no padding' mode */
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 if (NULL == ctx->add_padding) {
1073 if (0 != ctx->unprocessed_len) {
1074 return MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED;
1075 }
Manuel Pégourié-Gonnardebdc4132013-07-26 16:50:44 +02001076
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 return 0;
Manuel Pégourié-Gonnardebdc4132013-07-26 16:50:44 +02001078 }
1079
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 ctx->add_padding(ctx->unprocessed_data, mbedtls_cipher_get_iv_size(ctx),
1081 ctx->unprocessed_len);
1082 } else if (mbedtls_cipher_get_block_size(ctx) != ctx->unprocessed_len) {
Manuel Pégourié-Gonnardebdc4132013-07-26 16:50:44 +02001083 /*
1084 * For decrypt operations, expect a full block,
1085 * or an empty block if no padding
1086 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 if (NULL == ctx->add_padding && 0 == ctx->unprocessed_len) {
1088 return 0;
1089 }
Manuel Pégourié-Gonnardebdc4132013-07-26 16:50:44 +02001090
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 return MBEDTLS_ERR_CIPHER_FULL_BLOCK_EXPECTED;
Paul Bakker8123e9d2011-01-06 15:37:30 +00001092 }
1093
1094 /* cipher block */
Dave Rodgmande3de772023-06-24 12:51:06 +01001095 if (0 != (ret = mbedtls_cipher_get_base(ctx->cipher_info)->cbc_func(ctx->cipher_ctx,
Dave Rodgman3b46b772023-06-24 13:25:06 +01001096 ctx->operation,
1097 mbedtls_cipher_get_block_size(
1098 ctx),
1099 ctx->iv,
1100 ctx->unprocessed_data,
1101 output))) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 return ret;
Paul Bakker8123e9d2011-01-06 15:37:30 +00001103 }
1104
1105 /* Set output size for decryption */
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 if (MBEDTLS_DECRYPT == ctx->operation) {
1107 return ctx->get_padding(output, mbedtls_cipher_get_block_size(ctx),
1108 olen);
1109 }
Paul Bakker8123e9d2011-01-06 15:37:30 +00001110
1111 /* Set output size for encryption */
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 *olen = mbedtls_cipher_get_block_size(ctx);
1113 return 0;
Paul Bakker8123e9d2011-01-06 15:37:30 +00001114 }
Manuel Pégourié-Gonnard989ed382013-09-13 14:41:45 +02001115#else
1116 ((void) output);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001117#endif /* MBEDTLS_CIPHER_MODE_CBC */
Paul Bakker8123e9d2011-01-06 15:37:30 +00001118
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Paul Bakker8123e9d2011-01-06 15:37:30 +00001120}
1121
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122#if defined(MBEDTLS_CIPHER_MODE_WITH_PADDING)
Gilles Peskine449bd832023-01-11 14:50:10 +01001123int mbedtls_cipher_set_padding_mode(mbedtls_cipher_context_t *ctx,
1124 mbedtls_cipher_padding_t mode)
Manuel Pégourié-Gonnardac56a1a2013-07-25 12:31:10 +02001125{
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001126 if (NULL == ctx->cipher_info ||
1127 MBEDTLS_MODE_CBC != ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Manuel Pégourié-Gonnardac56a1a2013-07-25 12:31:10 +02001129 }
1130
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001131#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 if (ctx->psa_enabled == 1) {
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001133 /* While PSA Crypto knows about CBC padding
1134 * schemes, we currently don't make them
1135 * accessible through the cipher layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 if (mode != MBEDTLS_PADDING_NONE) {
1137 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
1138 }
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001139
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 return 0;
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001141 }
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001142#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001143
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 switch (mode) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001145#if defined(MBEDTLS_CIPHER_PADDING_PKCS7)
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 case MBEDTLS_PADDING_PKCS7:
1147 ctx->add_padding = add_pkcs_padding;
David Horstmann5a5440e2025-03-28 10:57:45 +00001148 ctx->get_padding = mbedtls_get_pkcs_padding;
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 break;
Paul Bakker48e93c82013-08-14 12:21:18 +02001150#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151#if defined(MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 case MBEDTLS_PADDING_ONE_AND_ZEROS:
1153 ctx->add_padding = add_one_and_zeros_padding;
1154 ctx->get_padding = get_one_and_zeros_padding;
1155 break;
Paul Bakker48e93c82013-08-14 12:21:18 +02001156#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157#if defined(MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN)
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 case MBEDTLS_PADDING_ZEROS_AND_LEN:
1159 ctx->add_padding = add_zeros_and_len_padding;
1160 ctx->get_padding = get_zeros_and_len_padding;
1161 break;
Paul Bakker48e93c82013-08-14 12:21:18 +02001162#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001163#if defined(MBEDTLS_CIPHER_PADDING_ZEROS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 case MBEDTLS_PADDING_ZEROS:
1165 ctx->add_padding = add_zeros_padding;
1166 ctx->get_padding = get_zeros_padding;
1167 break;
Paul Bakker48e93c82013-08-14 12:21:18 +02001168#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 case MBEDTLS_PADDING_NONE:
1170 ctx->add_padding = NULL;
1171 ctx->get_padding = get_no_padding;
1172 break;
Paul Bakker1a45d912013-08-14 12:04:26 +02001173
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 default:
1175 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnardebdc4132013-07-26 16:50:44 +02001176 }
1177
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 return 0;
Manuel Pégourié-Gonnardac56a1a2013-07-25 12:31:10 +02001179}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001180#endif /* MBEDTLS_CIPHER_MODE_WITH_PADDING */
Manuel Pégourié-Gonnardac56a1a2013-07-25 12:31:10 +02001181
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02001182#if defined(MBEDTLS_GCM_C) || defined(MBEDTLS_CHACHAPOLY_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001183int mbedtls_cipher_write_tag(mbedtls_cipher_context_t *ctx,
1184 unsigned char *tag, size_t tag_len)
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +02001185{
Gilles Peskine449bd832023-01-11 14:50:10 +01001186 if (ctx->cipher_info == NULL) {
1187 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1188 }
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +02001189
Gilles Peskine449bd832023-01-11 14:50:10 +01001190 if (MBEDTLS_ENCRYPT != ctx->operation) {
1191 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1192 }
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +02001193
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001194#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 if (ctx->psa_enabled == 1) {
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001196 /* While PSA Crypto has an API for multipart
1197 * operations, we currently don't make it
1198 * accessible through the cipher layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001199 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001200 }
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001201#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001202
Daniel King8fe47012016-05-17 20:33:28 -03001203#if defined(MBEDTLS_GCM_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001204 if (MBEDTLS_MODE_GCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Gilles Peskine5a7be102021-06-23 21:51:32 +02001205 size_t output_length;
1206 /* The code here doesn't yet support alternative implementations
1207 * that can delay up to a block of output. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001208 return mbedtls_gcm_finish((mbedtls_gcm_context *) ctx->cipher_ctx,
1209 NULL, 0, &output_length,
1210 tag, tag_len);
Gilles Peskine5a7be102021-06-23 21:51:32 +02001211 }
Daniel King8fe47012016-05-17 20:33:28 -03001212#endif
1213
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02001214#if defined(MBEDTLS_CHACHAPOLY_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001215 if (MBEDTLS_CIPHER_CHACHA20_POLY1305 == ((mbedtls_cipher_type_t) ctx->cipher_info->type)) {
Daniel King8fe47012016-05-17 20:33:28 -03001216 /* Don't allow truncated MAC for Poly1305 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001217 if (tag_len != 16U) {
1218 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1219 }
Daniel King8fe47012016-05-17 20:33:28 -03001220
Gilles Peskine449bd832023-01-11 14:50:10 +01001221 return mbedtls_chachapoly_finish(
1222 (mbedtls_chachapoly_context *) ctx->cipher_ctx, tag);
Daniel King8fe47012016-05-17 20:33:28 -03001223 }
1224#endif
Manuel Pégourié-Gonnard43a47802013-09-03 16:35:53 +02001225
Gilles Peskine449bd832023-01-11 14:50:10 +01001226 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +02001227}
Paul Bakker9af723c2014-05-01 13:03:14 +02001228
Gilles Peskine449bd832023-01-11 14:50:10 +01001229int mbedtls_cipher_check_tag(mbedtls_cipher_context_t *ctx,
1230 const unsigned char *tag, size_t tag_len)
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +02001231{
Daniel King8fe47012016-05-17 20:33:28 -03001232 unsigned char check_tag[16];
Janos Follath24eed8d2019-11-22 13:21:35 +00001233 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +02001234
Gilles Peskine449bd832023-01-11 14:50:10 +01001235 if (ctx->cipher_info == NULL) {
1236 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1237 }
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05001238
Gilles Peskine449bd832023-01-11 14:50:10 +01001239 if (MBEDTLS_DECRYPT != ctx->operation) {
1240 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Manuel Pégourié-Gonnard43a47802013-09-03 16:35:53 +02001241 }
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +02001242
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001243#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001244 if (ctx->psa_enabled == 1) {
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001245 /* While PSA Crypto has an API for multipart
1246 * operations, we currently don't make it
1247 * accessible through the cipher layer. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001248 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001249 }
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001250#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001251
Denis V. Lunev2df73ae2018-11-01 12:22:27 +03001252 /* Status to return on a non-authenticated algorithm. */
1253 ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Gilles Peskinee7835d92021-12-13 12:32:43 +01001254
Daniel King8fe47012016-05-17 20:33:28 -03001255#if defined(MBEDTLS_GCM_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001256 if (MBEDTLS_MODE_GCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Gilles Peskine5a7be102021-06-23 21:51:32 +02001257 size_t output_length;
1258 /* The code here doesn't yet support alternative implementations
1259 * that can delay up to a block of output. */
1260
Gilles Peskine449bd832023-01-11 14:50:10 +01001261 if (tag_len > sizeof(check_tag)) {
1262 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1263 }
Manuel Pégourié-Gonnard43a47802013-09-03 16:35:53 +02001264
Gilles Peskine449bd832023-01-11 14:50:10 +01001265 if (0 != (ret = mbedtls_gcm_finish(
1266 (mbedtls_gcm_context *) ctx->cipher_ctx,
1267 NULL, 0, &output_length,
1268 check_tag, tag_len))) {
1269 return ret;
Paul Bakkerb9cfaa02013-10-11 18:58:55 +02001270 }
Manuel Pégourié-Gonnard43a47802013-09-03 16:35:53 +02001271
1272 /* Check the tag in "constant-time" */
Gilles Peskine449bd832023-01-11 14:50:10 +01001273 if (mbedtls_ct_memcmp(tag, check_tag, tag_len) != 0) {
Gilles Peskinee7835d92021-12-13 12:32:43 +01001274 ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;
Gilles Peskinecd742982021-12-13 16:57:47 +01001275 goto exit;
1276 }
Manuel Pégourié-Gonnard43a47802013-09-03 16:35:53 +02001277 }
Daniel King8fe47012016-05-17 20:33:28 -03001278#endif /* MBEDTLS_GCM_C */
1279
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02001280#if defined(MBEDTLS_CHACHAPOLY_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001281 if (MBEDTLS_CIPHER_CHACHA20_POLY1305 == ((mbedtls_cipher_type_t) ctx->cipher_info->type)) {
Daniel King8fe47012016-05-17 20:33:28 -03001282 /* Don't allow truncated MAC for Poly1305 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001283 if (tag_len != sizeof(check_tag)) {
1284 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1285 }
Daniel King8fe47012016-05-17 20:33:28 -03001286
Hanno Becker18597cd2018-11-09 16:36:33 +00001287 ret = mbedtls_chachapoly_finish(
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 (mbedtls_chachapoly_context *) ctx->cipher_ctx, check_tag);
1289 if (ret != 0) {
1290 return ret;
Daniel King8fe47012016-05-17 20:33:28 -03001291 }
1292
1293 /* Check the tag in "constant-time" */
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 if (mbedtls_ct_memcmp(tag, check_tag, tag_len) != 0) {
Gilles Peskinee7835d92021-12-13 12:32:43 +01001295 ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;
Gilles Peskinecd742982021-12-13 16:57:47 +01001296 goto exit;
1297 }
Daniel King8fe47012016-05-17 20:33:28 -03001298 }
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02001299#endif /* MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +02001300
Gilles Peskinecd742982021-12-13 16:57:47 +01001301exit:
Gilles Peskine449bd832023-01-11 14:50:10 +01001302 mbedtls_platform_zeroize(check_tag, tag_len);
1303 return ret;
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +02001304}
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02001305#endif /* MBEDTLS_GCM_C || MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnardaa9ffc52013-09-03 16:19:22 +02001306
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +02001307/*
1308 * Packet-oriented wrapper for non-AEAD modes
1309 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001310int mbedtls_cipher_crypt(mbedtls_cipher_context_t *ctx,
1311 const unsigned char *iv, size_t iv_len,
1312 const unsigned char *input, size_t ilen,
1313 unsigned char *output, size_t *olen)
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +02001314{
Janos Follath24eed8d2019-11-22 13:21:35 +00001315 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +02001316 size_t finish_olen;
1317
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001318#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001319 if (ctx->psa_enabled == 1) {
Hanno Becker55e2e3d2018-11-12 12:36:17 +00001320 /* As in the non-PSA case, we don't check that
1321 * a key has been set. If not, the key slot will
1322 * still be in its default state of 0, which is
1323 * guaranteed to be invalid, hence the PSA-call
1324 * below will gracefully fail. */
1325 mbedtls_cipher_context_psa * const cipher_psa =
1326 (mbedtls_cipher_context_psa *) ctx->cipher_ctx;
1327
1328 psa_status_t status;
Jaeden Amerofe96fbe2019-02-20 10:32:28 +00001329 psa_cipher_operation_t cipher_op = PSA_CIPHER_OPERATION_INIT;
Hanno Becker55e2e3d2018-11-12 12:36:17 +00001330 size_t part_len;
1331
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 if (ctx->operation == MBEDTLS_DECRYPT) {
1333 status = psa_cipher_decrypt_setup(&cipher_op,
1334 cipher_psa->slot,
1335 cipher_psa->alg);
1336 } else if (ctx->operation == MBEDTLS_ENCRYPT) {
1337 status = psa_cipher_encrypt_setup(&cipher_op,
1338 cipher_psa->slot,
1339 cipher_psa->alg);
1340 } else {
1341 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Hanno Becker55e2e3d2018-11-12 12:36:17 +00001342 }
Hanno Becker55e2e3d2018-11-12 12:36:17 +00001343
1344 /* In the following, we can immediately return on an error,
1345 * because the PSA Crypto API guarantees that cipher operations
1346 * are terminated by unsuccessful calls to psa_cipher_update(),
1347 * and by any call to psa_cipher_finish(). */
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 if (status != PSA_SUCCESS) {
1349 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Przemyslaw Stekiel80c6a8e2021-09-29 12:13:11 +02001350 }
Hanno Becker55e2e3d2018-11-12 12:36:17 +00001351
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001352 if (((mbedtls_cipher_mode_t) ctx->cipher_info->mode) != MBEDTLS_MODE_ECB) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 status = psa_cipher_set_iv(&cipher_op, iv, iv_len);
1354 if (status != PSA_SUCCESS) {
1355 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
1356 }
1357 }
Hanno Becker55e2e3d2018-11-12 12:36:17 +00001358
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 status = psa_cipher_update(&cipher_op,
1360 input, ilen,
1361 output, ilen, olen);
1362 if (status != PSA_SUCCESS) {
1363 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
1364 }
1365
1366 status = psa_cipher_finish(&cipher_op,
1367 output + *olen, ilen - *olen,
1368 &part_len);
1369 if (status != PSA_SUCCESS) {
1370 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
1371 }
Hanno Becker55e2e3d2018-11-12 12:36:17 +00001372
1373 *olen += part_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 return 0;
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001375 }
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001376#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001377
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 if ((ret = mbedtls_cipher_set_iv(ctx, iv, iv_len)) != 0) {
1379 return ret;
1380 }
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +02001381
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 if ((ret = mbedtls_cipher_reset(ctx)) != 0) {
1383 return ret;
1384 }
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +02001385
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 if ((ret = mbedtls_cipher_update(ctx, input, ilen,
1387 output, olen)) != 0) {
1388 return ret;
1389 }
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +02001390
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 if ((ret = mbedtls_cipher_finish(ctx, output + *olen,
1392 &finish_olen)) != 0) {
1393 return ret;
1394 }
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +02001395
1396 *olen += finish_olen;
1397
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 return 0;
Manuel Pégourié-Gonnard3c1d1502014-05-12 13:46:08 +02001399}
1400
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001401#if defined(MBEDTLS_CIPHER_MODE_AEAD)
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +02001402/*
TRodziewicz18efb732021-04-29 23:12:19 +02001403 * Packet-oriented encryption for AEAD modes: internal function used by
1404 * mbedtls_cipher_auth_encrypt_ext().
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +02001405 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001406static int mbedtls_cipher_aead_encrypt(mbedtls_cipher_context_t *ctx,
1407 const unsigned char *iv, size_t iv_len,
1408 const unsigned char *ad, size_t ad_len,
1409 const unsigned char *input, size_t ilen,
1410 unsigned char *output, size_t *olen,
1411 unsigned char *tag, size_t tag_len)
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +02001412{
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001413#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001414 if (ctx->psa_enabled == 1) {
Hanno Beckerfe73ade2018-11-12 16:26:46 +00001415 /* As in the non-PSA case, we don't check that
1416 * a key has been set. If not, the key slot will
1417 * still be in its default state of 0, which is
1418 * guaranteed to be invalid, hence the PSA-call
1419 * below will gracefully fail. */
1420 mbedtls_cipher_context_psa * const cipher_psa =
1421 (mbedtls_cipher_context_psa *) ctx->cipher_ctx;
1422
1423 psa_status_t status;
1424
1425 /* PSA Crypto API always writes the authentication tag
1426 * at the end of the encrypted message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 if (output == NULL || tag != output + ilen) {
1428 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
1429 }
Hanno Beckerfe73ade2018-11-12 16:26:46 +00001430
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 status = psa_aead_encrypt(cipher_psa->slot,
1432 cipher_psa->alg,
1433 iv, iv_len,
1434 ad, ad_len,
1435 input, ilen,
1436 output, ilen + tag_len, olen);
1437 if (status != PSA_SUCCESS) {
1438 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
1439 }
Hanno Beckerfe73ade2018-11-12 16:26:46 +00001440
1441 *olen -= tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001442 return 0;
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001443 }
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001444#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001445
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001446#if defined(MBEDTLS_GCM_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001447 if (MBEDTLS_MODE_GCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +02001448 *olen = ilen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 return mbedtls_gcm_crypt_and_tag(ctx->cipher_ctx, MBEDTLS_GCM_ENCRYPT,
1450 ilen, iv, iv_len, ad, ad_len,
1451 input, output, tag_len, tag);
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +02001452 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001453#endif /* MBEDTLS_GCM_C */
1454#if defined(MBEDTLS_CCM_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001455 if (MBEDTLS_MODE_CCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Manuel Pégourié-Gonnard41936952014-05-13 13:18:17 +02001456 *olen = ilen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 return mbedtls_ccm_encrypt_and_tag(ctx->cipher_ctx, ilen,
1458 iv, iv_len, ad, ad_len, input, output,
1459 tag, tag_len);
Manuel Pégourié-Gonnard41936952014-05-13 13:18:17 +02001460 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001461#endif /* MBEDTLS_CCM_C */
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02001462#if defined(MBEDTLS_CHACHAPOLY_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001463 if (MBEDTLS_CIPHER_CHACHA20_POLY1305 == ((mbedtls_cipher_type_t) ctx->cipher_info->type)) {
Manuel Pégourié-Gonnardfe725de2018-05-08 09:38:09 +02001464 /* ChachaPoly has fixed length nonce and MAC (tag) */
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01001465 if ((iv_len != mbedtls_cipher_info_get_iv_size(ctx->cipher_info)) ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 (tag_len != 16U)) {
1467 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Daniel King8fe47012016-05-17 20:33:28 -03001468 }
1469
1470 *olen = ilen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 return mbedtls_chachapoly_encrypt_and_tag(ctx->cipher_ctx,
1472 ilen, iv, ad, ad_len, input, output, tag);
Daniel King8fe47012016-05-17 20:33:28 -03001473 }
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02001474#endif /* MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +02001475
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +02001477}
1478
1479/*
TRodziewicz18efb732021-04-29 23:12:19 +02001480 * Packet-oriented encryption for AEAD modes: internal function used by
1481 * mbedtls_cipher_auth_encrypt_ext().
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +02001482 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001483static int mbedtls_cipher_aead_decrypt(mbedtls_cipher_context_t *ctx,
1484 const unsigned char *iv, size_t iv_len,
1485 const unsigned char *ad, size_t ad_len,
1486 const unsigned char *input, size_t ilen,
1487 unsigned char *output, size_t *olen,
1488 const unsigned char *tag, size_t tag_len)
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +02001489{
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001490#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001491 if (ctx->psa_enabled == 1) {
Hanno Beckerfe73ade2018-11-12 16:26:46 +00001492 /* As in the non-PSA case, we don't check that
1493 * a key has been set. If not, the key slot will
1494 * still be in its default state of 0, which is
1495 * guaranteed to be invalid, hence the PSA-call
1496 * below will gracefully fail. */
1497 mbedtls_cipher_context_psa * const cipher_psa =
1498 (mbedtls_cipher_context_psa *) ctx->cipher_ctx;
1499
1500 psa_status_t status;
1501
1502 /* PSA Crypto API always writes the authentication tag
1503 * at the end of the encrypted message. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 if (input == NULL || tag != input + ilen) {
1505 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
1506 }
Hanno Beckerfe73ade2018-11-12 16:26:46 +00001507
Gilles Peskine449bd832023-01-11 14:50:10 +01001508 status = psa_aead_decrypt(cipher_psa->slot,
1509 cipher_psa->alg,
1510 iv, iv_len,
1511 ad, ad_len,
1512 input, ilen + tag_len,
1513 output, ilen, olen);
1514 if (status == PSA_ERROR_INVALID_SIGNATURE) {
1515 return MBEDTLS_ERR_CIPHER_AUTH_FAILED;
1516 } else if (status != PSA_SUCCESS) {
1517 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
1518 }
Hanno Beckerfe73ade2018-11-12 16:26:46 +00001519
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 return 0;
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001521 }
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001522#endif /* MBEDTLS_USE_PSA_CRYPTO && !MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckerce1ddee2018-11-09 16:20:29 +00001523
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001524#if defined(MBEDTLS_GCM_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001525 if (MBEDTLS_MODE_GCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Janos Follath24eed8d2019-11-22 13:21:35 +00001526 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +02001527
1528 *olen = ilen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 ret = mbedtls_gcm_auth_decrypt(ctx->cipher_ctx, ilen,
1530 iv, iv_len, ad, ad_len,
1531 tag, tag_len, input, output);
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +02001532
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 if (ret == MBEDTLS_ERR_GCM_AUTH_FAILED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001534 ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 }
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +02001536
Gilles Peskine449bd832023-01-11 14:50:10 +01001537 return ret;
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +02001538 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001539#endif /* MBEDTLS_GCM_C */
1540#if defined(MBEDTLS_CCM_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001541 if (MBEDTLS_MODE_CCM == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) {
Janos Follath24eed8d2019-11-22 13:21:35 +00001542 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Manuel Pégourié-Gonnard41936952014-05-13 13:18:17 +02001543
1544 *olen = ilen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001545 ret = mbedtls_ccm_auth_decrypt(ctx->cipher_ctx, ilen,
1546 iv, iv_len, ad, ad_len,
1547 input, output, tag, tag_len);
Manuel Pégourié-Gonnard41936952014-05-13 13:18:17 +02001548
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 if (ret == MBEDTLS_ERR_CCM_AUTH_FAILED) {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001550 ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 }
Manuel Pégourié-Gonnard41936952014-05-13 13:18:17 +02001552
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 return ret;
Manuel Pégourié-Gonnard41936952014-05-13 13:18:17 +02001554 }
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555#endif /* MBEDTLS_CCM_C */
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02001556#if defined(MBEDTLS_CHACHAPOLY_C)
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001557 if (MBEDTLS_CIPHER_CHACHA20_POLY1305 == ((mbedtls_cipher_type_t) ctx->cipher_info->type)) {
Janos Follath24eed8d2019-11-22 13:21:35 +00001558 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Daniel King8fe47012016-05-17 20:33:28 -03001559
Manuel Pégourié-Gonnardfe725de2018-05-08 09:38:09 +02001560 /* ChachaPoly has fixed length nonce and MAC (tag) */
Dave Rodgmanbb521fd2023-06-24 11:21:25 +01001561 if ((iv_len != mbedtls_cipher_info_get_iv_size(ctx->cipher_info)) ||
Gilles Peskine449bd832023-01-11 14:50:10 +01001562 (tag_len != 16U)) {
1563 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
Daniel King8fe47012016-05-17 20:33:28 -03001564 }
1565
1566 *olen = ilen;
Gilles Peskine449bd832023-01-11 14:50:10 +01001567 ret = mbedtls_chachapoly_auth_decrypt(ctx->cipher_ctx, ilen,
1568 iv, ad, ad_len, tag, input, output);
Daniel King8fe47012016-05-17 20:33:28 -03001569
Gilles Peskine449bd832023-01-11 14:50:10 +01001570 if (ret == MBEDTLS_ERR_CHACHAPOLY_AUTH_FAILED) {
Manuel Pégourié-Gonnardfe725de2018-05-08 09:38:09 +02001571 ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001572 }
Daniel King8fe47012016-05-17 20:33:28 -03001573
Gilles Peskine449bd832023-01-11 14:50:10 +01001574 return ret;
Daniel King8fe47012016-05-17 20:33:28 -03001575 }
Manuel Pégourié-Gonnarddca3a5d2018-05-07 10:43:27 +02001576#endif /* MBEDTLS_CHACHAPOLY_C */
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001577
Gilles Peskine449bd832023-01-11 14:50:10 +01001578 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001579}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001580#endif /* MBEDTLS_CIPHER_MODE_AEAD */
Manuel Pégourié-Gonnard4562ffe2014-05-13 12:19:29 +02001581
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001582#if defined(MBEDTLS_CIPHER_MODE_AEAD) || defined(MBEDTLS_NIST_KW_C)
1583/*
1584 * Packet-oriented encryption for AEAD/NIST_KW: public function.
1585 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001586int mbedtls_cipher_auth_encrypt_ext(mbedtls_cipher_context_t *ctx,
1587 const unsigned char *iv, size_t iv_len,
1588 const unsigned char *ad, size_t ad_len,
1589 const unsigned char *input, size_t ilen,
1590 unsigned char *output, size_t output_len,
1591 size_t *olen, size_t tag_len)
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001592{
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001593#if defined(MBEDTLS_NIST_KW_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 if (
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001595#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskinea56d3d92020-12-04 00:47:07 +01001596 ctx->psa_enabled == 0 &&
1597#endif
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001598 (MBEDTLS_MODE_KW == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1599 MBEDTLS_MODE_KWP == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode))) {
1600 mbedtls_nist_kw_mode_t mode =
1601 (MBEDTLS_MODE_KW == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) ?
1602 MBEDTLS_KW_MODE_KW : MBEDTLS_KW_MODE_KWP;
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001603
1604 /* There is no iv, tag or ad associated with KW and KWP,
1605 * so these length should be 0 as documented. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 if (iv_len != 0 || tag_len != 0 || ad_len != 0) {
1607 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1608 }
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001609
Manuel Pégourié-Gonnard841b6fa2020-12-07 10:42:21 +01001610 (void) iv;
1611 (void) ad;
1612
Gilles Peskine449bd832023-01-11 14:50:10 +01001613 return mbedtls_nist_kw_wrap(ctx->cipher_ctx, mode, input, ilen,
1614 output, olen, output_len);
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001615 }
1616#endif /* MBEDTLS_NIST_KW_C */
1617
1618#if defined(MBEDTLS_CIPHER_MODE_AEAD)
1619 /* AEAD case: check length before passing on to shared function */
Gilles Peskine449bd832023-01-11 14:50:10 +01001620 if (output_len < ilen + tag_len) {
1621 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1622 }
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001623
Gilles Peskine449bd832023-01-11 14:50:10 +01001624 int ret = mbedtls_cipher_aead_encrypt(ctx, iv, iv_len, ad, ad_len,
1625 input, ilen, output, olen,
1626 output + ilen, tag_len);
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001627 *olen += tag_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001628 return ret;
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001629#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001630 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001631#endif /* MBEDTLS_CIPHER_MODE_AEAD */
1632}
1633
1634/*
1635 * Packet-oriented decryption for AEAD/NIST_KW: public function.
1636 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001637int mbedtls_cipher_auth_decrypt_ext(mbedtls_cipher_context_t *ctx,
1638 const unsigned char *iv, size_t iv_len,
1639 const unsigned char *ad, size_t ad_len,
1640 const unsigned char *input, size_t ilen,
1641 unsigned char *output, size_t output_len,
1642 size_t *olen, size_t tag_len)
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001643{
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001644#if defined(MBEDTLS_NIST_KW_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001645 if (
Manuel Pégourié-Gonnard5c731b02023-06-21 10:37:30 +02001646#if defined(MBEDTLS_USE_PSA_CRYPTO) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskinea56d3d92020-12-04 00:47:07 +01001647 ctx->psa_enabled == 0 &&
1648#endif
Dave Rodgman1b8a3b12023-06-24 17:32:43 +01001649 (MBEDTLS_MODE_KW == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode) ||
1650 MBEDTLS_MODE_KWP == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode))) {
1651 mbedtls_nist_kw_mode_t mode =
1652 (MBEDTLS_MODE_KW == ((mbedtls_cipher_mode_t) ctx->cipher_info->mode)) ?
1653 MBEDTLS_KW_MODE_KW : MBEDTLS_KW_MODE_KWP;
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001654
1655 /* There is no iv, tag or ad associated with KW and KWP,
1656 * so these length should be 0 as documented. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001657 if (iv_len != 0 || tag_len != 0 || ad_len != 0) {
1658 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1659 }
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001660
Manuel Pégourié-Gonnard841b6fa2020-12-07 10:42:21 +01001661 (void) iv;
1662 (void) ad;
1663
Gilles Peskine449bd832023-01-11 14:50:10 +01001664 return mbedtls_nist_kw_unwrap(ctx->cipher_ctx, mode, input, ilen,
1665 output, olen, output_len);
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001666 }
1667#endif /* MBEDTLS_NIST_KW_C */
1668
1669#if defined(MBEDTLS_CIPHER_MODE_AEAD)
1670 /* AEAD case: check length before passing on to shared function */
Gilles Peskine449bd832023-01-11 14:50:10 +01001671 if (ilen < tag_len || output_len < ilen - tag_len) {
1672 return MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;
1673 }
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001674
Gilles Peskine449bd832023-01-11 14:50:10 +01001675 return mbedtls_cipher_aead_decrypt(ctx, iv, iv_len, ad, ad_len,
1676 input, ilen - tag_len, output, olen,
1677 input + ilen - tag_len, tag_len);
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001678#else
Gilles Peskine449bd832023-01-11 14:50:10 +01001679 return MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;
Manuel Pégourié-Gonnardfaddf982020-11-25 13:39:47 +01001680#endif /* MBEDTLS_CIPHER_MODE_AEAD */
1681}
1682#endif /* MBEDTLS_CIPHER_MODE_AEAD || MBEDTLS_NIST_KW_C */
1683
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001684#endif /* MBEDTLS_CIPHER_C */