mbed TLS v2.14.1

aes.h
Go to the documentation of this file.
1
23 /* Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved.
24 * 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.
37 *
38 * This file is part of Mbed TLS (https://tls.mbed.org)
39 */
40
41 #ifndef MBEDTLS_AES_H
42 #define MBEDTLS_AES_H
43
44 #if !defined(MBEDTLS_CONFIG_FILE)
45 #include "config.h"
46 #else
47 #include MBEDTLS_CONFIG_FILE
48 #endif
49
50 #include <stddef.h>
51 #include <stdint.h>
52
53 /* padlock.c and aesni.c rely on these values! */
54 #define MBEDTLS_AES_ENCRYPT 1
55 #define MBEDTLS_AES_DECRYPT 0
57 /* Error codes in range 0x0020-0x0022 */
58 #define MBEDTLS_ERR_AES_INVALID_KEY_LENGTH -0x0020
59 #define MBEDTLS_ERR_AES_INVALID_INPUT_LENGTH -0x0022
61 /* Error codes in range 0x0021-0x0025 */
62 #define MBEDTLS_ERR_AES_BAD_INPUT_DATA -0x0021
64 /* MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE is deprecated and should not be used. */
65 #define MBEDTLS_ERR_AES_FEATURE_UNAVAILABLE -0x0023
67 /* MBEDTLS_ERR_AES_HW_ACCEL_FAILED is deprecated and should not be used. */
68 #define MBEDTLS_ERR_AES_HW_ACCEL_FAILED -0x0025
70 #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
71 !defined(inline) && !defined(__cplusplus)
72 #define inline __inline
73 #endif
74
75 #ifdef __cplusplus
76 extern "C" {
77 #endif
78
79 #if !defined(MBEDTLS_AES_ALT)
80 // Regular implementation
81 //
82
86 typedef struct mbedtls_aes_context
87 {
88 int nr;
89 uint32_t *rk;
90 uint32_t buf[68];
98 }
99 mbedtls_aes_context;
100
101 #if defined(MBEDTLS_CIPHER_MODE_XTS)
102
105 typedef struct mbedtls_aes_xts_context
106 {
107 mbedtls_aes_context crypt;
109 mbedtls_aes_context tweak;
111 } mbedtls_aes_xts_context;
112 #endif /* MBEDTLS_CIPHER_MODE_XTS */
113
114 #else /* MBEDTLS_AES_ALT */
115 #include "aes_alt.h"
116 #endif /* MBEDTLS_AES_ALT */
117
126 void mbedtls_aes_init( mbedtls_aes_context *ctx );
127
133 void mbedtls_aes_free( mbedtls_aes_context *ctx );
134
135 #if defined(MBEDTLS_CIPHER_MODE_XTS)
136
144 void mbedtls_aes_xts_init( mbedtls_aes_xts_context *ctx );
145
151 void mbedtls_aes_xts_free( mbedtls_aes_xts_context *ctx );
152 #endif /* MBEDTLS_CIPHER_MODE_XTS */
153
167 int mbedtls_aes_setkey_enc( mbedtls_aes_context *ctx, const unsigned char *key,
168 unsigned int keybits );
169
183 int mbedtls_aes_setkey_dec( mbedtls_aes_context *ctx, const unsigned char *key,
184 unsigned int keybits );
185
186 #if defined(MBEDTLS_CIPHER_MODE_XTS)
187
201 int mbedtls_aes_xts_setkey_enc( mbedtls_aes_xts_context *ctx,
202 const unsigned char *key,
203 unsigned int keybits );
204
219 int mbedtls_aes_xts_setkey_dec( mbedtls_aes_xts_context *ctx,
220 const unsigned char *key,
221 unsigned int keybits );
222 #endif /* MBEDTLS_CIPHER_MODE_XTS */
223
244 int mbedtls_aes_crypt_ecb( mbedtls_aes_context *ctx,
245 int mode,
246 const unsigned char input[16],
247 unsigned char output[16] );
248
249 #if defined(MBEDTLS_CIPHER_MODE_CBC)
250
287 int mbedtls_aes_crypt_cbc( mbedtls_aes_context *ctx,
288 int mode,
289 size_t length,
290 unsigned char iv[16],
291 const unsigned char *input,
292 unsigned char *output );
293 #endif /* MBEDTLS_CIPHER_MODE_CBC */
294
295 #if defined(MBEDTLS_CIPHER_MODE_XTS)
296
330 int mbedtls_aes_crypt_xts( mbedtls_aes_xts_context *ctx,
331 int mode,
332 size_t length,
333 const unsigned char data_unit[16],
334 const unsigned char *input,
335 unsigned char *output );
336 #endif /* MBEDTLS_CIPHER_MODE_XTS */
337
338 #if defined(MBEDTLS_CIPHER_MODE_CFB)
339
373 int mbedtls_aes_crypt_cfb128( mbedtls_aes_context *ctx,
374 int mode,
375 size_t length,
376 size_t *iv_off,
377 unsigned char iv[16],
378 const unsigned char *input,
379 unsigned char *output );
380
413 int mbedtls_aes_crypt_cfb8( mbedtls_aes_context *ctx,
414 int mode,
415 size_t length,
416 unsigned char iv[16],
417 const unsigned char *input,
418 unsigned char *output );
419 #endif /*MBEDTLS_CIPHER_MODE_CFB */
420
421 #if defined(MBEDTLS_CIPHER_MODE_OFB)
422
462 int mbedtls_aes_crypt_ofb( mbedtls_aes_context *ctx,
463 size_t length,
464 size_t *iv_off,
465 unsigned char iv[16],
466 const unsigned char *input,
467 unsigned char *output );
468
469 #endif /* MBEDTLS_CIPHER_MODE_OFB */
470
471 #if defined(MBEDTLS_CIPHER_MODE_CTR)
472
542 int mbedtls_aes_crypt_ctr( mbedtls_aes_context *ctx,
543 size_t length,
544 size_t *nc_off,
545 unsigned char nonce_counter[16],
546 unsigned char stream_block[16],
547 const unsigned char *input,
548 unsigned char *output );
549 #endif /* MBEDTLS_CIPHER_MODE_CTR */
550
562 int mbedtls_internal_aes_encrypt( mbedtls_aes_context *ctx,
563 const unsigned char input[16],
564 unsigned char output[16] );
565
577 int mbedtls_internal_aes_decrypt( mbedtls_aes_context *ctx,
578 const unsigned char input[16],
579 unsigned char output[16] );
580
581 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
582 #if defined(MBEDTLS_DEPRECATED_WARNING)
583 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
584 #else
585 #define MBEDTLS_DEPRECATED
586 #endif
587
597 MBEDTLS_DEPRECATED void mbedtls_aes_encrypt( mbedtls_aes_context *ctx,
598 const unsigned char input[16],
599 unsigned char output[16] );
600
611 MBEDTLS_DEPRECATED void mbedtls_aes_decrypt( mbedtls_aes_context *ctx,
612 const unsigned char input[16],
613 unsigned char output[16] );
614
615 #undef MBEDTLS_DEPRECATED
616 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
617
624 int mbedtls_aes_self_test( int verbose );
625
626 #ifdef __cplusplus
627 }
628 #endif
629
630 #endif /* aes.h */
mbedtls_aes_context::buf
uint32_t buf[68]
Definition: aes.h:90
mbedtls_aes_xts_context::crypt
mbedtls_aes_context crypt
Definition: aes.h:107
mbedtls_aes_encrypt
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.
mbedtls_aes_self_test
int mbedtls_aes_self_test(int verbose)
Checkup routine.
mbedtls_aes_crypt_ofb
int mbedtls_aes_crypt_ofb(mbedtls_aes_context *ctx, size_t length, size_t *iv_off, unsigned char iv[16], const unsigned char *input, unsigned char *output)
This function performs an AES-OFB (Output Feedback Mode) encryption or decryption operation...
mbedtls_aes_xts_setkey_enc
int mbedtls_aes_xts_setkey_enc(mbedtls_aes_xts_context *ctx, const unsigned char *key, unsigned int keybits)
This function prepares an XTS context for encryption and sets the encryption key. ...
MBEDTLS_DEPRECATED
#define MBEDTLS_DEPRECATED
Definition: aes.h:585
config.h
Configuration options (set of defines)
mbedtls_aes_init
void mbedtls_aes_init(mbedtls_aes_context *ctx)
This function initializes the specified AES context.
mbedtls_internal_aes_encrypt
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...
mbedtls_aes_crypt_xts
int mbedtls_aes_crypt_xts(mbedtls_aes_xts_context *ctx, int mode, size_t length, const unsigned char data_unit[16], const unsigned char *input, unsigned char *output)
This function performs an AES-XTS encryption or decryption operation for an entire XTS data unit...
mbedtls_aes_context::nr
int nr
Definition: aes.h:88
mbedtls_aes_xts_init
void mbedtls_aes_xts_init(mbedtls_aes_xts_context *ctx)
This function initializes the specified AES XTS context.
mbedtls_aes_xts_context
The AES XTS context-type definition.
Definition: aes.h:105
mbedtls_aes_crypt_ctr
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.
mbedtls_aes_crypt_ecb
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.
mbedtls_aes_crypt_cbc
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.
mbedtls_aes_setkey_dec
int mbedtls_aes_setkey_dec(mbedtls_aes_context *ctx, const unsigned char *key, unsigned int keybits)
This function sets the decryption key.
mbedtls_aes_xts_free
void mbedtls_aes_xts_free(mbedtls_aes_xts_context *ctx)
This function releases and clears the specified AES XTS context.
mbedtls_aes_xts_context::tweak
mbedtls_aes_context tweak
Definition: aes.h:109
mbedtls_aes_crypt_cfb128
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.
mbedtls_aes_context::rk
uint32_t * rk
Definition: aes.h:89
mbedtls_aes_xts_setkey_dec
int mbedtls_aes_xts_setkey_dec(mbedtls_aes_xts_context *ctx, const unsigned char *key, unsigned int keybits)
This function prepares an XTS context for decryption and sets the decryption key. ...
mbedtls_aes_crypt_cfb8
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.
mbedtls_aes_setkey_enc
int mbedtls_aes_setkey_enc(mbedtls_aes_context *ctx, const unsigned char *key, unsigned int keybits)
This function sets the encryption key.
mbedtls_aes_free
void mbedtls_aes_free(mbedtls_aes_context *ctx)
This function releases and clears the specified AES context.
mbedtls_aes_context
The AES context-type definition.
Definition: aes.h:86
mbedtls_aes_xts_context
struct mbedtls_aes_xts_context mbedtls_aes_xts_context
The AES XTS context-type definition.
mbedtls_aes_context
struct mbedtls_aes_context mbedtls_aes_context
The AES context-type definition.
mbedtls_internal_aes_decrypt
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_aes_decrypt
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.