blob: 197d4db10b8c23b7ec5bd391714d832534741b5d [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
Rose Zadik7f441272018-01-22 11:48:23 +000023/* Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved.
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020024 * SPDX-License-Identifier: Apache-2.0
25 *
26 * Licensed under the Apache License, Version 2.0 (the "License"); you may
27 * not use this file except in compliance with the License.
28 * You may obtain a copy of the License at
29 *
30 * http://www.apache.org/licenses/LICENSE-2.0
31 *
32 * Unless required by applicable law or agreed to in writing, software
33 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
34 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
35 * See the License for the specific language governing permissions and
36 * limitations under the License.
Paul Bakkerb96f1542010-07-18 20:36:00 +000037 *
Rose Zadik7f441272018-01-22 11:48:23 +000038 * This file is part of Mbed TLS (https://tls.mbed.org)
Paul Bakker5121ce52009-01-03 21:22:43 +000039 */
Rose Zadik7f441272018-01-22 11:48:23 +000040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020041#ifndef MBEDTLS_AES_H
42#define MBEDTLS_AES_H
Paul Bakker5121ce52009-01-03 21:22:43 +000043
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020044#if !defined(MBEDTLS_CONFIG_FILE)
Paul Bakker90995b52013-06-24 19:20:35 +020045#include "config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020046#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020047#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020048#endif
Paul Bakker90995b52013-06-24 19:20:35 +020049
Rich Evans00ab4702015-02-06 13:43:58 +000050#include <stddef.h>
Manuel Pégourié-Gonnardab229102015-04-15 11:53:16 +020051#include <stdint.h>
Paul Bakker5c2364c2012-10-01 14:41:15 +000052
Manuel Pégourié-Gonnard5b685652013-12-18 11:45:21 +010053/* padlock.c and aesni.c rely on these values! */
Rose Zadik7f441272018-01-22 11:48:23 +000054#define MBEDTLS_AES_ENCRYPT 1 /**< AES encryption. */
55#define MBEDTLS_AES_DECRYPT 0 /**< AES decryption. */
Paul Bakker5121ce52009-01-03 21:22:43 +000056
Andres Amaya Garciac5380642017-11-28 19:57:51 +000057/* Error codes in range 0x0020-0x0022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020058#define MBEDTLS_ERR_AES_INVALID_KEY_LENGTH -0x0020 /**< Invalid key length. */
59#define MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH -0x0022 /**< Invalid data input length. */
Paul Bakker2b222c82009-07-27 21:03:45 +000060
Mohammad Azim Khane5b5bd72017-11-24 10:52:51 +000061/* Error codes in range 0x0021-0x0025 */
62#define MBEDTLS_ERR_AES_BAD_INPUT_DATA -0x0021 /**< Invalid input data. */
Ron Eldor9924bdc2018-10-04 10:59:13 +030063
64/* MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE is deprecated and should not be used. */
Rose Zadik7f441272018-01-22 11:48:23 +000065#define MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE -0x0023 /**< Feature not available. For example, an unsupported AES key size. */
Ron Eldor9924bdc2018-10-04 10:59:13 +030066
67/* MBEDTLS_ERR_AES_HW_ACCEL_FAILED is deprecated and should not be used. */
Gilles Peskine7ecab3d2018-01-26 17:56:38 +010068#define MBEDTLS_ERR_AES_HW_ACCEL_FAILED -0x0025 /**< AES hardware accelerator failed. */
Paul Bakker5121ce52009-01-03 21:22:43 +000069
Andres AGf5bf7182017-03-03 14:09:56 +000070#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
71 !defined(inline) && !defined(__cplusplus)
72#define inline __inline
73#endif
74
Paul Bakker407a0da2013-06-27 14:29:21 +020075#ifdef __cplusplus
76extern "C" {
77#endif
78
Ron Eldorb2aacec2017-05-18 16:53:08 +030079#if !defined(MBEDTLS_AES_ALT)
80// Regular implementation
81//
82
Paul Bakker5121ce52009-01-03 21:22:43 +000083/**
Rose Zadik7f441272018-01-22 11:48:23 +000084 * \brief The AES context-type definition.
Paul Bakker5121ce52009-01-03 21:22:43 +000085 */
Dawid Drozd428cc522018-07-24 10:02:47 +020086typedef struct mbedtls_aes_context
Paul Bakker5121ce52009-01-03 21:22:43 +000087{
Rose Zadik7f441272018-01-22 11:48:23 +000088 int nr; /*!< The number of rounds. */
89 uint32_t *rk; /*!< AES round keys. */
90 uint32_t buf[68]; /*!< Unaligned data buffer. This buffer can
91 hold 32 extra Bytes, which can be used for
92 one of the following purposes:
93 <ul><li>Alignment if VIA padlock is
94 used.</li>
95 <li>Simplifying key expansion in the 256-bit
96 case by generating an extra round key.
97 </li></ul> */
Paul Bakker5121ce52009-01-03 21:22:43 +000098}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020099mbedtls_aes_context;
Paul Bakker5121ce52009-01-03 21:22:43 +0000100
Jaeden Amero9366feb2018-05-29 18:55:17 +0100101#if defined(MBEDTLS_CIPHER_MODE_XTS)
102/**
103 * \brief The AES XTS context-type definition.
104 */
Dawid Drozd428cc522018-07-24 10:02:47 +0200105typedef struct mbedtls_aes_xts_context
Jaeden Amero9366feb2018-05-29 18:55:17 +0100106{
107 mbedtls_aes_context crypt; /*!< The AES context to use for AES block
108 encryption or decryption. */
109 mbedtls_aes_context tweak; /*!< The AES context used for tweak
110 computation. */
111} mbedtls_aes_xts_context;
112#endif /* MBEDTLS_CIPHER_MODE_XTS */
113
Ron Eldorb2aacec2017-05-18 16:53:08 +0300114#else /* MBEDTLS_AES_ALT */
115#include "aes_alt.h"
116#endif /* MBEDTLS_AES_ALT */
117
Paul Bakker5121ce52009-01-03 21:22:43 +0000118/**
Rose Zadik7f441272018-01-22 11:48:23 +0000119 * \brief This function initializes the specified AES context.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200120 *
Rose Zadik7f441272018-01-22 11:48:23 +0000121 * It must be the first API called before using
122 * the context.
123 *
Manuel Pégourié-Gonnarded459e62018-12-12 10:20:33 +0100124 * \param ctx The AES context to initialize. This must not be \c NULL.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200126void mbedtls_aes_init( mbedtls_aes_context *ctx );
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200127
128/**
Rose Zadik7f441272018-01-22 11:48:23 +0000129 * \brief This function releases and clears the specified AES context.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200130 *
Manuel Pégourié-Gonnarded459e62018-12-12 10:20:33 +0100131 * \param ctx The AES context to clear.
132 * If this is \c NULL, this function does nothing.
133 * Otherwise, the context must have been at least initialized.
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200134 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200135void mbedtls_aes_free( mbedtls_aes_context *ctx );
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200136
Jaeden Amero9366feb2018-05-29 18:55:17 +0100137#if defined(MBEDTLS_CIPHER_MODE_XTS)
138/**
139 * \brief This function initializes the specified AES XTS context.
140 *
141 * It must be the first API called before using
142 * the context.
143 *
Manuel Pégourié-Gonnarded459e62018-12-12 10:20:33 +0100144 * \param ctx The AES XTS context to initialize. This must not be \c NULL.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100145 */
146void mbedtls_aes_xts_init( mbedtls_aes_xts_context *ctx );
147
148/**
149 * \brief This function releases and clears the specified AES XTS context.
150 *
Manuel Pégourié-Gonnarded459e62018-12-12 10:20:33 +0100151 * \param ctx The AES XTS context to clear.
152 * If this is \c NULL, this function does nothing.
153 * Otherwise, the context must have been at least initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100154 */
155void mbedtls_aes_xts_free( mbedtls_aes_xts_context *ctx );
156#endif /* MBEDTLS_CIPHER_MODE_XTS */
157
Paul Bakkerc7ea99a2014-06-18 11:12:03 +0200158/**
Rose Zadik7f441272018-01-22 11:48:23 +0000159 * \brief This function sets the encryption key.
Paul Bakker5121ce52009-01-03 21:22:43 +0000160 *
Manuel Pégourié-Gonnarded459e62018-12-12 10:20:33 +0100161 * \param ctx The AES context to which the key should be bound.
162 * It must be initialized.
163 * \param key The encryption key.
164 * This must be a readable buffer of size \p keybits bits.
Rose Zadik7f441272018-01-22 11:48:23 +0000165 * \param keybits The size of data passed in bits. Valid options are:
166 * <ul><li>128 bits</li>
167 * <li>192 bits</li>
168 * <li>256 bits</li></ul>
Paul Bakker2b222c82009-07-27 21:03:45 +0000169 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100170 * \return \c 0 on success.
Rose Zadik819d13d2018-04-16 09:35:15 +0100171 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000172 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200173int mbedtls_aes_setkey_enc( mbedtls_aes_context *ctx, const unsigned char *key,
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +0200174 unsigned int keybits );
Paul Bakker5121ce52009-01-03 21:22:43 +0000175
176/**
Rose Zadik7f441272018-01-22 11:48:23 +0000177 * \brief This function sets the decryption key.
Paul Bakker5121ce52009-01-03 21:22:43 +0000178 *
Manuel Pégourié-Gonnarded459e62018-12-12 10:20:33 +0100179 * \param ctx The AES context to which the key should be bound.
180 * It must be initialized.
181 * \param key The decryption key.
182 * This must be a readable buffer of size \p keybits bits.
Rose Zadik7f441272018-01-22 11:48:23 +0000183 * \param keybits The size of data passed. Valid options are:
184 * <ul><li>128 bits</li>
185 * <li>192 bits</li>
186 * <li>256 bits</li></ul>
Paul Bakker2b222c82009-07-27 21:03:45 +0000187 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100188 * \return \c 0 on success.
189 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000190 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200191int mbedtls_aes_setkey_dec( mbedtls_aes_context *ctx, const unsigned char *key,
Manuel Pégourié-Gonnardb8186a52015-06-18 14:58:58 +0200192 unsigned int keybits );
Paul Bakker5121ce52009-01-03 21:22:43 +0000193
Jaeden Amero9366feb2018-05-29 18:55:17 +0100194#if defined(MBEDTLS_CIPHER_MODE_XTS)
195/**
196 * \brief This function prepares an XTS context for encryption and
197 * sets the encryption key.
198 *
199 * \param ctx The AES XTS context to which the key should be bound.
Manuel Pégourié-Gonnard68e3dff2018-12-12 12:48:04 +0100200 * It must be initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100201 * \param key The encryption key. This is comprised of the XTS key1
202 * concatenated with the XTS key2.
Manuel Pégourié-Gonnard68e3dff2018-12-12 12:48:04 +0100203 * This must be a readable buffer of size \p keybits bits.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100204 * \param keybits The size of \p key passed in bits. Valid options are:
205 * <ul><li>256 bits (each of key1 and key2 is a 128-bit key)</li>
206 * <li>512 bits (each of key1 and key2 is a 256-bit key)</li></ul>
207 *
208 * \return \c 0 on success.
209 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
210 */
211int mbedtls_aes_xts_setkey_enc( mbedtls_aes_xts_context *ctx,
212 const unsigned char *key,
213 unsigned int keybits );
214
215/**
216 * \brief This function prepares an XTS context for decryption and
217 * sets the decryption key.
218 *
219 * \param ctx The AES XTS context to which the key should be bound.
Manuel Pégourié-Gonnard68e3dff2018-12-12 12:48:04 +0100220 * It must be initialized.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100221 * \param key The decryption key. This is comprised of the XTS key1
222 * concatenated with the XTS key2.
Manuel Pégourié-Gonnard68e3dff2018-12-12 12:48:04 +0100223 * This must be a readable buffer of size \p keybits bits.
Jaeden Amero9366feb2018-05-29 18:55:17 +0100224 * \param keybits The size of \p key passed in bits. Valid options are:
225 * <ul><li>256 bits (each of key1 and key2 is a 128-bit key)</li>
226 * <li>512 bits (each of key1 and key2 is a 256-bit key)</li></ul>
227 *
228 * \return \c 0 on success.
229 * \return #MBEDTLS_ERR_AES_INVALID_KEY_LENGTH on failure.
230 */
231int mbedtls_aes_xts_setkey_dec( mbedtls_aes_xts_context *ctx,
232 const unsigned char *key,
233 unsigned int keybits );
234#endif /* MBEDTLS_CIPHER_MODE_XTS */
235
Paul Bakker5121ce52009-01-03 21:22:43 +0000236/**
Rose Zadik7f441272018-01-22 11:48:23 +0000237 * \brief This function performs an AES single-block encryption or
238 * decryption operation.
Paul Bakker5121ce52009-01-03 21:22:43 +0000239 *
Rose Zadik7f441272018-01-22 11:48:23 +0000240 * It performs the operation defined in the \p mode parameter
241 * (encrypt or decrypt), on the input data buffer defined in
242 * the \p input parameter.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000243 *
Rose Zadik7f441272018-01-22 11:48:23 +0000244 * mbedtls_aes_init(), and either mbedtls_aes_setkey_enc() or
245 * mbedtls_aes_setkey_dec() must be called before the first
246 * call to this API with the same context.
247 *
248 * \param ctx The AES context to use for encryption or decryption.
249 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
250 * #MBEDTLS_AES_DECRYPT.
251 * \param input The 16-Byte buffer holding the input data.
252 * \param output The 16-Byte buffer holding the output data.
253
254 * \return \c 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +0000255 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200256int mbedtls_aes_crypt_ecb( mbedtls_aes_context *ctx,
Paul Bakker5121ce52009-01-03 21:22:43 +0000257 int mode,
Paul Bakkerff60ee62010-03-16 21:09:09 +0000258 const unsigned char input[16],
Paul Bakker5121ce52009-01-03 21:22:43 +0000259 unsigned char output[16] );
260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261#if defined(MBEDTLS_CIPHER_MODE_CBC)
Paul Bakker5121ce52009-01-03 21:22:43 +0000262/**
Rose Zadik7f441272018-01-22 11:48:23 +0000263 * \brief This function performs an AES-CBC encryption or decryption operation
264 * on full blocks.
Paul Bakker5121ce52009-01-03 21:22:43 +0000265 *
Rose Zadik7f441272018-01-22 11:48:23 +0000266 * It performs the operation defined in the \p mode
267 * parameter (encrypt/decrypt), on the input data buffer defined in
268 * the \p input parameter.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000269 *
Rose Zadik7f441272018-01-22 11:48:23 +0000270 * It can be called as many times as needed, until all the input
271 * data is processed. mbedtls_aes_init(), and either
272 * mbedtls_aes_setkey_enc() or mbedtls_aes_setkey_dec() must be called
273 * before the first call to this API with the same context.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000274 *
Rose Zadik7f441272018-01-22 11:48:23 +0000275 * \note This function operates on aligned blocks, that is, the input size
276 * must be a multiple of the AES block size of 16 Bytes.
277 *
278 * \note Upon exit, the content of the IV is updated so that you can
279 * call the same function again on the next
280 * block(s) of data and get the same result as if it was
281 * encrypted in one call. This allows a "streaming" usage.
282 * If you need to retain the contents of the IV, you should
283 * either save it manually or use the cipher module instead.
284 *
285 *
286 * \param ctx The AES context to use for encryption or decryption.
287 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
288 * #MBEDTLS_AES_DECRYPT.
289 * \param length The length of the input data in Bytes. This must be a
290 * multiple of the block size (16 Bytes).
291 * \param iv Initialization vector (updated after use).
292 * \param input The buffer holding the input data.
293 * \param output The buffer holding the output data.
294 *
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 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200299int mbedtls_aes_crypt_cbc( mbedtls_aes_context *ctx,
Paul Bakker5121ce52009-01-03 21:22:43 +0000300 int mode,
Paul Bakker23986e52011-04-24 08:57:21 +0000301 size_t length,
Paul Bakker5121ce52009-01-03 21:22:43 +0000302 unsigned char iv[16],
Paul Bakkerff60ee62010-03-16 21:09:09 +0000303 const unsigned char *input,
Paul Bakker5121ce52009-01-03 21:22:43 +0000304 unsigned char *output );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200305#endif /* MBEDTLS_CIPHER_MODE_CBC */
Paul Bakker5121ce52009-01-03 21:22:43 +0000306
Aorimn5f778012016-06-09 23:22:58 +0200307#if defined(MBEDTLS_CIPHER_MODE_XTS)
308/**
Jaeden Amero9366feb2018-05-29 18:55:17 +0100309 * \brief This function performs an AES-XTS encryption or decryption
310 * operation for an entire XTS data unit.
Aorimn5f778012016-06-09 23:22:58 +0200311 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100312 * AES-XTS encrypts or decrypts blocks based on their location as
313 * defined by a data unit number. The data unit number must be
Jaeden Amerocd9fc5e2018-05-30 15:23:24 +0100314 * provided by \p data_unit.
Aorimn5f778012016-06-09 23:22:58 +0200315 *
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100316 * NIST SP 800-38E limits the maximum size of a data unit to 2^20
317 * AES blocks. If the data unit is larger than this, this function
318 * returns #MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH.
319 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100320 * \param ctx The AES XTS context to use for AES XTS operations.
321 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
322 * #MBEDTLS_AES_DECRYPT.
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100323 * \param length The length of a data unit in bytes. This can be any
324 * length between 16 bytes and 2^24 bytes inclusive
325 * (between 1 and 2^20 block cipher blocks).
Jaeden Amerocd9fc5e2018-05-30 15:23:24 +0100326 * \param data_unit The address of the data unit encoded as an array of 16
Jaeden Amero9366feb2018-05-29 18:55:17 +0100327 * bytes in little-endian format. For disk encryption, this
328 * is typically the index of the block device sector that
329 * contains the data.
330 * \param input The buffer holding the input data (which is an entire
331 * data unit). This function reads \p length bytes from \p
332 * input.
333 * \param output The buffer holding the output data (which is an entire
334 * data unit). This function writes \p length bytes to \p
335 * output.
Aorimn5f778012016-06-09 23:22:58 +0200336 *
Jaeden Amero9366feb2018-05-29 18:55:17 +0100337 * \return \c 0 on success.
338 * \return #MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH if \p length is
Jaeden Amero0a8b0202018-05-30 15:36:06 +0100339 * smaller than an AES block in size (16 bytes) or if \p
340 * length is larger than 2^20 blocks (16 MiB).
Aorimn5f778012016-06-09 23:22:58 +0200341 */
Jaeden Amero9366feb2018-05-29 18:55:17 +0100342int mbedtls_aes_crypt_xts( mbedtls_aes_xts_context *ctx,
343 int mode,
Jaeden Amero5162b932018-05-29 12:55:24 +0100344 size_t length,
Jaeden Amerocd9fc5e2018-05-30 15:23:24 +0100345 const unsigned char data_unit[16],
Jaeden Amero9366feb2018-05-29 18:55:17 +0100346 const unsigned char *input,
347 unsigned char *output );
Aorimn5f778012016-06-09 23:22:58 +0200348#endif /* MBEDTLS_CIPHER_MODE_XTS */
349
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200350#if defined(MBEDTLS_CIPHER_MODE_CFB)
Paul Bakker5121ce52009-01-03 21:22:43 +0000351/**
Rose Zadik7f441272018-01-22 11:48:23 +0000352 * \brief This function performs an AES-CFB128 encryption or decryption
353 * operation.
Paul Bakker5121ce52009-01-03 21:22:43 +0000354 *
Rose Zadik7f441272018-01-22 11:48:23 +0000355 * It performs the operation defined in the \p mode
356 * parameter (encrypt or decrypt), on the input data buffer
357 * defined in the \p input parameter.
Paul Bakkerca6f3e22011-10-06 13:11:08 +0000358 *
Rose Zadik7f441272018-01-22 11:48:23 +0000359 * For CFB, you must set up the context with mbedtls_aes_setkey_enc(),
360 * regardless of whether you are performing an encryption or decryption
361 * operation, that is, regardless of the \p mode parameter. This is
362 * because CFB mode uses the same key schedule for encryption and
363 * decryption.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000364 *
Rose Zadik7f441272018-01-22 11:48:23 +0000365 * \note Upon exit, the content of the IV is updated so that you can
366 * call the same function again on the next
367 * block(s) of data and get the same result as if it was
368 * encrypted in one call. This allows a "streaming" usage.
369 * If you need to retain the contents of the
370 * IV, you must either save it manually or use the cipher
371 * module instead.
Paul Bakkerf3ccc682010-03-18 21:21:02 +0000372 *
Rose Zadik7f441272018-01-22 11:48:23 +0000373 *
374 * \param ctx The AES context to use for encryption or decryption.
375 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
376 * #MBEDTLS_AES_DECRYPT.
377 * \param length The length of the input data.
378 * \param iv_off The offset in IV (updated after use).
379 * \param iv The initialization vector (updated after use).
380 * \param input The buffer holding the input data.
381 * \param output The buffer holding the output data.
382 *
383 * \return \c 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +0000384 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200385int mbedtls_aes_crypt_cfb128( mbedtls_aes_context *ctx,
Paul Bakker5121ce52009-01-03 21:22:43 +0000386 int mode,
Paul Bakker23986e52011-04-24 08:57:21 +0000387 size_t length,
Paul Bakker1ef71df2011-06-09 14:14:58 +0000388 size_t *iv_off,
Paul Bakker5121ce52009-01-03 21:22:43 +0000389 unsigned char iv[16],
Paul Bakkerff60ee62010-03-16 21:09:09 +0000390 const unsigned char *input,
Paul Bakker5121ce52009-01-03 21:22:43 +0000391 unsigned char *output );
392
Paul Bakker9a736322012-11-14 12:39:52 +0000393/**
Rose Zadik7f441272018-01-22 11:48:23 +0000394 * \brief This function performs an AES-CFB8 encryption or decryption
395 * operation.
Paul Bakker556efba2014-01-24 15:38:12 +0100396 *
Rose Zadik7f441272018-01-22 11:48:23 +0000397 * It performs the operation defined in the \p mode
398 * parameter (encrypt/decrypt), on the input data buffer defined
399 * in the \p input parameter.
Paul Bakker556efba2014-01-24 15:38:12 +0100400 *
Rose Zadik7f441272018-01-22 11:48:23 +0000401 * Due to the nature of CFB, you must use the same key schedule for
402 * both encryption and decryption operations. Therefore, you must
403 * use the context initialized with mbedtls_aes_setkey_enc() for
404 * both #MBEDTLS_AES_ENCRYPT and #MBEDTLS_AES_DECRYPT.
Manuel Pégourié-Gonnard2be147a2015-01-23 16:19:47 +0000405 *
Rose Zadik7f441272018-01-22 11:48:23 +0000406 * \note Upon exit, the content of the IV is updated so that you can
407 * call the same function again on the next
408 * block(s) of data and get the same result as if it was
409 * encrypted in one call. This allows a "streaming" usage.
410 * If you need to retain the contents of the
411 * IV, you should either save it manually or use the cipher
412 * module instead.
Paul Bakker556efba2014-01-24 15:38:12 +0100413 *
Rose Zadik7f441272018-01-22 11:48:23 +0000414 *
415 * \param ctx The AES context to use for encryption or decryption.
416 * \param mode The AES operation: #MBEDTLS_AES_ENCRYPT or
417 * #MBEDTLS_AES_DECRYPT
418 * \param length The length of the input data.
419 * \param iv The initialization vector (updated after use).
420 * \param input The buffer holding the input data.
421 * \param output The buffer holding the output data.
422 *
423 * \return \c 0 on success.
Paul Bakker556efba2014-01-24 15:38:12 +0100424 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200425int mbedtls_aes_crypt_cfb8( mbedtls_aes_context *ctx,
Paul Bakker556efba2014-01-24 15:38:12 +0100426 int mode,
427 size_t length,
428 unsigned char iv[16],
429 const unsigned char *input,
430 unsigned char *output );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200431#endif /*MBEDTLS_CIPHER_MODE_CFB */
Paul Bakker556efba2014-01-24 15:38:12 +0100432
Simon Butcher76a5b222018-04-22 22:57:27 +0100433#if defined(MBEDTLS_CIPHER_MODE_OFB)
434/**
Simon Butcher5db13622018-06-04 22:11:25 +0100435 * \brief This function performs an AES-OFB (Output Feedback Mode)
436 * encryption or decryption operation.
Simon Butcher76a5b222018-04-22 22:57:27 +0100437 *
Simon Butcher5db13622018-06-04 22:11:25 +0100438 * For OFB, you must set up the context with
439 * mbedtls_aes_setkey_enc(), regardless of whether you are
440 * performing an encryption or decryption operation. This is
441 * because OFB mode uses the same key schedule for encryption and
442 * decryption.
Simon Butcher76a5b222018-04-22 22:57:27 +0100443 *
Simon Butcher5db13622018-06-04 22:11:25 +0100444 * The OFB operation is identical for encryption or decryption,
445 * therefore no operation mode needs to be specified.
Simon Butcher76a5b222018-04-22 22:57:27 +0100446 *
Simon Butcher5db13622018-06-04 22:11:25 +0100447 * \note Upon exit, the content of iv, the Initialisation Vector, is
448 * updated so that you can call the same function again on the next
449 * block(s) of data and get the same result as if it was encrypted
450 * in one call. This allows a "streaming" usage, by initialising
451 * iv_off to 0 before the first call, and preserving its value
452 * between calls.
Simon Butcher968646c2018-06-02 18:27:04 +0100453 *
Simon Butcher5db13622018-06-04 22:11:25 +0100454 * For non-streaming use, the iv should be initialised on each call
455 * to a unique value, and iv_off set to 0 on each call.
Simon Butcher968646c2018-06-02 18:27:04 +0100456 *
Simon Butcher5db13622018-06-04 22:11:25 +0100457 * If you need to retain the contents of the initialisation vector,
458 * you must either save it manually or use the cipher module
459 * instead.
Simon Butcher968646c2018-06-02 18:27:04 +0100460 *
Jaeden Amerocb2c9352018-06-08 10:34:08 +0100461 * \warning For the OFB mode, the initialisation vector must be unique
462 * every encryption operation. Reuse of an initialisation vector
463 * will compromise security.
Simon Butcher76a5b222018-04-22 22:57:27 +0100464 *
465 * \param ctx The AES context to use for encryption or decryption.
466 * \param length The length of the input data.
467 * \param iv_off The offset in IV (updated after use).
468 * \param iv The initialization vector (updated after use).
469 * \param input The buffer holding the input data.
470 * \param output The buffer holding the output data.
471 *
472 * \return \c 0 on success.
473 */
474int mbedtls_aes_crypt_ofb( mbedtls_aes_context *ctx,
475 size_t length,
476 size_t *iv_off,
477 unsigned char iv[16],
478 const unsigned char *input,
479 unsigned char *output );
480
481#endif /* MBEDTLS_CIPHER_MODE_OFB */
482
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200483#if defined(MBEDTLS_CIPHER_MODE_CTR)
Paul Bakker556efba2014-01-24 15:38:12 +0100484/**
Rose Zadik7f441272018-01-22 11:48:23 +0000485 * \brief This function performs an AES-CTR encryption or decryption
486 * operation.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000487 *
Rose Zadik7f441272018-01-22 11:48:23 +0000488 * This function performs the operation defined in the \p mode
489 * parameter (encrypt/decrypt), on the input data buffer
490 * defined in the \p input parameter.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000491 *
Rose Zadik7f441272018-01-22 11:48:23 +0000492 * Due to the nature of CTR, you must use the same key schedule
493 * for both encryption and decryption operations. Therefore, you
494 * must use the context initialized with mbedtls_aes_setkey_enc()
495 * for both #MBEDTLS_AES_ENCRYPT and #MBEDTLS_AES_DECRYPT.
Paul Bakkerca6f3e22011-10-06 13:11:08 +0000496 *
Manuel Pégourié-Gonnard22997b72018-02-28 12:29:41 +0100497 * \warning You must never reuse a nonce value with the same key. Doing so
498 * would void the encryption for the two messages encrypted with
499 * the same nonce and key.
500 *
501 * There are two common strategies for managing nonces with CTR:
502 *
Manuel Pégourié-Gonnard4f24e952018-05-24 11:59:30 +0200503 * 1. You can handle everything as a single message processed over
504 * successive calls to this function. In that case, you want to
505 * set \p nonce_counter and \p nc_off to 0 for the first call, and
506 * then preserve the values of \p nonce_counter, \p nc_off and \p
507 * stream_block across calls to this function as they will be
508 * updated by this function.
Manuel Pégourié-Gonnard22997b72018-02-28 12:29:41 +0100509 *
Manuel Pégourié-Gonnard4f24e952018-05-24 11:59:30 +0200510 * With this strategy, you must not encrypt more than 2**128
511 * blocks of data with the same key.
512 *
513 * 2. You can encrypt separate messages by dividing the \p
514 * nonce_counter buffer in two areas: the first one used for a
515 * per-message nonce, handled by yourself, and the second one
516 * updated by this function internally.
517 *
518 * For example, you might reserve the first 12 bytes for the
519 * per-message nonce, and the last 4 bytes for internal use. In that
520 * case, before calling this function on a new message you need to
521 * set the first 12 bytes of \p nonce_counter to your chosen nonce
522 * value, the last 4 to 0, and \p nc_off to 0 (which will cause \p
523 * stream_block to be ignored). That way, you can encrypt at most
524 * 2**96 messages of up to 2**32 blocks each with the same key.
525 *
526 * The per-message nonce (or information sufficient to reconstruct
527 * it) needs to be communicated with the ciphertext and must be unique.
528 * The recommended way to ensure uniqueness is to use a message
529 * counter. An alternative is to generate random nonces, but this
530 * limits the number of messages that can be securely encrypted:
531 * for example, with 96-bit random nonces, you should not encrypt
532 * more than 2**32 messages with the same key.
533 *
534 * Note that for both stategies, sizes are measured in blocks and
535 * that an AES block is 16 bytes.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000536 *
Manuel Pégourié-Gonnardfa0c47d2018-05-24 19:02:06 +0200537 * \warning Upon return, \p stream_block contains sensitive data. Its
538 * content must not be written to insecure storage and should be
539 * securely discarded as soon as it's no longer needed.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000540 *
Rose Zadik7f441272018-01-22 11:48:23 +0000541 * \param ctx The AES context to use for encryption or decryption.
542 * \param length The length of the input data.
543 * \param nc_off The offset in the current \p stream_block, for
544 * resuming within the current cipher stream. The
545 * offset pointer should be 0 at the start of a stream.
546 * \param nonce_counter The 128-bit nonce and counter.
547 * \param stream_block The saved stream block for resuming. This is
548 * overwritten by the function.
549 * \param input The buffer holding the input data.
550 * \param output The buffer holding the output data.
551 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100552 * \return \c 0 on success.
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000553 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200554int mbedtls_aes_crypt_ctr( mbedtls_aes_context *ctx,
Paul Bakker1ef71df2011-06-09 14:14:58 +0000555 size_t length,
556 size_t *nc_off,
Paul Bakkerb6ecaf52011-04-19 14:29:23 +0000557 unsigned char nonce_counter[16],
558 unsigned char stream_block[16],
559 const unsigned char *input,
560 unsigned char *output );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200561#endif /* MBEDTLS_CIPHER_MODE_CTR */
Paul Bakker90995b52013-06-24 19:20:35 +0200562
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200563/**
Rose Zadik7f441272018-01-22 11:48:23 +0000564 * \brief Internal AES block encryption function. This is only
565 * exposed to allow overriding it using
566 * \c MBEDTLS_AES_ENCRYPT_ALT.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200567 *
Rose Zadik7f441272018-01-22 11:48:23 +0000568 * \param ctx The AES context to use for encryption.
569 * \param input The plaintext block.
570 * \param output The output (ciphertext) block.
Andres AGf5bf7182017-03-03 14:09:56 +0000571 *
Rose Zadik7f441272018-01-22 11:48:23 +0000572 * \return \c 0 on success.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200573 */
Andres AGf5bf7182017-03-03 14:09:56 +0000574int mbedtls_internal_aes_encrypt( mbedtls_aes_context *ctx,
575 const unsigned char input[16],
576 unsigned char output[16] );
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200577
578/**
Rose Zadik7f441272018-01-22 11:48:23 +0000579 * \brief Internal AES block decryption function. This is only
580 * exposed to allow overriding it using see
581 * \c MBEDTLS_AES_DECRYPT_ALT.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200582 *
Rose Zadik7f441272018-01-22 11:48:23 +0000583 * \param ctx The AES context to use for decryption.
584 * \param input The ciphertext block.
585 * \param output The output (plaintext) block.
Andres AGf5bf7182017-03-03 14:09:56 +0000586 *
Rose Zadik7f441272018-01-22 11:48:23 +0000587 * \return \c 0 on success.
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200588 */
Andres AGf5bf7182017-03-03 14:09:56 +0000589int mbedtls_internal_aes_decrypt( mbedtls_aes_context *ctx,
590 const unsigned char input[16],
591 unsigned char output[16] );
592
593#if !defined(MBEDTLS_DEPRECATED_REMOVED)
594#if defined(MBEDTLS_DEPRECATED_WARNING)
595#define MBEDTLS_DEPRECATED __attribute__((deprecated))
596#else
597#define MBEDTLS_DEPRECATED
598#endif
599/**
Hanno Beckerca1cdb22017-07-20 09:50:59 +0100600 * \brief Deprecated internal AES block encryption function
601 * without return value.
Andres AGf5bf7182017-03-03 14:09:56 +0000602 *
Rose Zadik7f441272018-01-22 11:48:23 +0000603 * \deprecated Superseded by mbedtls_aes_encrypt_ext() in 2.5.0.
Andres AGf5bf7182017-03-03 14:09:56 +0000604 *
Rose Zadik7f441272018-01-22 11:48:23 +0000605 * \param ctx The AES context to use for encryption.
606 * \param input Plaintext block.
607 * \param output Output (ciphertext) block.
Andres AGf5bf7182017-03-03 14:09:56 +0000608 */
Hanno Beckerbedc2052017-06-26 12:46:56 +0100609MBEDTLS_DEPRECATED void mbedtls_aes_encrypt( mbedtls_aes_context *ctx,
610 const unsigned char input[16],
611 unsigned char output[16] );
Andres AGf5bf7182017-03-03 14:09:56 +0000612
613/**
Hanno Beckerca1cdb22017-07-20 09:50:59 +0100614 * \brief Deprecated internal AES block decryption function
615 * without return value.
Andres AGf5bf7182017-03-03 14:09:56 +0000616 *
Rose Zadik7f441272018-01-22 11:48:23 +0000617 * \deprecated Superseded by mbedtls_aes_decrypt_ext() in 2.5.0.
Andres AGf5bf7182017-03-03 14:09:56 +0000618 *
Rose Zadik7f441272018-01-22 11:48:23 +0000619 * \param ctx The AES context to use for decryption.
620 * \param input Ciphertext block.
621 * \param output Output (plaintext) block.
Andres AGf5bf7182017-03-03 14:09:56 +0000622 */
Hanno Beckerbedc2052017-06-26 12:46:56 +0100623MBEDTLS_DEPRECATED void mbedtls_aes_decrypt( mbedtls_aes_context *ctx,
624 const unsigned char input[16],
625 unsigned char output[16] );
Andres AGf5bf7182017-03-03 14:09:56 +0000626
627#undef MBEDTLS_DEPRECATED
628#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnard31993f22015-05-12 15:41:08 +0200629
Paul Bakker5121ce52009-01-03 21:22:43 +0000630/**
Rose Zadik7f441272018-01-22 11:48:23 +0000631 * \brief Checkup routine.
Paul Bakker5121ce52009-01-03 21:22:43 +0000632 *
Rose Zadik5ad7aea2018-03-26 12:00:09 +0100633 * \return \c 0 on success.
634 * \return \c 1 on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000635 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200636int mbedtls_aes_self_test( int verbose );
Paul Bakker5121ce52009-01-03 21:22:43 +0000637
638#ifdef __cplusplus
639}
640#endif
641
642#endif /* aes.h */