mcuxClEcc_Types.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------*/
/* Copyright 2020-2025 NXP                                                  */
/*                                                                          */
/* NXP Confidential and Proprietary. This software is owned or controlled   */
/* by NXP and may only be used strictly in accordance with the applicable   */
/* license terms.  By expressly accepting such terms or by downloading,     */
/* installing, activating and/or otherwise using the software, you are      */
/* agreeing that you have read, and that you agree to comply with and are   */
/* bound by, such license terms.  If you do not agree to be bound by the    */
/* applicable license terms, then you may not retain, install, activate or  */
/* otherwise use the software.                                              */
/*--------------------------------------------------------------------------*/

 
 
#ifndef MCUXCLECC_TYPES_H_
#define MCUXCLECC_TYPES_H_
 
 
#include <mcuxClCore_Platform.h>
#include <mcuxCsslFlowProtection.h>
#include <mcuxClEcc_Constants.h>
#include <mcuxCsslAnalysis.h>
#include <mcuxClBuffer.h>
 
#include <mcuxClSignature_Types.h>
 
#ifdef __cplusplus
extern "C" {
#endif


typedef uint32_t mcuxClEcc_Status_t;

typedef MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClEcc_Status_t) mcuxClEcc_Status_Protected_t;
 

typedef struct mcuxClEcc_MontDH_DomainParams mcuxClEcc_MontDH_DomainParams_t;
 

typedef struct mcuxClEcc_EdDSA_DomainParams mcuxClEcc_EdDSA_DomainParams_t;

struct mcuxClEcc_EdDSA_GenerateKeyPairDescriptor;

typedef struct mcuxClEcc_EdDSA_GenerateKeyPairDescriptor mcuxClEcc_EdDSA_GenerateKeyPairDescriptor_t;

struct mcuxClEcc_EdDSA_SignatureProtocolDescriptor;

typedef struct mcuxClEcc_EdDSA_SignatureProtocolDescriptor mcuxClEcc_EdDSA_SignatureProtocolDescriptor_t;
 

typedef struct mcuxClEcc_Weier_DomainParams mcuxClEcc_Weier_DomainParams_t;

struct mcuxClEcc_WeierECC_PointEncDescriptor;

typedef struct mcuxClEcc_WeierECC_PointEncDescriptor mcuxClEcc_WeierECC_PointEncDescriptor_t;

typedef const mcuxClEcc_WeierECC_PointEncDescriptor_t * mcuxClEcc_WeierECC_PointEncType_t;

struct mcuxClEcc_ECDSA_SignatureProtocolDescriptor;

typedef struct mcuxClEcc_ECDSA_SignatureProtocolDescriptor  mcuxClEcc_ECDSA_SignatureProtocolDescriptor_t;
 
/**********************************************************/
/* Parameter structure of mcuxClEcc APIs                   */
/**********************************************************/
 

typedef struct {
    mcuxCl_InputBuffer_t pP;
    uint32_t pLen;
    mcuxCl_InputBuffer_t pA;
    mcuxCl_InputBuffer_t pB;
    mcuxCl_InputBuffer_t pG;
    mcuxCl_InputBuffer_t pN;
    uint32_t nLen;
} mcuxClEcc_Weier_BasicDomainParams_t;
 
 /* mcuxClEcc_Types */
 
 
/**********************************************************/
/* Descriptors of mcuxClEcc APIs                           */
/**********************************************************/
 

 
/**********************************************************/
/* Signature ProtocolDescriptors and ModeDescriptors      */
/**********************************************************/

extern const mcuxClSignature_ModeDescriptor_t mcuxClSignature_ModeDescriptor_Ed25519;
 
MCUX_CSSL_ANALYSIS_START_PATTERN_URL_IN_COMMENTS()
MCUX_CSSL_ANALYSIS_STOP_PATTERN_URL_IN_COMMENTS()
MCUX_CSSL_ANALYSIS_START_SUPPRESS_DECLARED_BUT_NEVER_REFERENCED("Consumed by mcuxClSignature component. Hence, it is declared but never referenced.")
static mcuxClSignature_Mode_t mcuxClSignature_Mode_Ed25519 =
  &mcuxClSignature_ModeDescriptor_Ed25519;
