Objects

Data Structures

struct  fsl_sho_ibo_t
struct  fsl_shw_uco_t
struct  fsl_shw_result_t
struct  fsl_shw_kso_t
struct  fsl_shw_sko_t
struct  fsl_shw_pco_t
 Platform Capability Object. More...
struct  fsl_shw_hco_t
struct  fsl_shw_hmco_t
struct  fsl_shw_scco_t
struct  fsl_shw_acco_t

Typedefs

typedef struct fsl_sho_ibo_t fsl_sho_ibo_t
typedef struct fsl_shw_uco_t fsl_shw_uco_t
typedef struct fsl_shw_result_t fsl_shw_result_t
typedef struct fsl_shw_kso_t fsl_shw_kso_t
typedef struct fsl_shw_sko_t fsl_shw_sko_t
typedef struct fsl_shw_pco_t fsl_shw_pco_t
typedef struct fsl_shw_hco_t fsl_shw_hco_t
typedef struct fsl_shw_hmco_t fsl_shw_hmco_t
typedef struct fsl_shw_scco_t fsl_shw_scco_t
typedef struct fsl_shw_acco_t fsl_shw_acco_t
typedef struct fsl_sho_ibo_t fsl_sho_ibo_t
typedef struct fsl_shw_uco_t fsl_shw_uco_t
typedef struct fsl_shw_result_t fsl_shw_result_t
typedef struct fsl_shw_kso_t fsl_shw_kso_t
typedef struct fsl_shw_sko_t fsl_shw_sko_t
typedef struct fsl_shw_pco_t fsl_shw_pco_t
typedef struct fsl_shw_hco_t fsl_shw_hco_t
typedef struct fsl_shw_hmco_t fsl_shw_hmco_t
typedef struct fsl_shw_scco_t fsl_shw_scco_t
typedef struct fsl_shw_acco_t fsl_shw_acco_t

Detailed Description

These objects are used to pass information into and out of the API. Through flags and other settings, they control the behavior of the Operational Functions.

They are manipulated and queried by use of the various access functions. There are different sets defined for each object. See Object-Manipulation Operations.


Typedef Documentation

typedef struct fsl_sho_ibo_t fsl_sho_ibo_t

Application Initialization Object

This object, the operations on it, and its interaction with the driver are TBD.

typedef struct fsl_sho_ibo_t fsl_sho_ibo_t

Application Initialization Object

This object, the operations on it, and its interaction with the driver are TBD.

Authenticate-Cipher Context Object

An object for controlling the function of, and holding information about, data for the authenticate-cipher functions, fsl_shw_gen_encrypt() and fsl_shw_auth_decrypt().

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions. See Authentication-Cipher Context Object Operations.

Authenticate-Cipher Context Object

An object for controlling the function of, and holding information about, data for the authenticate-cipher functions, fsl_shw_gen_encrypt() and fsl_shw_auth_decrypt().

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions. See Authentication-Cipher Context Object Operations.

typedef struct fsl_shw_hco_t fsl_shw_hco_t

Hash Context Object

This object contains information to control hashing functions.

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions. See Hash Context Object Operations.

typedef struct fsl_shw_hco_t fsl_shw_hco_t

Hash Context Object

This object contains information to control hashing functions.

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions. See Hash Context Object Operations.

HMAC Context Object

This object contains information to control HMAC functions.

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions. See HMAC Context Object Operations.

HMAC Context Object

This object contains information to control HMAC functions.

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions. See HMAC Context Object Operations.

typedef struct fsl_shw_kso_t fsl_shw_kso_t

Keystore Object

This object holds the context of a user keystore, including the functions that define the interface and pointers to where the key data is stored. The user must supply a set of functions to handle keystore management, including slot allocation, deallocation, etc. A default keystore manager is provided as part of the API.

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions. See Keystore Object Operations.

typedef struct fsl_shw_kso_t fsl_shw_kso_t

Keystore Object

This object holds the context of a user keystore, including the functions that define the interface and pointers to where the key data is stored. The user must supply a set of functions to handle keystore management, including slot allocation, deallocation, etc. A default keystore manager is provided as part of the API.

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions. See Keystore Object Operations.

typedef struct fsl_shw_pco_t fsl_shw_pco_t

Platform Capabilities Object

This object will contain information about the cryptographic features of the platform which the program is running on.

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions.

See Platform Context Object Operations.

typedef struct fsl_shw_pco_t fsl_shw_pco_t

Platform Capabilities Object

This object will contain information about the cryptographic features of the platform which the program is running on.

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions.

See Platform Context Object Operations.

Result Object

This object will contain success and failure information about a specific cryptographic request which has been made.

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions. See Result Object Operations.

Result Object

This object will contain success and failure information about a specific cryptographic request which has been made.

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions. See Result Object Operations.

Symmetric Cipher Context Object

This object contains information to control Symmetric Ciphering encrypt and decrypt functions in FSL_SYM_MODE_STREAM (ARC4), FSL_SYM_MODE_ECB, FSL_SYM_MODE_CBC, and FSL_SYM_MODE_CTR modes and the fsl_shw_symmetric_encrypt() and fsl_shw_symmetric_decrypt() functions. CCM mode is controlled with the fsl_shw_acco_t object.

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions. See Symmetric Cipher Context Operations.

Symmetric Cipher Context Object

This object contains information to control Symmetric Ciphering encrypt and decrypt functions in FSL_SYM_MODE_STREAM (ARC4), FSL_SYM_MODE_ECB, FSL_SYM_MODE_CBC, and FSL_SYM_MODE_CTR modes and the fsl_shw_symmetric_encrypt() and fsl_shw_symmetric_decrypt() functions. CCM mode is controlled with the fsl_shw_acco_t object.

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions. See Symmetric Cipher Context Operations.

typedef struct fsl_shw_sko_t fsl_shw_sko_t

Secret Key Object

This object contains a key for a cryptographic operation, and information about its current state, its intended usage, etc. It may instead contain information about a protected key, or an indication to use a platform- specific secret key.

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions. See Secret Key Object Operations.

typedef struct fsl_shw_sko_t fsl_shw_sko_t

Secret Key Object

This object contains a key for a cryptographic operation, and information about its current state, its intended usage, etc. It may instead contain information about a protected key, or an indication to use a platform- specific secret key.

No direct access to its members should be made by programs. Instead, the object should be manipulated using the provided functions. See Secret Key Object Operations.

typedef struct fsl_shw_uco_t fsl_shw_uco_t

User Context Object

This object must be initialized by a call to fsl_shw_uco_init(). It must then be passed to fsl_shw_register_user() before it can be used in any calls besides those in User Context Operations.

It contains the user's configuration for the API, for instance whether an operation should block, or instead should call back the user upon completion of the operation.

See User Context Operations for further information.

typedef struct fsl_shw_uco_t fsl_shw_uco_t

User Context Object

This object must be initialized by a call to fsl_shw_uco_init(). It must then be passed to fsl_shw_register_user() before it can be used in any calls besides those in User Context Operations.

It contains the user's configuration for the API, for instance whether an operation should block, or instead should call back the user upon completion of the operation.

See User Context Operations for further information.

footer
©  Freescale Semiconductor, Inc., 2007.  All rights reserved.
Freescale Confidential Proprietary
NDA Required
doxygen