MCUX CLNS
MCUX Crypto Library Normal Secure
mcuxClCss_Ecc_Functions

Defines all functions of mcuxClCss_Ecc. More...

Functions

MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_EccKeyGen_Async (mcuxClCss_EccKeyGenOption_t options, mcuxClCss_KeyIndex_t signingKeyIdx, mcuxClCss_KeyIndex_t privateKeyIdx, mcuxClCss_KeyProp_t generatedKeyProperties, uint8_t const *pRandomData, uint8_t *pPublicKey)
 Generates an ECC key pair on the NIST P-256 curve. More...
 
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_EccKeyExchange_Async (mcuxClCss_KeyIndex_t privateKeyIdx, uint8_t const *pPublicKey, mcuxClCss_KeyIndex_t sharedSecretIdx, mcuxClCss_KeyProp_t sharedSecretProperties)
 Performs a Diffie-Hellman key exchange with an internal ECC private key and an external ECC public key. More...
 
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_EccSign_Async (mcuxClCss_EccSignOption_t options, mcuxClCss_KeyIndex_t keyIdx, uint8_t const *pInputHash, uint8_t const *pInputMessage, size_t inputMessageLength, uint8_t *pOutput)
 Generates an ECDSA signature of a given message. More...
 
MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_EccVerify_Async (mcuxClCss_EccVerifyOption_t options, uint8_t const *pInputHash, uint8_t const *pInputMessage, size_t inputMessageLength, uint8_t const *pSignatureAndPubKey, uint8_t *pOutput)
 Verifies an ECDSA signature of a given message. More...
 

Detailed Description

Defines all functions of mcuxClCss_Ecc.

Function Documentation

◆ mcuxClCss_EccKeyGen_Async()

MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_EccKeyGen_Async ( mcuxClCss_EccKeyGenOption_t  options,
mcuxClCss_KeyIndex_t  signingKeyIdx,
mcuxClCss_KeyIndex_t  privateKeyIdx,
mcuxClCss_KeyProp_t  generatedKeyProperties,
uint8_t const *  pRandomData,
uint8_t *  pPublicKey 
)

Generates an ECC key pair on the NIST P-256 curve.

Before execution, CSS will wait until mcuxClCss_HwState_t.drbgentlvl == MCUXCLCSS_STATUS_DRBGENTLVL_HIGH. This can lead to a delay if the DRBG is in a state with less security strength at the time of the call.

Call mcuxClCss_WaitForOperation to complete the operation. The public key will be stored in the standard ANSI X9.62 byte order (big-endian).

Parameters
[in]optionsThe command options. For more information, see mcuxClCss_EccKeyGenOption_t.
[in]signingKeyIdxThe index of the key to sign the generated public key.
[in]privateKeyIdxOutput key index.
[in]generatedKeyPropertiesThe desired key properties of the generated key.
[in]pRandomDataRandom data provided by the user.
[out]pPublicKeyPointer to the memory area which receives the public key and optionally the key signature.
Parameter properties
options.kgsign == MCUXCLCSS_ECC_PUBLICKEY_SIGN_DISABLE
signingKeyIdx is ignored.
options.kgsrc == MCUXCLCSS_ECC_OUTPUTKEY_DETERMINISTIC
privateKeyIdx also defines the key index of the source key material. The source key material will be overwritten by the output public key.
options.kgsign_rnd == MCUXCLCSS_ECC_NO_RANDOM_DATA
pRandomData is ignored.
pPublicKey must be aligned on a 4-byte boundary.
Returns
An error code that can be any error code in MCUXCLCSS_STATUS_, see individual documentation for more information
Return values
MCUXCLCSS_STATUS_SW_INVALID_PARAMif invalid parameters were specified
MCUXCLCSS_STATUS_SW_CANNOT_INTERRUPTif a running operation prevented the request
MCUXCLCSS_STATUS_OK_WAITon successful request
Examples
ecc_keygen_sign_verify.c, and tls_master_key_session_keys.c.

◆ mcuxClCss_EccKeyExchange_Async()

MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_EccKeyExchange_Async ( mcuxClCss_KeyIndex_t  privateKeyIdx,
uint8_t const *  pPublicKey,
mcuxClCss_KeyIndex_t  sharedSecretIdx,
mcuxClCss_KeyProp_t  sharedSecretProperties 
)

Performs a Diffie-Hellman key exchange with an internal ECC private key and an external ECC public key.

Before execution, CSS will wait until mcuxClCss_HwState_t.drbgentlvl == MCUXCLCSS_STATUS_DRBGENTLVL_LOW. This can lead to a delay if the DRBG is in a state with less security strength at the time of the call.

Call mcuxClCss_WaitForOperation to complete the operation. The public key must be stored in the standard ANSI X9.62 byte order (big-endian).

