Generic cipher wrapper. More...
#include "config.h"
#include <string.h>
Go to the source code of this file.
Generic cipher wrapper.
Copyright (C) 2006-2013, Brainspark B.V.
This file is part of PolarSSL (http://www.polarssl.org) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
All rights reserved.
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_ERR_CIPHER_ALLOC_FAILED -0x6180 |
Failed to allocate memory.
Definition at line 55 of file cipher.h.
Referenced by cipher_init_ctx(), and polarssl_strerror().
#define POLARSSL_ERR_CIPHER_AUTH_FAILED -0x6300 |
Authentication failed (for AEAD modes).
Definition at line 58 of file cipher.h.
Referenced by polarssl_strerror(), and verify_int().
#define POLARSSL_ERR_CIPHER_BAD_INPUT_DATA -0x6100 |
Bad input parameters to function.
Definition at line 54 of file cipher.h.
Referenced by arc4_setkey_wrap(), cipher_finish(), cipher_free_ctx(), cipher_init_ctx(), cipher_reset(), cipher_set_iv(), cipher_setkey(), cipher_update(), polarssl_strerror(), and verify_int().
#define POLARSSL_ERR_CIPHER_FEATURE_UNAVAILABLE -0x6080 |
The selected feature is not available.
Definition at line 53 of file cipher.h.
Referenced by aes_crypt_cbc_wrap(), aes_crypt_cfb128_wrap(), aes_crypt_ctr_wrap(), blowfish_crypt_cbc_wrap(), blowfish_crypt_cfb64_wrap(), blowfish_crypt_ctr_wrap(), camellia_crypt_cbc_wrap(), camellia_crypt_cfb128_wrap(), camellia_crypt_ctr_wrap(), cipher_finish(), cipher_set_iv(), cipher_update(), des3_crypt_cbc_wrap(), des_crypt_cbc_wrap(), des_crypt_cfb128_wrap(), des_crypt_ctr_wrap(), polarssl_strerror(), and verify_int().
#define POLARSSL_ERR_CIPHER_FULL_BLOCK_EXPECTED -0x6280 |
Decryption of block requires a full block.
Definition at line 57 of file cipher.h.
Referenced by cipher_finish(), cipher_update(), polarssl_strerror(), test_suite_dec_empty_buf(), and verify_int().
#define POLARSSL_ERR_CIPHER_INVALID_PADDING -0x6200 |
Input data contains invalid padding and is rejected.
Definition at line 56 of file cipher.h.
Referenced by polarssl_strerror(), and verify_int().
#define POLARSSL_MAX_BLOCK_LENGTH 16 |
#define POLARSSL_MAX_IV_LENGTH 16 |
Maximum length of any IV, in bytes.
Definition at line 158 of file cipher.h.
Referenced by cipher_set_iv().
anonymous enum |
enum cipher_id_t |
enum cipher_mode_t |
enum cipher_padding_t |
enum cipher_type_t |
enum operation_t |
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. |
Definition at line 583 of file cipher.c.
References cipher_context_t::add_padding, cipher_info_t::base, cipher_base_t::cbc_func, cipher_context_t::cipher_ctx, cipher_get_block_size(), cipher_get_iv_size(), cipher_context_t::cipher_info, cipher_context_t::get_padding, cipher_context_t::iv, cipher_info_t::mode, cipher_context_t::operation, POLARSSL_DECRYPT, POLARSSL_ENCRYPT, POLARSSL_ERR_CIPHER_BAD_INPUT_DATA, POLARSSL_ERR_CIPHER_FEATURE_UNAVAILABLE, POLARSSL_ERR_CIPHER_FULL_BLOCK_EXPECTED, POLARSSL_MODE_CBC, POLARSSL_MODE_CFB, POLARSSL_MODE_CTR, POLARSSL_MODE_ECB, POLARSSL_MODE_GCM, POLARSSL_MODE_STREAM, cipher_context_t::unprocessed_data, and cipher_context_t::unprocessed_len.
Referenced by pkcs12_pbe(), pkcs5_pbes2(), ssl_decrypt_buf(), ssl_encrypt_buf(), test_suite_dec_empty_buf(), test_suite_decrypt_test_vec(), test_suite_enc_dec_buf(), test_suite_enc_dec_buf_multipart(), test_suite_enc_fail(), and test_suite_test_vec_ecb().
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 |
Definition at line 141 of file cipher.c.
References cipher_info_t::base, cipher_context_t::cipher_ctx, cipher_context_t::cipher_info, cipher_base_t::ctx_free_func, and POLARSSL_ERR_CIPHER_BAD_INPUT_DATA.
Referenced by gcm_free(), pkcs12_pbe(), pkcs5_pbes2(), ssl_transform_free(), test_suite_dec_empty_buf(), test_suite_decrypt_test_vec(), test_suite_enc_dec_buf(), test_suite_enc_dec_buf_multipart(), test_suite_enc_fail(), and test_suite_test_vec_ecb().
static unsigned int cipher_get_block_size | ( | const cipher_context_t * | ctx | ) | [inline, static] |
Returns the block size of the given cipher.
ctx | cipher's context. Must have been initialised. |
Definition at line 348 of file cipher.h.
References cipher_info_t::block_size, and cipher_context_t::cipher_info.
Referenced by cipher_finish(), cipher_update(), test_suite_enc_dec_buf(), test_suite_enc_dec_buf_multipart(), and test_suite_test_vec_ecb().
static cipher_mode_t cipher_get_cipher_mode | ( | const cipher_context_t * | ctx | ) | [inline, static] |
Returns the mode of operation for the cipher.
(e.g. POLARSSL_MODE_CBC)
ctx | cipher's context. Must have been initialised. |
Definition at line 365 of file cipher.h.
References cipher_context_t::cipher_info, cipher_info_t::mode, and POLARSSL_MODE_NONE.
static int cipher_get_iv_size | ( | const cipher_context_t * | ctx | ) | [inline, static] |
Returns the size of the cipher's IV/NONCE in bytes.
ctx | cipher's context. Must have been initialised. |
Definition at line 382 of file cipher.h.
References cipher_context_t::cipher_info, cipher_info_t::iv_size, and cipher_context_t::iv_size.
Referenced by cipher_finish().
static int cipher_get_key_size | ( | const cipher_context_t * | ctx | ) | [inline, static] |
Returns the key length of the cipher.
ctx | cipher's context. Must have been initialised. |
Definition at line 433 of file cipher.h.
References cipher_context_t::cipher_info, cipher_info_t::key_length, and POLARSSL_KEY_LENGTH_NONE.
static const char* cipher_get_name | ( | const cipher_context_t * | ctx | ) | [inline, static] |
Returns the name of the given cipher, as a string.
ctx | cipher's context. Must have been initialised. |
Definition at line 416 of file cipher.h.
References cipher_context_t::cipher_info, and cipher_info_t::name.
static operation_t cipher_get_operation | ( | const cipher_context_t * | ctx | ) | [inline, static] |
Returns the operation of the given cipher.
ctx | cipher's context. Must have been initialised. |
Definition at line 450 of file cipher.h.
References cipher_context_t::cipher_info, cipher_context_t::operation, and POLARSSL_OPERATION_NONE.
static cipher_type_t cipher_get_type | ( | const cipher_context_t * | ctx | ) | [inline, static] |
Returns the type of the given cipher.
ctx | cipher's context. Must have been initialised. |
Definition at line 401 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. |
Definition at line 86 of file cipher.c.
References cipher_definitions, cipher_definition_t::info, and cipher_info_t::name.
Referenced by test_suite_enc_dec_buf().
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. |
Definition at line 75 of file cipher.c.
References cipher_definitions, cipher_definition_t::info, and cipher_definition_t::type.
Referenced by pkcs12_pbe(), pkcs5_pbes2(), ssl_derive_keys(), test_suite_dec_empty_buf(), test_suite_decrypt_test_vec(), test_suite_enc_dec_buf(), test_suite_enc_dec_buf_multipart(), test_suite_enc_fail(), and test_suite_test_vec_ecb().
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) |
Definition at line 100 of file cipher.c.
References cipher_info_t::base, cipher_base_t::cipher, cipher_definitions, cipher_definition_t::info, cipher_info_t::key_length, and cipher_info_t::mode.
Referenced by gcm_init().
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. |
0
on success, POLARSSL_ERR_CIPHER_BAD_INPUT_DATA
on parameter failure, POLARSSL_ERR_CIPHER_ALLOC_FAILED
if allocation of the cipher-specific context failed. Definition at line 115 of file cipher.c.
References cipher_info_t::base, cipher_context_t::cipher_ctx, cipher_context_t::cipher_info, cipher_base_t::ctx_alloc_func, POLARSSL_ERR_CIPHER_ALLOC_FAILED, POLARSSL_ERR_CIPHER_BAD_INPUT_DATA, POLARSSL_PADDING_NONE, and POLARSSL_PADDING_PKCS7.
Referenced by gcm_init(), pkcs12_pbe(), pkcs5_pbes2(), ssl_derive_keys(), test_suite_dec_empty_buf(), test_suite_decrypt_test_vec(), test_suite_enc_dec_buf(), test_suite_enc_dec_buf_multipart(), test_suite_enc_fail(), and test_suite_test_vec_ecb().
const int* cipher_list | ( | void | ) |
Returns the list of ciphers supported by the generic cipher module.
Definition at line 54 of file cipher.c.
References cipher_definitions, supported_ciphers, supported_init, and cipher_definition_t::type.
int cipher_reset | ( | cipher_context_t * | ctx | ) |
Finish preparation of the given context.
ctx | generic cipher context |
Definition at line 210 of file cipher.c.
References cipher_context_t::cipher_info, POLARSSL_ERR_CIPHER_BAD_INPUT_DATA, and cipher_context_t::unprocessed_len.
Referenced by pkcs12_pbe(), pkcs5_pbes2(), ssl_decrypt_buf(), ssl_encrypt_buf(), test_suite_dec_empty_buf(), test_suite_decrypt_test_vec(), test_suite_enc_dec_buf(), test_suite_enc_dec_buf_multipart(), and test_suite_enc_fail().
int cipher_self_test | ( | int | verbose | ) |
Checkup routine.
Definition at line 782 of file cipher.c.
Referenced by test_suite_cipher_selftest().
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. |
Definition at line 181 of file cipher.c.
References cipher_info_t::accepts_variable_iv_size, cipher_context_t::cipher_info, cipher_context_t::iv, cipher_context_t::iv_size, cipher_info_t::iv_size, POLARSSL_ERR_CIPHER_BAD_INPUT_DATA, POLARSSL_ERR_CIPHER_FEATURE_UNAVAILABLE, and POLARSSL_MAX_IV_LENGTH.
Referenced by pkcs12_pbe(), pkcs5_pbes2(), ssl_decrypt_buf(), ssl_encrypt_buf(), test_suite_dec_empty_buf(), test_suite_decrypt_test_vec(), test_suite_enc_dec_buf(), test_suite_enc_dec_buf_multipart(), and test_suite_enc_fail().
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. |
Definition at line 151 of file cipher.c.
References cipher_info_t::base, cipher_context_t::cipher_ctx, cipher_context_t::cipher_info, cipher_context_t::key_length, cipher_info_t::key_length, cipher_info_t::mode, cipher_context_t::operation, POLARSSL_DECRYPT, POLARSSL_ENCRYPT, POLARSSL_ERR_CIPHER_BAD_INPUT_DATA, POLARSSL_MODE_CFB, POLARSSL_MODE_CTR, cipher_base_t::setkey_dec_func, and cipher_base_t::setkey_enc_func.
Referenced by gcm_init(), pkcs12_pbe(), pkcs5_pbes2(), ssl_derive_keys(), test_suite_dec_empty_buf(), test_suite_decrypt_test_vec(), test_suite_enc_dec_buf(), test_suite_enc_dec_buf_multipart(), test_suite_enc_fail(), and test_suite_test_vec_ecb().
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. |
Definition at line 239 of file cipher.c.
References cipher_info_t::base, cipher_base_t::cbc_func, cipher_base_t::cfb_func, cipher_context_t::cipher_ctx, cipher_get_block_size(), cipher_context_t::cipher_info, cipher_base_t::ctr_func, cipher_base_t::ecb_func, gcm_update(), cipher_context_t::iv, cipher_info_t::mode, cipher_context_t::operation, POLARSSL_DECRYPT, POLARSSL_ENCRYPT, POLARSSL_ERR_CIPHER_BAD_INPUT_DATA, POLARSSL_ERR_CIPHER_FEATURE_UNAVAILABLE, POLARSSL_ERR_CIPHER_FULL_BLOCK_EXPECTED, POLARSSL_MODE_CBC, POLARSSL_MODE_CFB, POLARSSL_MODE_CTR, POLARSSL_MODE_ECB, POLARSSL_MODE_GCM, POLARSSL_MODE_STREAM, cipher_base_t::stream_func, cipher_context_t::unprocessed_data, and cipher_context_t::unprocessed_len.
Referenced by gcm_gen_table(), gcm_starts(), gcm_update(), pkcs12_pbe(), pkcs5_pbes2(), ssl_decrypt_buf(), ssl_encrypt_buf(), test_suite_dec_empty_buf(), test_suite_decrypt_test_vec(), test_suite_enc_dec_buf(), test_suite_enc_dec_buf_multipart(), test_suite_enc_fail(), and test_suite_test_vec_ecb().