PolarSSL v1.1.4
Data Structures | Defines | Enumerations | Functions
cipher.h File Reference

Generic cipher wrapper. More...

#include <string.h>
Include dependency graph for cipher.h:
This graph shows which files directly or indirectly include this file:

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

Defines

#define POLARSSL_ERR_CIPHER_FEATURE_UNAVAILABLE   -0x6080
 The selected feature is not available.
#define POLARSSL_ERR_CIPHER_BAD_INPUT_DATA   -0x6100
 Bad input parameters to function.
#define POLARSSL_ERR_CIPHER_ALLOC_FAILED   -0x6180
 Failed to allocate memory.
#define POLARSSL_ERR_CIPHER_INVALID_PADDING   -0x6200
 Input data contains invalid padding and is rejected.
#define POLARSSL_ERR_CIPHER_FULL_BLOCK_EXPECTED   -0x6280
 Decryption of block requires a full block.

Enumerations

enum  cipher_id_t {
  POLARSSL_CIPHER_ID_NONE = 0, POLARSSL_CIPHER_ID_AES, POLARSSL_CIPHER_ID_DES, POLARSSL_CIPHER_ID_3DES,
  POLARSSL_CIPHER_ID_CAMELLIA
}
enum  cipher_type_t {
  POLARSSL_CIPHER_NONE = 0, POLARSSL_CIPHER_AES_128_CBC, POLARSSL_CIPHER_AES_192_CBC, POLARSSL_CIPHER_AES_256_CBC,
  POLARSSL_CIPHER_AES_128_CFB128, POLARSSL_CIPHER_AES_192_CFB128, POLARSSL_CIPHER_AES_256_CFB128, POLARSSL_CIPHER_AES_128_CTR,
  POLARSSL_CIPHER_AES_192_CTR, POLARSSL_CIPHER_AES_256_CTR, POLARSSL_CIPHER_CAMELLIA_128_CBC, POLARSSL_CIPHER_CAMELLIA_192_CBC,
  POLARSSL_CIPHER_CAMELLIA_256_CBC, POLARSSL_CIPHER_CAMELLIA_128_CFB128, POLARSSL_CIPHER_CAMELLIA_192_CFB128, POLARSSL_CIPHER_CAMELLIA_256_CFB128,
  POLARSSL_CIPHER_CAMELLIA_128_CTR, POLARSSL_CIPHER_CAMELLIA_192_CTR, POLARSSL_CIPHER_CAMELLIA_256_CTR, POLARSSL_CIPHER_DES_CBC,
  POLARSSL_CIPHER_DES_EDE_CBC, POLARSSL_CIPHER_DES_EDE3_CBC
}
enum  cipher_mode_t {
  POLARSSL_MODE_NONE = 0, POLARSSL_MODE_CBC, POLARSSL_MODE_CFB128, POLARSSL_MODE_OFB,
  POLARSSL_MODE_CTR
}
enum  operation_t { POLARSSL_OPERATION_NONE = -1, POLARSSL_DECRYPT = 0, POLARSSL_ENCRYPT }
enum  {
  POLARSSL_KEY_LENGTH_NONE = 0, POLARSSL_KEY_LENGTH_DES = 64, POLARSSL_KEY_LENGTH_DES_EDE = 128, POLARSSL_KEY_LENGTH_DES_EDE3 = 192,
  POLARSSL_MAX_IV_LENGTH = 16
}

Functions

const int * cipher_list (void)
 Returns the list of ciphers supported by the generic cipher module.
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_type (const cipher_type_t cipher_type)
 Returns the cipher information structure associated with the given cipher type.
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.
static unsigned int cipher_get_block_size (const cipher_context_t *ctx)
 Returns the block size of the given cipher.
static cipher_mode_t cipher_get_cipher_mode (const cipher_context_t *ctx)
 Returns the mode of operation for the cipher.
