Flags to show information about link data and link segments. More...
Flags to show information about link data and link segments.
#define fsl_shw_acco_clear_flags | ( | acobject, | |||
acflags | ) | (acobject)->flags &= ~(acflags) |
Clear some flags in a Authentication-Cipher Context Object.
Turns off the flags specified in flags. Other flags are untouched.
acobject | Pointer to object to operate on. | |
acflags | The flags to reset (one or more from fsl_shw_auth_ctx_flags_t ORed together). |
#define fsl_shw_acco_clear_flags | ( | acobject, | |||
acflags | ) | (acobject)->flags &= ~(acflags) |
Clear some flags in a Authentication-Cipher Context Object.
Turns off the flags specified in flags. Other flags are untouched.
acobject | Pointer to object to operate on. | |
acflags | The flags to reset (one or more from fsl_shw_auth_ctx_flags_t ORed together). |
#define fsl_shw_acco_init | ( | acobject, | |||
acmode | ) |
{ \ (acobject)->flags = 0; \ (acobject)->mode = (acmode); \ }
Initialize a Authentication-Cipher Context.
acobject | Pointer to object to operate on. | |
acmode | The mode for this object (only FSL_ACC_MODE_CCM supported). |
#define fsl_shw_acco_init | ( | acobject, | |||
acmode | ) |
{ \ (acobject)->flags = 0; \ (acobject)->mode = (acmode); \ }
Initialize a Authentication-Cipher Context.
acobject | Pointer to object to operate on. | |
acmode | The mode for this object (only FSL_ACC_MODE_CCM supported). |
#define fsl_shw_acco_set_ccm | ( | acobject, | |||
acalg, | |||||
accounter, | |||||
acmaclen | ) |
{ \ (acobject)->flags = 0; \ (acobject)->mode = FSL_ACC_MODE_CCM; \ (acobject)->auth_info.CCM_ctx_info.block_size_bytes = 16; \ (acobject)->cipher_ctx_info.block_size_bytes = 16; \ (acobject)->mac_length = acmaclen; \ fsl_shw_scco_set_counter_info(&(acobject)->cipher_ctx_info, accounter, \ FSL_CTR_MOD_128); \ }
Set up the Authentication-Cipher Object for CCM mode.
This will set the auth_object for CCM mode and save the ctr, and mac_length. This function can be called instead of fsl_shw_acco_init().
The paramater ctr is Counter Block 0, (counter value 0), which is for the MAC.
acobject | Pointer to object to operate on. | |
acalg | Cipher algorithm. Only AES is supported. | |
accounter | The initial counter value. | |
acmaclen | The number of octets used for the MAC. Valid values are 4, 6, 8, 10, 12, 14, and 16. |
#define fsl_shw_acco_set_ccm | ( | acobject, | |||
acalg, | |||||
accounter, | |||||
acmaclen | ) |
{ \ (acobject)->flags = 0; \ (acobject)->mode = FSL_ACC_MODE_CCM; \ (acobject)->auth_info.CCM_ctx_info.block_size_bytes = 16; \ (acobject)->cipher_ctx_info.block_size_bytes = 16; \ (acobject)->mac_length = acmaclen; \ fsl_shw_scco_set_counter_info(&(acobject)->cipher_ctx_info, accounter, \ FSL_CTR_MOD_128); \ }
Set up the Authentication-Cipher Object for CCM mode.
This will set the auth_object for CCM mode and save the ctr, and mac_length. This function can be called instead of fsl_shw_acco_init().
The paramater ctr is Counter Block 0, (counter value 0), which is for the MAC.
acobject | Pointer to object to operate on. | |
acalg | Cipher algorithm. Only AES is supported. | |
accounter | The initial counter value. | |
acmaclen | The number of octets used for the MAC. Valid values are 4, 6, 8, 10, 12, 14, and 16. |
#define fsl_shw_acco_set_flags | ( | acobject, | |||
acflags | ) | (acobject)->flags |= (acflags) |
Set the flags for a Authentication-Cipher Context.
Turns on the flags specified in flags. Other flags are untouched.
acobject | Pointer to object to operate on. | |
acflags | The flags to set (one or more from fsl_shw_auth_ctx_flags_t ORed together). |
#define fsl_shw_acco_set_flags | ( | acobject, | |||
acflags | ) | (acobject)->flags |= (acflags) |
Set the flags for a Authentication-Cipher Context.
Turns on the flags specified in flags. Other flags are untouched.
acobject | Pointer to object to operate on. | |
acflags | The flags to set (one or more from fsl_shw_auth_ctx_flags_t ORed together). |
#define fsl_shw_ccm_nist_format_ctr_and_iv | ( | acobject, | |||
act, | |||||
acad, | |||||
acq, | |||||
acN, | |||||
acQ | ) |
{ \ uint64_t Q = acQ; \ uint8_t bflag = ((acad)?0x40:0) | ((((act)-2)/2)<<3) | ((acq)-1); \ unsigned i; \ uint8_t* qptr = (acobject)->auth_info.CCM_ctx_info.context + 15; \ (acobject)->auth_info.CCM_ctx_info.block_size_bytes = 16; \ (acobject)->cipher_ctx_info.block_size_bytes = 16; \ (acobject)->mode = FSL_ACC_MODE_CCM; \ (acobject)->flags = FSL_ACCO_NIST_CCM; \ \ /* Store away the MAC length (after calculating actual value */ \ (acobject)->mac_length = (act); \ /* Set Flag field in Block 0 */ \ *((acobject)->auth_info.CCM_ctx_info.context) = bflag; \ /* Set Nonce field in Block 0 */ \ copy_bytes((acobject)->auth_info.CCM_ctx_info.context+1, acN, \ 15-(acq)); \ /* Set Flag field in ctr */ \ *((acobject)->cipher_ctx_info.context) = (acq)-1; \ /* Update the Q (payload length) field of Block0 */ \ (acobject)->q_length = acq; \ for (i = 0; i < (acq); i++) { \ *qptr-- = Q & 0xFF; \ Q >>= 8; \ } \ /* Set the Nonce field of the ctr */ \ copy_bytes((acobject)->cipher_ctx_info.context+1, acN, 15-(acq)); \ /* Clear the block counter field of the ctr */ \ memset((acobject)->cipher_ctx_info.context+16-(acq), 0, (acq)+1); \ }
Format the First Block (IV) & Initial Counter Value per NIST CCM.
This function will also set the IV and CTR values per Appendix A of NIST Special Publication 800-38C (May 2004). It will also perform the fsl_shw_acco_set_ccm() operation with information derived from this set of parameters.
Note this function assumes the algorithm is AES. It initializes the auth_object by setting the mode to FSL_ACC_MODE_CCM and setting the flags to be FSL_ACCO_NIST_CCM.
acobject | Pointer to object to operate on. | |
act | The number of octets used for the MAC. Valid values are 4, 6, 8, 10, 12, 14, and 16. | |
acad | Number of octets of Associated Data (may be zero). | |
acq | A value for the size of the length of q field. Valid values are 1-8. | |
acN | The Nonce (packet number or other changing value). Must be (15 - q_length) octets long. | |
acQ | The value of Q (size of the payload in octets). |
#define fsl_shw_ccm_nist_format_ctr_and_iv | ( | acobject, | |||
act, | |||||
acad, | |||||
acq, | |||||
acN, | |||||
acQ | ) |
{ \ uint64_t Q = acQ; \ uint8_t bflag = ((acad)?0x40:0) | ((((act)-2)/2)<<3) | ((acq)-1); \ unsigned i; \ uint8_t* qptr = (acobject)->auth_info.CCM_ctx_info.context + 15; \ (acobject)->auth_info.CCM_ctx_info.block_size_bytes = 16; \ (acobject)->cipher_ctx_info.block_size_bytes = 16; \ (acobject)->mode = FSL_ACC_MODE_CCM; \ (acobject)->flags = FSL_ACCO_NIST_CCM; \ \ /* Store away the MAC length (after calculating actual value */ \ (acobject)->mac_length = (act); \ /* Set Flag field in Block 0 */ \ *((acobject)->auth_info.CCM_ctx_info.context) = bflag; \ /* Set Nonce field in Block 0 */ \ copy_bytes((acobject)->auth_info.CCM_ctx_info.context+1, acN, \ 15-(acq)); \ /* Set Flag field in ctr */ \ *((acobject)->cipher_ctx_info.context) = (acq)-1; \ /* Update the Q (payload length) field of Block0 */ \ (acobject)->q_length = acq; \ for (i = 0; i < (acq); i++) { \ *qptr-- = Q & 0xFF; \ Q >>= 8; \ } \ /* Set the Nonce field of the ctr */ \ copy_bytes((acobject)->cipher_ctx_info.context+1, acN, 15-(acq)); \ /* Clear the block counter field of the ctr */ \ memset((acobject)->cipher_ctx_info.context+16-(acq), 0, (acq)+1); \ }
Format the First Block (IV) & Initial Counter Value per NIST CCM.
This function will also set the IV and CTR values per Appendix A of NIST Special Publication 800-38C (May 2004). It will also perform the fsl_shw_acco_set_ccm() operation with information derived from this set of parameters.
Note this function assumes the algorithm is AES. It initializes the auth_object by setting the mode to FSL_ACC_MODE_CCM and setting the flags to be FSL_ACCO_NIST_CCM.
acobject | Pointer to object to operate on. | |
act | The number of octets used for the MAC. Valid values are 4, 6, 8, 10, 12, 14, and 16. | |
acad | Number of octets of Associated Data (may be zero). | |
acq | A value for the size of the length of q field. Valid values are 1-8. | |
acN | The Nonce (packet number or other changing value). Must be (15 - q_length) octets long. | |
acQ | The value of Q (size of the payload in octets). |
#define fsl_shw_ccm_nist_update_ctr_and_iv | ( | acobject, | |||
acN, | |||||
acQ | ) |
{ \ uint64_t Q = acQ; \ unsigned i; \ uint8_t* qptr = (acobject)->auth_info.CCM_ctx_info.context + 15; \ \ /* Update the Nonce field field of Block0 */ \ copy_bytes((acobject)->auth_info.CCM_ctx_info.context+1, acN, \ 15 - (acobject)->q_length); \ /* Update the Q (payload length) field of Block0 */ \ for (i = 0; i < (acobject)->q_length; i++) { \ *qptr-- = Q & 0xFF; \ Q >>= 8; \ } \ /* Update the Nonce field of the ctr */ \ copy_bytes((acobject)->cipher_ctx_info.context+1, acN, \ 15 - (acobject)->q_length); \ }
Update the First Block (IV) & Initial Counter Value per NIST CCM.
This function will set the IV and CTR values per Appendix A of NIST Special Publication 800-38C (May 2004).
Note this function assumes that fsl_shw_ccm_nist_format_ctr_and_iv() has previously been called on the auth_object.
acobject | Pointer to object to operate on. | |
acN | The Nonce (packet number or other changing value). Must be (15 - q_length) octets long. | |
acQ | The value of Q (size of the payload in octets). |
#define fsl_shw_ccm_nist_update_ctr_and_iv | ( | acobject, | |||
acN, | |||||
acQ | ) |
{ \ uint64_t Q = acQ; \ unsigned i; \ uint8_t* qptr = (acobject)->auth_info.CCM_ctx_info.context + 15; \ \ /* Update the Nonce field field of Block0 */ \ copy_bytes((acobject)->auth_info.CCM_ctx_info.context+1, acN, \ 15 - (acobject)->q_length); \ /* Update the Q (payload length) field of Block0 */ \ for (i = 0; i < (acobject)->q_length; i++) { \ *qptr-- = Q & 0xFF; \ Q >>= 8; \ } \ /* Update the Nonce field of the ctr */ \ copy_bytes((acobject)->cipher_ctx_info.context+1, acN, \ 15 - (acobject)->q_length); \ }
Update the First Block (IV) & Initial Counter Value per NIST CCM.
This function will set the IV and CTR values per Appendix A of NIST Special Publication 800-38C (May 2004).
Note this function assumes that fsl_shw_ccm_nist_format_ctr_and_iv() has previously been called on the auth_object.
acobject | Pointer to object to operate on. | |
acN | The Nonce (packet number or other changing value). Must be (15 - q_length) octets long. | |
acQ | The value of Q (size of the payload in octets). |
#define fsl_shw_hco_clear_flags | ( | hcobject, | |||
hcflags | ) | (hcobject)->flags &= ~(hcflags) |
Clear flags in a Hash Context Object.
Turns off the flags specified in flags. Other flags are untouched.
hcobject | The hash context to be operated on. | |
hcflags | The flags to be reset in the context. These can be ORed members of fsl_shw_hash_ctx_flags_t. |
#define fsl_shw_hco_clear_flags | ( | hcobject, | |||
hcflags | ) | (hcobject)->flags &= ~(hcflags) |
Clear flags in a Hash Context Object.
Turns off the flags specified in flags. Other flags are untouched.
hcobject | The hash context to be operated on. | |
hcflags | The flags to be reset in the context. These can be ORed members of fsl_shw_hash_ctx_flags_t. |
#define fsl_shw_hco_get_digest | ( | hcobject, | |||
hccontext, | |||||
hcclength, | |||||
hcmsglen | ) |
{ \ copy_bytes(hccontext, (hcobject)->context, hcclength); \ if ((hcobject)->algorithm == FSL_HASH_ALG_SHA224 \ || (hcobject)->algorithm == FSL_HASH_ALG_SHA256) { \ *(hcmsglen) = (hcobject)->context[8]; \ } else { \ *(hcmsglen) = (hcobject)->context[5]; \ } \ }
Get the current hash value and message length from the hash context object.
The algorithm must have already been specified. See fsl_shw_hco_init().
hcobject | The hash context to query. | |
[out] | hccontext | Pointer to the location of length octets where to store a copy of the current value of the digest. |
hcclength | Number of octets of hash value to copy. | |
[out] | hcmsglen | Pointer to the location to store the number of octets already hashed. |
#define fsl_shw_hco_get_digest | ( | hcobject, | |||
hccontext, | |||||
hcclength, | |||||
hcmsglen | ) |
{ \ copy_bytes(hccontext, (hcobject)->context, hcclength); \ if ((hcobject)->algorithm == FSL_HASH_ALG_SHA224 \ || (hcobject)->algorithm == FSL_HASH_ALG_SHA256) { \ *(hcmsglen) = (hcobject)->context[8]; \ } else { \ *(hcmsglen) = (hcobject)->context[5]; \ } \ }
Get the current hash value and message length from the hash context object.
The algorithm must have already been specified. See fsl_shw_hco_init().
hcobject | The hash context to query. | |
[out] | hccontext | Pointer to the location of length octets where to store a copy of the current value of the digest. |
hcclength | Number of octets of hash value to copy. | |
[out] | hcmsglen | Pointer to the location to store the number of octets already hashed. |
#define fsl_shw_hco_get_info | ( | hcobject, | |||
hcalgorithm | ) |
{ \ *(hcalgorithm) = (hcobject)->algorithm; \ }
Get the hash algorithm from the hash context object.
hcobject | The hash context to query. | |
[out] | hcalgorithm | Pointer to where the algorithm is to be stored. |
#define fsl_shw_hco_get_info | ( | hcobject, | |||
hcalgorithm | ) |
{ \ *(hcalgorithm) = (hcobject)->algorithm; \ }
Get the hash algorithm from the hash context object.
hcobject | The hash context to query. | |
[out] | hcalgorithm | Pointer to where the algorithm is to be stored. |
#define fsl_shw_hco_init | ( | hcobject, | |||
hcalgorithm | ) |
{ \ (hcobject)->algorithm = hcalgorithm; \ (hcobject)->flags = 0; \ switch (hcalgorithm) { \ case FSL_HASH_ALG_MD5: \ (hcobject)->digest_length = 16; \ (hcobject)->context_length = 16; \ (hcobject)->context_register_length = 24; \ break; \ case FSL_HASH_ALG_SHA1: \ (hcobject)->digest_length = 20; \ (hcobject)->context_length = 20; \ (hcobject)->context_register_length = 24; \ break; \ case FSL_HASH_ALG_SHA224: \ (hcobject)->digest_length = 28; \ (hcobject)->context_length = 32; \ (hcobject)->context_register_length = 36; \ break; \ case FSL_HASH_ALG_SHA256: \ (hcobject)->digest_length = 32; \ (hcobject)->context_length = 32; \ (hcobject)->context_register_length = 36; \ break; \ default: \ /* error ! */ \ (hcobject)->digest_length = 1; \ (hcobject)->context_length = 1; \ (hcobject)->context_register_length = 1; \ break; \ } \ }
Initialize a Hash Context Object.
This function must be called before performing any other operation with the Object. It sets the current message length and hash algorithm in the hash context object.
hcobject | The hash context to operate upon. | |
hcalgorithm | The hash algorithm to be used (FSL_HASH_ALG_MD5, FSL_HASH_ALG_SHA256, etc). |
#define fsl_shw_hco_init | ( | hcobject, | |||
hcalgorithm | ) |
{ \ (hcobject)->algorithm = hcalgorithm; \ (hcobject)->flags = 0; \ switch (hcalgorithm) { \ case FSL_HASH_ALG_MD5: \ (hcobject)->digest_length = 16; \ (hcobject)->context_length = 16; \ (hcobject)->context_register_length = 24; \ break; \ case FSL_HASH_ALG_SHA1: \ (hcobject)->digest_length = 20; \ (hcobject)->context_length = 20; \ (hcobject)->context_register_length = 24; \ break; \ case FSL_HASH_ALG_SHA224: \ (hcobject)->digest_length = 28; \ (hcobject)->context_length = 32; \ (hcobject)->context_register_length = 36; \ break; \ case FSL_HASH_ALG_SHA256: \ (hcobject)->digest_length = 32; \ (hcobject)->context_length = 32; \ (hcobject)->context_register_length = 36; \ break; \ default: \ /* error ! */ \ (hcobject)->digest_length = 1; \ (hcobject)->context_length = 1; \ (hcobject)->context_register_length = 1; \ break; \ } \ }
Initialize a Hash Context Object.
This function must be called before performing any other operation with the Object. It sets the current message length and hash algorithm in the hash context object.
hcobject | The hash context to operate upon. | |
hcalgorithm | The hash algorithm to be used (FSL_HASH_ALG_MD5, FSL_HASH_ALG_SHA256, etc). |
#define fsl_shw_hco_set_digest | ( | hcobject, | |||
hccontext, | |||||
hcmsglen | ) |
{ \ copy_bytes((hcobject)->context, hccontext, (hcobject)->context_length); \ if (((hcobject)->algorithm == FSL_HASH_ALG_SHA224) \ || ((hcobject)->algorithm == FSL_HASH_ALG_SHA256)) { \ (hcobject)->context[8] = hcmsglen; \ } else { \ (hcobject)->context[5] = hcmsglen; \ } \ }
Set the current hash value and message length in the hash context object.
The algorithm must have already been specified. See fsl_shw_hco_init().
hcobject | The hash context to operate upon. | |
hccontext | Pointer to buffer of appropriate length to copy into the hash context object. | |
hcmsglen | The number of octets of the message which have already been hashed. |
#define fsl_shw_hco_set_digest | ( | hcobject, | |||
hccontext, | |||||
hcmsglen | ) |
{ \ copy_bytes((hcobject)->context, hccontext, (hcobject)->context_length); \ if (((hcobject)->algorithm == FSL_HASH_ALG_SHA224) \ || ((hcobject)->algorithm == FSL_HASH_ALG_SHA256)) { \ (hcobject)->context[8] = hcmsglen; \ } else { \ (hcobject)->context[5] = hcmsglen; \ } \ }
Set the current hash value and message length in the hash context object.
The algorithm must have already been specified. See fsl_shw_hco_init().
hcobject | The hash context to operate upon. | |
hccontext | Pointer to buffer of appropriate length to copy into the hash context object. | |
hcmsglen | The number of octets of the message which have already been hashed. |
#define fsl_shw_hco_set_flags | ( | hcobject, | |||
hcflags | ) | (hcobject)->flags |= (hcflags) |
Set flags in a Hash Context Object.
Turns on the flags specified in flags. Other flags are untouched.
hcobject | The hash context to be operated on. | |
hcflags | The flags to be set in the context. These can be ORed members of fsl_shw_hash_ctx_flags_t. |
#define fsl_shw_hco_set_flags | ( | hcobject, | |||
hcflags | ) | (hcobject)->flags |= (hcflags) |
Set flags in a Hash Context Object.
Turns on the flags specified in flags. Other flags are untouched.
hcobject | The hash context to be operated on. | |
hcflags | The flags to be set in the context. These can be ORed members of fsl_shw_hash_ctx_flags_t. |
#define fsl_shw_hmco_clear_flags | ( | hcobject, | |||
hcflags | ) | (hcobject)->flags &= ~(hcflags) |
Clear flags in an HMAC Context Object.
Turns off the flags specified in flags. Other flags are untouched.
hcobject | The HMAC context to be operated on. | |
hcflags | The flags to be reset in the context. These can be ORed members of fsl_shw_hmac_ctx_flags_t. |
#define fsl_shw_hmco_clear_flags | ( | hcobject, | |||
hcflags | ) | (hcobject)->flags &= ~(hcflags) |
Clear flags in an HMAC Context Object.
Turns off the flags specified in flags. Other flags are untouched.
hcobject | The HMAC context to be operated on. | |
hcflags | The flags to be reset in the context. These can be ORed members of fsl_shw_hmac_ctx_flags_t. |
#define fsl_shw_hmco_init | ( | hcobject, | |||
hcalgorithm | ) | fsl_shw_hco_init(hcobject, hcalgorithm) |
Initialize an HMAC Context Object.
This function must be called before performing any other operation with the Object. It sets the current message length and hash algorithm in the HMAC context object.
hcobject | The HMAC context to operate upon. | |
hcalgorithm | The hash algorithm to be used (FSL_HASH_ALG_MD5, FSL_HASH_ALG_SHA256, etc). |
#define fsl_shw_hmco_init | ( | hcobject, | |||
hcalgorithm | ) | fsl_shw_hco_init(hcobject, hcalgorithm) |
Initialize an HMAC Context Object.
This function must be called before performing any other operation with the Object. It sets the current message length and hash algorithm in the HMAC context object.
hcobject | The HMAC context to operate upon. | |
hcalgorithm | The hash algorithm to be used (FSL_HASH_ALG_MD5, FSL_HASH_ALG_SHA256, etc). |
#define fsl_shw_hmco_set_flags | ( | hcobject, | |||
hcflags | ) | (hcobject)->flags |= (hcflags) |
Set flags in an HMAC Context Object.
Turns on the flags specified in flags. Other flags are untouched.
hcobject | The HMAC context to be operated on. | |
hcflags | The flags to be set in the context. These can be ORed members of fsl_shw_hmac_ctx_flags_t. |
#define fsl_shw_hmco_set_flags | ( | hcobject, | |||
hcflags | ) | (hcobject)->flags |= (hcflags) |
Set flags in an HMAC Context Object.
Turns on the flags specified in flags. Other flags are untouched.
hcobject | The HMAC context to be operated on. | |
hcflags | The flags to be set in the context. These can be ORed members of fsl_shw_hmac_ctx_flags_t. |
#define fsl_shw_pco_check_auth_supported | ( | pcobject, | |||
pcmode | ) | ((pcmode == FSL_ACC_MODE_CCM) ? 1 : 0) |
Determine whether a given Encryption-Authentication mode is supported.
pcobject | The Platform Capababilities Object to query. | |
pcmode | The Authentication mode. |
#define fsl_shw_pco_check_auth_supported | ( | pcobject, | |||
pcmode | ) | ((pcmode == FSL_ACC_MODE_CCM) ? 1 : 0) |
Determine whether a given Encryption-Authentication mode is supported.
pcobject | The Platform Capababilities Object to query. | |
pcmode | The Authentication mode. |
#define fsl_shw_pco_check_black_key_supported | ( | pcobject | ) | 1 |
Determine whether Black Keys (key establishment / wrapping) is supported.
pcobject | The Platform Capababilities Object to query. |
#define fsl_shw_pco_check_black_key_supported | ( | pcobject | ) | 1 |
Determine whether Black Keys (key establishment / wrapping) is supported.
pcobject | The Platform Capababilities Object to query. |
#define fsl_shw_pco_check_pk_supported | ( | pcobject | ) | 0 |
Determine whether Programmed Key features are available
pc_info | The Platform Capabilities Object to query. |
#define fsl_shw_pco_check_pk_supported | ( | pcobject | ) | 0 |
Determine whether Programmed Key features are available
pc_info | The Platform Capabilities Object to query. |
#define fsl_shw_pco_check_spo_supported | ( | pcobject | ) | ((pcobject)->scm_version == 2) |
Determine whether Secure Partitions are supported
pcobject | The Platform Capabilities Object to query. |
#define fsl_shw_pco_check_spo_supported | ( | pcobject | ) | ((pcobject)->scm_version == 2) |
Determine whether Secure Partitions are supported
pcobject | The Platform Capabilities Object to query. |
#define fsl_shw_pco_check_sw_keys_supported | ( | pcobject | ) | 0 |
Determine whether Software Key features are available
pc_info | The Platform Capabilities Object to query. |
#define fsl_shw_pco_check_sw_keys_supported | ( | pcobject | ) | 0 |
Determine whether Software Key features are available
pc_info | The Platform Capabilities Object to query. |
#define fsl_shw_pco_check_sym_supported | ( | pcobject, | |||
pcalg, | |||||
pcmode | ) | ((pcobject)->sym_support[pcalg][pcmode]) |
Determine whether the combination of a given symmetric algorithm and a given mode is supported.
pcobject | The Platform Capababilities Object to query. | |
pcalg | A Symmetric Cipher algorithm. | |
pcmode | A Symmetric Cipher mode. |
#define fsl_shw_pco_check_sym_supported | ( | pcobject, | |||
pcalg, | |||||
pcmode | ) | ((pcobject)->sym_support[pcalg][pcmode]) |
Determine whether the combination of a given symmetric algorithm and a given mode is supported.
pcobject | The Platform Capababilities Object to query. | |
pcalg | A Symmetric Cipher algorithm. | |
pcmode | A Symmetric Cipher mode. |
#define fsl_shw_pco_get_driver_version | ( | pcobject, | |||
pcmajor, | |||||
pcminor | ) |
{ \ *(pcmajor) = (pcobject)->driver_major; \ *(pcminor) = (pcobject)->driver_minor; \ }
Get underlying driver version.
pcobject | The Platform Capababilities Object to query. | |
[out] | pcmajor | A pointer to where the major version of the driver is to be stored. |
[out] | pcminor | A pointer to where the minor version of the driver is to be stored. |
#define fsl_shw_pco_get_driver_version | ( | pcobject, | |||
pcmajor, | |||||
pcminor | ) |
{ \ *(pcmajor) = (pcobject)->driver_major; \ *(pcminor) = (pcobject)->driver_minor; \ }
Get underlying driver version.
pcobject | The Platform Capababilities Object to query. | |
[out] | pcmajor | A pointer to where the major version of the driver is to be stored. |
[out] | pcminor | A pointer to where the minor version of the driver is to be stored. |
#define fsl_shw_pco_get_hash_algorithms | ( | pcobject, | |||
gsalgorithms, | |||||
gsacount | ) |
{ \
*(gsalgorithms) = (pcobject)->hash_algorithms; \
*(gsacount) = sizeof((pcobject)->hash_algorithms)/4; \
}
Get list of hash algorithms supported.
pcobject | The Platform Capababilities Object to query. | |
[out] | gsalgorithms | A pointer which will be set to the list of algorithms. |
[out] | gsacount | The number of algorithms in the list at algorithms. |
#define fsl_shw_pco_get_hash_algorithms | ( | pcobject, | |||
gsalgorithms, | |||||
gsacount | ) |
{ \
*(gsalgorithms) = (pcobject)->hash_algorithms; \
*(gsacount) = sizeof((pcobject)->hash_algorithms)/4; \
}
Get list of hash algorithms supported.
pcobject | The Platform Capababilities Object to query. | |
[out] | gsalgorithms | A pointer which will be set to the list of algorithms. |
[out] | gsacount | The number of algorithms in the list at algorithms. |
#define fsl_shw_pco_get_scc_driver_version | ( | pcobject, | |||
pcmajor, | |||||
pcminor | ) |
{ \ *(pcmajor) = (pcobject)->scc_driver_major; \ *(pcminor) = (pcobject)->scc_driver_minor; \ }
Get FSL SHW SCC driver version
pcobject | The Platform Capabilities Object to query. | |
[out] | pcmajor | A pointer to where the major version of the SCC driver is to be stored. |
[out] | pcminor | A pointer to where the minor version of the SCC driver is to be stored. |
#define fsl_shw_pco_get_scc_driver_version | ( | pcobject, | |||
pcmajor, | |||||
pcminor | ) |
{ \ *(pcmajor) = (pcobject)->scc_driver_major; \ *(pcminor) = (pcobject)->scc_driver_minor; \ }
Get FSL SHW SCC driver version
pcobject | The Platform Capabilities Object to query. | |
[out] | pcmajor | A pointer to where the major version of the SCC driver is to be stored. |
[out] | pcminor | A pointer to where the minor version of the SCC driver is to be stored. |
#define fsl_shw_pco_get_scm_block_size | ( | pcobject | ) | ((pcobject)->block_size_bytes) |
Get the size of an SCM block, in bytes
pcobject | The Platform Capabilities Object to query. |
#define fsl_shw_pco_get_scm_block_size | ( | pcobject | ) | ((pcobject)->block_size_bytes) |
Get the size of an SCM block, in bytes
pcobject | The Platform Capabilities Object to query. |
#define fsl_shw_pco_get_scm_version | ( | pcobject | ) | ((pcobject)->scm_version) |
Get SCM hardware version
pcobject | The Platform Capabilities Object to query. |
#define fsl_shw_pco_get_scm_version | ( | pcobject | ) | ((pcobject)->scm_version) |
Get SCM hardware version
pcobject | The Platform Capabilities Object to query. |
#define fsl_shw_pco_get_smn_size | ( | pcobject, | |||
black_size, | |||||
red_size | ) |
{ \ if ((pcobject)->scm_version == 1) { \ *(black_size) = (pcobject)->scc_info.black_ram_size_blocks; \ *(red_size) = (pcobject)->scc_info.red_ram_size_blocks; \ } else { \ *(black_size) = 0; \ *(red_size) = 0; \ } \ }
Get size of Black and Red RAM memory
pcobject | The Platform Capabilities Object to query. | |
[out] | black_size | A pointer to where the size of the Black RAM, in blocks, is to be placed. |
[out] | red_size | A pointer to where the size of the Red RAM, in blocks, is to be placed. |
#define fsl_shw_pco_get_smn_size | ( | pcobject, | |||
black_size, | |||||
red_size | ) |
{ \ if ((pcobject)->scm_version == 1) { \ *(black_size) = (pcobject)->scc_info.black_ram_size_blocks; \ *(red_size) = (pcobject)->scc_info.red_ram_size_blocks; \ } else { \ *(black_size) = 0; \ *(red_size) = 0; \ } \ }
Get size of Black and Red RAM memory
pcobject | The Platform Capabilities Object to query. | |
[out] | black_size | A pointer to where the size of the Black RAM, in blocks, is to be placed. |
[out] | red_size | A pointer to where the size of the Red RAM, in blocks, is to be placed. |
#define fsl_shw_pco_get_smn_version | ( | pcobject | ) | ((pcobject)->smn_version) |
Get SMN hardware version
pcobject | The Platform Capabilities Object to query. |
#define fsl_shw_pco_get_smn_version | ( | pcobject | ) | ((pcobject)->smn_version) |
Get SMN hardware version
pcobject | The Platform Capabilities Object to query. |
#define fsl_shw_pco_get_spo_count | ( | pcobject | ) |
(((pcobject)->scm_version == 2) ? \ ((pcobject)->scc2_info.partition_count) : 0 )
Get the number of Secure Partitions on this platform
pcobject | The Platform Capabilities Object to query. |
#define fsl_shw_pco_get_spo_count | ( | pcobject | ) |
(((pcobject)->scm_version == 2) ? \ ((pcobject)->scc2_info.partition_count) : 0 )
Get the number of Secure Partitions on this platform
pcobject | The Platform Capabilities Object to query. |
#define fsl_shw_pco_get_spo_size_bytes | ( | pcobject | ) |
(((pcobject)->scm_version == 2) ? \ ((pcobject)->scc2_info.partition_size_bytes) : 0 )
Get the size of a Secure Partitions
pcobject | The Platform Capabilities Object to query. |
#define fsl_shw_pco_get_spo_size_bytes | ( | pcobject | ) |
(((pcobject)->scm_version == 2) ? \ ((pcobject)->scc2_info.partition_size_bytes) : 0 )
Get the size of a Secure Partitions
pcobject | The Platform Capabilities Object to query. |
#define fsl_shw_pco_get_sym_algorithms | ( | pcobject, | |||
pcalgorithms, | |||||
pcacount | ) |
{ \
*(pcalgorithms) = (pcobject)->sym_algorithms; \
*(pcacount) = sizeof((pcobject)->sym_algorithms)/4; \
}
Get list of symmetric algorithms supported.
pcobject | The Platform Capababilities Object to query. | |
[out] | pcalgorithms | A pointer to where to store the location of the list of algorithms. |
[out] | pcacount | A pointer to where to store the number of algorithms in the list at algorithms. |
#define fsl_shw_pco_get_sym_algorithms | ( | pcobject, | |||
pcalgorithms, | |||||
pcacount | ) |
{ \
*(pcalgorithms) = (pcobject)->sym_algorithms; \
*(pcacount) = sizeof((pcobject)->sym_algorithms)/4; \
}
Get list of symmetric algorithms supported.
pcobject | The Platform Capababilities Object to query. | |
[out] | pcalgorithms | A pointer to where to store the location of the list of algorithms. |
[out] | pcacount | A pointer to where to store the number of algorithms in the list at algorithms. |
#define fsl_shw_pco_get_sym_modes | ( | pcobject, | |||
gsmodes, | |||||
gsacount | ) |
{ \
*(gsmodes) = (pcobject)->sym_modes; \
*(gsacount) = sizeof((pcobject)->sym_modes)/4; \
}
Get list of symmetric modes supported.
pcobject | The Platform Capababilities Object to query. | |
[out] | gsmodes | A pointer to where to store the location of the list of modes. |
[out] | gsacount | A pointer to where to store the number of algorithms in the list at modes. |
#define fsl_shw_pco_get_sym_modes | ( | pcobject, | |||
gsmodes, | |||||
gsacount | ) |
{ \
*(gsmodes) = (pcobject)->sym_modes; \
*(gsacount) = sizeof((pcobject)->sym_modes)/4; \
}
Get list of symmetric modes supported.
pcobject | The Platform Capababilities Object to query. | |
[out] | gsmodes | A pointer to where to store the location of the list of modes. |
[out] | gsacount | A pointer to where to store the number of algorithms in the list at modes. |
#define fsl_shw_pco_get_version | ( | pcobject, | |||
pcmajor, | |||||
pcminor | ) |
{ \ *(pcmajor) = (pcobject)->api_major; \ *(pcminor) = (pcobject)->api_minor; \ }
Get FSL SHW API version
pcobject | The Platform Capababilities Object to query. | |
[out] | pcmajor | A pointer to where the major version of the API is to be stored. |
[out] | pcminor | A pointer to where the minor version of the API is to be stored. |
#define fsl_shw_pco_get_version | ( | pcobject, | |||
pcmajor, | |||||
pcminor | ) |
{ \ *(pcmajor) = (pcobject)->api_major; \ *(pcminor) = (pcobject)->api_minor; \ }
Get FSL SHW API version
pcobject | The Platform Capababilities Object to query. | |
[out] | pcmajor | A pointer to where the major version of the API is to be stored. |
[out] | pcminor | A pointer to where the minor version of the API is to be stored. |
#define fsl_shw_ro_get_reference | ( | robject | ) | (robject)->user_ref |
Retrieve the reference value from a Result Object.
robject | The result object to query. |
#define fsl_shw_ro_get_reference | ( | robject | ) | (robject)->user_ref |
Retrieve the reference value from a Result Object.
robject | The result object to query. |
#define fsl_shw_ro_get_status | ( | robject | ) | (robject)->code |
Retrieve the status code from a Result Object.
robject | The result object to query. |
#define fsl_shw_ro_get_status | ( | robject | ) | (robject)->code |
Retrieve the status code from a Result Object.
robject | The result object to query. |
#define fsl_shw_scco_clear_flags | ( | scobject, | |||
scflags | ) | (scobject)->flags &= ~(scflags) |
Clear some flags in a Symmetric Cipher Context Object.
Turns off the flags specified in flags. Other flags are untouched.
scobject | The context object to operate on. | |
scflags | The flags to reset (one or more values from fsl_shw_sym_ctx_flags_t ORed together). |
#define fsl_shw_scco_clear_flags | ( | scobject, | |||
scflags | ) | (scobject)->flags &= ~(scflags) |
Clear some flags in a Symmetric Cipher Context Object.
Turns off the flags specified in flags. Other flags are untouched.
scobject | The context object to operate on. | |
scflags | The flags to reset (one or more values from fsl_shw_sym_ctx_flags_t ORed together). |
#define fsl_shw_scco_get_context | ( | scobject, | |||
sccontext | ) | copy_bytes(sccontext, (scobject)->context, (scobject)->block_size_bytes) |
Get the Context for a Symmetric Cipher Context.
This is to retrieve the context/IV for FSL_SYM_MODE_CBC mode, or to retrieve context (the S-Box and pointers) for ARC4. The full context will be copied.
scobject | The context object to operate on. | |
[out] | sccontext | Pointer to location where context will be stored. |
#define fsl_shw_scco_get_context | ( | scobject, | |||
sccontext | ) | copy_bytes(sccontext, (scobject)->context, (scobject)->block_size_bytes) |
Get the Context for a Symmetric Cipher Context.
This is to retrieve the context/IV for FSL_SYM_MODE_CBC mode, or to retrieve context (the S-Box and pointers) for ARC4. The full context will be copied.
scobject | The context object to operate on. | |
[out] | sccontext | Pointer to location where context will be stored. |
#define fsl_shw_scco_get_counter_info | ( | scobject, | |||
sccounter, | |||||
scmodulus | ) |
{ \ if ((sccounter) != NULL) { \ copy_bytes(sccounter, (scobject)->context, \ (scobject)->block_size_bytes); \ } \ if ((scmodulus) != NULL) { \ *(scmodulus) = (scobject)->modulus_exp; \ } \ }
Get the Counter Value for a Symmetric Cipher Context.
This will retrieve the Counter Value is for CTR mode.
scobject | The context object to query. | |
[out] | sccounter | Pointer to location to store the current counter value. The number of octets copied will be the block size for the algorithm. |
[out] | scmodulus | Pointer to location to store the modulus. |
#define fsl_shw_scco_get_counter_info | ( | scobject, | |||
sccounter, | |||||
scmodulus | ) |
{ \ if ((sccounter) != NULL) { \ copy_bytes(sccounter, (scobject)->context, \ (scobject)->block_size_bytes); \ } \ if ((scmodulus) != NULL) { \ *(scmodulus) = (scobject)->modulus_exp; \ } \ }
Get the Counter Value for a Symmetric Cipher Context.
This will retrieve the Counter Value is for CTR mode.
scobject | The context object to query. | |
[out] | sccounter | Pointer to location to store the current counter value. The number of octets copied will be the block size for the algorithm. |
[out] | scmodulus | Pointer to location to store the modulus. |
#define fsl_shw_scco_init | ( | scobject, | |||
scalg, | |||||
scmode | ) |
{ \ register uint32_t bsb; /* block-size bytes */ \ \ switch (scalg) { \ case FSL_KEY_ALG_AES: \ bsb = 16; \ break; \ case FSL_KEY_ALG_DES: \ /* fall through */ \ case FSL_KEY_ALG_TDES: \ bsb = 8; \ break; \ case FSL_KEY_ALG_ARC4: \ bsb = 259; \ break; \ case FSL_KEY_ALG_HMAC: \ bsb = 1; /* meaningless */ \ break; \ default: \ bsb = 00; \ } \ (scobject)->block_size_bytes = bsb; \ (scobject)->mode = scmode; \ (scobject)->flags = 0; \ }
Initialize a Symmetric Cipher Context Object.
This function must be called before performing any other operation with the Object. This will set the mode and algorithm and initialize the Object.
scobject | The context object to operate on. | |
scalg | The cipher algorithm this context will be used with. | |
scmode | FSL_SYM_MODE_CBC, FSL_SYM_MODE_ECB, etc. |
#define fsl_shw_scco_init | ( | scobject, | |||
scalg, | |||||
scmode | ) |
{ \ register uint32_t bsb; /* block-size bytes */ \ \ switch (scalg) { \ case FSL_KEY_ALG_AES: \ bsb = 16; \ break; \ case FSL_KEY_ALG_DES: \ /* fall through */ \ case FSL_KEY_ALG_TDES: \ bsb = 8; \ break; \ case FSL_KEY_ALG_ARC4: \ bsb = 259; \ break; \ case FSL_KEY_ALG_HMAC: \ bsb = 1; /* meaningless */ \ break; \ default: \ bsb = 00; \ } \ (scobject)->block_size_bytes = bsb; \ (scobject)->mode = scmode; \ (scobject)->flags = 0; \ }
Initialize a Symmetric Cipher Context Object.
This function must be called before performing any other operation with the Object. This will set the mode and algorithm and initialize the Object.
scobject | The context object to operate on. | |
scalg | The cipher algorithm this context will be used with. | |
scmode | FSL_SYM_MODE_CBC, FSL_SYM_MODE_ECB, etc. |
#define fsl_shw_scco_set_context | ( | scobject, | |||
sccontext | ) |
copy_bytes((scobject)->context, sccontext, \ (scobject)->block_size_bytes)
Set the Context (IV) for a Symmetric Cipher Context.
This is to set the context/IV for FSL_SYM_MODE_CBC mode, or to set the context (the S-Box and pointers) for ARC4. The full context size will be copied.
scobject | The context object to operate on. | |
sccontext | A pointer to the buffer which contains the context. |
#define fsl_shw_scco_set_context | ( | scobject, | |||
sccontext | ) |
copy_bytes((scobject)->context, sccontext, \ (scobject)->block_size_bytes)
Set the Context (IV) for a Symmetric Cipher Context.
This is to set the context/IV for FSL_SYM_MODE_CBC mode, or to set the context (the S-Box and pointers) for ARC4. The full context size will be copied.
scobject | The context object to operate on. | |
sccontext | A pointer to the buffer which contains the context. |
#define fsl_shw_scco_set_counter_info | ( | scobject, | |||
sccounter, | |||||
scmodulus | ) |
{ \
if ((sccounter) != NULL) { \
copy_bytes((scobject)->context, sccounter, \
(scobject)->block_size_bytes); \
} \
(scobject)->modulus_exp = scmodulus; \
}
Set the Counter Value for a Symmetric Cipher Context.
This will set the Counter Value for CTR mode.
scobject | The context object to operate on. | |
sccounter | The starting counter value. The number of octets. copied will be the block size for the algorithm. | |
scmodulus | The modulus for controlling the incrementing of the counter. |
#define fsl_shw_scco_set_counter_info | ( | scobject, | |||
sccounter, | |||||
scmodulus | ) |
{ \
if ((sccounter) != NULL) { \
copy_bytes((scobject)->context, sccounter, \
(scobject)->block_size_bytes); \
} \
(scobject)->modulus_exp = scmodulus; \
}
Set the Counter Value for a Symmetric Cipher Context.
This will set the Counter Value for CTR mode.
scobject | The context object to operate on. | |
sccounter | The starting counter value. The number of octets. copied will be the block size for the algorithm. | |
scmodulus | The modulus for controlling the incrementing of the counter. |
#define fsl_shw_scco_set_flags | ( | scobject, | |||
scflags | ) | (scobject)->flags |= (scflags) |
Set the flags for a Symmetric Cipher Context.
Turns on the flags specified in flags. Other flags are untouched.
scobject | The context object to operate on. | |
scflags | The flags to reset (one or more values from fsl_shw_sym_ctx_flags_t ORed together). |
#define fsl_shw_scco_set_flags | ( | scobject, | |||
scflags | ) | (scobject)->flags |= (scflags) |
Set the flags for a Symmetric Cipher Context.
Turns on the flags specified in flags. Other flags are untouched.
scobject | The context object to operate on. | |
scflags | The flags to reset (one or more values from fsl_shw_sym_ctx_flags_t ORed together). |
#define fsl_shw_sko_calculate_wrapped_size | ( | wkeyinfo, | |||
wkeylen | ) |
{ \ register fsl_shw_sko_t* kp = wkeyinfo; \ register uint32_t kl = kp->key_length; \ int key_blocks = (kl + 15) / 16; \ int base_size = 35; /* ICV + T' + ALG + LEN + FLAGS */ \ \ *(wkeylen) = base_size + 16 * key_blocks; \ }
Determine the size of a wrapped key based upon the cleartext key's length.
This function can be used to calculate the number of octets that fsl_shw_extract_key() will write into the location at covered_key.
If zero is returned at length, this means that the key length in key_info is not supported.
wkeyinfo | Information about a key to be wrapped. | |
wkeylen | Location to store the length of a wrapped version of the key in key_info. |
#define fsl_shw_sko_calculate_wrapped_size | ( | wkeyinfo, | |||
wkeylen | ) |
{ \ register fsl_shw_sko_t* kp = wkeyinfo; \ register uint32_t kl = kp->key_length; \ int key_blocks = (kl + 15) / 16; \ int base_size = 35; /* ICV + T' + ALG + LEN + FLAGS */ \ \ *(wkeylen) = base_size + 16 * key_blocks; \ }
Determine the size of a wrapped key based upon the cleartext key's length.
This function can be used to calculate the number of octets that fsl_shw_extract_key() will write into the location at covered_key.
If zero is returned at length, this means that the key length in key_info is not supported.
wkeyinfo | Information about a key to be wrapped. | |
wkeylen | Location to store the length of a wrapped version of the key in key_info. |
#define fsl_shw_sko_clear_flags | ( | skobject, | |||
skflags | ) | (skobject)->flags &= ~(skflags) |
Clear some flags in the key object.
Turns off the flags specified in flags. Other flags are untouched.
skobject | A variable of type fsl_shw_sko_t. | |
skflags | (One or more) ORed members of fsl_shw_key_flags_t which are to be reset. |
#define fsl_shw_sko_clear_flags | ( | skobject, | |||
skflags | ) | (skobject)->flags &= ~(skflags) |
Clear some flags in the key object.
Turns off the flags specified in flags. Other flags are untouched.
skobject | A variable of type fsl_shw_sko_t. | |
skflags | (One or more) ORed members of fsl_shw_key_flags_t which are to be reset. |
#define fsl_shw_sko_get_algorithm | ( | skobject, | |||
skalgorithm | ) | *(skalgorithm) = (skobject)->algorithm |
Extract the algorithm from a key object.
skobject | The Key Object to be queried. | |
[out] | skalgorithm | A pointer to the location to store the algorithm. |
#define fsl_shw_sko_get_algorithm | ( | skobject, | |||
skalgorithm | ) | *(skalgorithm) = (skobject)->algorithm |
Extract the algorithm from a key object.
skobject | The Key Object to be queried. | |
[out] | skalgorithm | A pointer to the location to store the algorithm. |
#define fsl_shw_sko_get_established_info | ( | skobject, | |||
skhandle | ) | *(skhandle) = (skobject)->handle |
Retrieve the established-key handle from a key object.
skobject | A variable of type fsl_shw_sko_t. | |
skhandle | The location to store the handle of the unwrapped key. |
#define fsl_shw_sko_get_established_info | ( | skobject, | |||
skhandle | ) | *(skhandle) = (skobject)->handle |
Retrieve the established-key handle from a key object.
skobject | A variable of type fsl_shw_sko_t. | |
skhandle | The location to store the handle of the unwrapped key. |
#define fsl_shw_sko_get_key | ( | skobject, | |||
skkey | ) |
{ \ fsl_shw_kso_t* keystore = (skobject)->keystore; \ if (keystore != NULL) { \ *(skkey) = keystore->slot_get_address(keystore->user_data, \ (skobject)->handle); \ } else { \ *(skkey) = NULL; \ } \ }
Retrieve the cleartext key from a key object that is stored in a user keystore.
skobject | The Key Object to be queried. | |
[out] | skkey | A pointer to the location to store the key. NULL if the key is not stored in a user keystore. |
#define fsl_shw_sko_get_key | ( | skobject, | |||
skkey | ) |
{ \ fsl_shw_kso_t* keystore = (skobject)->keystore; \ if (keystore != NULL) { \ *(skkey) = keystore->slot_get_address(keystore->user_data, \ (skobject)->handle); \ } else { \ *(skkey) = NULL; \ } \ }
Retrieve the cleartext key from a key object that is stored in a user keystore.
skobject | The Key Object to be queried. | |
[out] | skkey | A pointer to the location to store the key. NULL if the key is not stored in a user keystore. |
#define fsl_shw_sko_init | ( | skobject, | |||
skalgorithm | ) |
{ \ (skobject)->algorithm = skalgorithm; \ (skobject)->flags = 0; \ (skobject)->keystore = NULL; \ }
Initialize a Secret Key Object.
This function must be called before performing any other operation with the Object.
skobject | The Secret Key Object to be initialized. | |
skalgorithm | DES, AES, etc. |
#define fsl_shw_sko_init | ( | skobject, | |||
skalgorithm | ) |
{ \ (skobject)->algorithm = skalgorithm; \ (skobject)->flags = 0; \ (skobject)->keystore = NULL; \ }
Initialize a Secret Key Object.
This function must be called before performing any other operation with the Object.
skobject | The Secret Key Object to be initialized. | |
skalgorithm | DES, AES, etc. |
#define fsl_shw_sko_init_pf_key | ( | skobject, | |||
skalgorithm, | |||||
skhwkey | ) |
{ \ (skobject)->algorithm = -1; \ (skobject)->flags = -1; \ (skobject)->keystore = NULL; \ }
Initialize a Secret Key Object to use a Platform Key register.
This function must be called before performing any other operation with the Object. INVALID on this platform.
skobject | The Secret Key Object to be initialized. | |
skalgorithm | DES, AES, etc. | |
skhwkey | one of the fsl_shw_pf_key_t values. |
#define fsl_shw_sko_init_pf_key | ( | skobject, | |||
skalgorithm, | |||||
skhwkey | ) |
{ \ (skobject)->algorithm = -1; \ (skobject)->flags = -1; \ (skobject)->keystore = NULL; \ }
Initialize a Secret Key Object to use a Platform Key register.
This function must be called before performing any other operation with the Object. INVALID on this platform.
skobject | The Secret Key Object to be initialized. | |
skalgorithm | DES, AES, etc. | |
skhwkey | one of the fsl_shw_pf_key_t values. |
#define fsl_shw_sko_set_established_info | ( | skobject, | |||
skuserid, | |||||
skhandle | ) |
{ \ (skobject)->userid = (skuserid); \ (skobject)->handle = (skhandle); \ (skobject)->flags |= FSL_SKO_KEY_ESTABLISHED; \ (skobject)->flags &= \ ~(FSL_SKO_KEY_PRESENT); \ }
Set the establish key handle into a key object.
The userid field will be used to validate the access to the unwrapped key. This feature is not available for all platforms, nor for all algorithms and modes.
The FSL_SKO_KEY_ESTABLISHED will be set (and the FSL_SKO_KEY_PRESENT flag will be cleared).
skobject | A variable of type fsl_shw_sko_t. | |
skuserid | The User ID to verify this user is an authorized user of the key. | |
skhandle | A handle from fsl_shw_sko_get_established_info. |
#define fsl_shw_sko_set_established_info | ( | skobject, | |||
skuserid, | |||||
skhandle | ) |
{ \ (skobject)->userid = (skuserid); \ (skobject)->handle = (skhandle); \ (skobject)->flags |= FSL_SKO_KEY_ESTABLISHED; \ (skobject)->flags &= \ ~(FSL_SKO_KEY_PRESENT); \ }
Set the establish key handle into a key object.
The userid field will be used to validate the access to the unwrapped key. This feature is not available for all platforms, nor for all algorithms and modes.
The FSL_SKO_KEY_ESTABLISHED will be set (and the FSL_SKO_KEY_PRESENT flag will be cleared).
skobject | A variable of type fsl_shw_sko_t. | |
skuserid | The User ID to verify this user is an authorized user of the key. | |
skhandle | A handle from fsl_shw_sko_get_established_info. |
#define fsl_shw_sko_set_flags | ( | skobject, | |||
skflags | ) | (skobject)->flags |= (skflags) |
Set some flags in the key object.
Turns on the flags specified in flags. Other flags are untouched.
skobject | A variable of type fsl_shw_sko_t. | |
skflags | (One or more) ORed members of fsl_shw_key_flags_t which are to be set. |
#define fsl_shw_sko_set_flags | ( | skobject, | |||
skflags | ) | (skobject)->flags |= (skflags) |
Set some flags in the key object.
Turns on the flags specified in flags. Other flags are untouched.
skobject | A variable of type fsl_shw_sko_t. | |
skflags | (One or more) ORed members of fsl_shw_key_flags_t which are to be set. |
#define fsl_shw_sko_set_key | ( | skobject, | |||
skkey, | |||||
skkeylen | ) |
{ \ (skobject)->key_length = skkeylen; \ copy_bytes((skobject)->key, skkey, skkeylen); \ (skobject)->flags |= FSL_SKO_KEY_PRESENT; \ (skobject)->flags &= ~FSL_SKO_KEY_ESTABLISHED; \ }
Store a cleartext key in the key object.
This has the side effect of setting the FSL_SKO_KEY_PRESENT flag and resetting the FSL_SKO_KEY_ESTABLISHED flag.
skobject | A variable of type fsl_shw_sko_t. | |
skkey | A pointer to the beginning of the key. | |
skkeylen | The length, in octets, of the key. The value should be appropriate to the key size supported by the algorithm. 64 octets is the absolute maximum value allowed for this call. |
#define fsl_shw_sko_set_key | ( | skobject, | |||
skkey, | |||||
skkeylen | ) |
{ \ (skobject)->key_length = skkeylen; \ copy_bytes((skobject)->key, skkey, skkeylen); \ (skobject)->flags |= FSL_SKO_KEY_PRESENT; \ (skobject)->flags &= ~FSL_SKO_KEY_ESTABLISHED; \ }
Store a cleartext key in the key object.
This has the side effect of setting the FSL_SKO_KEY_PRESENT flag and resetting the FSL_SKO_KEY_ESTABLISHED flag.
skobject | A variable of type fsl_shw_sko_t. | |
skkey | A pointer to the beginning of the key. | |
skkeylen | The length, in octets, of the key. The value should be appropriate to the key size supported by the algorithm. 64 octets is the absolute maximum value allowed for this call. |
#define fsl_shw_sko_set_key_length | ( | skobject, | |||
skkeylen | ) | (skobject)->key_length = skkeylen; |
Set a size for the key.
This function would normally be used when the user wants the key to be generated from a random source.
skobject | A variable of type fsl_shw_sko_t. | |
skkeylen | The length, in octets, of the key. The value should be appropriate to the key size supported by the algorithm. 64 octets is the absolute maximum value allowed for this call. |
#define fsl_shw_sko_set_key_length | ( | skobject, | |||
skkeylen | ) | (skobject)->key_length = skkeylen; |
Set a size for the key.
This function would normally be used when the user wants the key to be generated from a random source.
skobject | A variable of type fsl_shw_sko_t. | |
skkeylen | The length, in octets, of the key. The value should be appropriate to the key size supported by the algorithm. 64 octets is the absolute maximum value allowed for this call. |
#define fsl_shw_sko_set_keystore | ( | skobject, | |||
user_keystore | ) | (skobject)->keystore = (user_keystore) |
Establish a user Keystore to hold the key.
#define fsl_shw_sko_set_keystore | ( | skobject, | |||
user_keystore | ) | (skobject)->keystore = (user_keystore) |
Establish a user Keystore to hold the key.
#define fsl_shw_sko_set_user_id | ( | skobject, | |||
skuserid | ) | (skobject)->userid = (skuserid) |
Set the User ID associated with the key.
skobject | A variable of type fsl_shw_sko_t. | |
skuserid | The User ID to identify authorized users of the key. |
#define fsl_shw_sko_set_user_id | ( | skobject, | |||
skuserid | ) | (skobject)->userid = (skuserid) |
Set the User ID associated with the key.
skobject | A variable of type fsl_shw_sko_t. | |
skuserid | The User ID to identify authorized users of the key. |
#define fsl_shw_uco_clear_flags | ( | ucontext, | |||
uflags | ) | (ucontext)->flags &= ~(uflags) |
Clear flags in the User Context.
Turns off the flags specified in flags. Other flags are untouched.
ucontext | The User Context object to operate on. | |
uflags | ORed values from fsl_shw_user_ctx_flags_t. |
#define fsl_shw_uco_clear_flags | ( | ucontext, | |||
uflags | ) | (ucontext)->flags &= ~(uflags) |
Clear flags in the User Context.
Turns off the flags specified in flags. Other flags are untouched.
ucontext | The User Context object to operate on. | |
uflags | ORed values from fsl_shw_user_ctx_flags_t. |
#define fsl_shw_uco_init | ( | ucontext, | |||
usize | ) |
{ \ (ucontext)->pool_size = usize; \ (ucontext)->flags = FSL_UCO_BLOCKING_MODE; \ (ucontext)->sahara_openfd = -1; \ (ucontext)->mem_util = NULL; \ (ucontext)->callback = NULL; \ }
Initialize a User Context Object.
This function must be called before performing any other operation with the Object. It sets the User Context Object to initial values, and set the size of the results pool. The mode will be set to a default of FSL_UCO_BLOCKING_MODE.
When using non-blocking operations, this sets the maximum number of operations which can be outstanding. This number includes the counts of operations waiting to start, operation(s) being performed, and results which have not been retrieved.
Changes to this value are ignored once user registration has completed. It should be set to 1 if only blocking operations will ever be performed.
ucontext | The User Context object to operate on. | |
usize | The maximum number of operations which can be outstanding. |
#define fsl_shw_uco_init | ( | ucontext, | |||
usize | ) |
{ \ (ucontext)->pool_size = usize; \ (ucontext)->flags = FSL_UCO_BLOCKING_MODE; \ (ucontext)->sahara_openfd = -1; \ (ucontext)->mem_util = NULL; \ (ucontext)->callback = NULL; \ }
Initialize a User Context Object.
This function must be called before performing any other operation with the Object. It sets the User Context Object to initial values, and set the size of the results pool. The mode will be set to a default of FSL_UCO_BLOCKING_MODE.
When using non-blocking operations, this sets the maximum number of operations which can be outstanding. This number includes the counts of operations waiting to start, operation(s) being performed, and results which have not been retrieved.
Changes to this value are ignored once user registration has completed. It should be set to 1 if only blocking operations will ever be performed.
ucontext | The User Context object to operate on. | |
usize | The maximum number of operations which can be outstanding. |
#define fsl_shw_uco_set_callback | ( | ucontext, | |||
ucallback | ) | (ucontext)->callback = ucallback |
Set the User Reference for the User Context.
ucontext | The User Context object to operate on. | |
ucallback | The function the API will invoke when an operation completes. |
#define fsl_shw_uco_set_callback | ( | ucontext, | |||
ucallback | ) | (ucontext)->callback = ucallback |
Set the User Reference for the User Context.
ucontext | The User Context object to operate on. | |
ucallback | The function the API will invoke when an operation completes. |
#define fsl_shw_uco_set_flags | ( | ucontext, | |||
uflags | ) | (ucontext)->flags |= (uflags) |
Set flags in the User Context.
Turns on the flags specified in flags. Other flags are untouched.
ucontext | The User Context object to operate on. | |
uflags | ORed values from fsl_shw_user_ctx_flags_t. |
#define fsl_shw_uco_set_flags | ( | ucontext, | |||
uflags | ) | (ucontext)->flags |= (uflags) |
Set flags in the User Context.
Turns on the flags specified in flags. Other flags are untouched.
ucontext | The User Context object to operate on. | |
uflags | ORed values from fsl_shw_user_ctx_flags_t. |
#define fsl_shw_uco_set_reference | ( | ucontext, | |||
uref | ) | (ucontext)->user_ref = uref |
Set the User Reference for the User Context.
ucontext | The User Context object to operate on. | |
uref | A value which will be passed back with a result. |
#define fsl_shw_uco_set_reference | ( | ucontext, | |||
uref | ) | (ucontext)->user_ref = uref |
Set the User Reference for the User Context.
ucontext | The User Context object to operate on. | |
uref | A value which will be passed back with a result. |
#define SAH_IN_USER_KEYSTORE 0x100 |
The Data field points to the location of the key, which is in a secure partition held by the user. The memory address needs to be converted to kernel space manually, by looking through the partitions that the user holds.
#define SAH_IN_USER_KEYSTORE 0x100 |
The Data field points to the location of the key, which is in a secure partition held by the user. The memory address needs to be converted to kernel space manually, by looking through the partitions that the user holds.
Referenced by sah_DePhysicalise_Links(), sah_Make_Links(), and sah_Physicalise_Links().
#define SAH_KEY_IS_HIDDEN 0x08 |
The ptr and length in this link are really 'established key' info. They are to be converted to ptr/length before putting on request queue.
#define SAH_KEY_IS_HIDDEN 0x08 |
The ptr and length in this link are really 'established key' info. They are to be converted to ptr/length before putting on request queue.
#define SAH_LINK_INSERTED_LINK 0x80 |
The link was inserted during the Physicalise procedure. It is tagged so it can be removed during DePhysicalise, thereby returning to the caller an intact chain.
#define SAH_LINK_INSERTED_LINK 0x80 |
The link was inserted during the Physicalise procedure. It is tagged so it can be removed during DePhysicalise, thereby returning to the caller an intact chain.
Referenced by sah_DePhysicalise_Links(), and sah_Physicalise_Links().
#define SAH_OUTPUT_LINK 0x04 |
The data in this link will change when the descriptor gets executed.
#define SAH_OUTPUT_LINK 0x04 |
The data in this link will change when the descriptor gets executed.
Referenced by add_assoc_preamble(), sah_add_in_keyout_desc(), sah_add_in_out_desc(), sah_add_key_out_desc(), sah_add_out_in_desc(), sah_add_two_out_desc(), sah_DePhysicalise_Links(), sah_Make_Links(), and sah_Physicalise_Links().
#define SAH_OWNS_LINK_DATA 0x01 |
This flag indicates that the data in a link is owned by the security function component and this memory will be freed by the security function component. To be used as part of the flag field of the sah_Link structure.
#define SAH_OWNS_LINK_DATA 0x01 |
This flag indicates that the data in a link is owned by the security function component and this memory will be freed by the security function component. To be used as part of the flag field of the sah_Link structure.
Referenced by add_assoc_preamble(), process_assoc_from_nist_params(), and sah_Physicalise_Links().
#define SAH_PREPHYS_DATA 0x40 |
The Data field points to a physical address, and does not need to be processed by the driver. Honored only in Kernel API.
#define SAH_PREPHYS_DATA 0x40 |
The Data field points to a physical address, and does not need to be processed by the driver. Honored only in Kernel API.
Referenced by sah_DePhysicalise_Links(), sah_Make_Links(), and sah_Physicalise_Links().
#define SAH_REWORKED_LINK 0x10 |
The link structure has been appended to the previous one by the driver. It needs to be removed before leaving the driver (and returning to API).
#define SAH_REWORKED_LINK 0x10 |
The link structure has been appended to the previous one by the driver. It needs to be removed before leaving the driver (and returning to API).
#define SAH_STORED_KEY_INFO 0x20 |
The length and data fields of this link contain the slot and user id used to access the SCC stored key
#define SAH_STORED_KEY_INFO 0x20 |
The length and data fields of this link contain the slot and user id used to access the SCC stored key
Referenced by sah_DePhysicalise_Links(), sah_Make_Links(), and sah_Physicalise_Links().
#define SAH_USES_LINK_DATA 0x02 |
The data in a link is not owned by the security function component and therefore it will not attempt to free this memory. To be used as part of the flag field of the sah_Link structure.
#define SAH_USES_LINK_DATA 0x02 |
The data in a link is not owned by the security function component and therefore it will not attempt to free this memory. To be used as part of the flag field of the sah_Link structure.
Referenced by add_assoc_preamble(), process_assoc_from_nist_params(), sah_add_in_key_desc(), sah_add_in_keyout_desc(), sah_add_in_out_desc(), sah_add_key_out_desc(), sah_add_out_in_desc(), sah_add_two_d_desc(), sah_add_two_in_desc(), and sah_add_two_out_desc().
typedef struct fsl_sho_ibo_t fsl_sho_ibo_t |
Initialization Object
typedef struct fsl_sho_ibo_t fsl_sho_ibo_t |
Initialization Object
typedef enum fsl_shw_acc_mode_t fsl_shw_acc_mode_t |
The type of Authentication-Cipher function which will be performed.
typedef enum fsl_shw_acc_mode_t fsl_shw_acc_mode_t |
The type of Authentication-Cipher function which will be performed.
typedef struct fsl_shw_acco_t fsl_shw_acco_t |
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().
typedef struct fsl_shw_acco_t fsl_shw_acco_t |
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().
typedef enum fsl_shw_auth_ctx_flags_t fsl_shw_auth_ctx_flags_t |
Flags which describe the state of the fsl_shw_acco_t.
The FSL_ACCO_CTX_INIT and FSL_ACCO_CTX_FINALIZE flags, when used together, provide for a one-shot operation.
typedef enum fsl_shw_auth_ctx_flags_t fsl_shw_auth_ctx_flags_t |
Flags which describe the state of the fsl_shw_acco_t.
The FSL_ACCO_CTX_INIT and FSL_ACCO_CTX_FINALIZE flags, when used together, provide for a one-shot operation.
typedef enum fsl_shw_ctr_mod_t fsl_shw_ctr_mod_t |
Modulus Selector for CTR modes.
The incrementing of the Counter value may be modified by a modulus. If no modulus is needed or desired for AES, use FSL_CTR_MOD_128.
typedef enum fsl_shw_ctr_mod_t fsl_shw_ctr_mod_t |
Modulus Selector for CTR modes.
The incrementing of the Counter value may be modified by a modulus. If no modulus is needed or desired for AES, use FSL_CTR_MOD_128.
typedef enum fsl_shw_hash_alg_t fsl_shw_hash_alg_t |
Algorithm selector for Cryptographic Hash functions.
Selection of algorithm determines how large the context and digest will be. Context is the same size as the digest (resulting hash), unless otherwise specified.
typedef enum fsl_shw_hash_alg_t fsl_shw_hash_alg_t |
Algorithm selector for Cryptographic Hash functions.
Selection of algorithm determines how large the context and digest will be. Context is the same size as the digest (resulting hash), unless otherwise specified.
typedef enum fsl_shw_hash_ctx_flags_t fsl_shw_hash_ctx_flags_t |
Flags which control a Hash operation.
typedef enum fsl_shw_hash_ctx_flags_t fsl_shw_hash_ctx_flags_t |
Flags which control a Hash operation.
typedef struct fsl_shw_hco_t fsl_shw_hco_t |
Hash Context Object
typedef struct fsl_shw_hco_t fsl_shw_hco_t |
Hash Context Object
typedef enum fsl_shw_hmac_ctx_flags_t fsl_shw_hmac_ctx_flags_t |
Flags which control an HMAC operation.
These may be combined by ORing them together. See fsl_shw_hmco_set_flags() and fsl_shw_hmco_clear_flags().
typedef enum fsl_shw_hmac_ctx_flags_t fsl_shw_hmac_ctx_flags_t |
Flags which control an HMAC operation.
These may be combined by ORing them together. See fsl_shw_hmco_set_flags() and fsl_shw_hmco_clear_flags().
typedef struct fsl_shw_hmco_t fsl_shw_hmco_t |
HMAC Context Object
typedef struct fsl_shw_hmco_t fsl_shw_hmco_t |
HMAC Context Object
typedef enum fsl_shw_key_alg_t fsl_shw_key_alg_t |
Algorithm Identifier.
Selection of algorithm will determine how large the block size of the algorithm is. Context size is the same length unless otherwise specified. Selection of algorithm also affects the allowable key length.
typedef enum fsl_shw_key_alg_t fsl_shw_key_alg_t |
Algorithm Identifier.
Selection of algorithm will determine how large the block size of the algorithm is. Context size is the same length unless otherwise specified. Selection of algorithm also affects the allowable key length.
typedef enum fsl_shw_key_flags_t fsl_shw_key_flags_t |
Flags which describe the state of the fsl_shw_sko_t.
These may be ORed together to get the desired effect. See fsl_shw_sko_set_flags() and fsl_shw_sko_clear_flags()
typedef enum fsl_shw_key_flags_t fsl_shw_key_flags_t |
Flags which describe the state of the fsl_shw_sko_t.
These may be ORed together to get the desired effect. See fsl_shw_sko_set_flags() and fsl_shw_sko_clear_flags()
typedef enum fsl_shw_key_wrap_t fsl_shw_key_wrap_t |
The operation which controls the behavior of fsl_shw_establish_key().
These values are passed to fsl_shw_establish_key().
typedef enum fsl_shw_key_wrap_t fsl_shw_key_wrap_t |
The operation which controls the behavior of fsl_shw_establish_key().
These values are passed to fsl_shw_establish_key().
typedef struct fsl_shw_kso_t fsl_shw_kso_t |
Keystore Object
typedef struct fsl_shw_kso_t fsl_shw_kso_t |
Keystore Object
typedef enum fsl_shw_partition_status_t fsl_shw_partition_status_t |
Partition status information.
typedef enum fsl_shw_partition_status_t fsl_shw_partition_status_t |
Partition status information.
typedef struct fsl_shw_pco_t fsl_shw_pco_t |
Platform Capability Object.
typedef struct fsl_shw_pco_t fsl_shw_pco_t |
Platform Capability Object.
typedef enum fsl_shw_permission_t fsl_shw_permission_t |
Permissions flags for Secure Partitions
typedef enum fsl_shw_permission_t fsl_shw_permission_t |
Permissions flags for Secure Partitions
typedef struct fsl_shw_result_t fsl_shw_result_t |
Result object
typedef struct fsl_shw_result_t fsl_shw_result_t |
Result object
typedef enum fsl_shw_return_t fsl_shw_return_t |
Return code for FSL_SHW library.
These codes may be returned from a function call. In non-blocking mode, they will appear as the status in a Result Object.
typedef enum fsl_shw_return_t fsl_shw_return_t |
Return code for FSL_SHW library.
These codes may be returned from a function call. In non-blocking mode, they will appear as the status in a Result Object.
typedef struct fsl_shw_scco_t fsl_shw_scco_t |
Symmetric Crypto Context Object Context Object
typedef struct fsl_shw_scco_t fsl_shw_scco_t |
Symmetric Crypto Context Object Context Object
typedef struct fsl_shw_sko_t fsl_shw_sko_t |
Secret Key Context Object
typedef struct fsl_shw_sko_t fsl_shw_sko_t |
Secret Key Context Object
typedef struct fsl_shw_spo_t fsl_shw_spo_t |
Secure Partition information
This holds the context to a single secure partition owned by the user. It is only available in the kernel version of the User Context Object.
typedef struct fsl_shw_spo_t fsl_shw_spo_t |
Secure Partition information
This holds the context to a single secure partition owned by the user. It is only available in the kernel version of the User Context Object.
typedef enum fsl_shw_sym_ctx_flags_t fsl_shw_sym_ctx_flags_t |
Flags to control use of the fsl_shw_scco_t.
These may be ORed together to get the desired effect. See fsl_shw_scco_set_flags() and fsl_shw_scco_clear_flags()
typedef enum fsl_shw_sym_ctx_flags_t fsl_shw_sym_ctx_flags_t |
Flags to control use of the fsl_shw_scco_t.
These may be ORed together to get the desired effect. See fsl_shw_scco_set_flags() and fsl_shw_scco_clear_flags()
typedef enum fsl_shw_sym_mode_t fsl_shw_sym_mode_t |
Mode selector for Symmetric Ciphers.
The selection of mode determines how a cryptographic algorithm will be used to process the plaintext or ciphertext.
For all modes which are run block-by-block (that is, all but FSL_SYM_MODE_STREAM), any partial operations must be performed on a text length which is multiple of the block size. Except for FSL_SYM_MODE_CTR, these block-by-block algorithms must also be passed a total number of octets which is a multiple of the block size.
In modes which require that the total number of octets of data be a multiple of the block size (FSL_SYM_MODE_ECB and FSL_SYM_MODE_CBC), and the user has a total number of octets which are not a multiple of the block size, the user must perform any necessary padding to get to the correct data length.
typedef enum fsl_shw_sym_mode_t fsl_shw_sym_mode_t |
Mode selector for Symmetric Ciphers.
The selection of mode determines how a cryptographic algorithm will be used to process the plaintext or ciphertext.
For all modes which are run block-by-block (that is, all but FSL_SYM_MODE_STREAM), any partial operations must be performed on a text length which is multiple of the block size. Except for FSL_SYM_MODE_CTR, these block-by-block algorithms must also be passed a total number of octets which is a multiple of the block size.
In modes which require that the total number of octets of data be a multiple of the block size (FSL_SYM_MODE_ECB and FSL_SYM_MODE_CBC), and the user has a total number of octets which are not a multiple of the block size, the user must perform any necessary padding to get to the correct data length.
typedef struct fsl_shw_uco_t fsl_shw_uco_t |
User Context Object
typedef struct fsl_shw_uco_t fsl_shw_uco_t |
User Context Object
typedef enum fsl_shw_user_ctx_flags_t fsl_shw_user_ctx_flags_t |
Flags for the state of the User Context Object (fsl_shw_uco_t).
typedef enum fsl_shw_user_ctx_flags_t fsl_shw_user_ctx_flags_t |
Flags for the state of the User Context Object (fsl_shw_uco_t).
typedef uint64_t key_userid_t |
Type of value which is associated with an established key.
typedef uint64_t key_userid_t |
Type of value which is associated with an established key.
Structure type for descriptors.
The first five fields are passed to the hardware.
Structure type for descriptors.
The first five fields are passed to the hardware.
typedef struct sah_Head_Desc sah_Head_Desc |
The first descriptor in a chain.
typedef struct sah_Head_Desc sah_Head_Desc |
The first descriptor in a chain.
typedef uint8_t* sah_Int |
Indefinite precision integer used for security operations on SAHARA accelerator. The data will always be in little Endian format.
typedef uint8_t* sah_Int |
Indefinite precision integer used for security operations on SAHARA accelerator. The data will always be in little Endian format.
Structure type for links.
The first three fields are used by hardware.
Structure type for links.
The first three fields are used by hardware.
typedef uint32_t sah_Link_Flags |
typedef for flags field of sah_Link
sah_Link_Flags
Type to be used for flags associated with a Link in security function. These flags are used internally by the security function component only.
Values defined at Link Flags
typedef uint32_t sah_Link_Flags |
typedef for flags field of sah_Link
sah_Link_Flags
Type to be used for flags associated with a Link in security function. These flags are used internally by the security function component only.
Values defined at Link Flags
typedef struct sah_Mem_Util sah_Mem_Util |
Structure for API memory utilities.
FIELDS
void * ref - parameter to be passed into the memory function calls
void * (*malloc)(void *ref, size_t n) - pointer to user's malloc function
void (*free)(void *ref, void *ptr) - pointer to user's free function
void * (*memcpy)(void *ref, void *dest, const void *src, size_t n) - pointer to user's memcpy function
void * (*memset)(void *ref, void *ptr, int ch, size_t n) - pointer to user's memset function
typedef struct sah_Mem_Util sah_Mem_Util |
Structure for API memory utilities.
FIELDS
void * ref - parameter to be passed into the memory function calls
void * (*malloc)(void *ref, size_t n) - pointer to user's malloc function
void (*free)(void *ref, void *ptr) - pointer to user's free function
void * (*memcpy)(void *ref, void *dest, const void *src, size_t n) - pointer to user's memcpy function
void * (*memset)(void *ref, void *ptr, int ch, size_t n) - pointer to user's memset function
typedef uint8_t* sah_Oct_Str |
Byte array used for block cipher and hash digest/MAC operations on SAHARA accelerator. The Endian format will be as specified by the function using the sah_Oct_Str.
typedef uint8_t* sah_Oct_Str |
Byte array used for block cipher and hash digest/MAC operations on SAHARA accelerator. The Endian format will be as specified by the function using the sah_Oct_Str.
A queue of descriptor heads -- used to hold requests waiting for user to pick up the results.
A queue of descriptor heads -- used to hold requests waiting for user to pick up the results.
typedef struct sah_results sah_results |
Used by Sahara API to retrieve completed non-blocking results.
typedef struct sah_results sah_results |
Used by Sahara API to retrieve completed non-blocking results.
enum fsl_shw_acc_mode_t |
The type of Authentication-Cipher function which will be performed.
enum fsl_shw_acc_mode_t |
The type of Authentication-Cipher function which will be performed.
Flags which describe the state of the fsl_shw_acco_t.
The FSL_ACCO_CTX_INIT and FSL_ACCO_CTX_FINALIZE flags, when used together, provide for a one-shot operation.
Flags which describe the state of the fsl_shw_acco_t.
The FSL_ACCO_CTX_INIT and FSL_ACCO_CTX_FINALIZE flags, when used together, provide for a one-shot operation.
enum fsl_shw_ctr_mod_t |
Modulus Selector for CTR modes.
The incrementing of the Counter value may be modified by a modulus. If no modulus is needed or desired for AES, use FSL_CTR_MOD_128.
enum fsl_shw_ctr_mod_t |
Modulus Selector for CTR modes.
The incrementing of the Counter value may be modified by a modulus. If no modulus is needed or desired for AES, use FSL_CTR_MOD_128.
enum fsl_shw_hash_alg_t |
Algorithm selector for Cryptographic Hash functions.
Selection of algorithm determines how large the context and digest will be. Context is the same size as the digest (resulting hash), unless otherwise specified.
enum fsl_shw_hash_alg_t |
Algorithm selector for Cryptographic Hash functions.
Selection of algorithm determines how large the context and digest will be. Context is the same size as the digest (resulting hash), unless otherwise specified.
Flags which control a Hash operation.
FSL_HASH_FLAGS_INIT |
Context is empty. Hash is started from scratch, with a message-processed count of zero. |
FSL_HASH_FLAGS_SAVE |
Retrieve context from hardware after hashing. If used with the FSL_HASH_FLAGS_FINALIZE flag, the final digest value will be saved in the object. |
FSL_HASH_FLAGS_LOAD |
Place context into hardware before hashing. |
FSL_HASH_FLAGS_FINALIZE |
PAD message and perform final digest operation. If user message is pre-padded, this flag should not be used. |
FSL_HASH_FLAGS_INIT |
Context is empty. Hash is started from scratch, with a message-processed count of zero. |
FSL_HASH_FLAGS_SAVE |
Retrieve context from hardware after hashing. If used with the FSL_HASH_FLAGS_FINALIZE flag, the final digest value will be saved in the object. |
FSL_HASH_FLAGS_LOAD |
Place context into hardware before hashing. |
FSL_HASH_FLAGS_FINALIZE |
PAD message and perform final digest operation. If user message is pre-padded, this flag should not be used. |
FSL_HASH_FLAGS_INIT |
Context is empty. Hash is started from scratch, with a message-processed count of zero. |
FSL_HASH_FLAGS_SAVE |
Retrieve context from hardware after hashing. If used with the FSL_HASH_FLAGS_FINALIZE flag, the final digest value will be saved in the object. |
FSL_HASH_FLAGS_LOAD |
Place context into hardware before hashing. |
FSL_HASH_FLAGS_FINALIZE |
PAD message and perform final digest operation. If user message is pre-padded, this flag should not be used. |
FSL_HASH_FLAGS_INIT |
Context is empty. Hash is started from scratch, with a message-processed count of zero. |
FSL_HASH_FLAGS_SAVE |
Retrieve context from hardware after hashing. If used with the FSL_HASH_FLAGS_FINALIZE flag, the final digest value will be saved in the object. |
FSL_HASH_FLAGS_LOAD |
Place context into hardware before hashing. |
FSL_HASH_FLAGS_FINALIZE |
PAD message and perform final digest operation. If user message is pre-padded, this flag should not be used. |
FSL_HASH_FLAGS_INIT |
Context is empty. Hash is started from scratch, with a message-processed count of zero. |
FSL_HASH_FLAGS_SAVE |
Retrieve context from hardware after hashing. If used with the FSL_HASH_FLAGS_FINALIZE flag, the final digest value will be saved in the object. |
FSL_HASH_FLAGS_LOAD |
Place context into hardware before hashing. |
FSL_HASH_FLAGS_FINALIZE |
PAD message and perform final digest operation. If user message is pre-padded, this flag should not be used. |
Flags which control a Hash operation.
FSL_HASH_FLAGS_INIT |
Context is empty. Hash is started from scratch, with a message-processed count of zero. |
FSL_HASH_FLAGS_SAVE |
Retrieve context from hardware after hashing. If used with the FSL_HASH_FLAGS_FINALIZE flag, the final digest value will be saved in the object. |
FSL_HASH_FLAGS_LOAD |
Place context into hardware before hashing. |
FSL_HASH_FLAGS_FINALIZE |
PAD message and perform final digest operation. If user message is pre-padded, this flag should not be used. |
FSL_HASH_FLAGS_INIT |
Context is empty. Hash is started from scratch, with a message-processed count of zero. |
FSL_HASH_FLAGS_SAVE |
Retrieve context from hardware after hashing. If used with the FSL_HASH_FLAGS_FINALIZE flag, the final digest value will be saved in the object. |
FSL_HASH_FLAGS_LOAD |
Place context into hardware before hashing. |
FSL_HASH_FLAGS_FINALIZE |
PAD message and perform final digest operation. If user message is pre-padded, this flag should not be used. |
FSL_HASH_FLAGS_INIT |
Context is empty. Hash is started from scratch, with a message-processed count of zero. |
FSL_HASH_FLAGS_SAVE |
Retrieve context from hardware after hashing. If used with the FSL_HASH_FLAGS_FINALIZE flag, the final digest value will be saved in the object. |
FSL_HASH_FLAGS_LOAD |
Place context into hardware before hashing. |
FSL_HASH_FLAGS_FINALIZE |
PAD message and perform final digest operation. If user message is pre-padded, this flag should not be used. |
FSL_HASH_FLAGS_INIT |
Context is empty. Hash is started from scratch, with a message-processed count of zero. |
FSL_HASH_FLAGS_SAVE |
Retrieve context from hardware after hashing. If used with the FSL_HASH_FLAGS_FINALIZE flag, the final digest value will be saved in the object. |
FSL_HASH_FLAGS_LOAD |
Place context into hardware before hashing. |
FSL_HASH_FLAGS_FINALIZE |
PAD message and perform final digest operation. If user message is pre-padded, this flag should not be used. |
FSL_HASH_FLAGS_INIT |
Context is empty. Hash is started from scratch, with a message-processed count of zero. |
FSL_HASH_FLAGS_SAVE |
Retrieve context from hardware after hashing. If used with the FSL_HASH_FLAGS_FINALIZE flag, the final digest value will be saved in the object. |
FSL_HASH_FLAGS_LOAD |
Place context into hardware before hashing. |
FSL_HASH_FLAGS_FINALIZE |
PAD message and perform final digest operation. If user message is pre-padded, this flag should not be used. |
Flags which control an HMAC operation.
These may be combined by ORing them together. See fsl_shw_hmco_set_flags() and fsl_shw_hmco_clear_flags().
FSL_HMAC_FLAGS_INIT |
Message context is empty. HMAC is started from scratch (with key) or from precompute of inner hash, depending on whether FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT is set. |
FSL_HMAC_FLAGS_SAVE |
Retrieve ongoing context from hardware after hashing. If used with the FSL_HMAC_FLAGS_FINALIZE flag, the final digest value (HMAC) will be saved in the object. |
FSL_HMAC_FLAGS_LOAD |
Place ongoing context into hardware before hashing. |
FSL_HMAC_FLAGS_FINALIZE |
PAD message and perform final HMAC operations of inner and outer hashes. |
FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT |
This means that the context contains precomputed inner and outer hash values. |
FSL_HMAC_FLAGS_INIT |
Message context is empty. HMAC is started from scratch (with key) or from precompute of inner hash, depending on whether FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT is set. |
FSL_HMAC_FLAGS_SAVE |
Retrieve ongoing context from hardware after hashing. If used with the FSL_HMAC_FLAGS_FINALIZE flag, the final digest value (HMAC) will be saved in the object. |
FSL_HMAC_FLAGS_LOAD |
Place ongoing context into hardware before hashing. |
FSL_HMAC_FLAGS_FINALIZE |
PAD message and perform final HMAC operations of inner and outer hashes. |
FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT |
This means that the context contains precomputed inner and outer hash values. |
FSL_HMAC_FLAGS_INIT |
Message context is empty. HMAC is started from scratch (with key) or from precompute of inner hash, depending on whether FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT is set. |
FSL_HMAC_FLAGS_SAVE |
Retrieve ongoing context from hardware after hashing. If used with the FSL_HMAC_FLAGS_FINALIZE flag, the final digest value (HMAC) will be saved in the object. |
FSL_HMAC_FLAGS_LOAD |
Place ongoing context into hardware before hashing. |
FSL_HMAC_FLAGS_FINALIZE |
PAD message and perform final HMAC operations of inner and outer hashes. |
FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT |
This means that the context contains precomputed inner and outer hash values. |
FSL_HMAC_FLAGS_INIT |
Message context is empty. HMAC is started from scratch (with key) or from precompute of inner hash, depending on whether FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT is set. |
FSL_HMAC_FLAGS_SAVE |
Retrieve ongoing context from hardware after hashing. If used with the FSL_HMAC_FLAGS_FINALIZE flag, the final digest value (HMAC) will be saved in the object. |
FSL_HMAC_FLAGS_LOAD |
Place ongoing context into hardware before hashing. |
FSL_HMAC_FLAGS_FINALIZE |
PAD message and perform final HMAC operations of inner and outer hashes. |
FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT |
This means that the context contains precomputed inner and outer hash values. |
Flags which control an HMAC operation.
These may be combined by ORing them together. See fsl_shw_hmco_set_flags() and fsl_shw_hmco_clear_flags().
FSL_HMAC_FLAGS_INIT |
Message context is empty. HMAC is started from scratch (with key) or from precompute of inner hash, depending on whether FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT is set. |
FSL_HMAC_FLAGS_SAVE |
Retrieve ongoing context from hardware after hashing. If used with the FSL_HMAC_FLAGS_FINALIZE flag, the final digest value (HMAC) will be saved in the object. |
FSL_HMAC_FLAGS_LOAD |
Place ongoing context into hardware before hashing. |
FSL_HMAC_FLAGS_FINALIZE |
PAD message and perform final HMAC operations of inner and outer hashes. |
FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT |
This means that the context contains precomputed inner and outer hash values. |
FSL_HMAC_FLAGS_INIT |
Message context is empty. HMAC is started from scratch (with key) or from precompute of inner hash, depending on whether FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT is set. |
FSL_HMAC_FLAGS_SAVE |
Retrieve ongoing context from hardware after hashing. If used with the FSL_HMAC_FLAGS_FINALIZE flag, the final digest value (HMAC) will be saved in the object. |
FSL_HMAC_FLAGS_LOAD |
Place ongoing context into hardware before hashing. |
FSL_HMAC_FLAGS_FINALIZE |
PAD message and perform final HMAC operations of inner and outer hashes. |
FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT |
This means that the context contains precomputed inner and outer hash values. |
FSL_HMAC_FLAGS_INIT |
Message context is empty. HMAC is started from scratch (with key) or from precompute of inner hash, depending on whether FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT is set. |
FSL_HMAC_FLAGS_SAVE |
Retrieve ongoing context from hardware after hashing. If used with the FSL_HMAC_FLAGS_FINALIZE flag, the final digest value (HMAC) will be saved in the object. |
FSL_HMAC_FLAGS_LOAD |
Place ongoing context into hardware before hashing. |
FSL_HMAC_FLAGS_FINALIZE |
PAD message and perform final HMAC operations of inner and outer hashes. |
FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT |
This means that the context contains precomputed inner and outer hash values. |
FSL_HMAC_FLAGS_INIT |
Message context is empty. HMAC is started from scratch (with key) or from precompute of inner hash, depending on whether FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT is set. |
FSL_HMAC_FLAGS_SAVE |
Retrieve ongoing context from hardware after hashing. If used with the FSL_HMAC_FLAGS_FINALIZE flag, the final digest value (HMAC) will be saved in the object. |
FSL_HMAC_FLAGS_LOAD |
Place ongoing context into hardware before hashing. |
FSL_HMAC_FLAGS_FINALIZE |
PAD message and perform final HMAC operations of inner and outer hashes. |
FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT |
This means that the context contains precomputed inner and outer hash values. |
enum fsl_shw_key_alg_t |
Algorithm Identifier.
Selection of algorithm will determine how large the block size of the algorithm is. Context size is the same length unless otherwise specified. Selection of algorithm also affects the allowable key length.
enum fsl_shw_key_alg_t |
Algorithm Identifier.
Selection of algorithm will determine how large the block size of the algorithm is. Context size is the same length unless otherwise specified. Selection of algorithm also affects the allowable key length.
enum fsl_shw_key_flags_t |
Flags which describe the state of the fsl_shw_sko_t.
These may be ORed together to get the desired effect. See fsl_shw_sko_set_flags() and fsl_shw_sko_clear_flags()
enum fsl_shw_key_flags_t |
Flags which describe the state of the fsl_shw_sko_t.
These may be ORed together to get the desired effect. See fsl_shw_sko_set_flags() and fsl_shw_sko_clear_flags()
enum fsl_shw_key_wrap_t |
The operation which controls the behavior of fsl_shw_establish_key().
These values are passed to fsl_shw_establish_key().
enum fsl_shw_key_wrap_t |
The operation which controls the behavior of fsl_shw_establish_key().
These values are passed to fsl_shw_establish_key().
Partition status information.
Partition status information.
enum fsl_shw_permission_t |
Permissions flags for Secure Partitions
enum fsl_shw_permission_t |
Permissions flags for Secure Partitions
enum fsl_shw_pf_key_t |
enum fsl_shw_pf_key_t |
enum fsl_shw_return_t |
Return code for FSL_SHW library.
These codes may be returned from a function call. In non-blocking mode, they will appear as the status in a Result Object.
enum fsl_shw_return_t |
Return code for FSL_SHW library.
These codes may be returned from a function call. In non-blocking mode, they will appear as the status in a Result Object.
Flags to control use of the fsl_shw_scco_t.
These may be ORed together to get the desired effect. See fsl_shw_scco_set_flags() and fsl_shw_scco_clear_flags()
FSL_SYM_CTX_INIT |
Context is empty. In ARC4, this means that the S-Box needs to be generated from the key. In FSL_SYM_MODE_CBC mode, this allows an IV of zero to be specified. In FSL_SYM_MODE_CTR mode, it means that an initial CTR value of zero is desired. |
FSL_SYM_CTX_LOAD |
Load context from object into hardware before running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_SAVE |
Save context from hardware into object after running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_PROTECT |
Context (SBox) is to be unwrapped and wrapped on each use. This flag is unsupported. |
FSL_SYM_CTX_INIT |
Context is empty. In ARC4, this means that the S-Box needs to be generated from the key. In FSL_SYM_MODE_CBC mode, this allows an IV of zero to be specified. In FSL_SYM_MODE_CTR mode, it means that an initial CTR value of zero is desired. |
FSL_SYM_CTX_LOAD |
Load context from object into hardware before running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_SAVE |
Save context from hardware into object after running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_PROTECT |
Context (SBox) is to be unwrapped and wrapped on each use. This flag is unsupported. |
FSL_SYM_CTX_INIT |
Context is empty. In ARC4, this means that the S-Box needs to be generated from the key. In FSL_SYM_MODE_CBC mode, this allows an IV of zero to be specified. In FSL_SYM_MODE_CTR mode, it means that an initial CTR value of zero is desired. |
FSL_SYM_CTX_LOAD |
Load context from object into hardware before running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_SAVE |
Save context from hardware into object after running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_PROTECT |
Context (SBox) is to be unwrapped and wrapped on each use. This flag is unsupported. |
FSL_SYM_CTX_INIT |
Context is empty. In ARC4, this means that the S-Box needs to be generated from the key. In FSL_SYM_MODE_CBC mode, this allows an IV of zero to be specified. In FSL_SYM_MODE_CTR mode, it means that an initial CTR value of zero is desired. |
FSL_SYM_CTX_LOAD |
Load context from object into hardware before running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_SAVE |
Save context from hardware into object after running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_PROTECT |
Context (SBox) is to be unwrapped and wrapped on each use. This flag is unsupported. |
Flags to control use of the fsl_shw_scco_t.
These may be ORed together to get the desired effect. See fsl_shw_scco_set_flags() and fsl_shw_scco_clear_flags()
FSL_SYM_CTX_INIT |
Context is empty. In ARC4, this means that the S-Box needs to be generated from the key. In FSL_SYM_MODE_CBC mode, this allows an IV of zero to be specified. In FSL_SYM_MODE_CTR mode, it means that an initial CTR value of zero is desired. |
FSL_SYM_CTX_LOAD |
Load context from object into hardware before running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_SAVE |
Save context from hardware into object after running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_PROTECT |
Context (SBox) is to be unwrapped and wrapped on each use. This flag is unsupported. |
FSL_SYM_CTX_INIT |
Context is empty. In ARC4, this means that the S-Box needs to be generated from the key. In FSL_SYM_MODE_CBC mode, this allows an IV of zero to be specified. In FSL_SYM_MODE_CTR mode, it means that an initial CTR value of zero is desired. |
FSL_SYM_CTX_LOAD |
Load context from object into hardware before running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_SAVE |
Save context from hardware into object after running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_PROTECT |
Context (SBox) is to be unwrapped and wrapped on each use. This flag is unsupported. |
FSL_SYM_CTX_INIT |
Context is empty. In ARC4, this means that the S-Box needs to be generated from the key. In FSL_SYM_MODE_CBC mode, this allows an IV of zero to be specified. In FSL_SYM_MODE_CTR mode, it means that an initial CTR value of zero is desired. |
FSL_SYM_CTX_LOAD |
Load context from object into hardware before running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_SAVE |
Save context from hardware into object after running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_PROTECT |
Context (SBox) is to be unwrapped and wrapped on each use. This flag is unsupported. |
FSL_SYM_CTX_INIT |
Context is empty. In ARC4, this means that the S-Box needs to be generated from the key. In FSL_SYM_MODE_CBC mode, this allows an IV of zero to be specified. In FSL_SYM_MODE_CTR mode, it means that an initial CTR value of zero is desired. |
FSL_SYM_CTX_LOAD |
Load context from object into hardware before running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_SAVE |
Save context from hardware into object after running cipher. In FSL_SYM_MODE_CTR mode, this would refer to the Counter Value. |
FSL_SYM_CTX_PROTECT |
Context (SBox) is to be unwrapped and wrapped on each use. This flag is unsupported. |
enum fsl_shw_sym_mode_t |
Mode selector for Symmetric Ciphers.
The selection of mode determines how a cryptographic algorithm will be used to process the plaintext or ciphertext.
For all modes which are run block-by-block (that is, all but FSL_SYM_MODE_STREAM), any partial operations must be performed on a text length which is multiple of the block size. Except for FSL_SYM_MODE_CTR, these block-by-block algorithms must also be passed a total number of octets which is a multiple of the block size.
In modes which require that the total number of octets of data be a multiple of the block size (FSL_SYM_MODE_ECB and FSL_SYM_MODE_CBC), and the user has a total number of octets which are not a multiple of the block size, the user must perform any necessary padding to get to the correct data length.
enum fsl_shw_sym_mode_t |
Mode selector for Symmetric Ciphers.
The selection of mode determines how a cryptographic algorithm will be used to process the plaintext or ciphertext.
For all modes which are run block-by-block (that is, all but FSL_SYM_MODE_STREAM), any partial operations must be performed on a text length which is multiple of the block size. Except for FSL_SYM_MODE_CTR, these block-by-block algorithms must also be passed a total number of octets which is a multiple of the block size.
In modes which require that the total number of octets of data be a multiple of the block size (FSL_SYM_MODE_ECB and FSL_SYM_MODE_CBC), and the user has a total number of octets which are not a multiple of the block size, the user must perform any necessary padding to get to the correct data length.
enum fsl_shw_tamper_t |
enum fsl_shw_tamper_t |
Flags for the state of the User Context Object (fsl_shw_uco_t).
FSL_UCO_BLOCKING_MODE |
API will block the caller until operation completes. The result will be available in the return code. If this is not set, user will have to get results using fsl_shw_get_results(). |
FSL_UCO_CALLBACK_MODE |
User wants callback (at the function specified with fsl_shw_uco_set_callback()) when the operation completes. This flag is valid only if FSL_UCO_BLOCKING_MODE is not set. |
FSL_UCO_SAVE_DESC_CHAIN |
Do not free descriptor chain after driver (adaptor) finishes |
FSL_UCO_CALLBACK_SETUP_COMPLETE |
User has made at least one request with callbacks requested, so API is ready to handle others. |
FSL_UCO_CHAIN_PREPHYSICALIZED |
(virtual) pointer to descriptor chain is completely linked with physical (DMA) addresses, ready for the hardware. This flag should not be used by FSL SHW API programs. |
FSL_UCO_CONTEXT_CHANGED |
The user has changed the context but the changes have not been copied to the kernel driver. |
FSL_UCO_USERMODE_USER |
Internal Use. This context belongs to a user-mode API user. |
FSL_UCO_BLOCKING_MODE |
API will block the caller until operation completes. The result will be available in the return code. If this is not set, user will have to get results using fsl_shw_get_results(). |
FSL_UCO_CALLBACK_MODE |
User wants callback (at the function specified with fsl_shw_uco_set_callback()) when the operation completes. This flag is valid only if FSL_UCO_BLOCKING_MODE is not set. |
FSL_UCO_SAVE_DESC_CHAIN |
Do not free descriptor chain after driver (adaptor) finishes |
FSL_UCO_CALLBACK_SETUP_COMPLETE |
User has made at least one request with callbacks requested, so API is ready to handle others. |
FSL_UCO_CHAIN_PREPHYSICALIZED |
(virtual) pointer to descriptor chain is completely linked with physical (DMA) addresses, ready for the hardware. This flag should not be used by FSL SHW API programs. |
FSL_UCO_CONTEXT_CHANGED |
The user has changed the context but the changes have not been copied to the kernel driver. |
FSL_UCO_USERMODE_USER |
Internal Use. This context belongs to a user-mode API user. |
FSL_UCO_BLOCKING_MODE |
API will block the caller until operation completes. The result will be available in the return code. If this is not set, user will have to get results using fsl_shw_get_results(). |
FSL_UCO_CALLBACK_MODE |
User wants callback (at the function specified with fsl_shw_uco_set_callback()) when the operation completes. This flag is valid only if FSL_UCO_BLOCKING_MODE is not set. |
FSL_UCO_SAVE_DESC_CHAIN |
Do not free descriptor chain after driver (adaptor) finishes |
FSL_UCO_CALLBACK_SETUP_COMPLETE |
User has made at least one request with callbacks requested, so API is ready to handle others. |
FSL_UCO_CHAIN_PREPHYSICALIZED |
(virtual) pointer to descriptor chain is completely linked with physical (DMA) addresses, ready for the hardware. This flag should not be used by FSL SHW API programs. |
FSL_UCO_CONTEXT_CHANGED |
The user has changed the context but the changes have not been copied to the kernel driver. |
FSL_UCO_USERMODE_USER |
Internal Use. This context belongs to a user-mode API user. |
FSL_UCO_BLOCKING_MODE |
API will block the caller until operation completes. The result will be available in the return code. If this is not set, user will have to get results using fsl_shw_get_results(). |
FSL_UCO_CALLBACK_MODE |
User wants callback (at the function specified with fsl_shw_uco_set_callback()) when the operation completes. This flag is valid only if FSL_UCO_BLOCKING_MODE is not set. |
FSL_UCO_SAVE_DESC_CHAIN |
Do not free descriptor chain after driver (adaptor) finishes |
FSL_UCO_CALLBACK_SETUP_COMPLETE |
User has made at least one request with callbacks requested, so API is ready to handle others. |
FSL_UCO_CHAIN_PREPHYSICALIZED |
(virtual) pointer to descriptor chain is completely linked with physical (DMA) addresses, ready for the hardware. This flag should not be used by FSL SHW API programs. |
FSL_UCO_CONTEXT_CHANGED |
The user has changed the context but the changes have not been copied to the kernel driver. |
FSL_UCO_USERMODE_USER |
Internal Use. This context belongs to a user-mode API user. |
FSL_UCO_BLOCKING_MODE |
API will block the caller until operation completes. The result will be available in the return code. If this is not set, user will have to get results using fsl_shw_get_results(). |
FSL_UCO_CALLBACK_MODE |
User wants callback (at the function specified with fsl_shw_uco_set_callback()) when the operation completes. This flag is valid only if FSL_UCO_BLOCKING_MODE is not set. |
FSL_UCO_SAVE_DESC_CHAIN |
Do not free descriptor chain after driver (adaptor) finishes |
FSL_UCO_CALLBACK_SETUP_COMPLETE |
User has made at least one request with callbacks requested, so API is ready to handle others. |
FSL_UCO_CHAIN_PREPHYSICALIZED |
(virtual) pointer to descriptor chain is completely linked with physical (DMA) addresses, ready for the hardware. This flag should not be used by FSL SHW API programs. |
FSL_UCO_CONTEXT_CHANGED |
The user has changed the context but the changes have not been copied to the kernel driver. |
FSL_UCO_USERMODE_USER |
Internal Use. This context belongs to a user-mode API user. |
Flags for the state of the User Context Object (fsl_shw_uco_t).
FSL_UCO_BLOCKING_MODE |
API will block the caller until operation completes. The result will be available in the return code. If this is not set, user will have to get results using fsl_shw_get_results(). |
FSL_UCO_CALLBACK_MODE |
User wants callback (at the function specified with fsl_shw_uco_set_callback()) when the operation completes. This flag is valid only if FSL_UCO_BLOCKING_MODE is not set. |
FSL_UCO_SAVE_DESC_CHAIN |
Do not free descriptor chain after driver (adaptor) finishes |
FSL_UCO_CALLBACK_SETUP_COMPLETE |
User has made at least one request with callbacks requested, so API is ready to handle others. |
FSL_UCO_CHAIN_PREPHYSICALIZED |
(virtual) pointer to descriptor chain is completely linked with physical (DMA) addresses, ready for the hardware. This flag should not be used by FSL SHW API programs. |
FSL_UCO_CONTEXT_CHANGED |
The user has changed the context but the changes have not been copied to the kernel driver. |
FSL_UCO_USERMODE_USER |
Internal Use. This context belongs to a user-mode API user. |
FSL_UCO_BLOCKING_MODE |
API will block the caller until operation completes. The result will be available in the return code. If this is not set, user will have to get results using fsl_shw_get_results(). |
FSL_UCO_CALLBACK_MODE |
User wants callback (at the function specified with fsl_shw_uco_set_callback()) when the operation completes. This flag is valid only if FSL_UCO_BLOCKING_MODE is not set. |
FSL_UCO_SAVE_DESC_CHAIN |
Do not free descriptor chain after driver (adaptor) finishes |
FSL_UCO_CALLBACK_SETUP_COMPLETE |
User has made at least one request with callbacks requested, so API is ready to handle others. |
FSL_UCO_CHAIN_PREPHYSICALIZED |
(virtual) pointer to descriptor chain is completely linked with physical (DMA) addresses, ready for the hardware. This flag should not be used by FSL SHW API programs. |
FSL_UCO_CONTEXT_CHANGED |
The user has changed the context but the changes have not been copied to the kernel driver. |
FSL_UCO_USERMODE_USER |
Internal Use. This context belongs to a user-mode API user. |
FSL_UCO_BLOCKING_MODE |
API will block the caller until operation completes. The result will be available in the return code. If this is not set, user will have to get results using fsl_shw_get_results(). |
FSL_UCO_CALLBACK_MODE |
User wants callback (at the function specified with fsl_shw_uco_set_callback()) when the operation completes. This flag is valid only if FSL_UCO_BLOCKING_MODE is not set. |
FSL_UCO_SAVE_DESC_CHAIN |
Do not free descriptor chain after driver (adaptor) finishes |
FSL_UCO_CALLBACK_SETUP_COMPLETE |
User has made at least one request with callbacks requested, so API is ready to handle others. |
FSL_UCO_CHAIN_PREPHYSICALIZED |
(virtual) pointer to descriptor chain is completely linked with physical (DMA) addresses, ready for the hardware. This flag should not be used by FSL SHW API programs. |
FSL_UCO_CONTEXT_CHANGED |
The user has changed the context but the changes have not been copied to the kernel driver. |
FSL_UCO_USERMODE_USER |
Internal Use. This context belongs to a user-mode API user. |
FSL_UCO_BLOCKING_MODE |
API will block the caller until operation completes. The result will be available in the return code. If this is not set, user will have to get results using fsl_shw_get_results(). |
FSL_UCO_CALLBACK_MODE |
User wants callback (at the function specified with fsl_shw_uco_set_callback()) when the operation completes. This flag is valid only if FSL_UCO_BLOCKING_MODE is not set. |
FSL_UCO_SAVE_DESC_CHAIN |
Do not free descriptor chain after driver (adaptor) finishes |
FSL_UCO_CALLBACK_SETUP_COMPLETE |
User has made at least one request with callbacks requested, so API is ready to handle others. |
FSL_UCO_CHAIN_PREPHYSICALIZED |
(virtual) pointer to descriptor chain is completely linked with physical (DMA) addresses, ready for the hardware. This flag should not be used by FSL SHW API programs. |
FSL_UCO_CONTEXT_CHANGED |
The user has changed the context but the changes have not been copied to the kernel driver. |
FSL_UCO_USERMODE_USER |
Internal Use. This context belongs to a user-mode API user. |
FSL_UCO_BLOCKING_MODE |
API will block the caller until operation completes. The result will be available in the return code. If this is not set, user will have to get results using fsl_shw_get_results(). |
FSL_UCO_CALLBACK_MODE |
User wants callback (at the function specified with fsl_shw_uco_set_callback()) when the operation completes. This flag is valid only if FSL_UCO_BLOCKING_MODE is not set. |
FSL_UCO_SAVE_DESC_CHAIN |
Do not free descriptor chain after driver (adaptor) finishes |
FSL_UCO_CALLBACK_SETUP_COMPLETE |
User has made at least one request with callbacks requested, so API is ready to handle others. |
FSL_UCO_CHAIN_PREPHYSICALIZED |
(virtual) pointer to descriptor chain is completely linked with physical (DMA) addresses, ready for the hardware. This flag should not be used by FSL SHW API programs. |
FSL_UCO_CONTEXT_CHANGED |
The user has changed the context but the changes have not been copied to the kernel driver. |
FSL_UCO_USERMODE_USER |
Internal Use. This context belongs to a user-mode API user. |
fsl_shw_return_t do_scc_decrypt_region | ( | fsl_shw_uco_t * | user_ctx, | |
void * | partition_base, | |||
uint32_t | offset_bytes, | |||
uint32_t | byte_count, | |||
const uint8_t * | black_data, | |||
uint32_t * | IV, | |||
fsl_shw_cypher_mode_t | cypher_mode | |||
) |
Decrypt a region of secure memory using the hardware secret key.
Call the proper function to decrypt a region of encrypted secure memory
user_ctx | User context of the partition owner (NULL in kernel) | |
partition_base | Base address (physical) of the partition | |
offset_bytes | Offset from base address that the decrypted data shall be placed | |
byte_count | Length of the message (bytes) | |
black_data | Pointer to where the encrypted data is stored | |
IV | IV to use for decryption | |
cypher_mode | Cyphering mode to use, specified by type fsl_shw_cypher_mode_t |
Call the proper function to decrypt a region of encrypted secure memory
user_ctx | User context of the partition owner (NULL in kernel) | |
partition_base | Base address (physical) of the partition | |
offset_bytes | Offset from base address that the decrypted data shall be placed | |
byte_count | Length of the message (bytes) | |
black_data | Pointer to where the encrypted data is stored | |
owner_id |
References FSL_RETURN_ERROR_S, FSL_RETURN_OK_S, and os_cache_flush_range.
fsl_shw_return_t do_scc_encrypt_region | ( | fsl_shw_uco_t * | user_ctx, | |
void * | partition_base, | |||
uint32_t | offset_bytes, | |||
uint32_t | byte_count, | |||
uint8_t * | black_data, | |||
uint32_t * | IV, | |||
fsl_shw_cypher_mode_t | cypher_mode | |||
) |
Encrypt a region of secure memory using the hardware secret key.
Call the proper function to encrypt a region of encrypted secure memory
user_ctx | User context of the partition owner (NULL in kernel) | |
partition_base | Base address (physical) of the partition | |
offset_bytes | Offset from base address of the data to be encrypted | |
byte_count | Length of the message (bytes) | |
black_data | Pointer to where the encrypted data is stored | |
IV | IV to use for encryption | |
cypher_mode | Cyphering mode to use, specified by type fsl_shw_cypher_mode_t |
user_ctx | User context | |
partition_base | Base address of the partition | |
offset_bytes | Offset of data from the partition base | |
byte_count | Length of the data to encrypt | |
black_data | Location to store the encrypted data | |
IV | IV to use for the encryption routine | |
cypher_mode | Cyphering mode to use, specified by type fsl_shw_cypher_mode_t |
Call the proper function to encrypt a region of encrypted secure memory
user_ctx | User context of the partition owner (NULL in kernel) | |
partition_base | Base address (physical) of the partition | |
offset_bytes | Offset from base address of the data to be encrypted | |
byte_count | Length of the message (bytes) | |
black_data | Pointer to where the encrypted data is stored | |
IV | IV to use for encryption | |
cypher_mode | Cyphering mode to use, specified by type fsl_shw_cypher_mode_t |
References FSL_RETURN_ERROR_S, FSL_RETURN_OK_S, os_cache_flush_range, and os_cache_inv_range.
fsl_shw_return_t fsl_shw_add_entropy | ( | fsl_shw_uco_t * | user_ctx, | |
uint32_t | length, | |||
uint8_t * | data | |||
) |
Add entropy to random number generator.
user_ctx | A user context from fsl_shw_register_user(). | |
length | Number of bytes at data. | |
data | Entropy to add to random number generator. |
Add entropy to a random number generator
user_ctx | ||
length | ||
data |
References DESC_IN_IN, FSL_RETURN_ERROR_S, FSL_RETURN_NO_RESOURCE_S, FSL_RETURN_OK_S, os_alloc_memory, os_free_memory, RNG_ADD_ENTROPY, rng_availability, RNG_STATUS_OK, SAH_HDR_RNG_GENERATE, and sah_validate_uco().
Referenced by add_entropy(), and rng_test_add_entropy().
fsl_shw_return_t fsl_shw_auth_decrypt | ( | fsl_shw_uco_t * | user_ctx, | |
fsl_shw_acco_t * | auth_ctx, | |||
fsl_shw_sko_t * | cipher_key_info, | |||
fsl_shw_sko_t * | auth_key_info, | |||
uint32_t | auth_data_length, | |||
const uint8_t * | auth_data, | |||
uint32_t | payload_length, | |||
const uint8_t * | ct, | |||
const uint8_t * | auth_value, | |||
uint8_t * | payload | |||
) |
Authenticate and decrypt a (CCM) stream.
user_ctx | The user's context | |
auth_ctx | Info on this Auth operation | |
cipher_key_info | Key to encrypt payload | |
auth_key_info | (unused - same key in CCM) | |
auth_data_length | Length in bytes of auth_data | |
auth_data | Any auth-only data | |
payload_length | Length in bytes of payload | |
ct | The encrypted data | |
auth_value | The authentication code to validate | |
[out] | payload | The location to store decrypted data |
References add_assoc_preamble(), block_zeros, fsl_shw_acco_t::CCM_ctx_info, fsl_shw_acco_t::cipher_ctx_info, DESC_IN_IN, DESC_IN_KEY, DESC_IN_OUT, DESC_OUT_OUT, fsl_shw_acco_t::flags, fsl_shw_uco_t::flags, FSL_ACC_MODE_CCM, FSL_RETURN_AUTH_FAILED_S, FSL_RETURN_BAD_FLAG_S, FSL_RETURN_BAD_MODE_S, FSL_RETURN_ERROR_S, FSL_RETURN_OK_S, FSL_UCO_BLOCKING_MODE, fsl_shw_acco_t::mac_length, fsl_shw_acco_t::mode, SAH_HDR_SKHA_ENC_DEC, SAH_HDR_SKHA_READ_CONTEXT_IV, SAH_HDR_SKHA_SET_MODE_ENC_DEC, SAH_HDR_SKHA_SET_MODE_IV_KEY, sah_insert_skha_modulus_128, and fsl_shw_acco_t::unencrypted_mac.
fsl_shw_return_t fsl_shw_deregister_user | ( | fsl_shw_uco_t * | user_ctx | ) |
Destroy the association between the the user and the provider of the API.
user_ctx | The user context which is no longer needed. |
References FSL_RETURN_ERROR_S, FSL_RETURN_OK_S, fsl_shw_spo_t::kernel_base, OS_ERROR_OK_S, os_free_memory, os_lock_save_context, os_unlock_restore_context, sah_deregister(), shw_queue_lock, SHW_REMOVE_USER(), unmap_user_memory(), and fsl_shw_spo_t::user_base.
fsl_shw_return_t fsl_shw_diminish_perms | ( | fsl_shw_uco_t * | user_ctx, | |
void * | address, | |||
uint32_t | permissions | |||
) |
Diminish the permissions of a block of secure memory. Note that permissions can only be revoked.
user_ctx | User context | |
address | Base address of the secure memory to work with | |
permissions | Permissions to initialize the partition with. Can be made by ORing flags from the fsl_shw_permission_t. |
References FSL_RETURN_ERROR_S, and FSL_RETURN_OK_S.
fsl_shw_return_t fsl_shw_establish_key | ( | fsl_shw_uco_t * | user_ctx, | |
fsl_shw_sko_t * | key_info, | |||
fsl_shw_key_wrap_t | establish_type, | |||
const uint8_t * | key | |||
) |
Establish the key in a protected location, which can be the system keystore, user keystore, or (on platforms that support it) as a Platform Key.
By default, keys initialized with fsl_shw_sko_init() will be placed into the system keystore. The user can cause the key to be established in a user keystore by first calling fsl_shw_sko_set_keystore() on the key. Normally, keys in the system keystore can only be used for hardware encrypt or decrypt operations, however if the FSL_SKO_KEY_SW_KEY flag is applied using fsl_shw_sko_set_flags(), the key will be established as a software key, which can then be read out using fsl_shw_read_key().
Keys initialized with fsl_shw_sko_init_pf_key() are established as a Platform Key. Their use is covered in Hardware key-select extensions - DryIce.
This function only needs to be used when unwrapping a key, setting up a key which could be wrapped with a later call to fsl_shw_extract_key(), or setting up a key as a Platform Key. Normal cleartext keys can simply be placed into fsl_shw_sko_t key objects with fsl_shw_sko_set_key() and used directly.
The maximum key size supported for wrapped/unwrapped keys is 32 octets. (This is the maximum reasonable key length on Sahara - 32 octets for an HMAC key based on SHA-256.) The key size is determined by the key_info. The expected length of key can be determined by fsl_shw_sko_calculate_wrapped_size()
The protected key will not be available for use until this operation successfully completes.
This feature is not available for all platforms, nor for all algorithms and modes.
user_ctx | A user context from fsl_shw_register_user(). | |
[in,out] | key_info | The information about the key to be which will be established. In the create case, the key length must be set. |
establish_type | How key will be interpreted to establish a key for use. | |
key | If establish_type is FSL_KEY_WRAP_UNWRAP, this is the location of a wrapped key. If establish_type is FSL_KEY_WRAP_CREATE, this parameter can be NULL. If establish_type is FSL_KEY_WRAP_ACCEPT, this is the location of a plaintext key. |
Place a key into a protected location for use only by cryptographic algorithms.
This only needs to be used to a) unwrap a key, or b) set up a key which could be wrapped with a later call to fsl_shw_extract_key(). Normal cleartext keys can simply be placed into fsl_shw_sko_t key objects with fsl_shw_sko_set_key() and used directly.
The maximum key size supported for wrapped/unwrapped keys is 32 octets. (This is the maximum reasonable key length on Sahara - 32 octets for an HMAC key based on SHA-256.) The key size is determined by the key_info. The expected length of key can be determined by fsl_shw_sko_calculate_wrapped_size()
The protected key will not be available for use until this operation successfully completes.
This feature is not available for all platforms, nor for all algorithms and modes.
user_ctx | A user context from fsl_shw_register_user(). | |
[in,out] | key_info | The information about the key to be which will be established. In the create case, the key length must be set. |
establish_type | How key will be interpreted to establish a key for use. | |
key | If establish_type is FSL_KEY_WRAP_UNWRAP, this is the location of a wrapped key. If establish_type is FSL_KEY_WRAP_CREATE, this parameter can be NULL. If establish_type is FSL_KEY_WRAP_ACCEPT, this is the location of a plaintext key. |
References DESC_KEY_OUT, fsl_shw_uco_t::flags, FSL_RETURN_BAD_FLAG_S, FSL_RETURN_ERROR_S, FSL_RETURN_NO_RESOURCE_S, FSL_RETURN_OK_S, FSL_SKO_KEY_ESTABLISHED, FSL_UCO_BLOCKING_MODE, fsl_shw_sko_t::keystore, keystore_slot_alloc(), keystore_slot_dealloc(), keystore_slot_load(), LOG_DIAG, and SAH_HDR_RNG_GENERATE.
Referenced by create_key(), extract_reestablish_key(), run_user_wrap(), run_wrap(), and test_software_key().
fsl_shw_return_t fsl_shw_extract_key | ( | fsl_shw_uco_t * | user_ctx, | |
fsl_shw_sko_t * | key_info, | |||
uint8_t * | covered_key | |||
) |
Wrap a key and retrieve the wrapped value.
A wrapped key is a key that has been cryptographically obscured. It is only able to be used with keys that have been established by fsl_shw_establish_key().
For keys established in the system or user keystore, this function will also release the key (see fsl_shw_release_key()) so that it must be re- established before reuse. This function will not release keys that are established as a Platform Key, so a call to fsl_shw_release_key() is necessary to release those keys.
This feature is not available for all platforms, nor for all algorithms and modes.
user_ctx | A user context from fsl_shw_register_user(). | |
key_info | The information about the key to be deleted. | |
[out] | covered_key | The location to store the wrapped key. (This size is based upon the maximum key size of 32 octets). |
Wrap a key and retrieve the wrapped value.
A wrapped key is a key that has been cryptographically obscured. It is only able to be used with fsl_shw_establish_key().
This function will also release the key (see fsl_shw_release_key()) so that it must be re-established before reuse.
This feature is not available for all platforms, nor for all algorithms and modes.
user_ctx | A user context from fsl_shw_register_user(). | |
key_info | The information about the key to be deleted. | |
[out] | covered_key | The location to store the 48-octet wrapped key. (This size is based upon the maximum key size of 32 octets). |
References fsl_shw_uco_t::flags, FSL_RETURN_NO_RESOURCE_S, FSL_RETURN_OK_S, FSL_SKO_KEY_ESTABLISHED, FSL_SKO_KEY_PRESENT, FSL_SKO_KEY_SW_KEY, FSL_UCO_BLOCKING_MODE, fsl_shw_sko_t::keystore, and keystore_slot_dealloc().
Referenced by extract_reestablish_key(), run_user_wrap(), run_wrap(), and test_software_key().
fsl_shw_return_t fsl_shw_gen_encrypt | ( | fsl_shw_uco_t * | user_ctx, | |
fsl_shw_acco_t * | auth_ctx, | |||
fsl_shw_sko_t * | cipher_key_info, | |||
fsl_shw_sko_t * | auth_key_info, | |||
uint32_t | auth_data_length, | |||
const uint8_t * | auth_data, | |||
uint32_t | payload_length, | |||
const uint8_t * | payload, | |||
uint8_t * | ct, | |||
uint8_t * | auth_value | |||
) |
Generate a (CCM) auth code and encrypt the payload.
Perform Generation-Encryption by doing a Cipher and a Hash.
Generate the authentication value auth_value as well as encrypt the payload into ct (the ciphertext). This is a one-shot function, so all of the auth_data and the total message payload must passed in one call. This also means that the flags in the auth_ctx must be FSL_ACCO_CTX_INIT and FSL_ACCO_CTX_FINALIZE.
user_ctx | A user context from fsl_shw_register_user(). | |
auth_ctx | Controlling object for Authenticate-decrypt. | |
cipher_key_info | The key being used for the cipher part of this operation. In CCM mode, this key is used for both parts. | |
auth_key_info | The key being used for the authentication part of this operation. In CCM mode, this key is ignored and may be NULL. | |
auth_data_length | Length, in octets, of auth_data. | |
auth_data | Data to be authenticated but not encrypted. | |
payload_length | Length, in octets, of payload. | |
payload | Pointer to the plaintext to be encrypted. | |
[out] | ct | Pointer to the where the encrypted payload will be stored. Must be payload_length octets long. |
[out] | auth_value | Pointer to where the generated authentication field will be stored. Must be as many octets as indicated by MAC length in the function_ctx. |
This is a very complicated function. Seven (or eight) descriptors are required to perform a CCM calculation.
First: Load CTR0 and key.
Second: Run an octet of data through to bump to CTR1. (This could be done in software, but software will have to bump and later decrement - or copy and bump.
Third: (in Virtio) Load a descriptor with data of zeros for CBC IV.
Fourth: Run any (optional) "additional data" through the CBC-mode portion of the algorithm.
Fifth: Run the payload through in CCM mode.
Sixth: Extract the unencrypted MAC.
Seventh: Load CTR0.
Eighth: Encrypt the MAC.
user_ctx | The user's context | |
auth_ctx | Info on this Auth operation | |
cipher_key_info | Key to encrypt payload | |
auth_key_info | (unused - same key in CCM) | |
auth_data_length | Length in bytes of auth_data | |
auth_data | Any auth-only data | |
payload_length | Length in bytes of payload | |
payload | The data to encrypt | |
[out] | ct | The location to store encrypted data |
[out] | auth_value | The location to store authentication code |
References add_assoc_preamble(), block_zeros, fsl_shw_acco_t::CCM_ctx_info, fsl_shw_acco_t::cipher_ctx_info, DESC_IN_IN, DESC_IN_KEY, DESC_IN_OUT, DESC_OUT_OUT, fsl_shw_acco_t::flags, FSL_ACC_MODE_CCM, FSL_ACC_MODE_SSL, FSL_RETURN_BAD_FLAG_S, FSL_RETURN_BAD_MODE_S, FSL_RETURN_ERROR_S, FSL_RETURN_OK_S, garbage_output, fsl_shw_acco_t::mac_length, fsl_shw_acco_t::mode, SAH_HDR_SKHA_ENC_DEC, SAH_HDR_SKHA_READ_CONTEXT_IV, SAH_HDR_SKHA_SET_MODE_ENC_DEC, SAH_HDR_SKHA_SET_MODE_IV_KEY, sah_insert_skha_modulus_128, and fsl_shw_acco_t::unencrypted_mac.
fsl_shw_pco_t* fsl_shw_get_capabilities | ( | fsl_shw_uco_t * | user_ctx | ) |
Determine the hardware security capabilities of this platform.
Though a user context object is passed into this function, it will always act in a non-blocking manner.
user_ctx | The user context which will be used for the query. |
References FSL_RETURN_OK_S, and get_capabilities().
fsl_shw_return_t fsl_shw_get_random | ( | fsl_shw_uco_t * | user_ctx, | |
uint32_t | length, | |||
uint8_t * | data | |||
) |
Get random data.
user_ctx | A user context from fsl_shw_register_user(). | |
length | The number of octets of data being requested. | |
[out] | data | A pointer to a location of length octets to where random data will be returned. |
Get random data.
user_ctx | A user context from fsl_shw_register_user(). | |
length | The number of octets of data being requested. | |
data | A pointer to a location of length octets to where random data will be returned. |
Get random data.
user_ctx | A user context from fsl_shw_register_user(). | |
length | The number of octets of data being requested. | |
[out] | data | A pointer to a location of length octets to where random data will be returned. |
Get random data.
user_ctx | A user context from fsl_shw_register_user(). | |
length | The number of octets of data being requested. | |
data | A pointer to a location of length octets to where random data will be returned. |
Get a random number
user_ctx | ||
length | ||
data |
References fsl_shw_uco_t::callback, rng_work_entry::completed, rng_work_entry::data_local, rng_work_entry::data_user, DESC_OUT_OUT, finish_random(), fsl_shw_uco_t::flags, FSL_RETURN_ERROR_S, FSL_RETURN_NO_RESOURCE_S, FSL_RETURN_OK_S, FSL_UCO_BLOCKING_MODE, rng_work_entry::hdr, rng_work_entry::length, os_alloc_memory, os_free_memory, os_sleep, RNG_ADD_WORK_ENTRY(), rng_availability, RNG_STATUS_OK, SAH_HDR_RNG_GENERATE, sah_validate_uco(), and fsl_shw_uco_t::user_ref.
Referenced by get_random(), and rng_test_get_random().
fsl_shw_return_t fsl_shw_get_results | ( | fsl_shw_uco_t * | user_ctx, | |
unsigned | result_size, | |||
fsl_shw_result_t | results[], | |||
unsigned * | result_count | |||
) |
Retrieve results from earlier operations.
user_ctx | The user's context. | |
result_size | The number of array elements of results. | |
[in,out] | results | Pointer to first of the (array of) locations to store results. |
[out] | result_count | Pointer to store the number of results which were returned. |
References sah_results::actual, FSL_RETURN_OK_S, os_free_memory, os_lock_save_context, os_unlock_restore_context, sah_results::requested, sah_results::results, sah_get_results(), sah_validate_uco(), and shw_queue_lock.
fsl_shw_return_t fsl_shw_hash | ( | fsl_shw_uco_t * | user_ctx, | |
fsl_shw_hco_t * | hash_ctx, | |||
const uint8_t * | msg, | |||
uint32_t | length, | |||
uint8_t * | result, | |||
uint32_t | result_len | |||
) |
Hash a stream of data with a cryptographic hash algorithm.
The flags in the hash_ctx control the operation of this function.
Hashing functions work on 64 octets of message at a time. Therefore, when any partial hashing of a long message is performed, the message length of each segment must be a multiple of 64. When ready to FSL_HASH_FLAGS_FINALIZE the hash, the length may be any value.
With the FSL_HASH_FLAGS_INIT and FSL_HASH_FLAGS_FINALIZE flags on, a one-shot complete hash, including padding, will be performed. The length may be any value.
The first octets of a data stream can be hashed by setting the FSL_HASH_FLAGS_INIT and FSL_HASH_FLAGS_SAVE flags. The length must be a multiple of 64.
The flag FSL_HASH_FLAGS_LOAD is used to load a context previously saved by FSL_HASH_FLAGS_SAVE. The two in combination will allow a (multiple-of-64 octets) 'middle sequence' of the data stream to be hashed with the beginning. The length must again be a multiple of 64.
Since the flag FSL_HASH_FLAGS_LOAD is used to load a context previously saved by FSL_HASH_FLAGS_SAVE, the FSL_HASH_FLAGS_LOAD and FSL_HASH_FLAGS_FINALIZE flags, used together, can be used to finish the stream. The length may be any value.
If the user program wants to do the padding for the hash, it can leave off the FSL_HASH_FLAGS_FINALIZE flag. The length must then be a multiple of 64 octets.
user_ctx | A user context from fsl_shw_register_user(). | |
[in,out] | hash_ctx | Hashing algorithm and state of the cipher. |
msg | Pointer to the data to be hashed. | |
length | Length, in octets, of the msg. | |
[out] | result | If not null, pointer to where to store the hash digest. |
result_len | Number of octets to store in result. |
References DESC_IN_IN, DESC_IN_OUT, FSL_HASH_FLAGS_FINALIZE, FSL_HASH_FLAGS_INIT, FSL_HASH_FLAGS_LOAD, FSL_HASH_FLAGS_SAVE, FSL_RETURN_BAD_FLAG_S, FSL_RETURN_ERROR_S, SAH_HDR_MDHA_HASH, SAH_HDR_MDHA_SET_MODE_HASH, SAH_HDR_MDHA_SET_MODE_MD_KEY, and SAH_HDR_MDHA_STORE_DIGEST.
fsl_shw_return_t fsl_shw_hmac | ( | fsl_shw_uco_t * | user_ctx, | |
fsl_shw_sko_t * | key_info, | |||
fsl_shw_hmco_t * | hmac_ctx, | |||
const uint8_t * | msg, | |||
uint32_t | length, | |||
uint8_t * | result, | |||
uint32_t | result_len | |||
) |
Get the hmac
user_ctx | Info for acquiring memory | |
key_info | ||
hmac_ctx | ||
msg | ||
length | ||
result | ||
result_len |
Continue, finalize, or one-shot an HMAC operation.
There are a number of ways to use this function. The flags in the hmac_ctx object will determine what operations occur.
If FSL_HMAC_FLAGS_INIT is set, then the hash will be started either from the key_info, or from the precomputed inner hash value in the hmac_ctx, depending on the value of FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT.
If, instead, FSL_HMAC_FLAGS_LOAD is set, then the hash will be continued from the ongoing inner hash computation in the hmac_ctx.
If FSL_HMAC_FLAGS_FINALIZE are set, then the msg will be padded, hashed, the outer hash will be performed, and the result will be generated.
If the FSL_HMAC_FLAGS_SAVE flag is set, then the (ongoing or final) digest value will be stored in the ongoing inner hash computation field of the hmac_ctx.
user_ctx | A user context from fsl_shw_register_user(). | |
key_info | If FSL_HMAC_FLAGS_INIT is set in the hmac_ctx, this is the key being used in this operation, and the IPAD. If FSL_HMAC_FLAGS_INIT is set in the hmac_ctx and key_info is NULL, then fsl_shw_hmac_precompute() has been used to populate the inner_precompute and outer_precompute contexts. If FSL_HMAC_FLAGS_INIT is not set, this parameter is ignored. | |
[in,out] | hmac_ctx | The context which controls, by its flags and algorithm, the operation of this function. |
msg | Pointer to the message to be hashed. | |
length | Length, in octets, of the msg. | |
[out] | result | Pointer, of result_len octets, to where to store the HMAC. |
result_len | Length of result buffer. |
Get the hmac
user_ctx | Info for acquiring memory | |
key_info | ||
hmac_ctx | ||
msg | ||
length | ||
result | ||
result_len |
References fsl_shw_hmco_t::context_length, fsl_shw_hmco_t::context_register_length, DESC_IN_IN, DESC_IN_KEY, DESC_IN_OUT, FSL_KEY_ALG_HMAC, FSL_RETURN_BAD_ALGORITHM_S, FSL_RETURN_BAD_DATA_LENGTH_S, FSL_RETURN_BAD_FLAG_S, FSL_RETURN_BAD_KEY_LENGTH_S, FSL_RETURN_ERROR_S, FSL_RETURN_NO_RESOURCE_S, FSL_RETURN_OK_S, fsl_shw_hmco_t::inner_precompute, fsl_shw_hmco_t::ongoing_context, fsl_shw_hmco_t::outer_precompute, SAH_HDR_MDHA_HASH, SAH_HDR_MDHA_SET_MODE_MD_KEY, and SAH_HDR_MDHA_STORE_DIGEST.
fsl_shw_return_t fsl_shw_hmac_precompute | ( | fsl_shw_uco_t * | user_ctx, | |
fsl_shw_sko_t * | key_info, | |||
fsl_shw_hmco_t * | hmac_ctx | |||
) |
Get the precompute information
user_ctx | ||
key_info | ||
hmac_ctx |
Precompute the Key hashes for an HMAC operation.
This function may be used to calculate the inner and outer precomputes, which are the hash contexts resulting from hashing the XORed key for the 'inner hash' and the 'outer hash', respectively, of the HMAC function.
After execution of this function, the hmac_ctx will contain the precomputed inner and outer contexts, so that they may be used by fsl_shw_hmac(). The flags of hmac_ctx will be updated with FSL_HMAC_FLAGS_PRECOMPUTES_PRESENT to mark their presence. In addition, the FSL_HMAC_FLAGS_INIT flag will be set.
user_ctx | A user context from fsl_shw_register_user(). | |
key_info | The key being used in this operation. Key must be 1 to 64 octets long. | |
[in,out] | hmac_ctx | The context which controls, by its flags and algorithm, the operation of this function. |
Get the precompute information
user_ctx | ||
key_info | ||
hmac_ctx |
References fsl_shw_hmco_t::context_register_length, DESC_KEY_OUT, FSL_KEY_ALG_HMAC, FSL_RETURN_BAD_ALGORITHM_S, FSL_RETURN_BAD_KEY_LENGTH_S, FSL_RETURN_ERROR_S, FSL_RETURN_OK_S, fsl_shw_hmco_t::inner_precompute, fsl_shw_hmco_t::outer_precompute, and SAH_HDR_MDHA_SET_MODE_HASH.
fsl_shw_return_t fsl_shw_read_key | ( | fsl_shw_uco_t * | user_ctx, | |
fsl_shw_sko_t * | key_info, | |||
uint8_t * | key | |||
) |
Read the key value from a key object.
Only a key marked as a software key (FSL_SKO_KEY_SW_KEY) can be read with this call. It has no effect on the status of the key store.
user_ctx | A user context from fsl_shw_register_user(). | |
key_info | The referenced key. | |
[out] | key | The location to store the key value. |
References FSL_RETURN_BAD_FLAG_S, FSL_RETURN_NO_RESOURCE_S, FSL_SKO_KEY_ESTABLISHED, FSL_SKO_KEY_SW_KEY, fsl_shw_sko_t::keystore, and keystore_slot_read().
Referenced by test_software_key().
fsl_shw_return_t fsl_shw_register_user | ( | fsl_shw_uco_t * | user_ctx | ) |
Create an association between the user and the provider of the API.
user_ctx | The user context which will be used for this association. |
Create an association between the the user and the provider of the API.
user_ctx | The user context which will be used for this association. |
References fsl_shw_uco_t::flags, FSL_RETURN_BAD_FLAG_S, FSL_RETURN_INTERNAL_ERROR_S, FSL_RETURN_NO_RESOURCE_S, FSL_RETURN_OK_S, FSL_UCO_BLOCKING_MODE, FSL_UCO_CALLBACK_MODE, fsl_shw_uco_t::pool_size, sah_register(), and SHW_ADD_USER().
fsl_shw_return_t fsl_shw_release_key | ( | fsl_shw_uco_t * | user_ctx, | |
fsl_shw_sko_t * | key_info | |||
) |
De-establish a key so that it can no longer be accessed.
The key will need to be re-established before it can again be used.
This feature is not available for all platforms, nor for all algorithms and modes.
user_ctx | A user context from fsl_shw_register_user(). | |
key_info | The information about the key to be deleted. |
References FSL_RETURN_NO_RESOURCE_S, FSL_SKO_KEY_ESTABLISHED, FSL_SKO_KEY_PRESENT, fsl_shw_sko_t::keystore, and keystore_slot_dealloc().
Referenced by extract_reestablish_key(), run_user_wrap(), run_wrap(), and test_software_key().
fsl_shw_return_t fsl_shw_sfree | ( | fsl_shw_uco_t * | user_ctx, | |
void * | address | |||
) |
Free a block of secure memory that was allocated with fsl_shw_smalloc
user_ctx | User context | |
address | Address of the block of secure memory to be released. |
References FSL_RETURN_ERROR_S, and FSL_RETURN_OK_S.
void* fsl_shw_smalloc | ( | fsl_shw_uco_t * | user_ctx, | |
uint32_t | size, | |||
const uint8_t * | UMID, | |||
uint32_t | permissions | |||
) |
Allocate a block of secure memory
user_ctx | User context | |
size | Memory size (octets). Note: currently only supports only single-partition sized blocks. | |
UMID | User Mode ID to use when registering the partition. | |
permissions | Permissions to initialize the partition with. Can be made by ORing flags from the fsl_shw_permission_t. |
References scc_configuration, and scc_get_configuration().
fsl_shw_return_t fsl_shw_symmetric_decrypt | ( | fsl_shw_uco_t * | user_ctx, | |
fsl_shw_sko_t * | key_info, | |||
fsl_shw_scco_t * | sym_ctx, | |||
uint32_t | length, | |||
const uint8_t * | ct, | |||
uint8_t * | pt | |||
) |
Decrypt a stream of data with a symmetric-key algorithm.
In ARC4, and also in FSL_SYM_MODE_CBC and FSL_SYM_MODE_CTR modes, the flags of the sym_ctx object will control part of the operation of this function. The FSL_SYM_CTX_INIT flag means that there is no context info in the object. The FSL_SYM_CTX_LOAD means to use information in the sym_ctx at the start of the operation, and the FSL_SYM_CTX_SAVE flag means to update the object's context information after the operation has been performed.
All of the data for an operation can be run through at once using the FSL_SYM_CTX_INIT or FSL_SYM_CTX_LOAD flags, as appropriate, and then using a length for the whole of the data.
If a FSL_SYM_CTX_SAVE flag were added, an additional call to the function would "pick up" where the previous call left off, allowing the user to perform the larger function in smaller steps.
In FSL_SYM_MODE_CBC and FSL_SYM_MODE_ECB modes, the length must always be a multiple of the block size for the algorithm being used. For proper operation in FSL_SYM_MODE_CTR mode, the length must be a multiple of the block size until the last operation on the total octet stream.
Some users of ARC4 may want to compute the context (S-Box and pointers) from the key before any data is available. This may be done by running this function with a length of zero, with the FSL_SYM_CTX_INIT & FSL_SYM_CTX_SAVE flags on in the sym_ctx. Subsequent operations would then run as normal with the load & save flags. Note that they key object is still required.
user_ctx | A user context from fsl_shw_register_user(). | |
key_info | The key and algorithm being used in this operation. | |
[in,out] | sym_ctx | Info on cipher mode, state of the cipher. |
length | Length, in octets, of the ct (and pt). | |
ct | pointer to ciphertext to be decrypted. | |
[out] | pt | pointer to where to store the resulting plaintext. |
Compute symmetric decryption
user_ctx | ||
key_info | ||
sym_ctx | ||
length | ||
pt | ||
ct |
References FSL_RETURN_ERROR_S.
Referenced by create_key(), extract_reestablish_key(), run_user_wrap(), and run_wrap().
fsl_shw_return_t fsl_shw_symmetric_encrypt | ( | fsl_shw_uco_t * | user_ctx, | |
fsl_shw_sko_t * | key_info, | |||
fsl_shw_scco_t * | sym_ctx, | |||
uint32_t | length, | |||
const uint8_t * | pt, | |||
uint8_t * | ct | |||
) |
Encrypt a stream of data with a symmetric-key algorithm.
In ARC4, and also in FSL_SYM_MODE_CBC and FSL_SYM_MODE_CTR modes, the flags of the sym_ctx object will control part of the operation of this function. The FSL_SYM_CTX_INIT flag means that there is no context info in the object. The FSL_SYM_CTX_LOAD means to use information in the sym_ctx at the start of the operation, and the FSL_SYM_CTX_SAVE flag means to update the object's context information after the operation has been performed.
All of the data for an operation can be run through at once using the FSL_SYM_CTX_INIT or FSL_SYM_CTX_LOAD flags, as appropriate, and then using a length for the whole of the data.
If a FSL_SYM_CTX_SAVE flag were added, an additional call to the function would "pick up" where the previous call left off, allowing the user to perform the larger function in smaller steps.
In FSL_SYM_MODE_CBC and FSL_SYM_MODE_ECB modes, the length must always be a multiple of the block size for the algorithm being used. For proper operation in FSL_SYM_MODE_CTR mode, the length must be a multiple of the block size until the last operation on the total octet stream.
Some users of ARC4 may want to compute the context (S-Box and pointers) from the key before any data is available. This may be done by running this function with a length of zero, with the init & save flags flags on in the sym_ctx. Subsequent operations would then run as normal with the load and save flags. Note that they key object is still required.
user_ctx | A user context from fsl_shw_register_user(). | |
key_info | Key and algorithm being used for this operation. | |
[in,out] | sym_ctx | Info on cipher mode, state of the cipher. |
length | Length, in octets, of the pt (and ct). | |
pt | pointer to plaintext to be encrypted. | |
[out] | ct | pointer to where to store the resulting ciphertext. |
Compute symmetric encryption
user_ctx | ||
key_info | ||
sym_ctx | ||
length | ||
pt | ||
ct |
References FSL_RETURN_ERROR_S.
Referenced by create_key(), run_user_wrap(), and run_wrap().
unsigned * actual [inherited] |
number of results obtained
Referenced by fsl_shw_get_results(), sah_get_results(), sah_get_results_from_pool(), and sah_get_results_pointers().
union { ... } auth_info [inherited] |
"auth" info struct
union { ... } auth_info [inherited] |
"auth" info struct
int black_ram_size_blocks [inherited] |
Number of blocks of Black RAM
int black_ram_size_blocks [inherited] |
Number of blocks of Black RAM
int block_size_bytes [inherited] |
Number of bytes per block of RAM; also block size of the crypto algorithm.
Referenced by OS_DEV_INIT().
void(* callback)(struct fsl_shw_uco_t *uco) [inherited] |
User's callback fn
Referenced by fsl_shw_get_random(), handle_sah_ioctl_dar(), init_uco(), sah_process_finished_request(), and sah_validate_uco().
fsl_shw_scco_t CCM_ctx_info [inherited] |
For running the CBC in AES-CCM.
fsl_shw_scco_t CCM_ctx_info [inherited] |
For running the CBC in AES-CCM.
fsl_shw_scco_t cipher_ctx_info [inherited] |
For running encrypt/decrypt.
Referenced by fsl_shw_auth_decrypt(), and fsl_shw_gen_encrypt().
uint8_t context_length [inherited] |
in bytes
Referenced by fsl_shw_hmac().
uint8_t context_register_length [inherited] |
in bytes
Referenced by fsl_shw_hmac(), and fsl_shw_hmac_precompute().
uint8_t * data [inherited] |
buffer to store data
Referenced by sah_Alloc_Link(), sah_Destroy_Links(), sah_Free_Chained_Links(), sah_Make_Links(), and sah_Physicalise_Links().
uint8_t digest_length [inherited] |
in bytes
uint32_t error_status [inherited] |
If error, register from Sahara
Referenced by sah_Handle_Interrupt(), and sah_process_finished_request().
uint32_t fault_address [inherited] |
If error, register from Sahara
Referenced by sah_get_results_from_pool(), sah_Handle_Interrupt(), and sah_process_finished_request().
uint32_t flags [inherited] |
from fsl_shw_user_ctx_flags_t
Referenced by fsl_shw_auth_decrypt(), fsl_shw_establish_key(), fsl_shw_extract_key(), fsl_shw_get_random(), fsl_shw_register_user(), init_uco(), process_hdr(), and sah_validate_uco().
sah_Link_Flags flags [inherited] |
indicates the component that created the data buffer. Security Function internal information
Referenced by sah_add_in_keyout_desc(), sah_Alloc_Link(), sah_Make_Links(), and sah_Physicalise_Links().
fsl_shw_hco_t hash_ctx_info [inherited] |
For running the hash
fsl_shw_hco_t hash_ctx_info [inherited] |
For running the hash
fsl_shw_hco_t hash_ctx_info [inherited] |
For running the hash
struct sah_Head_Desc * head [inherited] |
first entry in queue
Referenced by sah_Find_With_State(), sah_postprocess_queue(), sah_Queue_Append_Entry(), sah_Queue_Construct(), sah_Queue_Manager_Count_Entries(), sah_Queue_Manager_Reset_Entries(), sah_Queue_Remove_Any_Entry(), and sah_Queue_Remove_Entry().
uint32_t inner_precompute [inherited] |
largest digest + msg size
Referenced by fsl_shw_hmac(), and fsl_shw_hmac_precompute().
void * kernel_base [inherited] |
Base address (kernel virtual)
Referenced by fsl_shw_deregister_user(), and sah_handle_deregistration().
struct fsl_shw_kso_t * keystore [inherited] |
If present, key is in keystore
Referenced by fsl_shw_establish_key(), fsl_shw_extract_key(), fsl_shw_read_key(), and fsl_shw_release_key().
uint32_t len1 [inherited] |
number of data bytes in 'ptr1' buffer
Referenced by sah_Destroy_Descriptors(), sah_Free_Chained_Descriptors(), and sah_HW_Reset().
uint32_t len2 [inherited] |
number of data bytes in 'ptr2' buffer
Referenced by sah_Destroy_Descriptors(), sah_Free_Chained_Descriptors(), and sah_HW_Reset().
uint8_t mac_length [inherited] |
User's value for length
Referenced by fsl_shw_auth_decrypt(), and fsl_shw_gen_encrypt().
sah_Mem_Util * mem_util [inherited] |
Memory utility fns
Referenced by add_assoc_preamble(), process_assoc_from_nist_params(), sah_register(), and sah_validate_uco().
fsl_shw_acc_mode_t mode [inherited] |
CCM only
Referenced by fsl_shw_auth_decrypt(), and fsl_shw_gen_encrypt().
sah_Head_Desc *(* mu_alloc_head_desc)(void *ref) [inherited] |
Acquire a sah_Head_Desc
void(* mu_free)(void *ref, void *ptr) [inherited] |
Free buffer at ptr
void(* mu_free_head_desc)(void *ref, sah_Head_Desc *ptr) [inherited] |
Free sah_Head_Desc at ptr
void *(* mu_malloc)(void *ref, size_t n) [inherited] |
Acquire buffer of size n bytes
Referenced by add_assoc_preamble().
void *(* mu_memcpy)(void *ref, void *dest, const void *src, size_t n) [inherited] |
Funciton which will copy n bytes from src to dest
void *(* mu_memset)(void *ref, void *ptr, int ch, size_t n) [inherited] |
Set all n bytes of ptr to ch
struct fsl_shw_uco_t * next [inherited] |
To allow user-mode chaining of contexts, for signalling.
Referenced by SHW_ADD_USER(), and SHW_REMOVE_USER().
struct fsl_shw_spo_t * next [inherited] |
Pointer to the next partition owned by the user. NULL if this is the last partition.
struct sah_Link * next [inherited] |
pointer to the next sah_Link storing data
Referenced by sah_Alloc_Link(), sah_Copy_Links(), sah_DePhysicalise_Links(), sah_Destroy_Links(), sah_Free_Chained_Links(), sah_Make_Links(), and sah_Physicalise_Links().
struct sah_Head_Desc * next [inherited] |
Next in queue
Referenced by sah_Find_With_State(), sah_Physicalise_Descriptors(), sah_Queue_Append_Entry(), sah_Queue_Manager_Count_Entries(), sah_Queue_Manager_Reset_Entries(), and sah_Queue_Remove_Any_Entry().
struct sah_Desc * next [inherited] |
pointer to next descriptor
Referenced by sah_Alloc_Descriptor(), sah_Alloc_Head_Descriptor(), sah_Copy_Descriptors(), sah_Destroy_Descriptors(), sah_Free_Chained_Descriptors(), sah_HW_Reset(), and sah_Physicalise_Descriptors().
uint32_t ongoing_context [inherited] |
largest digest + msg size
Referenced by fsl_shw_hmac().
uint32_t op_status [inherited] |
If error, register from Sahara
Referenced by sah_Handle_Interrupt().
void * out1_ptr [inherited] |
For async post-processing
Referenced by sah_Copy_Descriptors().
void * out2_ptr [inherited] |
For async post-processing
uint32_t out_len [inherited] |
For async post-processing
uint32_t outer_precompute [inherited] |
largest digest + msg size
Referenced by fsl_shw_hmac(), and fsl_shw_hmac_precompute().
key_userid_t ownerid [inherited] |
Auth code for established key
Referenced by sah_Free_Chained_Links(), and sah_Make_Links().
int partition_count [inherited] |
Number of partitions on this platform
int partition_count [inherited] |
Number of partitions on this platform
int partition_count [inherited] |
Number of partitions on this platform
int partition_size_bytes [inherited] |
Number of bytes in each partition
int partition_size_bytes [inherited] |
Number of bytes in each partition
unsigned pool_size [inherited] |
maximum size of user pool
Referenced by fsl_shw_register_user(), and sah_validate_uco().
struct sah_Head_Desc * prev [inherited] |
previous in queue
Referenced by sah_Queue_Append_Entry(), and sah_Queue_Remove_Any_Entry().
void * ptr1 [inherited] |
pointer to first sah_Link structure
Referenced by sah_Alloc_Descriptor(), sah_Alloc_Head_Descriptor(), sah_Copy_Descriptors(), sah_Destroy_Descriptors(), sah_Free_Chained_Descriptors(), and sah_HW_Reset().
void * ptr2 [inherited] |
pointer to second sah_Link structure
Referenced by sah_Alloc_Descriptor(), sah_Alloc_Head_Descriptor(), sah_Copy_Descriptors(), sah_Destroy_Descriptors(), sah_Free_Chained_Descriptors(), and sah_HW_Reset().
unsigned q_length [inherited] |
NIST parameter -
int red_ram_size_blocks [inherited] |
Number of blocks of Red RAM
int red_ram_size_blocks [inherited] |
Number of blocks of Red RAM
int red_ram_size_blocks [inherited] |
Number of blocks of Red RAM
fsl_shw_return_t result [inherited] |
Result of running descriptor
Referenced by adaptor_Exec_Descriptor_Chain(), handle_sah_ioctl_dar(), sah_blocking_mode(), sah_get_results_from_pool(), and sah_process_finished_request().
fsl_shw_result_t * results [inherited] |
pointer to memory to hold results
Referenced by fsl_shw_get_results(), sah_get_results_from_pool(), and sah_get_results_pointers().
int scm_version [inherited] |
Version from SCM Configuration register
Referenced by OS_DEV_INIT().
uint32_t slot [inherited] |
Location of the the established key
Referenced by sah_Make_Links().
int smn_version [inherited] |
Version from SMN Status register
Referenced by OS_DEV_INIT().
uint32_t status [inherited] |
Status of queue entry
Referenced by sah_Find_With_State(), sah_Handle_Interrupt(), sah_postprocess_queue(), sah_process_finished_request(), sah_Queue_Manager_Append_Entry(), sah_Queue_Manager_Count_Entries(), sah_Queue_Manager_Prime(), and sah_Queue_Manager_Reset_Entries().
struct sah_Head_Desc * tail [inherited] |
last entry in queue
Referenced by sah_Queue_Append_Entry(), sah_Queue_Construct(), and sah_Queue_Remove_Any_Entry().
uint32_t uco_flags [inherited] |
at time of request
Referenced by adaptor_Exec_Descriptor_Chain(), handle_sah_ioctl_dar(), sah_Copy_Descriptors(), sah_DePhysicalise_Descriptors(), sah_Physicalise_Descriptors(), and sah_process_finished_request().
uint8_t unencrypted_mac [inherited] |
max block size...
Referenced by fsl_shw_auth_decrypt(), and fsl_shw_gen_encrypt().
struct sah_Head_Desc * user_desc [inherited] |
For API async get_results
Referenced by adaptor_Exec_Descriptor_Chain(), handle_sah_ioctl_dar(), and sah_get_results_pointers().
struct fsl_shw_uco_t * user_info [inherited] |
where result pool lives
Referenced by adaptor_Exec_Descriptor_Chain(), handle_sah_ioctl_dar(), and sah_process_finished_request().
uint32_t user_ref [inherited] |
User's reference
Referenced by fsl_shw_get_random(), and process_hdr().
uint32_t user_ref [inherited] |
at time of request
Referenced by sah_Copy_Descriptors(), and sah_get_results_from_pool().
© Freescale Semiconductor, Inc., 2007.
All rights reserved. Freescale Confidential Proprietary NDA Required |
![]() |