Doug Anson / mbedTLSLibrary

mbed TLS library

Dependents:   HTTPClient-SSL WS_SERVER

Embed: (wiki syntax)

« Back to documentation index

aes.h File Reference
Data Structures | Functions

aes.h File Reference

AES block cipher. More...

Go to the source code of this file.

Data Structures

struct  aes_context
 AES context structure. More...

Functions

void aes_init (aes_context *ctx)
 Initialize AES context.
void aes_free (aes_context *ctx)
 Clear AES context.
int aes_setkey_enc (aes_context *ctx, const unsigned char *key, unsigned int keysize)
 AES key schedule (encryption)
int aes_setkey_dec (aes_context *ctx, const unsigned char *key, unsigned int keysize)
 AES key schedule (decryption)
int aes_crypt_ecb (aes_context *ctx, int mode, const unsigned char input[16], unsigned char output[16])
 AES-ECB block encryption/decryption.
int aes_crypt_cbc (aes_context *ctx, int mode, size_t length, unsigned char iv[16], const unsigned char *input, unsigned char *output)
 AES-CBC buffer encryption/decryption Length should be a multiple of the block size (16 bytes)
int aes_crypt_cfb128 (aes_context *ctx, int mode, size_t length, size_t *iv_off, unsigned char iv[16], const unsigned char *input, unsigned char *output)
 AES-CFB128 buffer encryption/decryption.
int aes_crypt_cfb8 (aes_context *ctx, int mode, size_t length, unsigned char iv[16], const unsigned char *input, unsigned char *output)
 AES-CFB8 buffer encryption/decryption.
int aes_crypt_ctr (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)
 AES-CTR buffer encryption/decryption.
int aes_self_test (int verbose)
 Checkup routine.

Detailed Description

AES block cipher.

Copyright (C) 2006-2014, ARM Limited, All Rights Reserved

This file is part of mbed TLS (https://tls.mbed.org)

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Definition in file aes.h.

Function Documentation

int aes_crypt_cbc ( aes_context *  ctx,
int  mode,
size_t  length,
unsigned char  iv[16],
const unsigned char *  input,
unsigned char *  output 
)

AES-CBC buffer encryption/decryption Length should be a multiple of the block size (16 bytes)

Note:
Upon exit, the content of the IV is updated so that you can call the function same function again on the following block(s) of data and get the same result as if it was encrypted in one call. This allows a "streaming" usage. If on the other hand you need to retain the contents of the IV, you should either save it manually or use the cipher module instead.
Parameters:
ctxAES context
modeAES_ENCRYPT or AES_DECRYPT
lengthlength of the input data
ivinitialization vector (updated after use)
inputbuffer holding the input data
outputbuffer holding the output data
Returns:
0 if successful, or POLARSSL_ERR_AES_INVALID_INPUT_LENGTH

Definition at line 822 of file aes.c.

int aes_crypt_cfb128 ( aes_context *  ctx,
int  mode,
size_t  length,
size_t *  iv_off,
unsigned char  iv[16],
const unsigned char *  input,
unsigned char *  output 
)

AES-CFB128 buffer encryption/decryption.

Note: Due to the nature of CFB you should use the same key schedule for both encryption and decryption. So a context initialized with aes_setkey_enc() for both AES_ENCRYPT and AES_DECRYPT.

Note:
Upon exit, the content of the IV is updated so that you can call the function same function again on the following block(s) of data and get the same result as if it was encrypted in one call. This allows a "streaming" usage. If on the other hand you need to retain the contents of the IV, you should either save it manually or use the cipher module instead.
Parameters:
ctxAES context
modeAES_ENCRYPT or AES_DECRYPT
lengthlength of the input data
iv_offoffset in IV (updated after use)
ivinitialization vector (updated after use)
inputbuffer holding the input data
outputbuffer holding the output data
Returns:
0 if successful

Definition at line 888 of file aes.c.

int aes_crypt_cfb8 ( aes_context *  ctx,
int  mode,
size_t  length,
unsigned char  iv[16],
const unsigned char *  input,
unsigned char *  output 
)

AES-CFB8 buffer encryption/decryption.

Note: Due to the nature of CFB you should use the same key schedule for both encryption and decryption. So a context initialized with aes_setkey_enc() for both AES_ENCRYPT and AES_DECRYPT.

Note:
Upon exit, the content of the IV is updated so that you can call the function same function again on the following block(s) of data and get the same result as if it was encrypted in one call. This allows a "streaming" usage. If on the other hand you need to retain the contents of the IV, you should either save it manually or use the cipher module instead.
Parameters:
ctxAES context
modeAES_ENCRYPT or AES_DECRYPT
lengthlength of the input data
ivinitialization vector (updated after use)
inputbuffer holding the input data
outputbuffer holding the output data
Returns:
0 if successful

Definition at line 934 of file aes.c.

int aes_crypt_ctr ( 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 
)

AES-CTR buffer encryption/decryption.

Warning: You have to keep the maximum use of your counter in mind!

Note: Due to the nature of CTR you should use the same key schedule for both encryption and decryption. So a context initialized with aes_setkey_enc() for both AES_ENCRYPT and AES_DECRYPT.

Parameters:
ctxAES context
lengthThe length of the data
nc_offThe offset in the current stream_block (for resuming within current cipher stream). The offset pointer to should be 0 at the start of a stream.
nonce_counterThe 128-bit nonce and counter.
stream_blockThe saved stream-block for resuming. Is overwritten by the function.
inputThe input data stream
outputThe output data stream
Returns:
0 if successful

Definition at line 968 of file aes.c.

int aes_crypt_ecb ( aes_context *  ctx,
int  mode,
const unsigned char  input[16],
unsigned char  output[16] 
)

AES-ECB block encryption/decryption.

Parameters:
ctxAES context
modeAES_ENCRYPT or AES_DECRYPT
input16-byte input block
output16-byte output block
Returns:
0 if successful

Definition at line 709 of file aes.c.

void aes_free ( aes_context *  ctx )

Clear AES context.

Parameters:
ctxAES context to be cleared

Definition at line 473 of file aes.c.

void aes_init ( aes_context *  ctx )

Initialize AES context.

Parameters:
ctxAES context to be initialized

Definition at line 468 of file aes.c.

int aes_self_test ( int  verbose )

Checkup routine.

Returns:
0 if successful, or 1 if the test failed

Definition at line 1182 of file aes.c.

int aes_setkey_dec ( aes_context *  ctx,
const unsigned char *  key,
unsigned int  keysize 
)

AES key schedule (decryption)

Parameters:
ctxAES context to be initialized
keydecryption key
keysizemust be 128, 192 or 256
Returns:
0 if successful, or POLARSSL_ERR_AES_INVALID_KEY_LENGTH

Definition at line 596 of file aes.c.

int aes_setkey_enc ( aes_context *  ctx,
const unsigned char *  key,
unsigned int  keysize 
)

AES key schedule (encryption)

Parameters:
ctxAES context to be initialized
keyencryption key
keysizemust be 128, 192 or 256
Returns:
0 if successful, or POLARSSL_ERR_AES_INVALID_KEY_LENGTH

Definition at line 484 of file aes.c.

Generated on Tue Jul 12 2022 13:50:39 by  doxygen 1.7.2