mcuxClKey_Types.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------*/
/* Copyright 2020-2024, 2026 NXP                                            */
/*                                                                          */
/* SPDX-License-Identifier: BSD-3-Clause                                    */
/*                                                                          */
/* Redistribution and use in source and binary forms, with or without       */
/* modification, are permitted provided that the following conditions are   */
/* met:                                                                     */
/*                                                                          */
/* 1. Redistributions of source code must retain the above copyright        */
/*    notice, this list of conditions and the following disclaimer.         */
/*                                                                          */
/* 2. Redistributions in binary form must reproduce the above copyright     */
/*    notice, this list of conditions and the following disclaimer in the   */
/*    documentation and/or other materials provided with the distribution.  */
/*                                                                          */
/* 3. Neither the name of the copyright holder nor the names of its         */
/*    contributors may be used to endorse or promote products derived from  */
/*    this software without specific prior written permission.              */
/*                                                                          */
/* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS  */
/* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED    */
/* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A          */
/* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT       */
/* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,   */
/* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED */
/* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR   */
/* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF   */
/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING     */
/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS       */
/* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.             */
/*--------------------------------------------------------------------------*/

 
#ifndef MCUXCLKEY_TYPES_H_
#define MCUXCLKEY_TYPES_H_
 
#include <mcuxClCore_Platform.h>
#include <mcuxCsslAnalysis.h>
#include <mcuxCsslFlowProtection.h>
#include <mcuxClCore_FunctionIdentifiers.h>
#include <mcuxClBuffer.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**********************************************
 * TYPEDEFS
 **********************************************/

typedef uint32_t mcuxClKey_Status_t;

typedef uint32_t mcuxClKey_AlgorithmId_t;

typedef uint32_t mcuxClKey_Size_t;

typedef uint32_t mcuxClKey_Encoding_Spec_t;

typedef MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClKey_Status_t) mcuxClKey_Status_Encoded_t;
 
/* Forward declaration */
struct mcuxClKey_Encoding;

struct mcuxClKey_Descriptor;

typedef struct mcuxClKey_Descriptor mcuxClKey_Descriptor_t;

typedef mcuxClKey_Descriptor_t * const mcuxClKey_Handle_t;

struct mcuxClKey_TypeDescriptor;

typedef struct mcuxClKey_TypeDescriptor mcuxClKey_TypeDescriptor_t;

typedef const mcuxClKey_TypeDescriptor_t * mcuxClKey_Type_t;

typedef mcuxClKey_TypeDescriptor_t * mcuxClKey_CustomType_t;

struct mcuxClKey_EncodingDescriptor;

typedef struct mcuxClKey_EncodingDescriptor mcuxClKey_EncodingDescriptor_t;

typedef const mcuxClKey_EncodingDescriptor_t * mcuxClKey_Encoding_t;

struct mcuxClKey_Agreement_AdditionalInput{
  mcuxCl_InputBuffer_t input;
  uint32_t size;
};
 
typedef struct mcuxClKey_Agreement_AdditionalInput mcuxClKey_Agreement_AdditionalInput_t;

struct mcuxClKey_AgreementDescriptor;

typedef struct mcuxClKey_AgreementDescriptor mcuxClKey_AgreementDescriptor_t;

typedef const mcuxClKey_AgreementDescriptor_t * const mcuxClKey_Agreement_t;
 
 
#ifdef MCUXCL_FEATURE_KEY_SELFTEST

struct mcuxClKey_TestDescriptor;

typedef struct mcuxClKey_TestDescriptor mcuxClKey_TestDescriptor_t;

typedef const mcuxClKey_TestDescriptor_t * const mcuxClKey_Test_t;
#endif /* MCUXCL_FEATURE_KEY_SELFTEST */
struct mcuxClKey_GenerationDescriptor;

typedef struct mcuxClKey_GenerationDescriptor mcuxClKey_GenerationDescriptor_t;

typedef const mcuxClKey_GenerationDescriptor_t * const mcuxClKey_Generation_t;
 
#ifdef MCUXCL_FEATURE_KEY_DERIVATION
struct mcuxClKey_DerivationAlgorithmDescriptor;

typedef struct mcuxClKey_DerivationAlgorithmDescriptor mcuxClKey_DerivationAlgorithmDescriptor_t;

typedef const mcuxClKey_DerivationAlgorithmDescriptor_t * const mcuxClKey_DerivationAlgorithm_t;

struct mcuxClKey_DerivationInput {
  mcuxCl_InputBuffer_t input;
  uint32_t size;
};

typedef struct mcuxClKey_DerivationInput mcuxClKey_DerivationInput_t;

struct mcuxClKey_DerivationMode;

typedef struct mcuxClKey_DerivationMode mcuxClKey_DerivationMode_t;

typedef const mcuxClKey_DerivationMode_t * mcuxClKey_Derivation_t;

extern const mcuxClKey_TypeDescriptor_t mcuxClKey_TypeDescriptor_derivationKey_variableLength;

 
MCUX_CSSL_ANALYSIS_START_SUPPRESS_DECLARED_BUT_NEVER_REFERENCED("Consumed by user / customer. Hence, it is declared but never referenced. ")
static const mcuxClKey_Type_t mcuxClKey_Type_derivationKey_variableLength = &mcuxClKey_TypeDescriptor_derivationKey_variableLength;
MCUX_CSSL_ANALYSIS_STOP_SUPPRESS_DECLARED_BUT_NEVER_REFERENCED()
#endif /* MCUXCL_FEATURE_KEY_DERIVATION */

struct mcuxClKey_ValidationDescriptor;

typedef struct mcuxClKey_ValidationDescriptor mcuxClKey_ValidationDescriptor_t;

typedef const mcuxClKey_ValidationDescriptor_t * const mcuxClKey_Validation_t;
 /* mcuxClKey_Types */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* MCUXCLKEY_TYPES_H_ */