Defines all functions of mcuxClEcc. More...
Functions | |
mcuxClEcc_Status_t | mcuxClEcc_KeyGen (mcuxClSession_Handle_t pSession, const mcuxClEcc_KeyGen_Param_t *pParam) |
implements ECDSA key generation. | |
mcuxClEcc_Status_t | mcuxClEcc_Sign (mcuxClSession_Handle_t pSession, const mcuxClEcc_Sign_Param_t *pParam) |
implements ECDSA signature generation. | |
mcuxClEcc_Status_t | mcuxClEcc_Verify (mcuxClSession_Handle_t pSession, const mcuxClEcc_Verify_Param_t *pParam) |
implements ECDSA signature verification. | |
mcuxClEcc_Status_t | mcuxClEcc_PointMult (mcuxClSession_Handle_t pSession, const mcuxClEcc_PointMult_Param_t *pParam) |
implements ECC point multiplication. | |
mcuxClEcc_Status_t | mcuxClEcc_MontDH_GenerateKeyPair (mcuxClSession_Handle_t pSession, mcuxClKey_Handle_t privKey, mcuxClKey_Handle_t pubKey) |
implements ECC key pair generation step for a MontDH key agreement according to rfc7748. | |
mcuxClEcc_Status_t | mcuxClEcc_MontDH_KeyAgreement (mcuxClSession_Handle_t pSession, mcuxClKey_Handle_t key, mcuxClKey_Handle_t otherKey, uint8_t *pOut, uint32_t *const pOutLength) |
Implements the MontDH key agreement according to rfc7748. | |
mcuxClEcc_Status_t | mcuxClEcc_EdDSA_GenerateKeyPair (mcuxClSession_Handle_t pSession, const mcuxClEcc_EdDSA_GenerateKeyPairDescriptor_t *mode, mcuxClKey_Handle_t privKey, mcuxClKey_Handle_t pubKey) |
This function implements the EdDSA key pair generation for Ed25519 and Ed448 as specified in rfc8032 (see Sections 5.1.5 and 5.2.5 of https://datatracker.ietf.org/doc/html/rfc8032). | |
mcuxClEcc_Status_t | mcuxClEcc_EdDSA_GenerateSignature (mcuxClSession_Handle_t pSession, mcuxClKey_Handle_t key, const mcuxClEcc_EdDSA_SignatureProtocolDescriptor_t *mode, mcuxCl_InputBuffer_t pIn, uint32_t inSize, mcuxCl_Buffer_t pSignature, uint32_t *const pSignatureSize) |
This function implements the EdDSA signature generation for Ed25519 and Ed448 as specified in rfc8032 (see Sections 5.1.6 and 5.2.6 of https://datatracker.ietf.org/doc/html/rfc8032). | |
mcuxClEcc_Status_t | mcuxClEcc_EdDSA_VerifySignature (mcuxClSession_Handle_t session, mcuxClKey_Handle_t key, const mcuxClEcc_EdDSA_SignatureProtocolDescriptor_t *mode, mcuxCl_InputBuffer_t pIn, uint32_t inSize, mcuxCl_InputBuffer_t pSignature, uint32_t signatureSize) |
This function implements the EdDSA signature verification for Ed25519 and Ed448 as specified in rfc8032 (see Sections 5.1.7 and 5.2.7 of https://datatracker.ietf.org/doc/html/rfc8032). | |
mcuxClEcc_Status_t | mcuxClEcc_EdDSA_InitPrivKeyInputMode (mcuxClSession_Handle_t pSession, mcuxClEcc_EdDSA_GenerateKeyPairDescriptor_t *mode, const uint8_t *pPrivKey) |
This function initializes an EdDSA mode descriptor for EdDSA key pair generation with private key input. | |
mcuxClEcc_Status_t | mcuxClEcc_EdDSA_GenerateProtocolDescriptor (mcuxClSession_Handle_t pSession, const mcuxClEcc_EdDSA_DomainParams_t *pDomainParams, mcuxClEcc_EdDSA_SignatureProtocolDescriptor_t *pProtocolDescriptor, uint32_t phflag, mcuxCl_InputBuffer_t pContext, uint32_t contextLen) |
This function implements the protocol descriptor generation for Ed25519ctx, Ed25519ph, Ed448 and Ed448ph. | |
Defines all functions of mcuxClEcc.
mcuxClEcc_Status_t mcuxClEcc_KeyGen | ( | mcuxClSession_Handle_t | pSession, |
const mcuxClEcc_KeyGen_Param_t * | pParam | ||
) |
implements ECDSA key generation.
MCUXCLECC_STATUS_OK | if private key and public key are generated successfully; |
MCUXCLECC_STATUS_INVALID_PARAMS | if parameters are invalid; |
MCUXCLECC_STATUS_RNG_ERROR | if random number (DRBG / PRNG) error (unexpected behavior); |
MCUXCLECC_STATUS_FAULT_ATTACK | if fault attack (unexpected behavior) is detected. |
[in] | pSession | Handle for the current CL session. |
[in] | pParam | pointer to ECDSA Key Generation parameter structure. |
mcuxClEcc_Status_t mcuxClEcc_Sign | ( | mcuxClSession_Handle_t | pSession, |
const mcuxClEcc_Sign_Param_t * | pParam | ||
) |
implements ECDSA signature generation.
MCUXCLECC_STATUS_OK | if signature is generated successfully; |
MCUXCLECC_STATUS_INVALID_PARAMS | if parameters are invalid; |
MCUXCLECC_STATUS_RNG_ERROR | if random number (DRBG / PRNG) error (unexpected behavior); |
MCUXCLECC_STATUS_FAULT_ATTACK | if fault attack (unexpected behavior) is detected. |
[in] | pSession | Handle for the current CL session. |
[in] | pParam | pointer to ECDSA Sign parameter structure. |
mcuxClEcc_Status_t mcuxClEcc_Verify | ( | mcuxClSession_Handle_t | pSession, |
const mcuxClEcc_Verify_Param_t * | pParam | ||
) |
implements ECDSA signature verification.
MCUXCLECC_STATUS_OK | if ECDSA Signature is valid; |
MCUXCLECC_STATUS_INVALID_SIGNATURE | if ECDSA Signature is invalid; |
MCUXCLECC_STATUS_INVALID_PARAMS | if parameters are invalid; |
MCUXCLECC_STATUS_FAULT_ATTACK | if fault attack (unexpected behavior) is detected. |
[in] | pSession | Handle for the current CL session. |
[in] | pParam | pointer to ECDSA Verify parameter structure. |
mcuxClEcc_Status_t mcuxClEcc_PointMult | ( | mcuxClSession_Handle_t | pSession, |
const mcuxClEcc_PointMult_Param_t * | pParam | ||
) |
implements ECC point multiplication.
This API performs elliptic curve point multiplication on the given elliptic curve in short Weierstrass form. This API does not check if the curve parameters and the given point are valid or not. Invalid curve parameters or point might cause the return of MCUXCLECC_STATUS_INVALID_PARAMS, invalid result, and unexpected behavior (e.g., the return of MCUXCLECC_STATUS_FAULT_ATTACK).
[in] | pSession | Handle for the current CL session. |
[in] | pParam | pointer to ECC point multiplication parameter structure. |
MCUXCLECC_STATUS_OK | if point multiplication is calculated successfully, and the result is not the neutral point; |
MCUXCLECC_STATUS_INVALID_PARAMS | if parameters are invalid; |
MCUXCLECC_STATUS_NEUTRAL_POINT | if result is the neutral point; |
MCUXCLECC_STATUS_FAULT_ATTACK | if fault attack (unexpected behavior) is detected. |
mcuxClEcc_Status_t mcuxClEcc_MontDH_GenerateKeyPair | ( | mcuxClSession_Handle_t | pSession, |
mcuxClKey_Handle_t | privKey, | ||
mcuxClKey_Handle_t | pubKey | ||
) |
implements ECC key pair generation step for a MontDH key agreement according to rfc7748.
This function performs elliptic curve key generation of the private key and calculates corresponding public key for MontDH key agreement as specified in rfc7748. This API does not check if the curve parameters are correct. This API might return MCUXCLECC_STATUS_RNG_ERROR when RNG behave in unexpected way Unexpected behavior will return MCUXCLECC_STATUS_FAULT_ATTACK.
[in] | pSession | mcuxClSession_Descriptor structure |
[out] | privKey | private key handling structure |
[out] | pubKey | public key handling structure |
MCUXCLECC_STATUS_OK | if key generation correctly calculate private and public keys, public key does not belong to the small subgroup. |
MCUXCLECC_STATUS_RNG_ERROR | if RNG return an error. |
MCUXCLECC_STATUS_FAULT_ATTACK | if fault attack (unexpected behavior) is detected. |
mcuxClEcc_Status_t mcuxClEcc_MontDH_KeyAgreement | ( | mcuxClSession_Handle_t | pSession, |
mcuxClKey_Handle_t | key, | ||
mcuxClKey_Handle_t | otherKey, | ||
uint8_t * | pOut, | ||
uint32_t *const | pOutLength | ||
) |
Implements the MontDH key agreement according to rfc7748.
This function performs a MontDH key agreement to compute a shared secret between two parties using according to Curve25519 or Curve448 as specified in rfc7748. This API does not check if the curve parameters are correct. This API might return MCUXCLECC_STATUS_RNG_ERROR when RNG behave in unexpected way This API might return MCUXCLECC_STATUS_ERROR_SMALL_SUBGROUP if generated public key lies in the small subgroup Unexpected behavior will return MCUXCLECC_STATUS_FAULT_ATTACK.
[in] | pSession | Handle for the current CL session. |
[in] | key | private key handling structure |
[in] | otherKey | public key handling structure |
[out] | pOut | buffer for shared secret of length MCUXCLECC_MONTDH_CURVE25519/448_SIZE_SHAREDSECRET |
[out] | pOutLength | shared secret length |
MCUXCLECC_STATUS_OK | if key generation correctly calculate private and public keys, public key does not belong to the small subgroup. |
MCUXCLECC_STATUS_RNG_ERROR | if RNG return an error. |
MCUXCLECC_STATUS_ERROR_SMALL_SUBGROUP | if calculated public key lies in small subgroup. |
MCUXCLECC_STATUS_FAULT_ATTACK | if fault attack (unexpected behavior) is detected. |
mcuxClEcc_Status_t mcuxClEcc_EdDSA_GenerateKeyPair | ( | mcuxClSession_Handle_t | pSession, |
const mcuxClEcc_EdDSA_GenerateKeyPairDescriptor_t * | mode, | ||
mcuxClKey_Handle_t | privKey, | ||
mcuxClKey_Handle_t | pubKey | ||
) |
This function implements the EdDSA key pair generation for Ed25519 and Ed448 as specified in rfc8032 (see Sections 5.1.5 and 5.2.5 of https://datatracker.ietf.org/doc/html/rfc8032).
For an M byte private key d, which is either generated internally at random or passed as input, this function calculates the private key hash H(d)=(h0,...,h{2b-1}) and deduces and returns
This API does not check if the curve parameters are correct. This API might return MCUXCLECC_STATUS_RNG_ERROR when RNG behave in unexpected way Unexpected behavior will return MCUXCLECC_STATUS_FAULT_ATTACK.
[in] | pSession | Handle for the current CL session |
[in] | mode | Mode descriptor specifying the EdDSA GenerateKeyPair variant |
[in/out] | privKey Key handle for the private key. | |
[in/out] | pubKey Key handle for the public key. |
MCUXCLECC_STATUS_OK | private key data and public key have been generated successfully |
MCUXCLECC_STATUS_RNG_ERROR | random number generation (DRBG / PRNG) error (unexpected behavior) |
MCUXCLECC_STATUS_FAULT_ATTACK | fault attack (unexpected behavior) is detected |
mcuxClEcc_Status_t mcuxClEcc_EdDSA_GenerateSignature | ( | mcuxClSession_Handle_t | pSession, |
mcuxClKey_Handle_t | key, | ||
const mcuxClEcc_EdDSA_SignatureProtocolDescriptor_t * | mode, | ||
mcuxCl_InputBuffer_t | pIn, | ||
uint32_t | inSize, | ||
mcuxCl_Buffer_t | pSignature, | ||
uint32_t *const | pSignatureSize | ||
) |
This function implements the EdDSA signature generation for Ed25519 and Ed448 as specified in rfc8032 (see Sections 5.1.6 and 5.2.6 of https://datatracker.ietf.org/doc/html/rfc8032).
For given hash prefix prefix (either dom2(x, y) or dom4(x, y) according to the chosen EdDSA variant; see Sections 5.1 and 5.2 of https://datatracker.ietf.org/doc/html/rfc8032), a message digest m', i.e. either the message itself for PureEdDSA or the message hash for HashEdDSA (see Section 4 of https://datatracker.ietf.org/doc/html/rfc8032), the signing keys s and (hb,...,h{2b-1}) derived from the private key d (see mcuxClEcc_EdDSA_GenerateKeyPair) and a public key Qenc, this function calculates an EdDSA signature (Renc,S), where Renc and S are given by
- Renc = (r*G)enc - S = r+H(prefix||Renc||Qenc||m')*s mod n
where the secret scalar r is given by r=H(prefix||(hb,...,h{2b-1})||m') and G is the base point.
This API does not check if the curve parameters are correct. This API might return MCUXCLECC_STATUS_RNG_ERROR when RNG behave in unexpected way Unexpected behavior will return MCUXCLECC_STATUS_FAULT_ATTACK.
[in] | pSession | Handle for the current CL session |
[in] | key | Key handle for private key related data which a.o. references the secret signing keys s and (hb,...,h{2b-1}) as well as the public key Qenc. |
[in] | mode | Mode descriptor specifying the EdDSA variant |
[in] | pIn | Buffer for message digest m' |
[in] | inSize | Size of message digest m' |
[out] | pSignature | Buffer for where the signature (Renc,S) will be stored |
[out] | pSignatureSize | Will be set to the number of bytes of data that have been written to the pSignature buffer |
MCUXCLECC_STATUS_OK | signature generation was successful |
MCUXCLECC_STATUS_RNG_ERROR | random number generation (DRBG / PRNG) error (unexpected behavior) |
MCUXCLECC_STATUS_FAULT_ATTACK | fault attack (unexpected behavior) is detected |
mcuxClEcc_Status_t mcuxClEcc_EdDSA_VerifySignature | ( | mcuxClSession_Handle_t | session, |
mcuxClKey_Handle_t | key, | ||
const mcuxClEcc_EdDSA_SignatureProtocolDescriptor_t * | mode, | ||
mcuxCl_InputBuffer_t | pIn, | ||
uint32_t | inSize, | ||
mcuxCl_InputBuffer_t | pSignature, | ||
uint32_t | signatureSize | ||
) |
This function implements the EdDSA signature verification for Ed25519 and Ed448 as specified in rfc8032 (see Sections 5.1.7 and 5.2.7 of https://datatracker.ietf.org/doc/html/rfc8032).
For given hash prefix prefix (either dom2(x, y) or dom4(x, y) according to the chosen EdDSA variant; see Sections 5.1 and 5.2 of https://datatracker.ietf.org/doc/html/rfc8032), a message digest m', i.e. either the message itself for PureEdDSA or the message hash for HashEdDSA (see Section 4 of https://datatracker.ietf.org/doc/html/rfc8032), and a public key Qenc, this function:
This API does not check if the curve parameters are correct. This API might return MCUXCLECC_STATUS_RNG_ERROR when RNG behave in unexpected way Unexpected behavior will return MCUXCLECC_STATUS_FAULT_ATTACK.
[in] | session | Handle for the current CL session |
[in] | key | Key handle for public key Qenc |
[in] | mode | Mode descriptor specifying the EdDSA variant |
[in] | pIn | Buffer for message digest m' |
[in] | inSize | Size of message digest m' |
[in] | pSignature | Buffer for signature (Renc,S) |
[in] | signatureSize | Number of bytes of data in the pSignature buffer |
MCUXCLECC_STATUS_OK | signature verification passed |
MCUXCLECC_STATUS_INVALID_SIGNATURE | EdDSA signature is invalid |
MCUXCLECC_STATUS_INVALID_PARAMS | input parameters are invalid |
MCUXCLECC_STATUS_FAULT_ATTACK | fault attack (unexpected behavior) is detected |
mcuxClEcc_Status_t mcuxClEcc_EdDSA_InitPrivKeyInputMode | ( | mcuxClSession_Handle_t | pSession, |
mcuxClEcc_EdDSA_GenerateKeyPairDescriptor_t * | mode, | ||
const uint8_t * | pPrivKey | ||
) |
This function initializes an EdDSA mode descriptor for EdDSA key pair generation with private key input.
[in] | pSession | Handle for the current CL session |
[in/out] | mode Pointer to mode descriptor to be initialized for EdDSA key pair generation with private key input | |
[in] | pPrivKey | Pointer to private key input |
MCUXCLECC_STATUS_OK | EdDSA mode descriptor has been initialized successfully |
MCUXCLECC_STATUS_FAULT_ATTACK | fault attack (unexpected behavior) is detected |
mcuxClEcc_Status_t mcuxClEcc_EdDSA_GenerateProtocolDescriptor | ( | mcuxClSession_Handle_t | pSession, |
const mcuxClEcc_EdDSA_DomainParams_t * | pDomainParams, | ||
mcuxClEcc_EdDSA_SignatureProtocolDescriptor_t * | pProtocolDescriptor, | ||
uint32_t | phflag, | ||
mcuxCl_InputBuffer_t | pContext, | ||
uint32_t | contextLen | ||
) |
This function implements the protocol descriptor generation for Ed25519ctx, Ed25519ph, Ed448 and Ed448ph.
[in] | pSession | Handle for the current CL session |
[in] | pDomainParams | Pointer to domain parameters of the used curve |
[in] | pProtocolDescriptor | Protocol descriptor specifying the EdDSA variant |
[in] | phflag | Option whether pre-hashing is enabled |
[in] | pContext | User input context for the hash prefix |
[in] | contextLen | Length of the context |
MCUXCLECC_STATUS_OK | EdDSA protocol descriptor generated successfully |
MCUXCLECC_STATUS_FAULT_ATTACK | fault attack (unexpected behavior) is detected |