blob: 42e1fe85509e962a7a2ae22b52e77ca4a19a4a16 [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. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +020079 uint32_t MBEDTLS_PRIVATE(buf)[68]; /*!< Unaligned data buffer. This buffer can
Gilles Peskine449bd832023-01-11 14:50:10 +010080 hold 32 extra Bytes, which can be used for
81 one of the following purposes:
82 <ul><li>Alignment if VIA padlock is
83 used.</li>
84 <li>Simplifying key expansion in the 256-bit
85 case by generating an extra round key.
86 </li></ul> */
Paul Bakker5121ce52009-01-03 21:22:43 +000087}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020088mbedtls_aes_context;
Paul Bakker5121ce52009-01-03 21:22:43 +000089
Jaeden Amero9366feb2018-05-29 18:55:17 +010090#if defined(MBEDTLS_CIPHER_MODE_XTS)
91/**
92 * \brief The AES XTS context-type definition.
93 */
Gilles Peskine449bd832023-01-11 14:50:10 +010094typedef struct mbedtls_aes_xts_context {
Mateusz Starzyk846f0212021-05-19 19:44:07 +020095 mbedtls_aes_context MBEDTLS_PRIVATE(crypt); /*!< The AES context to use for AES block
Gilles Peskine449bd832023-01-11 14:50:10 +010096 encryption or decryption. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +020097 mbedtls_aes_context MBEDTLS_PRIVATE(tweak); /*!< The AES context used for tweak
Gilles Peskine449bd832023-01-11 14:50:10 +010098 computation. */
Jaeden Amero9366feb2018-05-29 18:55:17 +010099} mbedtls_aes_xts_context;
100#endif /* MBEDTLS_CIPHER_MODE_XTS */
101
Ron Eldorb2aacec2017-05-18 16:53:08 +0300102#else /* MBEDTLS_AES_ALT */
103#include "aes_alt.h"
104#endif /* MBEDTLS_AES_ALT */
105
Paul Bakker5121ce52009-01-03 21:22:43 +0000106/**
Rose Zadik7f441272018-01-22 11:48:23 +0000107 * \brief This function initializes the specified AES context.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200108 *
Rose Zadik7f441272018-01-22 11:48:23 +0000109 * It must be the first API called before using
110 * the context.
111 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500112 * \param ctx The AES context to initialize. This must not be \c NULL.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200113 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100114void mbedtls_aes_init(mbedtls_aes_context *ctx);
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200115
116/**
Rose Zadik7f441272018-01-22 11:48:23 +0000117 * \brief This function releases and clears the specified AES context.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200118 *
Rose Zadik7f441272018-01-22 11:48:23 +0000119 * \param ctx The AES context to clear.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500120 * If this is \c NULL, this function does nothing.
121 * Otherwise, the context must have been at least initialized.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200122 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100123void mbedtls_aes_free(mbedtls_aes_context *ctx);
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200124
Jaeden Amero9366feb2018-05-29 18:55:17 +0100125#if defined(MBEDTLS_CIPHER_MODE_XTS)
126/**
127 * \brief This function initializes the specified AES XTS context.
128 *
129 * It must be the first API called before using
130 * the context.
131 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500132 * \param ctx The AES XTS context to initialize. This must not be \c NULL.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100133 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100134void mbedtls_aes_xts_init(mbedtls_aes_xts_context *ctx);
Jaeden Amero9366feb2018-05-29 18:55:17 +0100135
136/**
137 * \brief This function releases and clears the specified AES XTS context.
138 *
139 * \param ctx The AES XTS context to clear.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500140 * If this is \c NULL, this function does nothing.
141 * Otherwise, the context must have been at least initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100142 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100143void mbedtls_aes_xts_free(mbedtls_aes_xts_context *ctx);
Jaeden Amero9366feb2018-05-29 18:55:17 +0100144#endif /* MBEDTLS_CIPHER_MODE_XTS */
145
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200146/**
Rose Zadik7f441272018-01-22 11:48:23 +0000147 * \brief This function sets the encryption key.
Paul Bakker5121ce52009-01-03 21:22:43 +0000148 *
Rose Zadik7f441272018-01-22 11:48:23 +0000149 * \param ctx The AES context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500150 * It must be initialized.
Rose Zadik7f441272018-01-22 11:48:23 +0000151 * \param key The encryption key.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500152 * This must be a readable buffer of size \p keybits bits.
Rose Zadik7f441272018-01-22 11:48:23 +0000153 * \param keybits The size of data passed in bits. Valid options are:
154 * <ul><li>128 bits</li>
155 * <li>192 bits</li>
156 * <li>256 bits</li></ul>
Paul Bakker2b222c82009-07-27 21:03:45 +0000157 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100158 * \return \c 0 on success.
Rose Zadik819d13d2018-04-16 09:35:15 +0100159 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000160 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200161MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100162int mbedtls_aes_setkey_enc(mbedtls_aes_context *ctx, const unsigned char *key,
163 unsigned int keybits);
Paul Bakker5121ce52009-01-03 21:22:43 +0000164
165/**
Rose Zadik7f441272018-01-22 11:48:23 +0000166 * \brief This function sets the decryption key.
Paul Bakker5121ce52009-01-03 21:22:43 +0000167 *
Rose Zadik7f441272018-01-22 11:48:23 +0000168 * \param ctx The AES context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500169 * It must be initialized.
Rose Zadik7f441272018-01-22 11:48:23 +0000170 * \param key The decryption key.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500171 * This must be a readable buffer of size \p keybits bits.
Rose Zadik7f441272018-01-22 11:48:23 +0000172 * \param keybits The size of data passed. Valid options are:
173 * <ul><li>128 bits</li>
174 * <li>192 bits</li>
175 * <li>256 bits</li></ul>
Paul Bakker2b222c82009-07-27 21:03:45 +0000176 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100177 * \return \c 0 on success.
178 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000179 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200180MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100181int mbedtls_aes_setkey_dec(mbedtls_aes_context *ctx, const unsigned char *key,
182 unsigned int keybits);
Paul Bakker5121ce52009-01-03 21:22:43 +0000183
Jaeden Amero9366feb2018-05-29 18:55:17 +0100184#if defined(MBEDTLS_CIPHER_MODE_XTS)
185/**
186 * \brief This function prepares an XTS context for encryption and
187 * sets the encryption key.
188 *
189 * \param ctx The AES XTS context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500190 * It must be initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100191 * \param key The encryption key. This is comprised of the XTS key1
192 * concatenated with the XTS key2.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500193 * This must be a readable buffer of size \p keybits bits.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100194 * \param keybits The size of \p key passed in bits. Valid options are:
195 * <ul><li>256 bits (each of key1 and key2 is a 128-bit key)</li>
196 * <li>512 bits (each of key1 and key2 is a 256-bit key)</li></ul>
197 *
198 * \return \c 0 on success.
199 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
200 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200201MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100202int mbedtls_aes_xts_setkey_enc(mbedtls_aes_xts_context *ctx,
203 const unsigned char *key,
204 unsigned int keybits);
Jaeden Amero9366feb2018-05-29 18:55:17 +0100205
206/**
207 * \brief This function prepares an XTS context for decryption and
208 * sets the decryption key.
209 *
210 * \param ctx The AES XTS context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500211 * It must be initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100212 * \param key The decryption key. This is comprised of the XTS key1
213 * concatenated with the XTS key2.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500214 * This must be a readable buffer of size \p keybits bits.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100215 * \param keybits The size of \p key passed in bits. Valid options are:
216 * <ul><li>256 bits (each of key1 and key2 is a 128-bit key)</li>
217 * <li>512 bits (each of key1 and key2 is a 256-bit key)</li></ul>
218 *
219 * \return \c 0 on success.
220 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
221 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200222MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100223int mbedtls_aes_xts_setkey_dec(mbedtls_aes_xts_context *ctx,
224 const unsigned char *key,
225 unsigned int keybits);
Jaeden Amero9366feb2018-05-29 18:55:17 +0100226#endif /* MBEDTLS_CIPHER_MODE_XTS */
227
Paul Bakker5121ce52009-01-03 21:22:43 +0000228/**
Rose Zadik7f441272018-01-22 11:48:23 +0000229 * \brief This function performs an AES single-block encryption or
230 * decryption operation.
Paul Bakker5121ce52009-01-03 21:22:43 +0000231 *
Rose Zadik7f441272018-01-22 11:48:23 +0000232 * It performs the operation defined in the \p mode parameter
233 * (encrypt or decrypt), on the input data buffer defined in
234 * the \p input parameter.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000235 *
Rose Zadik7f441272018-01-22 11:48:23 +0000236 * mbedtls_aes_init(), and either mbedtls_aes_setkey_enc() or
237 * mbedtls_aes_setkey_dec() must be called before the first
238 * call to this API with the same context.
239 *
240 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500241 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000242 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
243 * #MBEDTLS_AES_DECRYPT.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500244 * \param input The buffer holding the input data.
245 * It must be readable and at least \c 16 Bytes long.
246 * \param output The buffer where the output data will be written.
247 * It must be writeable and at least \c 16 Bytes long.
Rose Zadik7f441272018-01-22 11:48:23 +0000248
249 * \return \c 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +0000250 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200251MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100252int mbedtls_aes_crypt_ecb(mbedtls_aes_context *ctx,
253 int mode,
254 const unsigned char input[16],
255 unsigned char output[16]);
Paul Bakker5121ce52009-01-03 21:22:43 +0000256
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200257#if defined(MBEDTLS_CIPHER_MODE_CBC)
Paul Bakker5121ce52009-01-03 21:22:43 +0000258/**
Rose Zadik7f441272018-01-22 11:48:23 +0000259 * \brief This function performs an AES-CBC encryption or decryption operation
260 * on full blocks.
Paul Bakker5121ce52009-01-03 21:22:43 +0000261 *
Rose Zadik7f441272018-01-22 11:48:23 +0000262 * It performs the operation defined in the \p mode
263 * parameter (encrypt/decrypt), on the input data buffer defined in
264 * the \p input parameter.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000265 *
Rose Zadik7f441272018-01-22 11:48:23 +0000266 * It can be called as many times as needed, until all the input
267 * data is processed. mbedtls_aes_init(), and either
268 * mbedtls_aes_setkey_enc() or mbedtls_aes_setkey_dec() must be called
269 * before the first call to this API with the same context.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000270 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500271 * \note This function operates on full blocks, that is, the input size
272 * must be a multiple of the AES block size of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000273 *
274 * \note Upon exit, the content of the IV is updated so that you can
275 * call the same function again on the next
276 * block(s) of data and get the same result as if it was
277 * encrypted in one call. This allows a "streaming" usage.
278 * If you need to retain the contents of the IV, you should
279 * either save it manually or use the cipher module instead.
280 *
281 *
282 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500283 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000284 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
285 * #MBEDTLS_AES_DECRYPT.
286 * \param length The length of the input data in Bytes. This must be a
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500287 * multiple of the block size (\c 16 Bytes).
Rose Zadik7f441272018-01-22 11:48:23 +0000288 * \param iv Initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500289 * It must be a readable and writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000290 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500291 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000292 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500293 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000294 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100295 * \return \c 0 on success.
296 * \return #MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH
Rose Zadik7f441272018-01-22 11:48:23 +0000297 * on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000298 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200299MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100300int mbedtls_aes_crypt_cbc(mbedtls_aes_context *ctx,
301 int mode,
302 size_t length,
303 unsigned char iv[16],
304 const unsigned char *input,
305 unsigned char *output);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200306#endif /* MBEDTLS_CIPHER_MODE_CBC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000307
Aorimn5f778012016-06-09 23:22:58 +0200308#if defined(MBEDTLS_CIPHER_MODE_XTS)
309/**
Jaeden Amero9366feb2018-05-29 18:55:17 +0100310 * \brief This function performs an AES-XTS encryption or decryption
311 * operation for an entire XTS data unit.
Aorimn5f778012016-06-09 23:22:58 +0200312 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100313 * AES-XTS encrypts or decrypts blocks based on their location as
314 * defined by a data unit number. The data unit number must be
Jaeden Amerocd9fc5e2018-05-30 15:23:24 +0100315 * provided by \p data_unit.
Aorimn5f778012016-06-09 23:22:58 +0200316 *
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100317 * NIST SP 800-38E limits the maximum size of a data unit to 2^20
318 * AES blocks. If the data unit is larger than this, this function
319 * returns #MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH.
320 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100321 * \param ctx The AES XTS context to use for AES XTS operations.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500322 * It must be initialized and bound to a key.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100323 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
324 * #MBEDTLS_AES_DECRYPT.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500325 * \param length The length of a data unit in Bytes. This can be any
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100326 * length between 16 bytes and 2^24 bytes inclusive
327 * (between 1 and 2^20 block cipher blocks).
Jaeden Amerocd9fc5e2018-05-30 15:23:24 +0100328 * \param data_unit The address of the data unit encoded as an array of 16
Jaeden Amero9366feb2018-05-29 18:55:17 +0100329 * bytes in little-endian format. For disk encryption, this
330 * is typically the index of the block device sector that
331 * contains the data.
332 * \param input The buffer holding the input data (which is an entire
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500333 * data unit). This function reads \p length Bytes from \p
Jaeden Amero9366feb2018-05-29 18:55:17 +0100334 * input.
335 * \param output The buffer holding the output data (which is an entire
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500336 * data unit). This function writes \p length Bytes to \p
Jaeden Amero9366feb2018-05-29 18:55:17 +0100337 * output.
Aorimn5f778012016-06-09 23:22:58 +0200338 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100339 * \return \c 0 on success.
340 * \return #MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH if \p length is
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500341 * smaller than an AES block in size (16 Bytes) or if \p
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100342 * length is larger than 2^20 blocks (16 MiB).
Aorimn5f778012016-06-09 23:22:58 +0200343 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200344MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100345int mbedtls_aes_crypt_xts(mbedtls_aes_xts_context *ctx,
346 int mode,
347 size_t length,
348 const unsigned char data_unit[16],
349 const unsigned char *input,
350 unsigned char *output);
Aorimn5f778012016-06-09 23:22:58 +0200351#endif /* MBEDTLS_CIPHER_MODE_XTS */
352
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200353#if defined(MBEDTLS_CIPHER_MODE_CFB)
Paul Bakker5121ce52009-01-03 21:22:43 +0000354/**
Rose Zadik7f441272018-01-22 11:48:23 +0000355 * \brief This function performs an AES-CFB128 encryption or decryption
356 * operation.
Paul Bakker5121ce52009-01-03 21:22:43 +0000357 *
Rose Zadik7f441272018-01-22 11:48:23 +0000358 * It performs the operation defined in the \p mode
359 * parameter (encrypt or decrypt), on the input data buffer
360 * defined in the \p input parameter.
Paul Bakkerca6f3e22011-10-06 13:11:08 +0000361 *
Rose Zadik7f441272018-01-22 11:48:23 +0000362 * For CFB, you must set up the context with mbedtls_aes_setkey_enc(),
363 * regardless of whether you are performing an encryption or decryption
364 * operation, that is, regardless of the \p mode parameter. This is
365 * because CFB mode uses the same key schedule for encryption and
366 * decryption.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000367 *
Rose Zadik7f441272018-01-22 11:48:23 +0000368 * \note Upon exit, the content of the IV is updated so that you can
369 * call the same function again on the next
370 * block(s) of data and get the same result as if it was
371 * encrypted in one call. This allows a "streaming" usage.
372 * If you need to retain the contents of the
373 * IV, you must either save it manually or use the cipher
374 * module instead.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000375 *
Rose Zadik7f441272018-01-22 11:48:23 +0000376 *
377 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500378 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000379 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
380 * #MBEDTLS_AES_DECRYPT.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500381 * \param length The length of the input data in Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000382 * \param iv_off The offset in IV (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500383 * It must point to a valid \c size_t.
Rose Zadik7f441272018-01-22 11:48:23 +0000384 * \param iv The initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500385 * It must be a readable and writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000386 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500387 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000388 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500389 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000390 *
391 * \return \c 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +0000392 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200393MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100394int mbedtls_aes_crypt_cfb128(mbedtls_aes_context *ctx,
395 int mode,
396 size_t length,
397 size_t *iv_off,
398 unsigned char iv[16],
399 const unsigned char *input,
400 unsigned char *output);
Paul Bakker5121ce52009-01-03 21:22:43 +0000401
Paul Bakker9a736322012-11-14 12:39:52 +0000402/**
Rose Zadik7f441272018-01-22 11:48:23 +0000403 * \brief This function performs an AES-CFB8 encryption or decryption
404 * operation.
Paul Bakker556efba2014-01-24 15:38:12 +0100405 *
Rose Zadik7f441272018-01-22 11:48:23 +0000406 * It performs the operation defined in the \p mode
407 * parameter (encrypt/decrypt), on the input data buffer defined
408 * in the \p input parameter.
Paul Bakker556efba2014-01-24 15:38:12 +0100409 *
Rose Zadik7f441272018-01-22 11:48:23 +0000410 * Due to the nature of CFB, you must use the same key schedule for
411 * both encryption and decryption operations. Therefore, you must
412 * use the context initialized with mbedtls_aes_setkey_enc() for
413 * both #MBEDTLS_AES_ENCRYPT and #MBEDTLS_AES_DECRYPT.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000414 *
Rose Zadik7f441272018-01-22 11:48:23 +0000415 * \note Upon exit, the content of the IV is updated so that you can
416 * call the same function again on the next
417 * block(s) of data and get the same result as if it was
418 * encrypted in one call. This allows a "streaming" usage.
419 * If you need to retain the contents of the
420 * IV, you should either save it manually or use the cipher
421 * module instead.
Paul Bakker556efba2014-01-24 15:38:12 +0100422 *
Rose Zadik7f441272018-01-22 11:48:23 +0000423 *
424 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500425 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000426 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
427 * #MBEDTLS_AES_DECRYPT
428 * \param length The length of the input data.
429 * \param iv The initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500430 * It must be a readable and writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000431 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500432 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000433 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500434 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000435 *
436 * \return \c 0 on success.
Paul Bakker556efba2014-01-24 15:38:12 +0100437 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200438MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100439int mbedtls_aes_crypt_cfb8(mbedtls_aes_context *ctx,
440 int mode,
441 size_t length,
442 unsigned char iv[16],
443 const unsigned char *input,
444 unsigned char *output);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200445#endif /*MBEDTLS_CIPHER_MODE_CFB */
Paul Bakker556efba2014-01-24 15:38:12 +0100446
Simon Butcher76a5b222018-04-22 22:57:27 +0100447#if defined(MBEDTLS_CIPHER_MODE_OFB)
448/**
Simon Butcher5db13622018-06-04 22:11:25 +0100449 * \brief This function performs an AES-OFB (Output Feedback Mode)
450 * encryption or decryption operation.
Simon Butcher76a5b222018-04-22 22:57:27 +0100451 *
Simon Butcher5db13622018-06-04 22:11:25 +0100452 * For OFB, you must set up the context with
453 * mbedtls_aes_setkey_enc(), regardless of whether you are
454 * performing an encryption or decryption operation. This is
455 * because OFB mode uses the same key schedule for encryption and
456 * decryption.
Simon Butcher76a5b222018-04-22 22:57:27 +0100457 *
Simon Butcher5db13622018-06-04 22:11:25 +0100458 * The OFB operation is identical for encryption or decryption,
459 * therefore no operation mode needs to be specified.
Simon Butcher76a5b222018-04-22 22:57:27 +0100460 *
Simon Butcher5db13622018-06-04 22:11:25 +0100461 * \note Upon exit, the content of iv, the Initialisation Vector, is
462 * updated so that you can call the same function again on the next
463 * block(s) of data and get the same result as if it was encrypted
464 * in one call. This allows a "streaming" usage, by initialising
465 * iv_off to 0 before the first call, and preserving its value
466 * between calls.
Simon Butcher968646c2018-06-02 18:27:04 +0100467 *
Simon Butcher5db13622018-06-04 22:11:25 +0100468 * For non-streaming use, the iv should be initialised on each call
469 * to a unique value, and iv_off set to 0 on each call.
Simon Butcher968646c2018-06-02 18:27:04 +0100470 *
Simon Butcher5db13622018-06-04 22:11:25 +0100471 * If you need to retain the contents of the initialisation vector,
472 * you must either save it manually or use the cipher module
473 * instead.
Simon Butcher968646c2018-06-02 18:27:04 +0100474 *
Jaeden Amerocb2c9352018-06-08 10:34:08 +0100475 * \warning For the OFB mode, the initialisation vector must be unique
476 * every encryption operation. Reuse of an initialisation vector
477 * will compromise security.
Simon Butcher76a5b222018-04-22 22:57:27 +0100478 *
479 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500480 * It must be initialized and bound to a key.
Simon Butcher76a5b222018-04-22 22:57:27 +0100481 * \param length The length of the input data.
482 * \param iv_off The offset in IV (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500483 * It must point to a valid \c size_t.
Simon Butcher76a5b222018-04-22 22:57:27 +0100484 * \param iv The initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500485 * It must be a readable and writeable buffer of \c 16 Bytes.
Simon Butcher76a5b222018-04-22 22:57:27 +0100486 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500487 * It must be readable and of size \p length Bytes.
Simon Butcher76a5b222018-04-22 22:57:27 +0100488 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500489 * It must be writeable and of size \p length Bytes.
Simon Butcher76a5b222018-04-22 22:57:27 +0100490 *
491 * \return \c 0 on success.
492 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200493MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100494int mbedtls_aes_crypt_ofb(mbedtls_aes_context *ctx,
495 size_t length,
496 size_t *iv_off,
497 unsigned char iv[16],
498 const unsigned char *input,
499 unsigned char *output);
Simon Butcher76a5b222018-04-22 22:57:27 +0100500
501#endif /* MBEDTLS_CIPHER_MODE_OFB */
502
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200503#if defined(MBEDTLS_CIPHER_MODE_CTR)
Paul Bakker556efba2014-01-24 15:38:12 +0100504/**
Rose Zadik7f441272018-01-22 11:48:23 +0000505 * \brief This function performs an AES-CTR encryption or decryption
506 * operation.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000507 *
Rose Zadik7f441272018-01-22 11:48:23 +0000508 * Due to the nature of CTR, you must use the same key schedule
509 * for both encryption and decryption operations. Therefore, you
510 * must use the context initialized with mbedtls_aes_setkey_enc()
511 * for both #MBEDTLS_AES_ENCRYPT and #MBEDTLS_AES_DECRYPT.
Paul Bakkerca6f3e22011-10-06 13:11:08 +0000512 *
Manuel Pégourié-Gonnard22997b72018-02-28 12:29:41 +0100513 * \warning You must never reuse a nonce value with the same key. Doing so
514 * would void the encryption for the two messages encrypted with
515 * the same nonce and key.
516 *
517 * There are two common strategies for managing nonces with CTR:
518 *
Manuel Pégourié-Gonnard4f24e952018-05-24 11:59:30 +0200519 * 1. You can handle everything as a single message processed over
520 * successive calls to this function. In that case, you want to
521 * set \p nonce_counter and \p nc_off to 0 for the first call, and
522 * then preserve the values of \p nonce_counter, \p nc_off and \p
523 * stream_block across calls to this function as they will be
524 * updated by this function.
Manuel Pégourié-Gonnard22997b72018-02-28 12:29:41 +0100525 *
Manuel Pégourié-Gonnard4f24e952018-05-24 11:59:30 +0200526 * With this strategy, you must not encrypt more than 2**128
527 * blocks of data with the same key.
528 *
529 * 2. You can encrypt separate messages by dividing the \p
530 * nonce_counter buffer in two areas: the first one used for a
531 * per-message nonce, handled by yourself, and the second one
532 * updated by this function internally.
533 *
534 * For example, you might reserve the first 12 bytes for the
535 * per-message nonce, and the last 4 bytes for internal use. In that
536 * case, before calling this function on a new message you need to
537 * set the first 12 bytes of \p nonce_counter to your chosen nonce
538 * value, the last 4 to 0, and \p nc_off to 0 (which will cause \p
539 * stream_block to be ignored). That way, you can encrypt at most
540 * 2**96 messages of up to 2**32 blocks each with the same key.
541 *
542 * The per-message nonce (or information sufficient to reconstruct
543 * it) needs to be communicated with the ciphertext and must be unique.
544 * The recommended way to ensure uniqueness is to use a message
545 * counter. An alternative is to generate random nonces, but this
546 * limits the number of messages that can be securely encrypted:
547 * for example, with 96-bit random nonces, you should not encrypt
548 * more than 2**32 messages with the same key.
549 *
Tom Cosgrove1e211442022-05-26 11:51:00 +0100550 * Note that for both strategies, sizes are measured in blocks and
Manuel Pégourié-Gonnard4f24e952018-05-24 11:59:30 +0200551 * that an AES block is 16 bytes.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000552 *
Manuel Pégourié-Gonnardfa0c47d2018-05-24 19:02:06 +0200553 * \warning Upon return, \p stream_block contains sensitive data. Its
554 * content must not be written to insecure storage and should be
555 * securely discarded as soon as it's no longer needed.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000556 *
Rose Zadik7f441272018-01-22 11:48:23 +0000557 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500558 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000559 * \param length The length of the input data.
560 * \param nc_off The offset in the current \p stream_block, for
561 * resuming within the current cipher stream. The
562 * offset pointer should be 0 at the start of a stream.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500563 * It must point to a valid \c size_t.
Rose Zadik7f441272018-01-22 11:48:23 +0000564 * \param nonce_counter The 128-bit nonce and counter.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500565 * It must be a readable-writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000566 * \param stream_block The saved stream block for resuming. This is
567 * overwritten by the function.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500568 * It must be a readable-writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000569 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500570 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000571 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500572 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000573 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100574 * \return \c 0 on success.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000575 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200576MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100577int mbedtls_aes_crypt_ctr(mbedtls_aes_context *ctx,
578 size_t length,
579 size_t *nc_off,
580 unsigned char nonce_counter[16],
581 unsigned char stream_block[16],
582 const unsigned char *input,
583 unsigned char *output);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200584#endif /* MBEDTLS_CIPHER_MODE_CTR */
Paul Bakker90995b52013-06-24 19:20:35 +0200585
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200586/**
Rose Zadik7f441272018-01-22 11:48:23 +0000587 * \brief Internal AES block encryption function. This is only
588 * exposed to allow overriding it using
589 * \c MBEDTLS_AES_ENCRYPT_ALT.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200590 *
Rose Zadik7f441272018-01-22 11:48:23 +0000591 * \param ctx The AES context to use for encryption.
592 * \param input The plaintext block.
593 * \param output The output (ciphertext) block.
Andres AGf5bf7182017-03-03 14:09:56 +0000594 *
Rose Zadik7f441272018-01-22 11:48:23 +0000595 * \return \c 0 on success.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200596 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200597MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100598int mbedtls_internal_aes_encrypt(mbedtls_aes_context *ctx,
599 const unsigned char input[16],
600 unsigned char output[16]);
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200601
602/**
Rose Zadik7f441272018-01-22 11:48:23 +0000603 * \brief Internal AES block decryption function. This is only
604 * exposed to allow overriding it using see
605 * \c MBEDTLS_AES_DECRYPT_ALT.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200606 *
Rose Zadik7f441272018-01-22 11:48:23 +0000607 * \param ctx The AES context to use for decryption.
608 * \param input The ciphertext block.
609 * \param output The output (plaintext) block.
Andres AGf5bf7182017-03-03 14:09:56 +0000610 *
Rose Zadik7f441272018-01-22 11:48:23 +0000611 * \return \c 0 on success.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200612 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200613MBEDTLS_CHECK_RETURN_TYPICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100614int mbedtls_internal_aes_decrypt(mbedtls_aes_context *ctx,
615 const unsigned char input[16],
616 unsigned char output[16]);
Andres AGf5bf7182017-03-03 14:09:56 +0000617
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500618#if defined(MBEDTLS_SELF_TEST)
Paul Bakker5121ce52009-01-03 21:22:43 +0000619/**
Rose Zadik7f441272018-01-22 11:48:23 +0000620 * \brief Checkup routine.
Paul Bakker5121ce52009-01-03 21:22:43 +0000621 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100622 * \return \c 0 on success.
623 * \return \c 1 on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000624 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200625MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100626int mbedtls_aes_self_test(int verbose);
Paul Bakker5121ce52009-01-03 21:22:43 +0000627
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500628#endif /* MBEDTLS_SELF_TEST */
629
Paul Bakker5121ce52009-01-03 21:22:43 +0000630#ifdef __cplusplus
631}
632#endif
633
634#endif /* aes.h */