Parameters
[in]privateKeyIdxThe private key index.
[in]pPublicKeyPointer to the public key of a third party.
[in]sharedSecretIdxThe index in the CSSv2 keystore that receives the shared secret that is generated by the ECDH operation.
[in]sharedSecretPropertiesThe desired key properties of the shared secret.
Parameter properties
pPublicKey
The public key consists of the 256-bit X coordinate and the 256-bit Y coordinate. The point must lie on the NIST P-256 curve, be encoded in X9.62 format and aligned on a 4-byte boundary.
Returns
An error code that can be any error code in MCUXCLCSS_STATUS_, see individual documentation for more information
Return values
MCUXCLCSS_STATUS_SW_INVALID_PARAMif invalid parameters were specified
MCUXCLCSS_STATUS_SW_CANNOT_INTERRUPTif a running operation prevented the request
MCUXCLCSS_STATUS_OK_WAITon successful request
Examples
tls_master_key_session_keys.c.

◆ mcuxClCss_EccSign_Async()

MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_EccSign_Async ( mcuxClCss_EccSignOption_t  options,
mcuxClCss_KeyIndex_t  keyIdx,
uint8_t const *  pInputHash,
uint8_t const *  pInputMessage,
size_t  inputMessageLength,
uint8_t *  pOutput 
)

Generates an ECDSA signature of a given message.

The curve is NIST P-256. The message hash, must be stored in the standard ANSI X9.62 format. If the message is provided in plain, no prior conversion is necessary. The signature will be stored in the standard ANSI X9.62 byte order (big-endian).

Before execution, CSS will wait until mcuxClCss_HwState_t.drbgentlvl == MCUXCLCSS_STATUS_DRBGENTLVL_HIGH. This can lead to a delay if the DRBG is in a state with less security strength at the time of the call.

Call mcuxClCss_WaitForOperation to complete the operation.

Parameters
[in]optionsThe command options. For more information, see mcuxClCss_EccSignOption_t.
[in]keyIdxThe private key index.
[in]pInputHashThe hash of the message to sign in X9.62 format.
[in]pInputMessageThe message to sign.
[in]inputMessageLengthSize of pInputMessage in bytes.
[out]pOutputPointer to the memory area which receives the generated signature in X9.62 format. (64 bytes)
Parameter properties
options.echashchl == MCUXCLCSS_ECC_HASHED
pInputHash is used, and it must be aligned on a 4-byte boundary. pInputMessage is ignored.
options.echashchl == MCUXCLCSS_ECC_NOT_HASHED
pInputHash is ignored. pInputMessage and inputMessageLength are used.
pOptput must be aligned on a 4-byte boundary.
Returns
An error code that can be any error code in MCUXCLCSS_STATUS_, see individual documentation for more information
Return values
MCUXCLCSS_STATUS_SW_INVALID_PARAMif invalid parameters were specified
MCUXCLCSS_STATUS_SW_CANNOT_INTERRUPTif a running operation prevented the request
MCUXCLCSS_STATUS_OK_WAITon successful request
Examples
ecc_keygen_sign_verify.c.

◆ mcuxClCss_EccVerify_Async()

MCUXCLCSS_API mcuxClCss_Status_Protected_t mcuxClCss_EccVerify_Async ( mcuxClCss_EccVerifyOption_t  options,
uint8_t const *  pInputHash,
uint8_t const *  pInputMessage,
size_t  inputMessageLength,
uint8_t const *  pSignatureAndPubKey,
uint8_t *  pOutput 
)

Verifies an ECDSA signature of a given message.

The curve is NIST P-256. The message hash, must be stored in the standard ANSI X9.62 format. If the message is provided in plain, no prior conversion is necessary. The signature and public key must be stored in the standard ANSI X9.62 byte order (big-endian).

Before execution, CSS will wait until mcuxClCss_HwState_t.drbgentlvl == MCUXCLCSS_STATUS_DRBGENTLVL_LOW. This can lead to a delay if the DRBG is in a state with less security strength at the time of the call.

Call mcuxClCss_WaitForOperation to complete the operation.

Parameters
[in]optionsThe command options. For more information, see mcuxClCss_EccVerifyOption_t.
[in]pInputHashThe hash of the signed message in X9.62 format.
[in]pInputMessageThe message to sign.
[in]inputMessageLengthSize of pInputMessage in bytes.
[in]pSignatureAndPubKeyPointer to the memory area which contains the concatenation of the signature and the public key.
[out]pOutputPointer to the memory area which will receive the recalculated value of the R component in case of a successful signature verification.
Parameter properties
options.echashchl == MCUXCLCSS_ECC_HASHED
pInputHash is used, and it must be aligned on a 4-byte boundary. pInputMessage is ignored.
options.echashchl == MCUXCLCSS_ECC_NOT_HASHED
pInputHash is ignored. pInputMessage and inputMessageLength are used.
pSignatureAndPubKey
It must be aligned on a 4-byte boundary. The signature to be verified consists of the 256-bit R component and the 256-bit S component. The public key is the one for verification. (Uncompressed, X and Y components) The signature and the public key are in X9.62 format.
pOutput
It must be aligned on a 4-byte boundary. The output shall be compared to the first 32 bytes stored at pSignatureAndPublicKey.
Returns
An error code that can be any error code in MCUXCLCSS_STATUS_, see individual documentation for more information
Return values
MCUXCLCSS_STATUS_SW_INVALID_PARAMif invalid parameters were specified
MCUXCLCSS_STATUS_SW_CANNOT_INTERRUPTif a running operation prevented the request
MCUXCLCSS_STATUS_OK_WAITon successful request
Examples
ecc_keygen_sign_verify.c.