MCUX_CSSL_ANALYSIS_STOP_SUPPRESS_DECLARED_BUT_NEVER_REFERENCED()
 
  /* mcuxClEcc_EdDsaDescriptors */
 
 

 

extern const mcuxClSignature_ModeDescriptor_t mcuxClSignature_ModeDescriptor_ECDSA;

MCUX_CSSL_ANALYSIS_START_SUPPRESS_DECLARED_BUT_NEVER_REFERENCED("Consumed by mcuxClSignature component. Hence, it is declared but never referenced.")
static mcuxClSignature_Mode_t mcuxClSignature_Mode_ECDSA =
  &mcuxClSignature_ModeDescriptor_ECDSA;
MCUX_CSSL_ANALYSIS_STOP_SUPPRESS_DECLARED_BUT_NEVER_REFERENCED()
  /* mcuxClEcc_ECDSADescriptors */
 /* mcuxClEcc_Descriptors */


extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_secp160k1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_secp192k1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_secp224k1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_secp256k1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_secp192r1;
#define mcuxClEcc_Weier_DomainParams_NIST_P192 mcuxClEcc_Weier_DomainParams_secp192r1
#define mcuxClEcc_Weier_DomainParams_ansix9p192r1 mcuxClEcc_Weier_DomainParams_secp192r1

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_secp224r1;
#define mcuxClEcc_Weier_DomainParams_NIST_P224 mcuxClEcc_Weier_DomainParams_secp224r1
#define mcuxClEcc_Weier_DomainParams_ansix9p224r1 mcuxClEcc_Weier_DomainParams_secp224r1

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_secp256r1;
#define mcuxClEcc_Weier_DomainParams_NIST_P256 mcuxClEcc_Weier_DomainParams_secp256r1
#define mcuxClEcc_Weier_DomainParams_ansix9p256r1 mcuxClEcc_Weier_DomainParams_secp256r1

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_secp384r1;
#define mcuxClEcc_Weier_DomainParams_NIST_P384 mcuxClEcc_Weier_DomainParams_secp384r1
#define mcuxClEcc_Weier_DomainParams_ansix9p384r1 mcuxClEcc_Weier_DomainParams_secp384r1

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_secp521r1;
#define mcuxClEcc_Weier_DomainParams_NIST_P521 mcuxClEcc_Weier_DomainParams_secp521r1
#define mcuxClEcc_Weier_DomainParams_ansix9p521r1 mcuxClEcc_Weier_DomainParams_secp521r1

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_brainpoolP160r1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_brainpoolP192r1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_brainpoolP224r1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_brainpoolP256r1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_brainpoolP320r1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_brainpoolP384r1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_brainpoolP512r1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_brainpoolP160t1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_brainpoolP192t1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_brainpoolP224t1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_brainpoolP256t1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_brainpoolP320t1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_brainpoolP384t1;

extern const mcuxClEcc_Weier_DomainParams_t mcuxClEcc_Weier_DomainParams_brainpoolP512t1;
 
 
/* Ed25519 domain parameters */
extern const mcuxClEcc_EdDSA_DomainParams_t mcuxClEcc_EdDSA_DomainParams_Ed25519;
 /* mcuxClEcc_DomainParamsDescriptor */

 
 
/*********************************************************/
/* Encoding types related to point encoding specified in */
/* SEC 1: Elliptic Curve Cryptography                    */
/*********************************************************/

extern const mcuxClEcc_WeierECC_PointEncDescriptor_t mcuxClEcc_WeierECC_PointEncDescriptor_SEC;

MCUX_CSSL_ANALYSIS_START_SUPPRESS_DECLARED_BUT_NEVER_REFERENCED("Consumed by user / customer. Hence, it is declared but never referenced.")
static const mcuxClEcc_WeierECC_PointEncType_t mcuxClEcc_WeierECC_PointEncType_SEC = &mcuxClEcc_WeierECC_PointEncDescriptor_SEC;
MCUX_CSSL_ANALYSIS_STOP_SUPPRESS_DECLARED_BUT_NEVER_REFERENCED()
 /* mcuxClEcc_WeierECC_PointEncDescriptors */
 

 
 
 
 
 
 
 
 /* mcuxClEcc_ArithmeticOperation */
 
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* MCUXCLECC_TYPES_H_ */