blob: 6c75f77c136fd377be0886ab127e54764670100f [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file aes.h
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00003 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +01004 * \brief This file contains AES definitions and functions.
5 *
6 * The Advanced Encryption Standard (AES) specifies a FIPS-approved
Rose Zadik7f441272018-01-22 11:48:23 +00007 * cryptographic algorithm that can be used to protect electronic
8 * data.
9 *
10 * The AES algorithm is a symmetric block cipher that can
11 * encrypt and decrypt information. For more information, see
12 * <em>FIPS Publication 197: Advanced Encryption Standard</em> and
13 * <em>ISO/IEC 18033-2:2006: Information technology -- Security
14 * techniques -- Encryption algorithms -- Part 2: Asymmetric
15 * ciphers</em>.
Jaeden Amerof167deb2018-05-30 19:20:48 +010016 *
17 * The AES-XTS block mode is standardized by NIST SP 800-38E
18 * <https://nvlpubs.nist.gov/nistpubs/legacy/sp/nistspecialpublication800-38e.pdf>
19 * and described in detail by IEEE P1619
20 * <https://ieeexplore.ieee.org/servlet/opac?punumber=4375278>.
Darryl Greena40a1012018-01-05 15:33:17 +000021 */
Rose Zadik5ad7aea2018-03-26 12:00:09 +010022
Bence Szépkúti86974652020-06-15 11:59:37 +020023/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020024 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020025 * SPDX-License-Identifier: Apache-2.0
26 *
27 * Licensed under the Apache License, Version 2.0 (the "License"); you may
28 * not use this file except in compliance with the License.
29 * You may obtain a copy of the License at
30 *
31 * http://www.apache.org/licenses/LICENSE-2.0
32 *
33 * Unless required by applicable law or agreed to in writing, software
34 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
35 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
36 * See the License for the specific language governing permissions and
37 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000038 */
Rose Zadik7f441272018-01-22 11:48:23 +000039
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020040#ifndef MBEDTLS_AES_H
41#define MBEDTLS_AES_H
Mateusz Starzyk846f0212021-05-19 19:44:07 +020042#include "mbedtls/private_access.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000043
Bence Szépkútic662b362021-05-27 11:25:03 +020044#include "mbedtls/build_info.h"
Mateusz Starzyke35f8f62021-08-04 15:38:09 +020045#include "mbedtls/platform_util.h"
Paul Bakker90995b52013-06-24 19:20:35 +020046
Rich Evans00ab4702015-02-06 13:43:58 +000047#include <stddef.h>
Manuel Pégourié-Gonnardab229102015-04-15 11:53:16 +020048#include <stdint.h>
Paul Bakker5c2364c2012-10-01 14:41:15 +000049
Manuel Pégourié-Gonnard5b685652013-12-18 11:45:21 +010050/* padlock.c and aesni.c rely on these values! */
Rose Zadik7f441272018-01-22 11:48:23 +000051#define MBEDTLS_AES_ENCRYPT 1 /**< AES encryption. */
52#define MBEDTLS_AES_DECRYPT 0 /**< AES decryption. */
Paul Bakker5121ce52009-01-03 21:22:43 +000053
Andres Amaya Garciac5380642017-11-28 19:57:51 +000054/* Error codes in range 0x0020-0x0022 */
Gilles Peskined2971572021-07-26 18:48:10 +020055/** Invalid key length. */
56#define MBEDTLS_ERR_AES_INVALID_KEY_LENGTH -0x0020
57/** Invalid data input length. */
58#define MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH -0x0022
Paul Bakker2b222c82009-07-27 21:03:45 +000059
Mohammad Azim Khane5b5bd72017-11-24 10:52:51 +000060/* Error codes in range 0x0021-0x0025 */
Gilles Peskined2971572021-07-26 18:48:10 +020061/** Invalid input data. */
62#define MBEDTLS_ERR_AES_BAD_INPUT_DATA -0x0021
Ron Eldor9924bdc2018-10-04 10:59:13 +030063
Paul Bakker407a0da2013-06-27 14:29:21 +020064#ifdef __cplusplus
65extern "C" {
66#endif
67
Ron Eldorb2aacec2017-05-18 16:53:08 +030068#if !defined(MBEDTLS_AES_ALT)
69// Regular implementation
70//
71
Paul Bakker5121ce52009-01-03 21:22:43 +000072/**
Rose Zadik7f441272018-01-22 11:48:23 +000073 * \brief The AES context-type definition.
Paul Bakker5121ce52009-01-03 21:22:43 +000074 */
Gilles Peskine449bd832023-01-11 14:50:10 +010075typedef struct mbedtls_aes_context {
Mateusz Starzyk846f0212021-05-19 19:44:07 +020076 int MBEDTLS_PRIVATE(nr); /*!< The number of rounds. */
Werner Lewis6d719442022-06-13 12:28:07 +010077 size_t MBEDTLS_PRIVATE(rk_offset); /*!< The offset in array elements to AES
Gilles Peskine449bd832023-01-11 14:50:10 +010078 round keys in the buffer. */
Arto Kinnunenb1c626b2023-04-14 17:21:22 +080079#if defined(MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH) && !defined(MBEDTLS_PADLOCK_C)
Yanray Wang8b9877b2023-05-05 14:46:04 +080080 uint32_t MBEDTLS_PRIVATE(buf)[44]; /*!< Aligned data buffer to hold
81 round keys in the 128-bit case for
82 10 rounds calculation. */
Arto Kinnunenb1c626b2023-04-14 17:21:22 +080083#else
Mateusz Starzyk846f0212021-05-19 19:44:07 +020084 uint32_t MBEDTLS_PRIVATE(buf)[68]; /*!< Unaligned data buffer. This buffer can
Gilles Peskine449bd832023-01-11 14:50:10 +010085 hold 32 extra Bytes, which can be used for
86 one of the following purposes:
87 <ul><li>Alignment if VIA padlock is
88 used.</li>
89 <li>Simplifying key expansion in the 256-bit
90 case by generating an extra round key.
91 </li></ul> */
Arto Kinnunenb1c626b2023-04-14 17:21:22 +080092#endif /* MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH && !MBEDTLS_PADLOCK_C */
Paul Bakker5121ce52009-01-03 21:22:43 +000093}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020094mbedtls_aes_context;
Paul Bakker5121ce52009-01-03 21:22:43 +000095
Jaeden Amero9366feb2018-05-29 18:55:17 +010096#if defined(MBEDTLS_CIPHER_MODE_XTS)
97/**
98 * \brief The AES XTS context-type definition.
99 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100100typedef struct mbedtls_aes_xts_context {
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200101 mbedtls_aes_context MBEDTLS_PRIVATE(crypt); /*!< The AES context to use for AES block
Gilles Peskine449bd832023-01-11 14:50:10 +0100102 encryption or decryption. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200103 mbedtls_aes_context MBEDTLS_PRIVATE(tweak); /*!< The AES context used for tweak
Gilles Peskine449bd832023-01-11 14:50:10 +0100104 computation. */
Jaeden Amero9366feb2018-05-29 18:55:17 +0100105} mbedtls_aes_xts_context;
106#endif /* MBEDTLS_CIPHER_MODE_XTS */
107
Ron Eldorb2aacec2017-05-18 16:53:08 +0300108#else /* MBEDTLS_AES_ALT */
109#include "aes_alt.h"
110#endif /* MBEDTLS_AES_ALT */
111
Paul Bakker5121ce52009-01-03 21:22:43 +0000112/**
Rose Zadik7f441272018-01-22 11:48:23 +0000113 * \brief This function initializes the specified AES context.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200114 *
Rose Zadik7f441272018-01-22 11:48:23 +0000115 * It must be the first API called before using
116 * the context.
117 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500118 * \param ctx The AES context to initialize. This must not be \c NULL.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200119 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100120void mbedtls_aes_init(mbedtls_aes_context *ctx);
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200121
122/**
Rose Zadik7f441272018-01-22 11:48:23 +0000123 * \brief This function releases and clears the specified AES context.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200124 *
Rose Zadik7f441272018-01-22 11:48:23 +0000125 * \param ctx The AES context to clear.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500126 * If this is \c NULL, this function does nothing.
127 * Otherwise, the context must have been at least initialized.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200128 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100129void mbedtls_aes_free(mbedtls_aes_context *ctx);
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200130
Jaeden Amero9366feb2018-05-29 18:55:17 +0100131#if defined(MBEDTLS_CIPHER_MODE_XTS)
132/**
133 * \brief This function initializes the specified AES XTS context.
134 *
135 * It must be the first API called before using
136 * the context.
137 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500138 * \param ctx The AES XTS context to initialize. This must not be \c NULL.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100139 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100140void mbedtls_aes_xts_init(mbedtls_aes_xts_context *ctx);
Jaeden Amero9366feb2018-05-29 18:55:17 +0100141
142/**
143 * \brief This function releases and clears the specified AES XTS context.
144 *
145 * \param ctx The AES XTS context to clear.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500146 * If this is \c NULL, this function does nothing.
147 * Otherwise, the context must have been at least initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100148 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100149void mbedtls_aes_xts_free(mbedtls_aes_xts_context *ctx);
Jaeden Amero9366feb2018-05-29 18:55:17 +0100150#endif /* MBEDTLS_CIPHER_MODE_XTS */
151
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200152/**
Rose Zadik7f441272018-01-22 11:48:23 +0000153 * \brief This function sets the encryption key.
Paul Bakker5121ce52009-01-03 21:22:43 +0000154 *
Rose Zadik7f441272018-01-22 11:48:23 +0000155 * \param ctx The AES context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500156 * It must be initialized.
Rose Zadik7f441272018-01-22 11:48:23 +0000157 * \param key The encryption key.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500158 * This must be a readable buffer of size \p keybits bits.
Rose Zadik7f441272018-01-22 11:48:23 +0000159 * \param keybits The size of data passed in bits. Valid options are:
160 * <ul><li>128 bits</li>
161 * <li>192 bits</li>
162 * <li>256 bits</li></ul>
Paul Bakker2b222c82009-07-27 21:03:45 +0000163 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100164 * \return \c 0 on success.
Rose Zadik819d13d2018-04-16 09:35:15 +0100165 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000166 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200167MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100168int mbedtls_aes_setkey_enc(mbedtls_aes_context *ctx, const unsigned char *key,
169 unsigned int keybits);
Paul Bakker5121ce52009-01-03 21:22:43 +0000170
171/**
Rose Zadik7f441272018-01-22 11:48:23 +0000172 * \brief This function sets the decryption key.
Paul Bakker5121ce52009-01-03 21:22:43 +0000173 *
Rose Zadik7f441272018-01-22 11:48:23 +0000174 * \param ctx The AES context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500175 * It must be initialized.
Rose Zadik7f441272018-01-22 11:48:23 +0000176 * \param key The decryption key.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500177 * This must be a readable buffer of size \p keybits bits.
Rose Zadik7f441272018-01-22 11:48:23 +0000178 * \param keybits The size of data passed. Valid options are:
179 * <ul><li>128 bits</li>
180 * <li>192 bits</li>
181 * <li>256 bits</li></ul>
Paul Bakker2b222c82009-07-27 21:03:45 +0000182 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100183 * \return \c 0 on success.
184 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000185 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200186MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100187int mbedtls_aes_setkey_dec(mbedtls_aes_context *ctx, const unsigned char *key,
188 unsigned int keybits);
Paul Bakker5121ce52009-01-03 21:22:43 +0000189
Jaeden Amero9366feb2018-05-29 18:55:17 +0100190#if defined(MBEDTLS_CIPHER_MODE_XTS)
191/**
192 * \brief This function prepares an XTS context for encryption and
193 * sets the encryption key.
194 *
195 * \param ctx The AES XTS context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500196 * It must be initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100197 * \param key The encryption key. This is comprised of the XTS key1
198 * concatenated with the XTS key2.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500199 * This must be a readable buffer of size \p keybits bits.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100200 * \param keybits The size of \p key passed in bits. Valid options are:
201 * <ul><li>256 bits (each of key1 and key2 is a 128-bit key)</li>
202 * <li>512 bits (each of key1 and key2 is a 256-bit key)</li></ul>
203 *
204 * \return \c 0 on success.
205 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
206 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200207MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100208int mbedtls_aes_xts_setkey_enc(mbedtls_aes_xts_context *ctx,
209 const unsigned char *key,
210 unsigned int keybits);
Jaeden Amero9366feb2018-05-29 18:55:17 +0100211
212/**
213 * \brief This function prepares an XTS context for decryption and
214 * sets the decryption key.
215 *
216 * \param ctx The AES XTS context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500217 * It must be initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100218 * \param key The decryption key. This is comprised of the XTS key1
219 * concatenated with the XTS key2.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500220 * This must be a readable buffer of size \p keybits bits.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100221 * \param keybits The size of \p key passed in bits. Valid options are:
222 * <ul><li>256 bits (each of key1 and key2 is a 128-bit key)</li>
223 * <li>512 bits (each of key1 and key2 is a 256-bit key)</li></ul>
224 *
225 * \return \c 0 on success.
226 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
227 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200228MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100229int mbedtls_aes_xts_setkey_dec(mbedtls_aes_xts_context *ctx,
230 const unsigned char *key,
231 unsigned int keybits);
Jaeden Amero9366feb2018-05-29 18:55:17 +0100232#endif /* MBEDTLS_CIPHER_MODE_XTS */
233
Paul Bakker5121ce52009-01-03 21:22:43 +0000234/**
Rose Zadik7f441272018-01-22 11:48:23 +0000235 * \brief This function performs an AES single-block encryption or
236 * decryption operation.
Paul Bakker5121ce52009-01-03 21:22:43 +0000237 *
Rose Zadik7f441272018-01-22 11:48:23 +0000238 * It performs the operation defined in the \p mode parameter
239 * (encrypt or decrypt), on the input data buffer defined in
240 * the \p input parameter.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000241 *
Rose Zadik7f441272018-01-22 11:48:23 +0000242 * mbedtls_aes_init(), and either mbedtls_aes_setkey_enc() or
243 * mbedtls_aes_setkey_dec() must be called before the first
244 * call to this API with the same context.
245 *
246 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500247 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000248 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
249 * #MBEDTLS_AES_DECRYPT.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500250 * \param input The buffer holding the input data.
251 * It must be readable and at least \c 16 Bytes long.
252 * \param output The buffer where the output data will be written.
253 * It must be writeable and at least \c 16 Bytes long.
Rose Zadik7f441272018-01-22 11:48:23 +0000254
255 * \return \c 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +0000256 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200257MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100258int mbedtls_aes_crypt_ecb(mbedtls_aes_context *ctx,
259 int mode,
260 const unsigned char input[16],
261 unsigned char output[16]);
Paul Bakker5121ce52009-01-03 21:22:43 +0000262
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200263#if defined(MBEDTLS_CIPHER_MODE_CBC)
Paul Bakker5121ce52009-01-03 21:22:43 +0000264/**
Rose Zadik7f441272018-01-22 11:48:23 +0000265 * \brief This function performs an AES-CBC encryption or decryption operation
266 * on full blocks.
Paul Bakker5121ce52009-01-03 21:22:43 +0000267 *
Rose Zadik7f441272018-01-22 11:48:23 +0000268 * It performs the operation defined in the \p mode
269 * parameter (encrypt/decrypt), on the input data buffer defined in
270 * the \p input parameter.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000271 *
Rose Zadik7f441272018-01-22 11:48:23 +0000272 * It can be called as many times as needed, until all the input
273 * data is processed. mbedtls_aes_init(), and either
274 * mbedtls_aes_setkey_enc() or mbedtls_aes_setkey_dec() must be called
275 * before the first call to this API with the same context.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000276 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500277 * \note This function operates on full blocks, that is, the input size
278 * must be a multiple of the AES block size of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000279 *
280 * \note Upon exit, the content of the IV is updated so that you can
281 * call the same function again on the next
282 * block(s) of data and get the same result as if it was
283 * encrypted in one call. This allows a "streaming" usage.
284 * If you need to retain the contents of the IV, you should
285 * either save it manually or use the cipher module instead.
286 *
287 *
288 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500289 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000290 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
291 * #MBEDTLS_AES_DECRYPT.
292 * \param length The length of the input data in Bytes. This must be a
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500293 * multiple of the block size (\c 16 Bytes).
Rose Zadik7f441272018-01-22 11:48:23 +0000294 * \param iv Initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500295 * It must be a readable and writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000296 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500297 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000298 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500299 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000300 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100301 * \return \c 0 on success.
302 * \return #MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH
Rose Zadik7f441272018-01-22 11:48:23 +0000303 * on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000304 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200305MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100306int mbedtls_aes_crypt_cbc(mbedtls_aes_context *ctx,
307 int mode,
308 size_t length,
309 unsigned char iv[16],
310 const unsigned char *input,
311 unsigned char *output);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312#endif /* MBEDTLS_CIPHER_MODE_CBC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000313
Aorimn5f778012016-06-09 23:22:58 +0200314#if defined(MBEDTLS_CIPHER_MODE_XTS)
315/**
Jaeden Amero9366feb2018-05-29 18:55:17 +0100316 * \brief This function performs an AES-XTS encryption or decryption
317 * operation for an entire XTS data unit.
Aorimn5f778012016-06-09 23:22:58 +0200318 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100319 * AES-XTS encrypts or decrypts blocks based on their location as
320 * defined by a data unit number. The data unit number must be
Jaeden Amerocd9fc5e2018-05-30 15:23:24 +0100321 * provided by \p data_unit.
Aorimn5f778012016-06-09 23:22:58 +0200322 *
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100323 * NIST SP 800-38E limits the maximum size of a data unit to 2^20
324 * AES blocks. If the data unit is larger than this, this function
325 * returns #MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH.
326 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100327 * \param ctx The AES XTS context to use for AES XTS operations.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500328 * It must be initialized and bound to a key.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100329 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
330 * #MBEDTLS_AES_DECRYPT.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500331 * \param length The length of a data unit in Bytes. This can be any
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100332 * length between 16 bytes and 2^24 bytes inclusive
333 * (between 1 and 2^20 block cipher blocks).
Jaeden Amerocd9fc5e2018-05-30 15:23:24 +0100334 * \param data_unit The address of the data unit encoded as an array of 16
Jaeden Amero9366feb2018-05-29 18:55:17 +0100335 * bytes in little-endian format. For disk encryption, this
336 * is typically the index of the block device sector that
337 * contains the data.
338 * \param input The buffer holding the input data (which is an entire
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500339 * data unit). This function reads \p length Bytes from \p
Jaeden Amero9366feb2018-05-29 18:55:17 +0100340 * input.
341 * \param output The buffer holding the output data (which is an entire
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500342 * data unit). This function writes \p length Bytes to \p
Jaeden Amero9366feb2018-05-29 18:55:17 +0100343 * output.
Aorimn5f778012016-06-09 23:22:58 +0200344 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100345 * \return \c 0 on success.
346 * \return #MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH if \p length is
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500347 * smaller than an AES block in size (16 Bytes) or if \p
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100348 * length is larger than 2^20 blocks (16 MiB).
Aorimn5f778012016-06-09 23:22:58 +0200349 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200350MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100351int mbedtls_aes_crypt_xts(mbedtls_aes_xts_context *ctx,
352 int mode,
353 size_t length,
354 const unsigned char data_unit[16],
355 const unsigned char *input,
356 unsigned char *output);
Aorimn5f778012016-06-09 23:22:58 +0200357#endif /* MBEDTLS_CIPHER_MODE_XTS */
358
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200359#if defined(MBEDTLS_CIPHER_MODE_CFB)
Paul Bakker5121ce52009-01-03 21:22:43 +0000360/**
Rose Zadik7f441272018-01-22 11:48:23 +0000361 * \brief This function performs an AES-CFB128 encryption or decryption
362 * operation.
Paul Bakker5121ce52009-01-03 21:22:43 +0000363 *
Rose Zadik7f441272018-01-22 11:48:23 +0000364 * It performs the operation defined in the \p mode
365 * parameter (encrypt or decrypt), on the input data buffer
366 * defined in the \p input parameter.
Paul Bakkerca6f3e22011-10-06 13:11:08 +0000367 *
Rose Zadik7f441272018-01-22 11:48:23 +0000368 * For CFB, you must set up the context with mbedtls_aes_setkey_enc(),
369 * regardless of whether you are performing an encryption or decryption
370 * operation, that is, regardless of the \p mode parameter. This is
371 * because CFB mode uses the same key schedule for encryption and
372 * decryption.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000373 *
Rose Zadik7f441272018-01-22 11:48:23 +0000374 * \note Upon exit, the content of the IV is updated so that you can
375 * call the same function again on the next
376 * block(s) of data and get the same result as if it was
377 * encrypted in one call. This allows a "streaming" usage.
378 * If you need to retain the contents of the
379 * IV, you must either save it manually or use the cipher
380 * module instead.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000381 *
Rose Zadik7f441272018-01-22 11:48:23 +0000382 *
383 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500384 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000385 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
386 * #MBEDTLS_AES_DECRYPT.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500387 * \param length The length of the input data in Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000388 * \param iv_off The offset in IV (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500389 * It must point to a valid \c size_t.
Rose Zadik7f441272018-01-22 11:48:23 +0000390 * \param iv The initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500391 * It must be a readable and writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000392 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500393 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000394 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500395 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000396 *
397 * \return \c 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +0000398 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200399MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100400int mbedtls_aes_crypt_cfb128(mbedtls_aes_context *ctx,
401 int mode,
402 size_t length,
403 size_t *iv_off,
404 unsigned char iv[16],
405 const unsigned char *input,
406 unsigned char *output);
Paul Bakker5121ce52009-01-03 21:22:43 +0000407
Paul Bakker9a736322012-11-14 12:39:52 +0000408/**
Rose Zadik7f441272018-01-22 11:48:23 +0000409 * \brief This function performs an AES-CFB8 encryption or decryption
410 * operation.
Paul Bakker556efba2014-01-24 15:38:12 +0100411 *
Rose Zadik7f441272018-01-22 11:48:23 +0000412 * It performs the operation defined in the \p mode
413 * parameter (encrypt/decrypt), on the input data buffer defined
414 * in the \p input parameter.
Paul Bakker556efba2014-01-24 15:38:12 +0100415 *
Rose Zadik7f441272018-01-22 11:48:23 +0000416 * Due to the nature of CFB, you must use the same key schedule for
417 * both encryption and decryption operations. Therefore, you must
418 * use the context initialized with mbedtls_aes_setkey_enc() for
419 * both #MBEDTLS_AES_ENCRYPT and #MBEDTLS_AES_DECRYPT.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000420 *
Rose Zadik7f441272018-01-22 11:48:23 +0000421 * \note Upon exit, the content of the IV is updated so that you can
422 * call the same function again on the next
423 * block(s) of data and get the same result as if it was
424 * encrypted in one call. This allows a "streaming" usage.
425 * If you need to retain the contents of the
426 * IV, you should either save it manually or use the cipher
427 * module instead.
Paul Bakker556efba2014-01-24 15:38:12 +0100428 *
Rose Zadik7f441272018-01-22 11:48:23 +0000429 *
430 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500431 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000432 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
433 * #MBEDTLS_AES_DECRYPT
434 * \param length The length of the input data.
435 * \param iv The initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500436 * It must be a readable and writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000437 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500438 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000439 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500440 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000441 *
442 * \return \c 0 on success.
Paul Bakker556efba2014-01-24 15:38:12 +0100443 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200444MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100445int mbedtls_aes_crypt_cfb8(mbedtls_aes_context *ctx,
446 int mode,
447 size_t length,
448 unsigned char iv[16],
449 const unsigned char *input,
450 unsigned char *output);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200451#endif /*MBEDTLS_CIPHER_MODE_CFB */
Paul Bakker556efba2014-01-24 15:38:12 +0100452
Simon Butcher76a5b222018-04-22 22:57:27 +0100453#if defined(MBEDTLS_CIPHER_MODE_OFB)
454/**
Simon Butcher5db13622018-06-04 22:11:25 +0100455 * \brief This function performs an AES-OFB (Output Feedback Mode)
456 * encryption or decryption operation.
Simon Butcher76a5b222018-04-22 22:57:27 +0100457 *
Simon Butcher5db13622018-06-04 22:11:25 +0100458 * For OFB, you must set up the context with
459 * mbedtls_aes_setkey_enc(), regardless of whether you are
460 * performing an encryption or decryption operation. This is
461 * because OFB mode uses the same key schedule for encryption and
462 * decryption.
Simon Butcher76a5b222018-04-22 22:57:27 +0100463 *
Simon Butcher5db13622018-06-04 22:11:25 +0100464 * The OFB operation is identical for encryption or decryption,
465 * therefore no operation mode needs to be specified.
Simon Butcher76a5b222018-04-22 22:57:27 +0100466 *
Simon Butcher5db13622018-06-04 22:11:25 +0100467 * \note Upon exit, the content of iv, the Initialisation Vector, is
468 * updated so that you can call the same function again on the next
469 * block(s) of data and get the same result as if it was encrypted
470 * in one call. This allows a "streaming" usage, by initialising
471 * iv_off to 0 before the first call, and preserving its value
472 * between calls.
Simon Butcher968646c2018-06-02 18:27:04 +0100473 *
Simon Butcher5db13622018-06-04 22:11:25 +0100474 * For non-streaming use, the iv should be initialised on each call
475 * to a unique value, and iv_off set to 0 on each call.
Simon Butcher968646c2018-06-02 18:27:04 +0100476 *
Simon Butcher5db13622018-06-04 22:11:25 +0100477 * If you need to retain the contents of the initialisation vector,
478 * you must either save it manually or use the cipher module
479 * instead.
Simon Butcher968646c2018-06-02 18:27:04 +0100480 *
Jaeden Amerocb2c9352018-06-08 10:34:08 +0100481 * \warning For the OFB mode, the initialisation vector must be unique
482 * every encryption operation. Reuse of an initialisation vector
483 * will compromise security.
Simon Butcher76a5b222018-04-22 22:57:27 +0100484 *
485 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500486 * It must be initialized and bound to a key.
Simon Butcher76a5b222018-04-22 22:57:27 +0100487 * \param length The length of the input data.
488 * \param iv_off The offset in IV (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500489 * It must point to a valid \c size_t.
Simon Butcher76a5b222018-04-22 22:57:27 +0100490 * \param iv The initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500491 * It must be a readable and writeable buffer of \c 16 Bytes.
Simon Butcher76a5b222018-04-22 22:57:27 +0100492 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500493 * It must be readable and of size \p length Bytes.
Simon Butcher76a5b222018-04-22 22:57:27 +0100494 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500495 * It must be writeable and of size \p length Bytes.
Simon Butcher76a5b222018-04-22 22:57:27 +0100496 *
497 * \return \c 0 on success.
498 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200499MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100500int mbedtls_aes_crypt_ofb(mbedtls_aes_context *ctx,
501 size_t length,
502 size_t *iv_off,
503 unsigned char iv[16],
504 const unsigned char *input,
505 unsigned char *output);
Simon Butcher76a5b222018-04-22 22:57:27 +0100506
507#endif /* MBEDTLS_CIPHER_MODE_OFB */
508
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200509#if defined(MBEDTLS_CIPHER_MODE_CTR)
Paul Bakker556efba2014-01-24 15:38:12 +0100510/**
Rose Zadik7f441272018-01-22 11:48:23 +0000511 * \brief This function performs an AES-CTR encryption or decryption
512 * operation.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000513 *
Rose Zadik7f441272018-01-22 11:48:23 +0000514 * Due to the nature of CTR, you must use the same key schedule
515 * for both encryption and decryption operations. Therefore, you
516 * must use the context initialized with mbedtls_aes_setkey_enc()
517 * for both #MBEDTLS_AES_ENCRYPT and #MBEDTLS_AES_DECRYPT.
Paul Bakkerca6f3e22011-10-06 13:11:08 +0000518 *
Manuel Pégourié-Gonnard22997b72018-02-28 12:29:41 +0100519 * \warning You must never reuse a nonce value with the same key. Doing so
520 * would void the encryption for the two messages encrypted with
521 * the same nonce and key.
522 *
523 * There are two common strategies for managing nonces with CTR:
524 *
Manuel Pégourié-Gonnard4f24e952018-05-24 11:59:30 +0200525 * 1. You can handle everything as a single message processed over
526 * successive calls to this function. In that case, you want to
527 * set \p nonce_counter and \p nc_off to 0 for the first call, and
528 * then preserve the values of \p nonce_counter, \p nc_off and \p
529 * stream_block across calls to this function as they will be
530 * updated by this function.
Manuel Pégourié-Gonnard22997b72018-02-28 12:29:41 +0100531 *
Manuel Pégourié-Gonnard4f24e952018-05-24 11:59:30 +0200532 * With this strategy, you must not encrypt more than 2**128
533 * blocks of data with the same key.
534 *
535 * 2. You can encrypt separate messages by dividing the \p
536 * nonce_counter buffer in two areas: the first one used for a
537 * per-message nonce, handled by yourself, and the second one
538 * updated by this function internally.
539 *
540 * For example, you might reserve the first 12 bytes for the
541 * per-message nonce, and the last 4 bytes for internal use. In that
542 * case, before calling this function on a new message you need to
543 * set the first 12 bytes of \p nonce_counter to your chosen nonce
544 * value, the last 4 to 0, and \p nc_off to 0 (which will cause \p
545 * stream_block to be ignored). That way, you can encrypt at most
546 * 2**96 messages of up to 2**32 blocks each with the same key.
547 *
548 * The per-message nonce (or information sufficient to reconstruct
549 * it) needs to be communicated with the ciphertext and must be unique.
550 * The recommended way to ensure uniqueness is to use a message
551 * counter. An alternative is to generate random nonces, but this
552 * limits the number of messages that can be securely encrypted:
553 * for example, with 96-bit random nonces, you should not encrypt
554 * more than 2**32 messages with the same key.
555 *
Tom Cosgrove1e211442022-05-26 11:51:00 +0100556 * Note that for both strategies, sizes are measured in blocks and
Manuel Pégourié-Gonnard4f24e952018-05-24 11:59:30 +0200557 * that an AES block is 16 bytes.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000558 *
Manuel Pégourié-Gonnardfa0c47d2018-05-24 19:02:06 +0200559 * \warning Upon return, \p stream_block contains sensitive data. Its
560 * content must not be written to insecure storage and should be
561 * securely discarded as soon as it's no longer needed.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000562 *
Rose Zadik7f441272018-01-22 11:48:23 +0000563 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500564 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000565 * \param length The length of the input data.
566 * \param nc_off The offset in the current \p stream_block, for
567 * resuming within the current cipher stream. The
568 * offset pointer should be 0 at the start of a stream.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500569 * It must point to a valid \c size_t.
Rose Zadik7f441272018-01-22 11:48:23 +0000570 * \param nonce_counter The 128-bit nonce and counter.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500571 * It must be a readable-writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000572 * \param stream_block The saved stream block for resuming. This is
573 * overwritten by the function.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500574 * It must be a readable-writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000575 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500576 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000577 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500578 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000579 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100580 * \return \c 0 on success.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000581 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200582MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100583int mbedtls_aes_crypt_ctr(mbedtls_aes_context *ctx,
584 size_t length,
585 size_t *nc_off,
586 unsigned char nonce_counter[16],
587 unsigned char stream_block[16],
588 const unsigned char *input,
589 unsigned char *output);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200590#endif /* MBEDTLS_CIPHER_MODE_CTR */
Paul Bakker90995b52013-06-24 19:20:35 +0200591
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200592/**
Rose Zadik7f441272018-01-22 11:48:23 +0000593 * \brief Internal AES block encryption function. This is only
594 * exposed to allow overriding it using
595 * \c MBEDTLS_AES_ENCRYPT_ALT.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200596 *
Rose Zadik7f441272018-01-22 11:48:23 +0000597 * \param ctx The AES context to use for encryption.
598 * \param input The plaintext block.
599 * \param output The output (ciphertext) block.
Andres AGf5bf7182017-03-03 14:09:56 +0000600 *
Rose Zadik7f441272018-01-22 11:48:23 +0000601 * \return \c 0 on success.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200602 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200603MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100604int mbedtls_internal_aes_encrypt(mbedtls_aes_context *ctx,
605 const unsigned char input[16],
606 unsigned char output[16]);
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200607
608/**
Rose Zadik7f441272018-01-22 11:48:23 +0000609 * \brief Internal AES block decryption function. This is only
610 * exposed to allow overriding it using see
611 * \c MBEDTLS_AES_DECRYPT_ALT.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200612 *
Rose Zadik7f441272018-01-22 11:48:23 +0000613 * \param ctx The AES context to use for decryption.
614 * \param input The ciphertext block.
615 * \param output The output (plaintext) block.
Andres AGf5bf7182017-03-03 14:09:56 +0000616 *
Rose Zadik7f441272018-01-22 11:48:23 +0000617 * \return \c 0 on success.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200618 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200619MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100620int mbedtls_internal_aes_decrypt(mbedtls_aes_context *ctx,
621 const unsigned char input[16],
622 unsigned char output[16]);
Andres AGf5bf7182017-03-03 14:09:56 +0000623
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500624#if defined(MBEDTLS_SELF_TEST)
Paul Bakker5121ce52009-01-03 21:22:43 +0000625/**
Rose Zadik7f441272018-01-22 11:48:23 +0000626 * \brief Checkup routine.
Paul Bakker5121ce52009-01-03 21:22:43 +0000627 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100628 * \return \c 0 on success.
629 * \return \c 1 on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000630 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200631MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100632int mbedtls_aes_self_test(int verbose);
Paul Bakker5121ce52009-01-03 21:22:43 +0000633
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500634#endif /* MBEDTLS_SELF_TEST */
635
Paul Bakker5121ce52009-01-03 21:22:43 +0000636#ifdef __cplusplus
637}
638#endif
639
640#endif /* aes.h */