cipher.c File Reference

Generic cipher wrapper for PolarSSL. More...

#include "polarssl/config.h"
#include "polarssl/cipher.h"
#include "polarssl/cipher_wrap.h"
#include "polarssl/gcm.h"
#include <stdlib.h>
#include <stdio.h>
Include dependency graph for cipher.c:

Go to the source code of this file.

Defines

#define POLARSSL_CIPHER_MODE_STREAM
#define ASSERT(x)

Functions

const int * cipher_list (void)
 Returns the list of ciphers supported by the generic cipher module.
const cipher_info_tcipher_info_from_type (const cipher_type_t cipher_type)
 Returns the cipher information structure associated with the given cipher type.
const cipher_info_tcipher_info_from_string (const char *cipher_name)
 Returns the cipher information structure associated with the given cipher name.
const cipher_info_tcipher_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.
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.
int cipher_free_ctx (cipher_context_t *ctx)
 Free the cipher-specific context of ctx.
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.
int cipher_set_iv (cipher_context_t *ctx, const unsigned char *iv, size_t iv_len)
 Set the initialization vector (IV) or nonce.
int cipher_reset (cipher_context_t *ctx)
 Finish preparation of the given context.
int cipher_update (cipher_context_t *ctx, const unsigned char *input, size_t ilen, unsigned char *output, size_t *olen)
 Generic cipher update function.
int cipher_finish (cipher_context_t *ctx, unsigned char *output, size_t *olen)
 Generic cipher finalisation function.
int cipher_self_test (int verbose)
 Checkup routine.

Variables

static int supported_init = 0

Detailed Description

Generic cipher wrapper for PolarSSL.

Author:
Adriaan de Jong <dejong@fox-it.com>

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.c.


Define Documentation

#define ASSERT (  ) 
Value:
if (!(x)) { \
        printf( "failed with %i at %s\n", value, (#x) ); \
    return( 1 ); \
}

Definition at line 774 of file cipher.c.

#define POLARSSL_CIPHER_MODE_STREAM

Definition at line 44 of file cipher.c.


Function Documentation

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.

Parameters:
ctx Generic cipher context
output buffer to write data to. Needs block_size available.
olen length of the data written to the output buffer.
Returns:
0 on success, POLARSSL_ERR_CIPHER_BAD_INPUT_DATA if parameter verification fails, POLARSSL_ERR_CIPHER_FULL_BLOCK_EXPECTED if decryption expected a full block but was not provided one, POLARSSL_ERR_CIPHER_INVALID_PADDING on invalid padding while decrypting or a cipher specific error code.

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.

Parameters:
ctx Free the cipher-specific context
Returns:
0 on success, POLARSSL_ERR_CIPHER_BAD_INPUT_DATA if parameter verification fails.

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().

const cipher_info_t* cipher_info_from_string ( const char *  cipher_name  ) 

Returns the cipher information structure associated with the given cipher name.

Parameters:
cipher_name Name of the cipher to search for.
Returns:
the cipher information structure associated with the given cipher_name, or NULL if not found.

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.

Parameters:
cipher_type Type of the cipher to search for.
Returns:
the cipher information structure associated with the given cipher_type, or NULL if not found.

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.

Parameters:
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)
Returns:
the cipher information structure associated with the given cipher_type, or NULL if not found.

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.

Parameters:
ctx context to initialise. May not be NULL.
cipher_info cipher to use.
Returns:
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.

Returns:
a statically allocated array of ciphers, the last entry is 0.

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.

Parameters:
ctx generic cipher context
Returns:
0 on success, POLARSSL_ERR_CIPHER_BAD_INPUT_DATA if parameter verification fails.

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.

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

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.

Parameters:
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.
Returns:
O on success, or POLARSSL_ERR_CIPHER_BAD_INPUT_DATA
Note:
Some ciphers don't use IVs nor NONCE. For these ciphers, this function has no effect.

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.

Parameters:
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.
Returns:
0 on success, POLARSSL_ERR_CIPHER_BAD_INPUT_DATA if parameter verification fails or a cipher specific error code.

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)

Parameters:
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.
Returns:
0 on success, POLARSSL_ERR_CIPHER_BAD_INPUT_DATA if parameter verification fails, POLARSSL_ERR_CIPHER_FEATURE_UNAVAILABLE on an unsupported mode for a cipher or a cipher specific error code.
Note:
If the underlying cipher is GCM, all calls to this function, except the last one before cipher_finish(), must have ilen a multiple of the block size.

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().


Variable Documentation

int supported_init = 0 [static]

Definition at line 52 of file cipher.c.

Referenced by cipher_list().


Generated on 9 Apr 2014 for PolarSSL v1.3.2 by  doxygen 1.6.1