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

Data Structures
struct	sf_crypto_signature_rsa_specific_params_t

struct	sf_crypto_signature_cfg_t

struct	sf_crypto_signature_api_t

struct	sf_crypto_signature_instance_t

Macros
#define	SF_CRYPTO_SIGNATURE_API_VERSION_MAJOR (2U)

Typedefs
typedef void	sf_crypto_signature_algorithm_init_params_t

typedef void	sf_crypto_signature_ctrl_t

Enumerations
enum	sf_crypto_signature_mode_t { SF_CRYPTO_SIGNATURE_MODE_SIGN, SF_CRYPTO_SIGNATURE_MODE_VERIFY }

enum	sf_crypto_signature_message_operation_t { SF_CRYPTO_SIGNATURE_MESSAGE_OPERATION_NONE, SF_CRYPTO_SIGNATURE_MESSAGE_OPERATION_RSA_SHA1_PKCS1_1_5, SF_CRYPTO_SIGNATURE_MESSAGE_OPERATION_RSA_SHA224_PKCS1_1_5, SF_CRYPTO_SIGNATURE_MESSAGE_OPERATION_RSA_SHA256_PKCS1_1_5 }

Detailed Description

Interface definition for Synergy Crypto Signature Framework module.

Summary

The Signature framework module is a ThreadX aware module which provides sign and sign-verify services. They Key type and Key size provided in the configuration parameter determine the cryptography algorithm type and uses the appropriate Driver API interface to provide requested functionality. User can change the operation mode (Sign / Verify), message format and key data input multiple times after opening this module using the Open API. There is no need to close the module using Close API and then re-open the module if the intent is to just change operation mode, message format and/or key data input parameters.

Crypto Signature Framework Interface description: Crypto Framework

Macro Definition Documentation

◆ SF_CRYPTO_SIGNATURE_API_VERSION_MAJOR

#define SF_CRYPTO_SIGNATURE_API_VERSION_MAJOR (2U)

The API version of SSP Crypto Signature Framework

Typedef Documentation

◆ sf_crypto_signature_algorithm_init_params_t

typedef void sf_crypto_signature_algorithm_init_params_t

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

Implemented as

sf_crypto_signature_rsa_specific_params_t for RSA

◆ sf_crypto_signature_ctrl_t

typedef void sf_crypto_signature_ctrl_t

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

Implemented as

sf_crypto_signature_instance_ctrl_t

Enumeration Type Documentation

◆ sf_crypto_signature_message_operation_t

enum sf_crypto_signature_message_operation_t

Signature message operation

Enumerator
SF_CRYPTO_SIGNATURE_MESSAGE_OPERATION_NONE	Input message is pre-formatted using appropriate format. Sign/verify operation is performed on the input message.
SF_CRYPTO_SIGNATURE_MESSAGE_OPERATION_RSA_SHA1_PKCS1_1_5	Generates a 20-byte (SHA-1) digest and signs/verifies the digest using RSASSA-PKCS1 v1.5 padding scheme.
SF_CRYPTO_SIGNATURE_MESSAGE_OPERATION_RSA_SHA224_PKCS1_1_5	Generates a 28-byte (SHA-224) digest and signs/verifies the digest using RSASSA-PKCS1 v1.5 padding scheme.
SF_CRYPTO_SIGNATURE_MESSAGE_OPERATION_RSA_SHA256_PKCS1_1_5	Generates a 32-byte (SHA-256) digest and signs/verifies the digest using RSASSA-PKCS1 v1.5 padding scheme.

◆ sf_crypto_signature_mode_t

enum sf_crypto_signature_mode_t

Signature mode, sign or verify

Enumerator
SF_CRYPTO_SIGNATURE_MODE_SIGN	Perform Sign Operation.
SF_CRYPTO_SIGNATURE_MODE_VERIFY	Perform Verify Operation.

Data Structures

Macros

Typedefs

Enumerations