mbed TLS v1.3.14
|
Generic cipher wrapper. More...
Go to the source code of this file.
Data Structures | |
struct | cipher_base_t |
Base cipher information. More... | |
struct | cipher_info_t |
Cipher information. More... | |
struct | cipher_context_t |
Generic cipher context. More... | |
Macros | |
#define | POLARSSL_CIPHER_MODE_AEAD |
#define | POLARSSL_CIPHER_MODE_WITH_PADDING |
#define | POLARSSL_CIPHER_MODE_STREAM |
#define | POLARSSL_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080 |
The selected feature is not available. More... | |
#define | POLARSSL_ERR_CIPHER_BAD_INPUT_DATA -0x6100 |
Bad input parameters to function. More... | |
#define | POLARSSL_ERR_CIPHER_ALLOC_FAILED -0x6180 |
Failed to allocate memory. More... | |
#define | POLARSSL_ERR_CIPHER_INVALID_PADDING -0x6200 |
Input data contains invalid padding and is rejected. More... | |
#define | POLARSSL_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280 |
Decryption of block requires a full block. More... | |
#define | POLARSSL_ERR_CIPHER_AUTH_FAILED -0x6300 |
Authentication failed (for AEAD modes). More... | |
#define | POLARSSL_CIPHER_VARIABLE_IV_LEN 0x01 |
Cipher accepts IVs of variable length. More... | |
#define | POLARSSL_CIPHER_VARIABLE_KEY_LEN 0x02 |
Cipher accepts keys of variable length. More... | |
#define | POLARSSL_MAX_IV_LENGTH 16 |
Maximum length of any IV, in bytes. More... | |
#define | POLARSSL_MAX_BLOCK_LENGTH 16 |
Maximum block size of any cipher, in bytes. More... | |
#define | DEPRECATED |
Functions | |
const int * | cipher_list (void) |
Returns the list of ciphers supported by the generic cipher module. More... | |
const cipher_info_t * | cipher_info_from_string (const char *cipher_name) |
Returns the cipher information structure associated with the given cipher name. More... | |
const cipher_info_t * | cipher_info_from_type (const cipher_type_t cipher_type) |
Returns the cipher information structure associated with the given cipher type. More... | |
const cipher_info_t * | cipher_info_from_values (const cipher_id_t cipher_id, int key_length, const cipher_mode_t mode) |
Returns the cipher information structure associated with the given cipher id, key size and mode. More... | |
void | cipher_init (cipher_context_t *ctx) |
Initialize a cipher_context (as NONE) More... | |
void | cipher_free (cipher_context_t *ctx) |
Free and clear the cipher-specific context of ctx. More... | |
int | cipher_init_ctx (cipher_context_t *ctx, const cipher_info_t *cipher_info) |
Initialises and fills the cipher context structure with the appropriate values. More... | |
int | cipher_free_ctx (cipher_context_t *ctx) DEPRECATED |
Free the cipher-specific context of ctx. More... | |
static unsigned int | cipher_get_block_size (const cipher_context_t *ctx) |
Returns the block size of the given cipher. More... | |
static cipher_mode_t | cipher_get_cipher_mode (const cipher_context_t *ctx) |
Returns the mode of operation for the cipher. More... | |
static int | cipher_get_iv_size (const cipher_context_t *ctx) |
Returns the size of the cipher's IV/NONCE in bytes. More... | |
static cipher_type_t | cipher_get_type (const cipher_context_t *ctx) |
Returns the type of the given cipher. More... | |
static const char * | cipher_get_name (const cipher_context_t *ctx) |
Returns the name of the given cipher, as a string. More... | |
static int | cipher_get_key_size (const cipher_context_t *ctx) |
Returns the key length of the cipher. More... | |
static operation_t | cipher_get_operation (const cipher_context_t *ctx) |
Returns the operation of the given cipher. More... | |
int | cipher_setkey (cipher_context_t *ctx, const unsigned char *key, int key_length, const operation_t operation) |
Set the key to use with the given context. More... | |
int | cipher_set_padding_mode (cipher_context_t *ctx, cipher_padding_t mode) |
Set padding mode, for cipher modes that use padding. More... | |
int | cipher_set_iv (cipher_context_t *ctx, const unsigned char *iv, size_t iv_len) |
Set the initialization vector (IV) or nonce. More... | |
int | cipher_reset (cipher_context_t *ctx) |
Finish preparation of the given context. More... | |
int | cipher_update_ad (cipher_context_t *ctx, const unsigned char *ad, size_t ad_len) |
Add additional data (for AEAD ciphers). More... | |
int | cipher_update (cipher_context_t *ctx, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen) |
Generic cipher update function. More... | |
int | cipher_finish (cipher_context_t *ctx, unsigned char *output, size_t *olen) |
Generic cipher finalisation function. More... | |
int | cipher_write_tag (cipher_context_t *ctx, unsigned char *tag, size_t tag_len) |
Write tag for AEAD ciphers. More... | |
int | cipher_check_tag (cipher_context_t *ctx, const unsigned char *tag, size_t tag_len) |
Check tag for AEAD ciphers. More... | |
int | cipher_crypt (cipher_context_t *ctx, const unsigned char *iv, size_t iv_len, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen) |
Generic all-in-one encryption/decryption (for all ciphers except AEAD constructs). More... | |
int | cipher_auth_encrypt (cipher_context_t *ctx, const unsigned char *iv, size_t iv_len, const unsigned char *ad, size_t ad_len, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen, unsigned char *tag, size_t tag_len) |
Generic autenticated encryption (AEAD ciphers). More... | |
int | cipher_auth_decrypt (cipher_context_t *ctx, const unsigned char *iv, size_t iv_len, const unsigned char *ad, size_t ad_len, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen, const unsigned char *tag, size_t tag_len) |
Generic autenticated decryption (AEAD ciphers). More... | |
int | cipher_self_test (int verbose) |
Checkup routine. More... | |
Generic cipher wrapper.
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 cipher.h.
#define POLARSSL_CIPHER_VARIABLE_IV_LEN 0x01 |
#define POLARSSL_CIPHER_VARIABLE_KEY_LEN 0x02 |
#define POLARSSL_ERR_CIPHER_ALLOC_FAILED -0x6180 |
#define POLARSSL_ERR_CIPHER_AUTH_FAILED -0x6300 |
#define POLARSSL_ERR_CIPHER_BAD_INPUT_DATA -0x6100 |
#define POLARSSL_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080 |
#define POLARSSL_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280 |
#define POLARSSL_ERR_CIPHER_INVALID_PADDING -0x6200 |
#define POLARSSL_MAX_BLOCK_LENGTH 16 |
#define POLARSSL_MAX_IV_LENGTH 16 |
anonymous enum |
enum cipher_id_t |
enum cipher_mode_t |
enum cipher_padding_t |
enum cipher_type_t |
enum operation_t |
int cipher_auth_decrypt | ( | cipher_context_t * | ctx, |
const unsigned char * | iv, | ||
size_t | iv_len, | ||
const unsigned char * | ad, | ||
size_t | ad_len, | ||
const unsigned char * | input, | ||
size_t | ilen, | ||
unsigned char * | output, | ||
size_t * | olen, | ||
const unsigned char * | tag, | ||
size_t | tag_len | ||
) |
Generic autenticated decryption (AEAD ciphers).
ctx | generic cipher context |
iv | IV to use (or NONCE_COUNTER for CTR-mode ciphers) |
iv_len | IV length for ciphers with variable-size IV; discarded by ciphers with fixed-size IV. |
ad | Additional data to be authenticated. |
ad_len | Length of ad. |
input | buffer holding the input data |
ilen | length of the input data |
output | buffer for the output data. Should be able to hold at least ilen. |
olen | length of the output data, will be filled with the actual number of bytes written. |
tag | buffer holding the authentication tag |
tag_len | length of the authentication tag |
int cipher_auth_encrypt | ( | cipher_context_t * | ctx, |
const unsigned char * | iv, | ||
size_t | iv_len, | ||
const unsigned char * | ad, | ||
size_t | ad_len, | ||
const unsigned char * | input, | ||
size_t | ilen, | ||
unsigned char * | output, | ||
size_t * | olen, | ||
unsigned char * | tag, | ||
size_t | tag_len | ||
) |
Generic autenticated encryption (AEAD ciphers).
ctx | generic cipher context |
iv | IV to use (or NONCE_COUNTER for CTR-mode ciphers) |
iv_len | IV length for ciphers with variable-size IV; discarded by ciphers with fixed-size IV. |
ad | Additional data to authenticate. |
ad_len | Length of ad. |
input | buffer holding the input data |
ilen | length of the input data |
output | buffer for the output data. Should be able to hold at least ilen. |
olen | length of the output data, will be filled with the actual number of bytes written. |
tag | buffer for the authentication tag |
tag_len | desired tag length |
int cipher_check_tag | ( | cipher_context_t * | ctx, |
const unsigned char * | tag, | ||
size_t | tag_len | ||
) |
Check tag for AEAD ciphers.
Currently only supported with GCM. Must be called after cipher_finish().
ctx | Generic cipher context |
tag | Buffer holding the tag |
tag_len | Length of the tag to check |
int cipher_crypt | ( | cipher_context_t * | ctx, |
const unsigned char * | iv, | ||
size_t | iv_len, | ||
const unsigned char * | input, | ||
size_t | ilen, | ||
unsigned char * | output, | ||
size_t * | olen | ||
) |
Generic all-in-one encryption/decryption (for all ciphers except AEAD constructs).
ctx | generic cipher context |
iv | IV to use (or NONCE_COUNTER for CTR-mode ciphers) |
iv_len | IV length for ciphers with variable-size IV; discarded by ciphers with fixed-size IV. |
input | buffer holding the input data |
ilen | length of the input data |
output | buffer for the output data. Should be able to hold at least ilen + block_size. Cannot be the same buffer as input! |
olen | length of the output data, will be filled with the actual number of bytes written. |
int cipher_finish | ( | cipher_context_t * | ctx, |
unsigned char * | output, | ||
size_t * | olen | ||
) |
Generic cipher finalisation function.
If data still needs to be flushed from an incomplete block, data contained within it will be padded with the size of the last block, and written to the output buffer.
ctx | Generic cipher context |
output | buffer to write data to. Needs block_size available. |
olen | length of the data written to the output buffer. |
void cipher_free | ( | cipher_context_t * | ctx | ) |
Free and clear the cipher-specific context of ctx.
Freeing ctx itself remains the responsibility of the caller.
int cipher_free_ctx | ( | cipher_context_t * | ctx | ) |
Free the cipher-specific context of ctx.
Freeing ctx itself remains the responsibility of the caller.
ctx | Free the cipher-specific context |
|
inlinestatic |
Returns the block size of the given cipher.
ctx | cipher's context. Must have been initialised. |
Definition at line 400 of file cipher.h.
References cipher_info_t::block_size, and cipher_context_t::cipher_info.
|
inlinestatic |
Returns the mode of operation for the cipher.
(e.g. POLARSSL_MODE_CBC)
ctx | cipher's context. Must have been initialised. |
Definition at line 417 of file cipher.h.
References cipher_context_t::cipher_info, cipher_info_t::mode, and POLARSSL_MODE_NONE.
|
inlinestatic |
Returns the size of the cipher's IV/NONCE in bytes.
ctx | cipher's context. Must have been initialised. |
Definition at line 434 of file cipher.h.
References cipher_context_t::cipher_info, cipher_info_t::iv_size, and cipher_context_t::iv_size.
|
inlinestatic |
Returns the key length of the cipher.
ctx | cipher's context. Must have been initialised. |
Definition at line 485 of file cipher.h.
References cipher_context_t::cipher_info, cipher_info_t::key_length, and POLARSSL_KEY_LENGTH_NONE.
|
inlinestatic |
Returns the name of the given cipher, as a string.
ctx | cipher's context. Must have been initialised. |
Definition at line 468 of file cipher.h.
References cipher_context_t::cipher_info, and cipher_info_t::name.
|
inlinestatic |
Returns the operation of the given cipher.
ctx | cipher's context. Must have been initialised. |
Definition at line 502 of file cipher.h.
References cipher_context_t::cipher_info, cipher_context_t::operation, and POLARSSL_OPERATION_NONE.
|
inlinestatic |
Returns the type of the given cipher.
ctx | cipher's context. Must have been initialised. |
Definition at line 453 of file cipher.h.
References cipher_context_t::cipher_info, POLARSSL_CIPHER_NONE, and cipher_info_t::type.
const cipher_info_t* cipher_info_from_string | ( | const char * | cipher_name | ) |
Returns the cipher information structure associated with the given cipher name.
cipher_name | Name of the cipher to search for. |
const cipher_info_t* cipher_info_from_type | ( | const cipher_type_t | cipher_type | ) |
Returns the cipher information structure associated with the given cipher type.
cipher_type | Type of the cipher to search for. |
const cipher_info_t* cipher_info_from_values | ( | const cipher_id_t | cipher_id, |
int | key_length, | ||
const cipher_mode_t | mode | ||
) |
Returns the cipher information structure associated with the given cipher id, key size and mode.
cipher_id | Id of the cipher to search for (e.g. POLARSSL_CIPHER_ID_AES) |
key_length | Length of the key in bits |
mode | Cipher mode (e.g. POLARSSL_MODE_CBC) |
void cipher_init | ( | cipher_context_t * | ctx | ) |
Initialize a cipher_context (as NONE)
int cipher_init_ctx | ( | cipher_context_t * | ctx, |
const cipher_info_t * | cipher_info | ||
) |
Initialises and fills the cipher context structure with the appropriate values.
ctx | context to initialise. May not be NULL. |
cipher_info | cipher to use. |
const int* cipher_list | ( | void | ) |
Returns the list of ciphers supported by the generic cipher module.
int cipher_reset | ( | cipher_context_t * | ctx | ) |
Finish preparation of the given context.
ctx | generic cipher context |
int cipher_self_test | ( | int | verbose | ) |
Checkup routine.
int cipher_set_iv | ( | cipher_context_t * | ctx, |
const unsigned char * | iv, | ||
size_t | iv_len | ||
) |
Set the initialization vector (IV) or nonce.
ctx | generic cipher context |
iv | IV to use (or NONCE_COUNTER for CTR-mode ciphers) |
iv_len | IV length for ciphers with variable-size IV; discarded by ciphers with fixed-size IV. |
int cipher_set_padding_mode | ( | cipher_context_t * | ctx, |
cipher_padding_t | mode | ||
) |
Set padding mode, for cipher modes that use padding.
(Default: PKCS7 padding.)
ctx | generic cipher context |
mode | padding mode |
int cipher_setkey | ( | cipher_context_t * | ctx, |
const unsigned char * | key, | ||
int | key_length, | ||
const operation_t | operation | ||
) |
Set the key to use with the given context.
ctx | generic cipher context. May not be NULL. Must have been initialised using cipher_context_from_type or cipher_context_from_string. |
key | The key to use. |
key_length | key length to use, in bits. |
operation | Operation that the key will be used for, either POLARSSL_ENCRYPT or POLARSSL_DECRYPT. |
int cipher_update | ( | cipher_context_t * | ctx, |
const unsigned char * | input, | ||
size_t | ilen, | ||
unsigned char * | output, | ||
size_t * | olen | ||
) |
Generic cipher update function.
Encrypts/decrypts using the given cipher context. Writes as many block size'd blocks of data as possible to output. Any data that cannot be written immediately will either be added to the next block, or flushed when cipher_final is called. Exception: for POLARSSL_MODE_ECB, expects single block in size (e.g. 16 bytes for AES)
ctx | generic cipher context |
input | buffer holding the input data |
ilen | length of the input data |
output | buffer for the output data. Should be able to hold at least ilen + block_size. Cannot be the same buffer as input! |
olen | length of the output data, will be filled with the actual number of bytes written. |
int cipher_update_ad | ( | cipher_context_t * | ctx, |
const unsigned char * | ad, | ||
size_t | ad_len | ||
) |
Add additional data (for AEAD ciphers).
Currently only supported with GCM. Must be called exactly once, after cipher_reset().
ctx | generic cipher context |
ad | Additional data to use. |
ad_len | Length of ad. |
int cipher_write_tag | ( | cipher_context_t * | ctx, |
unsigned char * | tag, | ||
size_t | tag_len | ||
) |
Write tag for AEAD ciphers.
Currently only supported with GCM. Must be called after cipher_finish().
ctx | Generic cipher context |
tag | buffer to write the tag |
tag_len | Length of the tag to write |