static int cipher_get_iv_size (const cipher_context_t *ctx)
 Returns the size of the cipher's IV.
static cipher_type_t cipher_get_type (const cipher_context_t *ctx)
 Returns the type of the given cipher.
static const char * cipher_get_name (const cipher_context_t *ctx)
 Returns the name of the given cipher, as a string.
static int cipher_get_key_size (const cipher_context_t *ctx)
 Returns the key length of the cipher.
static operation_t cipher_get_operation (const cipher_context_t *ctx)
 Returns the operation of the given cipher.
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_reset (cipher_context_t *ctx, const unsigned char *iv)
 Reset the given context, setting the IV to iv.
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.

Detailed Description

Generic cipher wrapper.

Author:
Adriaan de Jong dejon.nosp@m.g@fo.nosp@m.x-it..nosp@m.com

Copyright (C) 2006-2011, 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 Documentation

#define POLARSSL_ERR_CIPHER_ALLOC_FAILED   -0x6180

Failed to allocate memory.

Definition at line 45 of file cipher.h.

#define POLARSSL_ERR_CIPHER_BAD_INPUT_DATA   -0x6100

Bad input parameters to function.

Definition at line 44 of file cipher.h.

The selected feature is not available.

Definition at line 43 of file cipher.h.

Decryption of block requires a full block.

Definition at line 47 of file cipher.h.

Input data contains invalid padding and is rejected.

Definition at line 46 of file cipher.h.


Enumeration Type Documentation

anonymous enum
Enumerator:
POLARSSL_KEY_LENGTH_NONE 

Undefined key length.

POLARSSL_KEY_LENGTH_DES 

Key length, in bits (including parity), for DES keys.

POLARSSL_KEY_LENGTH_DES_EDE 

Key length, in bits (including parity), for DES in two key EDE.

POLARSSL_KEY_LENGTH_DES_EDE3 

Key length, in bits (including parity), for DES in three-key EDE.

POLARSSL_MAX_IV_LENGTH 

Maximum length of any IV, in bytes.

Definition at line 96 of file cipher.h.

Enumerator:
POLARSSL_CIPHER_ID_NONE 
POLARSSL_CIPHER_ID_AES 
POLARSSL_CIPHER_ID_DES 
POLARSSL_CIPHER_ID_3DES 
POLARSSL_CIPHER_ID_CAMELLIA 

Definition at line 49 of file cipher.h.

Enumerator:
POLARSSL_MODE_NONE 
POLARSSL_MODE_CBC 
POLARSSL_MODE_CFB128 
POLARSSL_MODE_OFB 
POLARSSL_MODE_CTR 

Definition at line 82 of file cipher.h.

Enumerator:
POLARSSL_CIPHER_NONE 
POLARSSL_CIPHER_AES_128_CBC 
POLARSSL_CIPHER_AES_192_CBC 
POLARSSL_CIPHER_AES_256_CBC 
POLARSSL_CIPHER_AES_128_CFB128 
POLARSSL_CIPHER_AES_192_CFB128 
POLARSSL_CIPHER_AES_256_CFB128 
POLARSSL_CIPHER_AES_128_CTR 
POLARSSL_CIPHER_AES_192_CTR 
POLARSSL_CIPHER_AES_256_CTR 
POLARSSL_CIPHER_CAMELLIA_128_CBC 
POLARSSL_CIPHER_CAMELLIA_192_CBC 
POLARSSL_CIPHER_CAMELLIA_256_CBC 
POLARSSL_CIPHER_CAMELLIA_128_CFB128 
POLARSSL_CIPHER_CAMELLIA_192_CFB128 
POLARSSL_CIPHER_CAMELLIA_256_CFB128 
POLARSSL_CIPHER_CAMELLIA_128_CTR 
POLARSSL_CIPHER_CAMELLIA_192_CTR 
POLARSSL_CIPHER_CAMELLIA_256_CTR 
POLARSSL_CIPHER_DES_CBC 
POLARSSL_CIPHER_DES_EDE_CBC 
POLARSSL_CIPHER_DES_EDE3_CBC 

