blob: c35901122735f364444739af8ab9b602cab151a8 [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
Andres AGf5bf7182017-03-03 14:09:56 +000064#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
65 !defined(inline) && !defined(__cplusplus)
66#define inline __inline
67#endif
68
Paul Bakker407a0da2013-06-27 14:29:21 +020069#ifdef __cplusplus
70extern "C" {
71#endif
72
Ron Eldorb2aacec2017-05-18 16:53:08 +030073#if !defined(MBEDTLS_AES_ALT)
74// Regular implementation
75//
76
Paul Bakker5121ce52009-01-03 21:22:43 +000077/**
Rose Zadik7f441272018-01-22 11:48:23 +000078 * \brief The AES context-type definition.
Paul Bakker5121ce52009-01-03 21:22:43 +000079 */
Dawid Drozd428cc522018-07-24 10:02:47 +020080typedef struct mbedtls_aes_context
Paul Bakker5121ce52009-01-03 21:22:43 +000081{
Mateusz Starzyk846f0212021-05-19 19:44:07 +020082 int MBEDTLS_PRIVATE(nr); /*!< The number of rounds. */
Werner Lewis6d719442022-06-13 12:28:07 +010083 size_t MBEDTLS_PRIVATE(rk_offset); /*!< The offset in array elements to AES
84 round keys in the buffer. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +020085 uint32_t MBEDTLS_PRIVATE(buf)[68]; /*!< Unaligned data buffer. This buffer can
Rose Zadik7f441272018-01-22 11:48:23 +000086 hold 32 extra Bytes, which can be used for
87 one of the following purposes:
88 <ul><li>Alignment if VIA padlock is
89 used.</li>
90 <li>Simplifying key expansion in the 256-bit
91 case by generating an extra round key.
92 </li></ul> */
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 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200100typedef struct mbedtls_aes_xts_context
Jaeden Amero9366feb2018-05-29 18:55:17 +0100101{
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200102 mbedtls_aes_context MBEDTLS_PRIVATE(crypt); /*!< The AES context to use for AES block
Jaeden Amero9366feb2018-05-29 18:55:17 +0100103 encryption or decryption. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200104 mbedtls_aes_context MBEDTLS_PRIVATE(tweak); /*!< The AES context used for tweak
Jaeden Amero9366feb2018-05-29 18:55:17 +0100105 computation. */
106} mbedtls_aes_xts_context;
107#endif /* MBEDTLS_CIPHER_MODE_XTS */
108
Ron Eldorb2aacec2017-05-18 16:53:08 +0300109#else /* MBEDTLS_AES_ALT */
110#include "aes_alt.h"
111#endif /* MBEDTLS_AES_ALT */
112
Paul Bakker5121ce52009-01-03 21:22:43 +0000113/**
Rose Zadik7f441272018-01-22 11:48:23 +0000114 * \brief This function initializes the specified AES context.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200115 *
Rose Zadik7f441272018-01-22 11:48:23 +0000116 * It must be the first API called before using
117 * the context.
118 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500119 * \param ctx The AES context to initialize. This must not be \c NULL.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200120 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200121void mbedtls_aes_init( mbedtls_aes_context *ctx );
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200122
123/**
Rose Zadik7f441272018-01-22 11:48:23 +0000124 * \brief This function releases and clears the specified AES context.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200125 *
Rose Zadik7f441272018-01-22 11:48:23 +0000126 * \param ctx The AES context to clear.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500127 * If this is \c NULL, this function does nothing.
128 * Otherwise, the context must have been at least initialized.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200130void mbedtls_aes_free( mbedtls_aes_context *ctx );
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200131
Jaeden Amero9366feb2018-05-29 18:55:17 +0100132#if defined(MBEDTLS_CIPHER_MODE_XTS)
133/**
134 * \brief This function initializes the specified AES XTS context.
135 *
136 * It must be the first API called before using
137 * the context.
138 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500139 * \param ctx The AES XTS context to initialize. This must not be \c NULL.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100140 */
141void mbedtls_aes_xts_init( mbedtls_aes_xts_context *ctx );
142
143/**
144 * \brief This function releases and clears the specified AES XTS context.
145 *
146 * \param ctx The AES XTS context to clear.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500147 * If this is \c NULL, this function does nothing.
148 * Otherwise, the context must have been at least initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100149 */
150void mbedtls_aes_xts_free( mbedtls_aes_xts_context *ctx );
151#endif /* MBEDTLS_CIPHER_MODE_XTS */
152
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200153/**
Rose Zadik7f441272018-01-22 11:48:23 +0000154 * \brief This function sets the encryption key.
Paul Bakker5121ce52009-01-03 21:22:43 +0000155 *
Rose Zadik7f441272018-01-22 11:48:23 +0000156 * \param ctx The AES context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500157 * It must be initialized.
Rose Zadik7f441272018-01-22 11:48:23 +0000158 * \param key The encryption key.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500159 * This must be a readable buffer of size \p keybits bits.
Rose Zadik7f441272018-01-22 11:48:23 +0000160 * \param keybits The size of data passed in bits. Valid options are:
161 * <ul><li>128 bits</li>
162 * <li>192 bits</li>
163 * <li>256 bits</li></ul>
Paul Bakker2b222c82009-07-27 21:03:45 +0000164 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100165 * \return \c 0 on success.
Rose Zadik819d13d2018-04-16 09:35:15 +0100166 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000167 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200168MBEDTLS_CHECK_RETURN_TYPICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200169int mbedtls_aes_setkey_enc( mbedtls_aes_context *ctx, const unsigned char *key,
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +0200170 unsigned int keybits );
Paul Bakker5121ce52009-01-03 21:22:43 +0000171
172/**
Rose Zadik7f441272018-01-22 11:48:23 +0000173 * \brief This function sets the decryption key.
Paul Bakker5121ce52009-01-03 21:22:43 +0000174 *
Rose Zadik7f441272018-01-22 11:48:23 +0000175 * \param ctx The AES context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500176 * It must be initialized.
Rose Zadik7f441272018-01-22 11:48:23 +0000177 * \param key The decryption key.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500178 * This must be a readable buffer of size \p keybits bits.
Rose Zadik7f441272018-01-22 11:48:23 +0000179 * \param keybits The size of data passed. Valid options are:
180 * <ul><li>128 bits</li>
181 * <li>192 bits</li>
182 * <li>256 bits</li></ul>
Paul Bakker2b222c82009-07-27 21:03:45 +0000183 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100184 * \return \c 0 on success.
185 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000186 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200187MBEDTLS_CHECK_RETURN_TYPICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200188int mbedtls_aes_setkey_dec( mbedtls_aes_context *ctx, const unsigned char *key,
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +0200189 unsigned int keybits );
Paul Bakker5121ce52009-01-03 21:22:43 +0000190
Jaeden Amero9366feb2018-05-29 18:55:17 +0100191#if defined(MBEDTLS_CIPHER_MODE_XTS)
192/**
193 * \brief This function prepares an XTS context for encryption and
194 * sets the encryption key.
195 *
196 * \param ctx The AES XTS context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500197 * It must be initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100198 * \param key The encryption key. This is comprised of the XTS key1
199 * concatenated with the XTS key2.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500200 * This must be a readable buffer of size \p keybits bits.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100201 * \param keybits The size of \p key passed in bits. Valid options are:
202 * <ul><li>256 bits (each of key1 and key2 is a 128-bit key)</li>
203 * <li>512 bits (each of key1 and key2 is a 256-bit key)</li></ul>
204 *
205 * \return \c 0 on success.
206 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
207 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200208MBEDTLS_CHECK_RETURN_TYPICAL
Jaeden Amero9366feb2018-05-29 18:55:17 +0100209int mbedtls_aes_xts_setkey_enc( mbedtls_aes_xts_context *ctx,
210 const unsigned char *key,
211 unsigned int keybits );
212
213/**
214 * \brief This function prepares an XTS context for decryption and
215 * sets the decryption key.
216 *
217 * \param ctx The AES XTS context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500218 * It must be initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100219 * \param key The decryption key. This is comprised of the XTS key1
220 * concatenated with the XTS key2.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500221 * This must be a readable buffer of size \p keybits bits.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100222 * \param keybits The size of \p key passed in bits. Valid options are:
223 * <ul><li>256 bits (each of key1 and key2 is a 128-bit key)</li>
224 * <li>512 bits (each of key1 and key2 is a 256-bit key)</li></ul>
225 *
226 * \return \c 0 on success.
227 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
228 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200229MBEDTLS_CHECK_RETURN_TYPICAL
Jaeden Amero9366feb2018-05-29 18:55:17 +0100230int mbedtls_aes_xts_setkey_dec( mbedtls_aes_xts_context *ctx,
231 const unsigned char *key,
232 unsigned int keybits );
233#endif /* MBEDTLS_CIPHER_MODE_XTS */
234
Paul Bakker5121ce52009-01-03 21:22:43 +0000235/**
Rose Zadik7f441272018-01-22 11:48:23 +0000236 * \brief This function performs an AES single-block encryption or
237 * decryption operation.
Paul Bakker5121ce52009-01-03 21:22:43 +0000238 *
Rose Zadik7f441272018-01-22 11:48:23 +0000239 * It performs the operation defined in the \p mode parameter
240 * (encrypt or decrypt), on the input data buffer defined in
241 * the \p input parameter.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000242 *
Rose Zadik7f441272018-01-22 11:48:23 +0000243 * mbedtls_aes_init(), and either mbedtls_aes_setkey_enc() or
244 * mbedtls_aes_setkey_dec() must be called before the first
245 * call to this API with the same context.
246 *
247 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500248 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000249 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
250 * #MBEDTLS_AES_DECRYPT.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500251 * \param input The buffer holding the input data.
252 * It must be readable and at least \c 16 Bytes long.
253 * \param output The buffer where the output data will be written.
254 * It must be writeable and at least \c 16 Bytes long.
Rose Zadik7f441272018-01-22 11:48:23 +0000255
256 * \return \c 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +0000257 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200258MBEDTLS_CHECK_RETURN_TYPICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200259int mbedtls_aes_crypt_ecb( mbedtls_aes_context *ctx,
Paul Bakker5121ce52009-01-03 21:22:43 +0000260 int mode,
Paul Bakkerff60ee62010-03-16 21:09:09 +0000261 const unsigned char input[16],
Paul Bakker5121ce52009-01-03 21:22:43 +0000262 unsigned char output[16] );
263
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200264#if defined(MBEDTLS_CIPHER_MODE_CBC)
Paul Bakker5121ce52009-01-03 21:22:43 +0000265/**
Rose Zadik7f441272018-01-22 11:48:23 +0000266 * \brief This function performs an AES-CBC encryption or decryption operation
267 * on full blocks.
Paul Bakker5121ce52009-01-03 21:22:43 +0000268 *
Rose Zadik7f441272018-01-22 11:48:23 +0000269 * It performs the operation defined in the \p mode
270 * parameter (encrypt/decrypt), on the input data buffer defined in
271 * the \p input parameter.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000272 *
Rose Zadik7f441272018-01-22 11:48:23 +0000273 * It can be called as many times as needed, until all the input
274 * data is processed. mbedtls_aes_init(), and either
275 * mbedtls_aes_setkey_enc() or mbedtls_aes_setkey_dec() must be called
276 * before the first call to this API with the same context.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000277 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500278 * \note This function operates on full blocks, that is, the input size
279 * must be a multiple of the AES block size of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000280 *
281 * \note Upon exit, the content of the IV is updated so that you can
282 * call the same function again on the next
283 * block(s) of data and get the same result as if it was
284 * encrypted in one call. This allows a "streaming" usage.
285 * If you need to retain the contents of the IV, you should
286 * either save it manually or use the cipher module instead.
287 *
288 *
289 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500290 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000291 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
292 * #MBEDTLS_AES_DECRYPT.
293 * \param length The length of the input data in Bytes. This must be a
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500294 * multiple of the block size (\c 16 Bytes).
Rose Zadik7f441272018-01-22 11:48:23 +0000295 * \param iv Initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500296 * It must be a readable and writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000297 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500298 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000299 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500300 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000301 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100302 * \return \c 0 on success.
303 * \return #MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH
Rose Zadik7f441272018-01-22 11:48:23 +0000304 * on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000305 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200306MBEDTLS_CHECK_RETURN_TYPICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200307int mbedtls_aes_crypt_cbc( mbedtls_aes_context *ctx,
Paul Bakker5121ce52009-01-03 21:22:43 +0000308 int mode,
Paul Bakker23986e52011-04-24 08:57:21 +0000309 size_t length,
Paul Bakker5121ce52009-01-03 21:22:43 +0000310 unsigned char iv[16],
Paul Bakkerff60ee62010-03-16 21:09:09 +0000311 const unsigned char *input,
Paul Bakker5121ce52009-01-03 21:22:43 +0000312 unsigned char *output );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200313#endif /* MBEDTLS_CIPHER_MODE_CBC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000314
Aorimn5f778012016-06-09 23:22:58 +0200315#if defined(MBEDTLS_CIPHER_MODE_XTS)
316/**
Jaeden Amero9366feb2018-05-29 18:55:17 +0100317 * \brief This function performs an AES-XTS encryption or decryption
318 * operation for an entire XTS data unit.
Aorimn5f778012016-06-09 23:22:58 +0200319 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100320 * AES-XTS encrypts or decrypts blocks based on their location as
321 * defined by a data unit number. The data unit number must be
Jaeden Amerocd9fc5e2018-05-30 15:23:24 +0100322 * provided by \p data_unit.
Aorimn5f778012016-06-09 23:22:58 +0200323 *
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100324 * NIST SP 800-38E limits the maximum size of a data unit to 2^20
325 * AES blocks. If the data unit is larger than this, this function
326 * returns #MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH.
327 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100328 * \param ctx The AES XTS context to use for AES XTS operations.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500329 * It must be initialized and bound to a key.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100330 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
331 * #MBEDTLS_AES_DECRYPT.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500332 * \param length The length of a data unit in Bytes. This can be any
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100333 * length between 16 bytes and 2^24 bytes inclusive
334 * (between 1 and 2^20 block cipher blocks).
Jaeden Amerocd9fc5e2018-05-30 15:23:24 +0100335 * \param data_unit The address of the data unit encoded as an array of 16
Jaeden Amero9366feb2018-05-29 18:55:17 +0100336 * bytes in little-endian format. For disk encryption, this
337 * is typically the index of the block device sector that
338 * contains the data.
339 * \param input The buffer holding the input data (which is an entire
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500340 * data unit). This function reads \p length Bytes from \p
Jaeden Amero9366feb2018-05-29 18:55:17 +0100341 * input.
342 * \param output The buffer holding the output data (which is an entire
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500343 * data unit). This function writes \p length Bytes to \p
Jaeden Amero9366feb2018-05-29 18:55:17 +0100344 * output.
Aorimn5f778012016-06-09 23:22:58 +0200345 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100346 * \return \c 0 on success.
347 * \return #MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH if \p length is
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500348 * smaller than an AES block in size (16 Bytes) or if \p
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100349 * length is larger than 2^20 blocks (16 MiB).
Aorimn5f778012016-06-09 23:22:58 +0200350 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200351MBEDTLS_CHECK_RETURN_TYPICAL
Jaeden Amero9366feb2018-05-29 18:55:17 +0100352int mbedtls_aes_crypt_xts( mbedtls_aes_xts_context *ctx,
353 int mode,
Jaeden Amero5162b932018-05-29 12:55:24 +0100354 size_t length,
Jaeden Amerocd9fc5e2018-05-30 15:23:24 +0100355 const unsigned char data_unit[16],
Jaeden Amero9366feb2018-05-29 18:55:17 +0100356 const unsigned char *input,
357 unsigned char *output );
Aorimn5f778012016-06-09 23:22:58 +0200358#endif /* MBEDTLS_CIPHER_MODE_XTS */
359
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200360#if defined(MBEDTLS_CIPHER_MODE_CFB)
Paul Bakker5121ce52009-01-03 21:22:43 +0000361/**
Rose Zadik7f441272018-01-22 11:48:23 +0000362 * \brief This function performs an AES-CFB128 encryption or decryption
363 * operation.
Paul Bakker5121ce52009-01-03 21:22:43 +0000364 *
Rose Zadik7f441272018-01-22 11:48:23 +0000365 * It performs the operation defined in the \p mode
366 * parameter (encrypt or decrypt), on the input data buffer
367 * defined in the \p input parameter.
Paul Bakkerca6f3e22011-10-06 13:11:08 +0000368 *
Rose Zadik7f441272018-01-22 11:48:23 +0000369 * For CFB, you must set up the context with mbedtls_aes_setkey_enc(),
370 * regardless of whether you are performing an encryption or decryption
371 * operation, that is, regardless of the \p mode parameter. This is
372 * because CFB mode uses the same key schedule for encryption and
373 * decryption.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000374 *
Rose Zadik7f441272018-01-22 11:48:23 +0000375 * \note Upon exit, the content of the IV is updated so that you can
376 * call the same function again on the next
377 * block(s) of data and get the same result as if it was
378 * encrypted in one call. This allows a "streaming" usage.
379 * If you need to retain the contents of the
380 * IV, you must either save it manually or use the cipher
381 * module instead.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000382 *
Rose Zadik7f441272018-01-22 11:48:23 +0000383 *
384 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500385 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000386 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
387 * #MBEDTLS_AES_DECRYPT.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500388 * \param length The length of the input data in Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000389 * \param iv_off The offset in IV (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500390 * It must point to a valid \c size_t.
Rose Zadik7f441272018-01-22 11:48:23 +0000391 * \param iv The initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500392 * It must be a readable and writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000393 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500394 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000395 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500396 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000397 *
398 * \return \c 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +0000399 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200400MBEDTLS_CHECK_RETURN_TYPICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200401int mbedtls_aes_crypt_cfb128( mbedtls_aes_context *ctx,
Paul Bakker5121ce52009-01-03 21:22:43 +0000402 int mode,
Paul Bakker23986e52011-04-24 08:57:21 +0000403 size_t length,
Paul Bakker1ef71df2011-06-09 14:14:58 +0000404 size_t *iv_off,
Paul Bakker5121ce52009-01-03 21:22:43 +0000405 unsigned char iv[16],
Paul Bakkerff60ee62010-03-16 21:09:09 +0000406 const unsigned char *input,
Paul Bakker5121ce52009-01-03 21:22:43 +0000407 unsigned char *output );
408
Paul Bakker9a736322012-11-14 12:39:52 +0000409/**
Rose Zadik7f441272018-01-22 11:48:23 +0000410 * \brief This function performs an AES-CFB8 encryption or decryption
411 * operation.
Paul Bakker556efba2014-01-24 15:38:12 +0100412 *
Rose Zadik7f441272018-01-22 11:48:23 +0000413 * It performs the operation defined in the \p mode
414 * parameter (encrypt/decrypt), on the input data buffer defined
415 * in the \p input parameter.
Paul Bakker556efba2014-01-24 15:38:12 +0100416 *
Rose Zadik7f441272018-01-22 11:48:23 +0000417 * Due to the nature of CFB, you must use the same key schedule for
418 * both encryption and decryption operations. Therefore, you must
419 * use the context initialized with mbedtls_aes_setkey_enc() for
420 * both #MBEDTLS_AES_ENCRYPT and #MBEDTLS_AES_DECRYPT.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000421 *
Rose Zadik7f441272018-01-22 11:48:23 +0000422 * \note Upon exit, the content of the IV is updated so that you can
423 * call the same function again on the next
424 * block(s) of data and get the same result as if it was
425 * encrypted in one call. This allows a "streaming" usage.
426 * If you need to retain the contents of the
427 * IV, you should either save it manually or use the cipher
428 * module instead.
Paul Bakker556efba2014-01-24 15:38:12 +0100429 *
Rose Zadik7f441272018-01-22 11:48:23 +0000430 *
431 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500432 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000433 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
434 * #MBEDTLS_AES_DECRYPT
435 * \param length The length of the input data.
436 * \param iv The initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500437 * It must be a readable and writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000438 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500439 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000440 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500441 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000442 *
443 * \return \c 0 on success.
Paul Bakker556efba2014-01-24 15:38:12 +0100444 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200445MBEDTLS_CHECK_RETURN_TYPICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200446int mbedtls_aes_crypt_cfb8( mbedtls_aes_context *ctx,
Paul Bakker556efba2014-01-24 15:38:12 +0100447 int mode,
448 size_t length,
449 unsigned char iv[16],
450 const unsigned char *input,
451 unsigned char *output );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200452#endif /*MBEDTLS_CIPHER_MODE_CFB */
Paul Bakker556efba2014-01-24 15:38:12 +0100453
Simon Butcher76a5b222018-04-22 22:57:27 +0100454#if defined(MBEDTLS_CIPHER_MODE_OFB)
455/**
Simon Butcher5db13622018-06-04 22:11:25 +0100456 * \brief This function performs an AES-OFB (Output Feedback Mode)
457 * encryption or decryption operation.
Simon Butcher76a5b222018-04-22 22:57:27 +0100458 *
Simon Butcher5db13622018-06-04 22:11:25 +0100459 * For OFB, you must set up the context with
460 * mbedtls_aes_setkey_enc(), regardless of whether you are
461 * performing an encryption or decryption operation. This is
462 * because OFB mode uses the same key schedule for encryption and
463 * decryption.
Simon Butcher76a5b222018-04-22 22:57:27 +0100464 *
Simon Butcher5db13622018-06-04 22:11:25 +0100465 * The OFB operation is identical for encryption or decryption,
466 * therefore no operation mode needs to be specified.
Simon Butcher76a5b222018-04-22 22:57:27 +0100467 *
Simon Butcher5db13622018-06-04 22:11:25 +0100468 * \note Upon exit, the content of iv, the Initialisation Vector, is
469 * updated so that you can call the same function again on the next
470 * block(s) of data and get the same result as if it was encrypted
471 * in one call. This allows a "streaming" usage, by initialising
472 * iv_off to 0 before the first call, and preserving its value
473 * between calls.
Simon Butcher968646c2018-06-02 18:27:04 +0100474 *
Simon Butcher5db13622018-06-04 22:11:25 +0100475 * For non-streaming use, the iv should be initialised on each call
476 * to a unique value, and iv_off set to 0 on each call.
Simon Butcher968646c2018-06-02 18:27:04 +0100477 *
Simon Butcher5db13622018-06-04 22:11:25 +0100478 * If you need to retain the contents of the initialisation vector,
479 * you must either save it manually or use the cipher module
480 * instead.
Simon Butcher968646c2018-06-02 18:27:04 +0100481 *
Jaeden Amerocb2c9352018-06-08 10:34:08 +0100482 * \warning For the OFB mode, the initialisation vector must be unique
483 * every encryption operation. Reuse of an initialisation vector
484 * will compromise security.
Simon Butcher76a5b222018-04-22 22:57:27 +0100485 *
486 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500487 * It must be initialized and bound to a key.
Simon Butcher76a5b222018-04-22 22:57:27 +0100488 * \param length The length of the input data.
489 * \param iv_off The offset in IV (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500490 * It must point to a valid \c size_t.
Simon Butcher76a5b222018-04-22 22:57:27 +0100491 * \param iv The initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500492 * It must be a readable and writeable buffer of \c 16 Bytes.
Simon Butcher76a5b222018-04-22 22:57:27 +0100493 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500494 * It must be readable and of size \p length Bytes.
Simon Butcher76a5b222018-04-22 22:57:27 +0100495 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500496 * It must be writeable and of size \p length Bytes.
Simon Butcher76a5b222018-04-22 22:57:27 +0100497 *
498 * \return \c 0 on success.
499 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200500MBEDTLS_CHECK_RETURN_TYPICAL
Simon Butcher76a5b222018-04-22 22:57:27 +0100501int mbedtls_aes_crypt_ofb( mbedtls_aes_context *ctx,
502 size_t length,
503 size_t *iv_off,
504 unsigned char iv[16],
505 const unsigned char *input,
506 unsigned char *output );
507
508#endif /* MBEDTLS_CIPHER_MODE_OFB */
509
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200510#if defined(MBEDTLS_CIPHER_MODE_CTR)
Paul Bakker556efba2014-01-24 15:38:12 +0100511/**
Rose Zadik7f441272018-01-22 11:48:23 +0000512 * \brief This function performs an AES-CTR encryption or decryption
513 * operation.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000514 *
Rose Zadik7f441272018-01-22 11:48:23 +0000515 * Due to the nature of CTR, you must use the same key schedule
516 * for both encryption and decryption operations. Therefore, you
517 * must use the context initialized with mbedtls_aes_setkey_enc()
518 * for both #MBEDTLS_AES_ENCRYPT and #MBEDTLS_AES_DECRYPT.
Paul Bakkerca6f3e22011-10-06 13:11:08 +0000519 *
Manuel Pégourié-Gonnard22997b72018-02-28 12:29:41 +0100520 * \warning You must never reuse a nonce value with the same key. Doing so
521 * would void the encryption for the two messages encrypted with
522 * the same nonce and key.
523 *
524 * There are two common strategies for managing nonces with CTR:
525 *
Manuel Pégourié-Gonnard4f24e952018-05-24 11:59:30 +0200526 * 1. You can handle everything as a single message processed over
527 * successive calls to this function. In that case, you want to
528 * set \p nonce_counter and \p nc_off to 0 for the first call, and
529 * then preserve the values of \p nonce_counter, \p nc_off and \p
530 * stream_block across calls to this function as they will be
531 * updated by this function.
Manuel Pégourié-Gonnard22997b72018-02-28 12:29:41 +0100532 *
Manuel Pégourié-Gonnard4f24e952018-05-24 11:59:30 +0200533 * With this strategy, you must not encrypt more than 2**128
534 * blocks of data with the same key.
535 *
536 * 2. You can encrypt separate messages by dividing the \p
537 * nonce_counter buffer in two areas: the first one used for a
538 * per-message nonce, handled by yourself, and the second one
539 * updated by this function internally.
540 *
541 * For example, you might reserve the first 12 bytes for the
542 * per-message nonce, and the last 4 bytes for internal use. In that
543 * case, before calling this function on a new message you need to
544 * set the first 12 bytes of \p nonce_counter to your chosen nonce
545 * value, the last 4 to 0, and \p nc_off to 0 (which will cause \p
546 * stream_block to be ignored). That way, you can encrypt at most
547 * 2**96 messages of up to 2**32 blocks each with the same key.
548 *
549 * The per-message nonce (or information sufficient to reconstruct
550 * it) needs to be communicated with the ciphertext and must be unique.
551 * The recommended way to ensure uniqueness is to use a message
552 * counter. An alternative is to generate random nonces, but this
553 * limits the number of messages that can be securely encrypted:
554 * for example, with 96-bit random nonces, you should not encrypt
555 * more than 2**32 messages with the same key.
556 *
Tom Cosgrove1e211442022-05-26 11:51:00 +0100557 * Note that for both strategies, sizes are measured in blocks and
Manuel Pégourié-Gonnard4f24e952018-05-24 11:59:30 +0200558 * that an AES block is 16 bytes.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000559 *
Manuel Pégourié-Gonnardfa0c47d2018-05-24 19:02:06 +0200560 * \warning Upon return, \p stream_block contains sensitive data. Its
561 * content must not be written to insecure storage and should be
562 * securely discarded as soon as it's no longer needed.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000563 *
Rose Zadik7f441272018-01-22 11:48:23 +0000564 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500565 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000566 * \param length The length of the input data.
567 * \param nc_off The offset in the current \p stream_block, for
568 * resuming within the current cipher stream. The
569 * offset pointer should be 0 at the start of a stream.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500570 * It must point to a valid \c size_t.
Rose Zadik7f441272018-01-22 11:48:23 +0000571 * \param nonce_counter The 128-bit nonce and counter.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500572 * It must be a readable-writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000573 * \param stream_block The saved stream block for resuming. This is
574 * overwritten by the function.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500575 * It must be a readable-writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000576 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500577 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000578 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500579 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000580 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100581 * \return \c 0 on success.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000582 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200583MBEDTLS_CHECK_RETURN_TYPICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200584int mbedtls_aes_crypt_ctr( mbedtls_aes_context *ctx,
Paul Bakker1ef71df2011-06-09 14:14:58 +0000585 size_t length,
586 size_t *nc_off,
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000587 unsigned char nonce_counter[16],
588 unsigned char stream_block[16],
589 const unsigned char *input,
590 unsigned char *output );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200591#endif /* MBEDTLS_CIPHER_MODE_CTR */
Paul Bakker90995b52013-06-24 19:20:35 +0200592
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200593/**
Rose Zadik7f441272018-01-22 11:48:23 +0000594 * \brief Internal AES block encryption function. This is only
595 * exposed to allow overriding it using
596 * \c MBEDTLS_AES_ENCRYPT_ALT.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200597 *
Rose Zadik7f441272018-01-22 11:48:23 +0000598 * \param ctx The AES context to use for encryption.
599 * \param input The plaintext block.
600 * \param output The output (ciphertext) block.
Andres AGf5bf7182017-03-03 14:09:56 +0000601 *
Rose Zadik7f441272018-01-22 11:48:23 +0000602 * \return \c 0 on success.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200603 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200604MBEDTLS_CHECK_RETURN_TYPICAL
Andres AGf5bf7182017-03-03 14:09:56 +0000605int mbedtls_internal_aes_encrypt( mbedtls_aes_context *ctx,
606 const unsigned char input[16],
607 unsigned char output[16] );
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200608
609/**
Rose Zadik7f441272018-01-22 11:48:23 +0000610 * \brief Internal AES block decryption function. This is only
611 * exposed to allow overriding it using see
612 * \c MBEDTLS_AES_DECRYPT_ALT.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200613 *
Rose Zadik7f441272018-01-22 11:48:23 +0000614 * \param ctx The AES context to use for decryption.
615 * \param input The ciphertext block.
616 * \param output The output (plaintext) block.
Andres AGf5bf7182017-03-03 14:09:56 +0000617 *
Rose Zadik7f441272018-01-22 11:48:23 +0000618 * \return \c 0 on success.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200619 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200620MBEDTLS_CHECK_RETURN_TYPICAL
Andres AGf5bf7182017-03-03 14:09:56 +0000621int mbedtls_internal_aes_decrypt( mbedtls_aes_context *ctx,
622 const unsigned char input[16],
623 unsigned char output[16] );
624
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500625#if defined(MBEDTLS_SELF_TEST)
Paul Bakker5121ce52009-01-03 21:22:43 +0000626/**
Rose Zadik7f441272018-01-22 11:48:23 +0000627 * \brief Checkup routine.
Paul Bakker5121ce52009-01-03 21:22:43 +0000628 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100629 * \return \c 0 on success.
630 * \return \c 1 on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000631 */
Gilles Peskinee41803a2021-09-23 17:35:37 +0200632MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200633int mbedtls_aes_self_test( int verbose );
Paul Bakker5121ce52009-01-03 21:22:43 +0000634
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500635#endif /* MBEDTLS_SELF_TEST */
636
Paul Bakker5121ce52009-01-03 21:22:43 +0000637#ifdef __cplusplus
638}
639#endif
640
641#endif /* aes.h */