blob: ab8793cb5e252f05dbd1d90a59a6b40a6cd58973 [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
Paul Bakker5121ce52009-01-03 21:22:43 +000042
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020043#if !defined(MBEDTLS_CONFIG_FILE)
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010044#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020045#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020046#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020047#endif
Paul Bakker90995b52013-06-24 19:20:35 +020048
Rich Evans00ab4702015-02-06 13:43:58 +000049#include <stddef.h>
Manuel Pégourié-Gonnardab229102015-04-15 11:53:16 +020050#include <stdint.h>
Paul Bakker5c2364c2012-10-01 14:41:15 +000051
Manuel Pégourié-Gonnard5b685652013-12-18 11:45:21 +010052/* padlock.c and aesni.c rely on these values! */
Rose Zadik7f441272018-01-22 11:48:23 +000053#define MBEDTLS_AES_ENCRYPT 1 /**< AES encryption. */
54#define MBEDTLS_AES_DECRYPT 0 /**< AES decryption. */
Paul Bakker5121ce52009-01-03 21:22:43 +000055
Andres Amaya Garciac5380642017-11-28 19:57:51 +000056/* Error codes in range 0x0020-0x0022 */
Gilles Peskinea3974432021-07-26 18:48:10 +020057/** Invalid key length. */
58#define MBEDTLS_ERR_AES_INVALID_KEY_LENGTH -0x0020
59/** Invalid data input length. */
60#define MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH -0x0022
Paul Bakker2b222c82009-07-27 21:03:45 +000061
Mohammad Azim Khane5b5bd72017-11-24 10:52:51 +000062/* Error codes in range 0x0021-0x0025 */
Gilles Peskinea3974432021-07-26 18:48:10 +020063/** Invalid input data. */
64#define MBEDTLS_ERR_AES_BAD_INPUT_DATA -0x0021
Ron Eldor9924bdc2018-10-04 10:59:13 +030065
66/* MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE is deprecated and should not be used. */
Gilles Peskinea3974432021-07-26 18:48:10 +020067/** Feature not available. For example, an unsupported AES key size. */
68#define MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE -0x0023
Ron Eldor9924bdc2018-10-04 10:59:13 +030069
70/* MBEDTLS_ERR_AES_HW_ACCEL_FAILED is deprecated and should not be used. */
Gilles Peskinea3974432021-07-26 18:48:10 +020071/** AES hardware accelerator failed. */
72#define MBEDTLS_ERR_AES_HW_ACCEL_FAILED -0x0025
Paul Bakker5121ce52009-01-03 21:22:43 +000073
Andres AGf5bf7182017-03-03 14:09:56 +000074#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
75 !defined(inline) && !defined(__cplusplus)
76#define inline __inline
77#endif
78
Paul Bakker407a0da2013-06-27 14:29:21 +020079#ifdef __cplusplus
80extern "C" {
81#endif
82
Ron Eldorb2aacec2017-05-18 16:53:08 +030083#if !defined(MBEDTLS_AES_ALT)
84// Regular implementation
85//
86
Paul Bakker5121ce52009-01-03 21:22:43 +000087/**
Rose Zadik7f441272018-01-22 11:48:23 +000088 * \brief The AES context-type definition.
Paul Bakker5121ce52009-01-03 21:22:43 +000089 */
Dawid Drozd428cc522018-07-24 10:02:47 +020090typedef struct mbedtls_aes_context
Paul Bakker5121ce52009-01-03 21:22:43 +000091{
Rose Zadik7f441272018-01-22 11:48:23 +000092 int nr; /*!< The number of rounds. */
93 uint32_t *rk; /*!< AES round keys. */
94 uint32_t buf[68]; /*!< Unaligned data buffer. This buffer can
95 hold 32 extra Bytes, which can be used for
96 one of the following purposes:
97 <ul><li>Alignment if VIA padlock is
98 used.</li>
99 <li>Simplifying key expansion in the 256-bit
100 case by generating an extra round key.
101 </li></ul> */
Paul Bakker5121ce52009-01-03 21:22:43 +0000102}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200103mbedtls_aes_context;
Paul Bakker5121ce52009-01-03 21:22:43 +0000104
Jaeden Amero9366feb2018-05-29 18:55:17 +0100105#if defined(MBEDTLS_CIPHER_MODE_XTS)
106/**
107 * \brief The AES XTS context-type definition.
108 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200109typedef struct mbedtls_aes_xts_context
Jaeden Amero9366feb2018-05-29 18:55:17 +0100110{
111 mbedtls_aes_context crypt; /*!< The AES context to use for AES block
112 encryption or decryption. */
113 mbedtls_aes_context tweak; /*!< The AES context used for tweak
114 computation. */
115} mbedtls_aes_xts_context;
116#endif /* MBEDTLS_CIPHER_MODE_XTS */
117
Ron Eldorb2aacec2017-05-18 16:53:08 +0300118#else /* MBEDTLS_AES_ALT */
119#include "aes_alt.h"
120#endif /* MBEDTLS_AES_ALT */
121
Paul Bakker5121ce52009-01-03 21:22:43 +0000122/**
Rose Zadik7f441272018-01-22 11:48:23 +0000123 * \brief This function initializes the specified AES context.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200124 *
Rose Zadik7f441272018-01-22 11:48:23 +0000125 * It must be the first API called before using
126 * the context.
127 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500128 * \param ctx The AES context to initialize. This must not be \c NULL.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200129 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200130void mbedtls_aes_init( mbedtls_aes_context *ctx );
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200131
132/**
Rose Zadik7f441272018-01-22 11:48:23 +0000133 * \brief This function releases and clears the specified AES context.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200134 *
Rose Zadik7f441272018-01-22 11:48:23 +0000135 * \param ctx The AES context to clear.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500136 * If this is \c NULL, this function does nothing.
137 * Otherwise, the context must have been at least initialized.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200138 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200139void mbedtls_aes_free( mbedtls_aes_context *ctx );
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200140
Jaeden Amero9366feb2018-05-29 18:55:17 +0100141#if defined(MBEDTLS_CIPHER_MODE_XTS)
142/**
143 * \brief This function initializes the specified AES XTS context.
144 *
145 * It must be the first API called before using
146 * the context.
147 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500148 * \param ctx The AES XTS context to initialize. This must not be \c NULL.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100149 */
150void mbedtls_aes_xts_init( mbedtls_aes_xts_context *ctx );
151
152/**
153 * \brief This function releases and clears the specified AES XTS context.
154 *
155 * \param ctx The AES XTS context to clear.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500156 * If this is \c NULL, this function does nothing.
157 * Otherwise, the context must have been at least initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100158 */
159void mbedtls_aes_xts_free( mbedtls_aes_xts_context *ctx );
160#endif /* MBEDTLS_CIPHER_MODE_XTS */
161
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200162/**
Rose Zadik7f441272018-01-22 11:48:23 +0000163 * \brief This function sets the encryption key.
Paul Bakker5121ce52009-01-03 21:22:43 +0000164 *
Rose Zadik7f441272018-01-22 11:48:23 +0000165 * \param ctx The AES context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500166 * It must be initialized.
Rose Zadik7f441272018-01-22 11:48:23 +0000167 * \param key The encryption key.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500168 * This must be a readable buffer of size \p keybits bits.
Rose Zadik7f441272018-01-22 11:48:23 +0000169 * \param keybits The size of data passed in bits. Valid options are:
170 * <ul><li>128 bits</li>
171 * <li>192 bits</li>
172 * <li>256 bits</li></ul>
Paul Bakker2b222c82009-07-27 21:03:45 +0000173 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100174 * \return \c 0 on success.
Rose Zadik819d13d2018-04-16 09:35:15 +0100175 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000176 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200177int mbedtls_aes_setkey_enc( mbedtls_aes_context *ctx, const unsigned char *key,
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +0200178 unsigned int keybits );
Paul Bakker5121ce52009-01-03 21:22:43 +0000179
180/**
Rose Zadik7f441272018-01-22 11:48:23 +0000181 * \brief This function sets the decryption key.
Paul Bakker5121ce52009-01-03 21:22:43 +0000182 *
Rose Zadik7f441272018-01-22 11:48:23 +0000183 * \param ctx The AES context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500184 * It must be initialized.
Rose Zadik7f441272018-01-22 11:48:23 +0000185 * \param key The decryption key.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500186 * This must be a readable buffer of size \p keybits bits.
Rose Zadik7f441272018-01-22 11:48:23 +0000187 * \param keybits The size of data passed. Valid options are:
188 * <ul><li>128 bits</li>
189 * <li>192 bits</li>
190 * <li>256 bits</li></ul>
Paul Bakker2b222c82009-07-27 21:03:45 +0000191 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100192 * \return \c 0 on success.
193 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000194 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200195int mbedtls_aes_setkey_dec( mbedtls_aes_context *ctx, const unsigned char *key,
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +0200196 unsigned int keybits );
Paul Bakker5121ce52009-01-03 21:22:43 +0000197
Jaeden Amero9366feb2018-05-29 18:55:17 +0100198#if defined(MBEDTLS_CIPHER_MODE_XTS)
199/**
200 * \brief This function prepares an XTS context for encryption and
201 * sets the encryption key.
202 *
203 * \param ctx The AES XTS context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500204 * It must be initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100205 * \param key The encryption key. This is comprised of the XTS key1
206 * concatenated with the XTS key2.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500207 * This must be a readable buffer of size \p keybits bits.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100208 * \param keybits The size of \p key passed in bits. Valid options are:
209 * <ul><li>256 bits (each of key1 and key2 is a 128-bit key)</li>
210 * <li>512 bits (each of key1 and key2 is a 256-bit key)</li></ul>
211 *
212 * \return \c 0 on success.
213 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
214 */
215int mbedtls_aes_xts_setkey_enc( mbedtls_aes_xts_context *ctx,
216 const unsigned char *key,
217 unsigned int keybits );
218
219/**
220 * \brief This function prepares an XTS context for decryption and
221 * sets the decryption key.
222 *
223 * \param ctx The AES XTS context to which the key should be bound.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500224 * It must be initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100225 * \param key The decryption key. This is comprised of the XTS key1
226 * concatenated with the XTS key2.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500227 * This must be a readable buffer of size \p keybits bits.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100228 * \param keybits The size of \p key passed in bits. Valid options are:
229 * <ul><li>256 bits (each of key1 and key2 is a 128-bit key)</li>
230 * <li>512 bits (each of key1 and key2 is a 256-bit key)</li></ul>
231 *
232 * \return \c 0 on success.
233 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
234 */
235int mbedtls_aes_xts_setkey_dec( mbedtls_aes_xts_context *ctx,
236 const unsigned char *key,
237 unsigned int keybits );
238#endif /* MBEDTLS_CIPHER_MODE_XTS */
239
Paul Bakker5121ce52009-01-03 21:22:43 +0000240/**
Rose Zadik7f441272018-01-22 11:48:23 +0000241 * \brief This function performs an AES single-block encryption or
242 * decryption operation.
Paul Bakker5121ce52009-01-03 21:22:43 +0000243 *
Rose Zadik7f441272018-01-22 11:48:23 +0000244 * It performs the operation defined in the \p mode parameter
245 * (encrypt or decrypt), on the input data buffer defined in
246 * the \p input parameter.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000247 *
Rose Zadik7f441272018-01-22 11:48:23 +0000248 * mbedtls_aes_init(), and either mbedtls_aes_setkey_enc() or
249 * mbedtls_aes_setkey_dec() must be called before the first
250 * call to this API with the same context.
251 *
252 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500253 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000254 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
255 * #MBEDTLS_AES_DECRYPT.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500256 * \param input The buffer holding the input data.
257 * It must be readable and at least \c 16 Bytes long.
258 * \param output The buffer where the output data will be written.
259 * It must be writeable and at least \c 16 Bytes long.
Rose Zadik7f441272018-01-22 11:48:23 +0000260
261 * \return \c 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +0000262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200263int mbedtls_aes_crypt_ecb( mbedtls_aes_context *ctx,
Paul Bakker5121ce52009-01-03 21:22:43 +0000264 int mode,
Paul Bakkerff60ee62010-03-16 21:09:09 +0000265 const unsigned char input[16],
Paul Bakker5121ce52009-01-03 21:22:43 +0000266 unsigned char output[16] );
267
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200268#if defined(MBEDTLS_CIPHER_MODE_CBC)
Paul Bakker5121ce52009-01-03 21:22:43 +0000269/**
Rose Zadik7f441272018-01-22 11:48:23 +0000270 * \brief This function performs an AES-CBC encryption or decryption operation
271 * on full blocks.
Paul Bakker5121ce52009-01-03 21:22:43 +0000272 *
Rose Zadik7f441272018-01-22 11:48:23 +0000273 * It performs the operation defined in the \p mode
274 * parameter (encrypt/decrypt), on the input data buffer defined in
275 * the \p input parameter.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000276 *
Rose Zadik7f441272018-01-22 11:48:23 +0000277 * It can be called as many times as needed, until all the input
278 * data is processed. mbedtls_aes_init(), and either
279 * mbedtls_aes_setkey_enc() or mbedtls_aes_setkey_dec() must be called
280 * before the first call to this API with the same context.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000281 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500282 * \note This function operates on full blocks, that is, the input size
283 * must be a multiple of the AES block size of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000284 *
285 * \note Upon exit, the content of the IV is updated so that you can
286 * call the same function again on the next
287 * block(s) of data and get the same result as if it was
288 * encrypted in one call. This allows a "streaming" usage.
289 * If you need to retain the contents of the IV, you should
290 * either save it manually or use the cipher module instead.
291 *
292 *
293 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500294 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000295 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
296 * #MBEDTLS_AES_DECRYPT.
297 * \param length The length of the input data in Bytes. This must be a
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500298 * multiple of the block size (\c 16 Bytes).
Rose Zadik7f441272018-01-22 11:48:23 +0000299 * \param iv Initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500300 * It must be a readable and writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000301 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500302 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000303 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500304 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000305 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100306 * \return \c 0 on success.
307 * \return #MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH
Rose Zadik7f441272018-01-22 11:48:23 +0000308 * on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200310int mbedtls_aes_crypt_cbc( mbedtls_aes_context *ctx,
Paul Bakker5121ce52009-01-03 21:22:43 +0000311 int mode,
Paul Bakker23986e52011-04-24 08:57:21 +0000312 size_t length,
Paul Bakker5121ce52009-01-03 21:22:43 +0000313 unsigned char iv[16],
Paul Bakkerff60ee62010-03-16 21:09:09 +0000314 const unsigned char *input,
Paul Bakker5121ce52009-01-03 21:22:43 +0000315 unsigned char *output );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316#endif /* MBEDTLS_CIPHER_MODE_CBC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000317
Aorimn5f778012016-06-09 23:22:58 +0200318#if defined(MBEDTLS_CIPHER_MODE_XTS)
319/**
Jaeden Amero9366feb2018-05-29 18:55:17 +0100320 * \brief This function performs an AES-XTS encryption or decryption
321 * operation for an entire XTS data unit.
Aorimn5f778012016-06-09 23:22:58 +0200322 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100323 * AES-XTS encrypts or decrypts blocks based on their location as
324 * defined by a data unit number. The data unit number must be
Jaeden Amerocd9fc5e2018-05-30 15:23:24 +0100325 * provided by \p data_unit.
Aorimn5f778012016-06-09 23:22:58 +0200326 *
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100327 * NIST SP 800-38E limits the maximum size of a data unit to 2^20
328 * AES blocks. If the data unit is larger than this, this function
329 * returns #MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH.
330 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100331 * \param ctx The AES XTS context to use for AES XTS operations.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500332 * It must be initialized and bound to a key.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100333 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
334 * #MBEDTLS_AES_DECRYPT.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500335 * \param length The length of a data unit in Bytes. This can be any
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100336 * length between 16 bytes and 2^24 bytes inclusive
337 * (between 1 and 2^20 block cipher blocks).
Jaeden Amerocd9fc5e2018-05-30 15:23:24 +0100338 * \param data_unit The address of the data unit encoded as an array of 16
Jaeden Amero9366feb2018-05-29 18:55:17 +0100339 * bytes in little-endian format. For disk encryption, this
340 * is typically the index of the block device sector that
341 * contains the data.
342 * \param input The buffer holding the input data (which is an entire
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500343 * data unit). This function reads \p length Bytes from \p
Jaeden Amero9366feb2018-05-29 18:55:17 +0100344 * input.
345 * \param output The buffer holding the output data (which is an entire
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500346 * data unit). This function writes \p length Bytes to \p
Jaeden Amero9366feb2018-05-29 18:55:17 +0100347 * output.
Aorimn5f778012016-06-09 23:22:58 +0200348 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100349 * \return \c 0 on success.
350 * \return #MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH if \p length is
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500351 * smaller than an AES block in size (16 Bytes) or if \p
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100352 * length is larger than 2^20 blocks (16 MiB).
Aorimn5f778012016-06-09 23:22:58 +0200353 */
Jaeden Amero9366feb2018-05-29 18:55:17 +0100354int mbedtls_aes_crypt_xts( mbedtls_aes_xts_context *ctx,
355 int mode,
Jaeden Amero5162b932018-05-29 12:55:24 +0100356 size_t length,
Jaeden Amerocd9fc5e2018-05-30 15:23:24 +0100357 const unsigned char data_unit[16],
Jaeden Amero9366feb2018-05-29 18:55:17 +0100358 const unsigned char *input,
359 unsigned char *output );
Aorimn5f778012016-06-09 23:22:58 +0200360#endif /* MBEDTLS_CIPHER_MODE_XTS */
361
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200362#if defined(MBEDTLS_CIPHER_MODE_CFB)
Paul Bakker5121ce52009-01-03 21:22:43 +0000363/**
Rose Zadik7f441272018-01-22 11:48:23 +0000364 * \brief This function performs an AES-CFB128 encryption or decryption
365 * operation.
Paul Bakker5121ce52009-01-03 21:22:43 +0000366 *
Rose Zadik7f441272018-01-22 11:48:23 +0000367 * It performs the operation defined in the \p mode
368 * parameter (encrypt or decrypt), on the input data buffer
369 * defined in the \p input parameter.
Paul Bakkerca6f3e22011-10-06 13:11:08 +0000370 *
Rose Zadik7f441272018-01-22 11:48:23 +0000371 * For CFB, you must set up the context with mbedtls_aes_setkey_enc(),
372 * regardless of whether you are performing an encryption or decryption
373 * operation, that is, regardless of the \p mode parameter. This is
374 * because CFB mode uses the same key schedule for encryption and
375 * decryption.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000376 *
Rose Zadik7f441272018-01-22 11:48:23 +0000377 * \note Upon exit, the content of the IV is updated so that you can
378 * call the same function again on the next
379 * block(s) of data and get the same result as if it was
380 * encrypted in one call. This allows a "streaming" usage.
381 * If you need to retain the contents of the
382 * IV, you must either save it manually or use the cipher
383 * module instead.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000384 *
Rose Zadik7f441272018-01-22 11:48:23 +0000385 *
386 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500387 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000388 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
389 * #MBEDTLS_AES_DECRYPT.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500390 * \param length The length of the input data in Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000391 * \param iv_off The offset in IV (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500392 * It must point to a valid \c size_t.
Rose Zadik7f441272018-01-22 11:48:23 +0000393 * \param iv The initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500394 * It must be a readable and writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000395 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500396 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000397 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500398 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000399 *
400 * \return \c 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +0000401 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200402int mbedtls_aes_crypt_cfb128( mbedtls_aes_context *ctx,
Paul Bakker5121ce52009-01-03 21:22:43 +0000403 int mode,
Paul Bakker23986e52011-04-24 08:57:21 +0000404 size_t length,
Paul Bakker1ef71df2011-06-09 14:14:58 +0000405 size_t *iv_off,
Paul Bakker5121ce52009-01-03 21:22:43 +0000406 unsigned char iv[16],
Paul Bakkerff60ee62010-03-16 21:09:09 +0000407 const unsigned char *input,
Paul Bakker5121ce52009-01-03 21:22:43 +0000408 unsigned char *output );
409
Paul Bakker9a736322012-11-14 12:39:52 +0000410/**
Rose Zadik7f441272018-01-22 11:48:23 +0000411 * \brief This function performs an AES-CFB8 encryption or decryption
412 * operation.
Paul Bakker556efba2014-01-24 15:38:12 +0100413 *
Rose Zadik7f441272018-01-22 11:48:23 +0000414 * It performs the operation defined in the \p mode
415 * parameter (encrypt/decrypt), on the input data buffer defined
416 * in the \p input parameter.
Paul Bakker556efba2014-01-24 15:38:12 +0100417 *
Rose Zadik7f441272018-01-22 11:48:23 +0000418 * Due to the nature of CFB, you must use the same key schedule for
419 * both encryption and decryption operations. Therefore, you must
420 * use the context initialized with mbedtls_aes_setkey_enc() for
421 * both #MBEDTLS_AES_ENCRYPT and #MBEDTLS_AES_DECRYPT.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000422 *
Rose Zadik7f441272018-01-22 11:48:23 +0000423 * \note Upon exit, the content of the IV is updated so that you can
424 * call the same function again on the next
425 * block(s) of data and get the same result as if it was
426 * encrypted in one call. This allows a "streaming" usage.
427 * If you need to retain the contents of the
428 * IV, you should either save it manually or use the cipher
429 * module instead.
Paul Bakker556efba2014-01-24 15:38:12 +0100430 *
Rose Zadik7f441272018-01-22 11:48:23 +0000431 *
432 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500433 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000434 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
435 * #MBEDTLS_AES_DECRYPT
436 * \param length The length of the input data.
437 * \param iv The initialization vector (updated after use).
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500438 * It must be a readable and writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000439 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500440 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000441 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500442 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000443 *
444 * \return \c 0 on success.
Paul Bakker556efba2014-01-24 15:38:12 +0100445 */
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 */
500int 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 );
506
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 * This function performs the operation defined in the \p mode
515 * parameter (encrypt/decrypt), on the input data buffer
516 * defined in the \p input parameter.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000517 *
Rose Zadik7f441272018-01-22 11:48:23 +0000518 * Due to the nature of CTR, you must use the same key schedule
519 * for both encryption and decryption operations. Therefore, you
520 * must use the context initialized with mbedtls_aes_setkey_enc()
521 * for both #MBEDTLS_AES_ENCRYPT and #MBEDTLS_AES_DECRYPT.
Paul Bakkerca6f3e22011-10-06 13:11:08 +0000522 *
Manuel Pégourié-Gonnard22997b72018-02-28 12:29:41 +0100523 * \warning You must never reuse a nonce value with the same key. Doing so
524 * would void the encryption for the two messages encrypted with
525 * the same nonce and key.
526 *
527 * There are two common strategies for managing nonces with CTR:
528 *
Manuel Pégourié-Gonnard4f24e952018-05-24 11:59:30 +0200529 * 1. You can handle everything as a single message processed over
530 * successive calls to this function. In that case, you want to
531 * set \p nonce_counter and \p nc_off to 0 for the first call, and
532 * then preserve the values of \p nonce_counter, \p nc_off and \p
533 * stream_block across calls to this function as they will be
534 * updated by this function.
Manuel Pégourié-Gonnard22997b72018-02-28 12:29:41 +0100535 *
Manuel Pégourié-Gonnard4f24e952018-05-24 11:59:30 +0200536 * With this strategy, you must not encrypt more than 2**128
537 * blocks of data with the same key.
538 *
539 * 2. You can encrypt separate messages by dividing the \p
540 * nonce_counter buffer in two areas: the first one used for a
541 * per-message nonce, handled by yourself, and the second one
542 * updated by this function internally.
543 *
544 * For example, you might reserve the first 12 bytes for the
545 * per-message nonce, and the last 4 bytes for internal use. In that
546 * case, before calling this function on a new message you need to
547 * set the first 12 bytes of \p nonce_counter to your chosen nonce
548 * value, the last 4 to 0, and \p nc_off to 0 (which will cause \p
549 * stream_block to be ignored). That way, you can encrypt at most
550 * 2**96 messages of up to 2**32 blocks each with the same key.
551 *
552 * The per-message nonce (or information sufficient to reconstruct
553 * it) needs to be communicated with the ciphertext and must be unique.
554 * The recommended way to ensure uniqueness is to use a message
555 * counter. An alternative is to generate random nonces, but this
556 * limits the number of messages that can be securely encrypted:
557 * for example, with 96-bit random nonces, you should not encrypt
558 * more than 2**32 messages with the same key.
559 *
560 * Note that for both stategies, sizes are measured in blocks and
561 * that an AES block is 16 bytes.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000562 *
Manuel Pégourié-Gonnardfa0c47d2018-05-24 19:02:06 +0200563 * \warning Upon return, \p stream_block contains sensitive data. Its
564 * content must not be written to insecure storage and should be
565 * securely discarded as soon as it's no longer needed.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000566 *
Rose Zadik7f441272018-01-22 11:48:23 +0000567 * \param ctx The AES context to use for encryption or decryption.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500568 * It must be initialized and bound to a key.
Rose Zadik7f441272018-01-22 11:48:23 +0000569 * \param length The length of the input data.
570 * \param nc_off The offset in the current \p stream_block, for
571 * resuming within the current cipher stream. The
572 * offset pointer should be 0 at the start of a stream.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500573 * It must point to a valid \c size_t.
Rose Zadik7f441272018-01-22 11:48:23 +0000574 * \param nonce_counter The 128-bit nonce and counter.
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 stream_block The saved stream block for resuming. This is
577 * overwritten by the function.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500578 * It must be a readable-writeable buffer of \c 16 Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000579 * \param input The buffer holding the input data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500580 * It must be readable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000581 * \param output The buffer holding the output data.
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500582 * It must be writeable and of size \p length Bytes.
Rose Zadik7f441272018-01-22 11:48:23 +0000583 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100584 * \return \c 0 on success.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000585 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200586int mbedtls_aes_crypt_ctr( mbedtls_aes_context *ctx,
Paul Bakker1ef71df2011-06-09 14:14:58 +0000587 size_t length,
588 size_t *nc_off,
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000589 unsigned char nonce_counter[16],
590 unsigned char stream_block[16],
591 const unsigned char *input,
592 unsigned char *output );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200593#endif /* MBEDTLS_CIPHER_MODE_CTR */
Paul Bakker90995b52013-06-24 19:20:35 +0200594
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200595/**
Rose Zadik7f441272018-01-22 11:48:23 +0000596 * \brief Internal AES block encryption function. This is only
597 * exposed to allow overriding it using
598 * \c MBEDTLS_AES_ENCRYPT_ALT.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200599 *
Rose Zadik7f441272018-01-22 11:48:23 +0000600 * \param ctx The AES context to use for encryption.
601 * \param input The plaintext block.
602 * \param output The output (ciphertext) block.
Andres AGf5bf7182017-03-03 14:09:56 +0000603 *
Rose Zadik7f441272018-01-22 11:48:23 +0000604 * \return \c 0 on success.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200605 */
Andres AGf5bf7182017-03-03 14:09:56 +0000606int mbedtls_internal_aes_encrypt( mbedtls_aes_context *ctx,
607 const unsigned char input[16],
608 unsigned char output[16] );
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200609
610/**
Rose Zadik7f441272018-01-22 11:48:23 +0000611 * \brief Internal AES block decryption function. This is only
612 * exposed to allow overriding it using see
613 * \c MBEDTLS_AES_DECRYPT_ALT.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200614 *
Rose Zadik7f441272018-01-22 11:48:23 +0000615 * \param ctx The AES context to use for decryption.
616 * \param input The ciphertext block.
617 * \param output The output (plaintext) block.
Andres AGf5bf7182017-03-03 14:09:56 +0000618 *
Rose Zadik7f441272018-01-22 11:48:23 +0000619 * \return \c 0 on success.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200620 */
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
625#if !defined(MBEDTLS_DEPRECATED_REMOVED)
626#if defined(MBEDTLS_DEPRECATED_WARNING)
627#define MBEDTLS_DEPRECATED __attribute__((deprecated))
628#else
629#define MBEDTLS_DEPRECATED
630#endif
631/**
Hanno Beckerca1cdb22017-07-20 09:50:59 +0100632 * \brief Deprecated internal AES block encryption function
633 * without return value.
Andres AGf5bf7182017-03-03 14:09:56 +0000634 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500635 * \deprecated Superseded by mbedtls_internal_aes_encrypt()
Andres AGf5bf7182017-03-03 14:09:56 +0000636 *
Rose Zadik7f441272018-01-22 11:48:23 +0000637 * \param ctx The AES context to use for encryption.
638 * \param input Plaintext block.
639 * \param output Output (ciphertext) block.
Andres AGf5bf7182017-03-03 14:09:56 +0000640 */
Hanno Beckerbedc2052017-06-26 12:46:56 +0100641MBEDTLS_DEPRECATED void mbedtls_aes_encrypt( mbedtls_aes_context *ctx,
642 const unsigned char input[16],
643 unsigned char output[16] );
Andres AGf5bf7182017-03-03 14:09:56 +0000644
645/**
Hanno Beckerca1cdb22017-07-20 09:50:59 +0100646 * \brief Deprecated internal AES block decryption function
647 * without return value.
Andres AGf5bf7182017-03-03 14:09:56 +0000648 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500649 * \deprecated Superseded by mbedtls_internal_aes_decrypt()
Andres AGf5bf7182017-03-03 14:09:56 +0000650 *
Rose Zadik7f441272018-01-22 11:48:23 +0000651 * \param ctx The AES context to use for decryption.
652 * \param input Ciphertext block.
653 * \param output Output (plaintext) block.
Andres AGf5bf7182017-03-03 14:09:56 +0000654 */
Hanno Beckerbedc2052017-06-26 12:46:56 +0100655MBEDTLS_DEPRECATED void mbedtls_aes_decrypt( mbedtls_aes_context *ctx,
656 const unsigned char input[16],
657 unsigned char output[16] );
Andres AGf5bf7182017-03-03 14:09:56 +0000658
659#undef MBEDTLS_DEPRECATED
660#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200661
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500662
663#if defined(MBEDTLS_SELF_TEST)
Paul Bakker5121ce52009-01-03 21:22:43 +0000664/**
Rose Zadik7f441272018-01-22 11:48:23 +0000665 * \brief Checkup routine.
Paul Bakker5121ce52009-01-03 21:22:43 +0000666 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100667 * \return \c 0 on success.
668 * \return \c 1 on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000669 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200670int mbedtls_aes_self_test( int verbose );
Paul Bakker5121ce52009-01-03 21:22:43 +0000671
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500672#endif /* MBEDTLS_SELF_TEST */
673
Paul Bakker5121ce52009-01-03 21:22:43 +0000674#ifdef __cplusplus
675}
676#endif
677
678#endif /* aes.h */