Definition at line 57 of file cipher.h.

Enumerator:
POLARSSL_OPERATION_NONE 
POLARSSL_DECRYPT 
POLARSSL_ENCRYPT 

Definition at line 90 of file cipher.h.


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:
ctxGeneric cipher context
outputbuffer to write data to. Needs block_size data available.
olenlength 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.

Free the cipher-specific context of ctx.

Freeing ctx itself remains the responsibility of the caller.

Parameters:
ctxFree the cipher-specific context
Returns:
0 on success, POLARSSL_ERR_CIPHER_BAD_INPUT_DATA if parameter verification fails.
static unsigned int cipher_get_block_size ( const cipher_context_t ctx) [inline, static]

Returns the block size of the given cipher.

Parameters:
ctxcipher's context. Must have been initialised.
Returns:
size of the cipher's blocks, or 0 if ctx has not been initialised.

Definition at line 264 of file cipher.h.

References cipher_info_t::block_size, and cipher_context_t::cipher_info.

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)
Parameters:
ctxcipher's context. Must have been initialised.
Returns:
mode of operation, or POLARSSL_MODE_NONE if ctx has not been initialised.

Definition at line 281 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.

Parameters:
ctxcipher's context. Must have been initialised.
Returns:
size of the cipher's IV, or 0 if ctx has not been initialised.

Definition at line 297 of file cipher.h.

References cipher_context_t::cipher_info, and cipher_info_t::iv_size.

static int cipher_get_key_size ( const cipher_context_t ctx) [inline, static]

Returns the key length of the cipher.

Parameters:
ctxcipher's context. Must have been initialised.
Returns:
cipher's key length, in bits, or POLARSSL_KEY_LENGTH_NONE if ctx has not been initialised.

Definition at line 345 of file cipher.h.

References cipher_context_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.

Parameters:
ctxcipher's context. Must have been initialised.
Returns:
name of the cipher, or NULL if ctx was not initialised.

Definition at line 328 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.

Parameters:
ctxcipher's context. Must have been initialised.
Returns:
operation (POLARSSL_ENCRYPT or POLARSSL_DECRYPT), or POLARSSL_OPERATION_NONE if ctx has not been initialised.

Definition at line 362 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.

Parameters:
ctxcipher's context. Must have been initialised.
Returns:
type of the cipher, or POLARSSL_CIPHER_NONE if ctx has not been initialised.

Definition at line 313 of file cipher.h.

References cipher_context_t::cipher_info, 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.

Parameters:
cipher_nameName of the cipher to search for.
Returns:
the cipher information structure associated with the given cipher_name, or NULL if not found.
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_typeType of the cipher to search for.
Returns:
the cipher information structure associated with the given cipher_type, or NULL if not found.
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:
ctxcontext to initialise. May not be NULL.
cipher_infocipher 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.
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.
int cipher_reset ( cipher_context_t ctx,
const unsigned char *  iv 
)

Reset the given context, setting the IV to iv.

Parameters:
ctxgeneric cipher context
ivIV to use or NONCE_COUNTER in the case of a CTR-mode cipher
Returns:
0 on success, POLARSSL_ERR_CIPHER_BAD_INPUT_DATA if parameter verification fails.
int cipher_self_test ( int  verbose)

Checkup routine.

Returns:
0 if successful, or 1 if the test failed
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:
ctxgeneric cipher context. May not be NULL. Must have been initialised using cipher_context_from_type or cipher_context_from_string.
keyThe key to use.
key_lengthkey length to use, in bits.
operationOperation 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.
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.

Parameters:
ctxgeneric cipher context
inputbuffer holding the input data
ilenlength of the input data
outputbuffer for the output data. Should be able to hold at least ilen + block_size. Cannot be the same buffer as input!
olenlength 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.