SSP Crypto Cipher Framework Interface

Interface definition for Synergy Crypto Cipher Framework module. More...

Data Structures
struct	sf_crypto_cipher_aes_init_params_t
struct	sf_crypto_cipher_rsa_init_params_t
struct	sf_crypto_cipher_cfg_t
struct	sf_crypto_cipher_api_t
struct	sf_crypto_cipher_instance_t

Typedefs
typedef void	sf_crypto_cipher_algorithm_init_params_t
typedef void	sf_crypto_cipher_ctrl_t

Enumerations
enum	sf_crypto_cipher_mode_t {   SF_CRYPTO_CIPHER_MODE_ECB, SF_CRYPTO_CIPHER_MODE_CBC, SF_CRYPTO_CIPHER_MODE_CTR, SF_CRYPTO_CIPHER_MODE_XTS,   SF_CRYPTO_CIPHER_MODE_GCM }
enum	sf_crypto_cipher_op_mode_t { SF_CRYPTO_CIPHER_OP_MODE_ENCRYPT, SF_CRYPTO_CIPHER_OP_MODE_DECRYPT }
enum	sf_crypto_cipher_padding_scheme_t { SF_CRYPTO_CIPHER_PADDING_SCHEME_NO_PADDING, SF_CRYPTO_CIPHER_PADDING_SCHEME_PKCS7, SF_CRYPTO_CIPHER_PADDING_SCHEME_PKCS1_1_5 }

Detailed Description

Interface definition for Synergy Crypto Cipher Framework module.

Summary

This is a ThreadX aware Interface of SF_CRYPTO_CIPHER Framework module which provides encryption and decryption operations for AES and RSA algorithms.

Crypto Cipher Framework Interface description: Crypto Framework

Typedef Documentation

sf_crypto_cipher_algorithm_init_params_t

typedef void sf_crypto_cipher_algorithm_init_params_t

Algorithm specific parameters. Allocate an algorithm specific block to pass into the cipherInit API call.

Implemented as

• sf_crypto_cipher_aes_init_params_t for AES
• sf_crypto_cipher_rsa_init_params_t for RSA.

sf_crypto_cipher_ctrl_t

typedef void sf_crypto_cipher_ctrl_t

SSP Crypto Cipher framework control block. Allocate an instance specific control block to pass into the SSP Crypto framework Cipher API calls.

Implemented as

• sf_crypto_cipher_instance_ctrl_t

Enumeration Type Documentation

sf_crypto_cipher_mode_t

enum sf_crypto_cipher_mode_t

AES modes for the SSP Crypto Cipher Framework

Enumerator
SF_CRYPTO_CIPHER_MODE_ECB	Electronic Code Book chaining mode, default for RSA.
SF_CRYPTO_CIPHER_MODE_CBC	Cipher Block Chaining.
SF_CRYPTO_CIPHER_MODE_CTR	Counter Mode.
SF_CRYPTO_CIPHER_MODE_XTS	XEX-based tweaked-codebook mode with ciphertext stealing.
SF_CRYPTO_CIPHER_MODE_GCM	Galois Counter Mode.

sf_crypto_cipher_op_mode_t

enum sf_crypto_cipher_op_mode_t

Operating mode for Cipher APIs

Enumerator
SF_CRYPTO_CIPHER_OP_MODE_ENCRYPT	The operating mode is set to encryption.
SF_CRYPTO_CIPHER_OP_MODE_DECRYPT	The operating mode is set to decryption.

sf_crypto_cipher_padding_scheme_t

enum sf_crypto_cipher_padding_scheme_t

Padding mode to be used for Cipher operation - encrypting/ decrypting input data

Enumerator
SF_CRYPTO_CIPHER_PADDING_SCHEME_NO_PADDING	No padding scheme.
SF_CRYPTO_CIPHER_PADDING_SCHEME_PKCS7	PKCS#7 padding scheme - applicable only for AES operations.
SF_CRYPTO_CIPHER_PADDING_SCHEME_PKCS1_1_5	PKCS#1 v1.5 padding scheme - applicable only for RSA operations.