mbed TLS v2.7.17
aes.h
Go to the documentation of this file.
1 
15 /*
16  * Copyright The Mbed TLS Contributors
17  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
18  *
19  * This file is provided under the Apache License 2.0, or the
20  * GNU General Public License v2.0 or later.
21  *
22  * **********
23  * Apache License 2.0:
24  *
25  * Licensed under the Apache License, Version 2.0 (the "License"); you may
26  * not use this file except in compliance with the License.
27  * You may obtain a copy of the License at
28  *
29  * http://www.apache.org/licenses/LICENSE-2.0
30  *
31  * Unless required by applicable law or agreed to in writing, software
32  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
33  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
34  * See the License for the specific language governing permissions and
35  * limitations under the License.
36  *
37  * **********
38  *
39  * **********
40  * GNU General Public License v2.0 or later:
41  *
42  * This program is free software; you can redistribute it and/or modify
43  * it under the terms of the GNU General Public License as published by
44  * the Free Software Foundation; either version 2 of the License, or
45  * (at your option) any later version.
46  *
47  * This program is distributed in the hope that it will be useful,
48  * but WITHOUT ANY WARRANTY; without even the implied warranty of
49  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
50  * GNU General Public License for more details.
51  *
52  * You should have received a copy of the GNU General Public License along
53  * with this program; if not, write to the Free Software Foundation, Inc.,
54  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
55  *
56  * **********
57  */
58 
59 #ifndef MBEDTLS_AES_H
60 #define MBEDTLS_AES_H
61 
62 #if !defined(MBEDTLS_CONFIG_FILE)
63 #include "config.h"
64 #else
65 #include MBEDTLS_CONFIG_FILE
66 #endif
67 
68 #include <stddef.h>
69 #include <stdint.h>
70 
71 /* padlock.c and aesni.c rely on these values! */
72 #define MBEDTLS_AES_ENCRYPT 1
73 #define MBEDTLS_AES_DECRYPT 0
75 /* Error codes in range 0x0020-0x0022 */
76 #define MBEDTLS_ERR_AES_INVALID_KEY_LENGTH -0x0020
77 #define MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH -0x0022
79 /* Error codes in range 0x0023-0x0025 */
80 #define MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE -0x0023
81 #define MBEDTLS_ERR_AES_HW_ACCEL_FAILED -0x0025
83 #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
84  !defined(inline) && !defined(__cplusplus)
85 #define inline __inline
86 #endif
87 
88 #if !defined(MBEDTLS_AES_ALT)
89 // Regular implementation
90 //
91 
92 #ifdef __cplusplus
93 extern "C" {
94 #endif
95 
99 typedef struct
100 {
101  int nr;
102  uint32_t *rk;
103  uint32_t buf[68];
111 }
113 
123 
130 
144 int mbedtls_aes_setkey_enc( mbedtls_aes_context *ctx, const unsigned char *key,
145  unsigned int keybits );
146 
159 int mbedtls_aes_setkey_dec( mbedtls_aes_context *ctx, const unsigned char *key,
160  unsigned int keybits );
161 
183  int mode,
184  const unsigned char input[16],
185  unsigned char output[16] );
186 
187 #if defined(MBEDTLS_CIPHER_MODE_CBC)
188 
225  int mode,
226  size_t length,
227  unsigned char iv[16],
228  const unsigned char *input,
229  unsigned char *output );
230 #endif /* MBEDTLS_CIPHER_MODE_CBC */
231 
232 #if defined(MBEDTLS_CIPHER_MODE_CFB)
233 
268  int mode,
269  size_t length,
270  size_t *iv_off,
271  unsigned char iv[16],
272  const unsigned char *input,
273  unsigned char *output );
274 
308  int mode,
309  size_t length,
310  unsigned char iv[16],
311  const unsigned char *input,
312  unsigned char *output );
313 #endif /*MBEDTLS_CIPHER_MODE_CFB */
314 
315 #if defined(MBEDTLS_CIPHER_MODE_CTR)
316 
345  size_t length,
346  size_t *nc_off,
347  unsigned char nonce_counter[16],
348  unsigned char stream_block[16],
349  const unsigned char *input,
350  unsigned char *output );
351 #endif /* MBEDTLS_CIPHER_MODE_CTR */
352 
365  const unsigned char input[16],
366  unsigned char output[16] );
367 
380  const unsigned char input[16],
381  unsigned char output[16] );
382 
383 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
384 #if defined(MBEDTLS_DEPRECATED_WARNING)
385 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
386 #else
387 #define MBEDTLS_DEPRECATED
388 #endif
389 
400  const unsigned char input[16],
401  unsigned char output[16] );
402 
414  const unsigned char input[16],
415  unsigned char output[16] );
416 
417 #undef MBEDTLS_DEPRECATED
418 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
419 
420 #ifdef __cplusplus
421 }
422 #endif
423 
424 #else /* MBEDTLS_AES_ALT */
425 #include "aes_alt.h"
426 #endif /* MBEDTLS_AES_ALT */
427 
428 #ifdef __cplusplus
429 extern "C" {
430 #endif
431 
437 int mbedtls_aes_self_test( int verbose );
438 
439 #ifdef __cplusplus
440 }
441 #endif
442 
443 #endif /* aes.h */
MBEDTLS_DEPRECATED void mbedtls_aes_encrypt(mbedtls_aes_context *ctx, const unsigned char input[16], unsigned char output[16])
Deprecated internal AES block encryption function without return value.
int mbedtls_aes_self_test(int verbose)
Checkup routine.
#define MBEDTLS_DEPRECATED
Definition: aes.h:387
Configuration options (set of defines)
void mbedtls_aes_init(mbedtls_aes_context *ctx)
This function initializes the specified AES context.
int mbedtls_internal_aes_encrypt(mbedtls_aes_context *ctx, const unsigned char input[16], unsigned char output[16])
Internal AES block encryption function. This is only exposed to allow overriding it using MBEDTLS_AES...
int mbedtls_aes_crypt_ctr(mbedtls_aes_context *ctx, size_t length, size_t *nc_off, unsigned char nonce_counter[16], unsigned char stream_block[16], const unsigned char *input, unsigned char *output)
This function performs an AES-CTR encryption or decryption operation.
int mbedtls_aes_crypt_ecb(mbedtls_aes_context *ctx, int mode, const unsigned char input[16], unsigned char output[16])
This function performs an AES single-block encryption or decryption operation.
int mbedtls_aes_crypt_cbc(mbedtls_aes_context *ctx, int mode, size_t length, unsigned char iv[16], const unsigned char *input, unsigned char *output)
This function performs an AES-CBC encryption or decryption operation on full blocks.
int mbedtls_aes_setkey_dec(mbedtls_aes_context *ctx, const unsigned char *key, unsigned int keybits)
This function sets the decryption key.
int mbedtls_aes_crypt_cfb128(mbedtls_aes_context *ctx, int mode, size_t length, size_t *iv_off, unsigned char iv[16], const unsigned char *input, unsigned char *output)
This function performs an AES-CFB128 encryption or decryption operation.
uint32_t * rk
Definition: aes.h:102
int mbedtls_aes_crypt_cfb8(mbedtls_aes_context *ctx, int mode, size_t length, unsigned char iv[16], const unsigned char *input, unsigned char *output)
This function performs an AES-CFB8 encryption or decryption operation.
int mbedtls_aes_setkey_enc(mbedtls_aes_context *ctx, const unsigned char *key, unsigned int keybits)
This function sets the encryption key.
void mbedtls_aes_free(mbedtls_aes_context *ctx)
This function releases and clears the specified AES context.
The AES context-type definition.
Definition: aes.h:99
int mbedtls_internal_aes_decrypt(mbedtls_aes_context *ctx, const unsigned char input[16], unsigned char output[16])
Internal AES block decryption function. This is only exposed to allow overriding it using see MBEDTLS...
MBEDTLS_DEPRECATED void mbedtls_aes_decrypt(mbedtls_aes_context *ctx, const unsigned char input[16], unsigned char output[16])
Deprecated internal AES block decryption function without return value.