mcuxClOsccaSm2_Functions.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------*/
/* Copyright 2022-2023 NXP                                                  */
/*                                                                          */
/* NXP 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 MCUXCLOSCCASM2_FUNCTIONS_H_
#define MCUXCLOSCCASM2_FUNCTIONS_H_
 
 
#include <stdint.h>
#include <mcuxClConfig.h> // Exported features flags header
#include <mcuxClCore_Platform.h>
#include <mcuxClBuffer.h>
#include <mcuxClKey_Types.h>
#include <mcuxClSession.h>
#include <mcuxClOsccaSm2_Types.h>
#include <mcuxClKey_Types.h>
#ifdef MCUXCL_FEATURE_SM2_CIPHER
#include <mcuxClCipher_Types.h>
#endif /* MCUXCL_FEATURE_SM2_CIPHER */
#include <mcuxCsslFlowProtection.h>
#include <mcuxClOscca_FunctionIdentifiers.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/**********************************************************/
/* Public APIs of mcuxClOsccaSm2                           */
/**********************************************************/
#ifdef MCUXCL_FEATURE_SM2_INTERNAL
 
#ifdef MCUXCL_FEATURE_SM2_KEYGEN
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSm2_GenerateKeyPair, mcuxClKey_KeyGenFct_t)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClKey_Status_t) mcuxClOsccaSm2_GenerateKeyPair(
    mcuxClSession_Handle_t session,
    mcuxClKey_Generation_t generation,
    mcuxClKey_Handle_t privKey,
    mcuxClKey_Handle_t pubKey
);
 
#endif /* MCUXCL_FEATURE_SM2_KEYGEN */
 
#ifdef MCUXCL_FEATURE_SM2_CIPHER
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSm2_Cipher_SkeletonSM2, mcuxClCipher_CryptFunc_t)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClCipher_Status_t) mcuxClOsccaSm2_Cipher_SkeletonSM2(
  mcuxClSession_Handle_t session,
  mcuxClCipher_Context_t * const pContext,
  mcuxClKey_Handle_t pKey,
  mcuxClCipher_Mode_t pMode,
  mcuxCl_InputBuffer_t pIv,
  uint32_t ivLength,
  mcuxCl_InputBuffer_t pIn,
  uint32_t inLength,
  mcuxCl_Buffer_t pOut,
  uint32_t * const pOutLength,
  uint32_t steps 
);
 
#endif /* MCUXCL_FEATURE_SM2_CIPHER */
 
#ifdef MCUXCL_FEATURE_SM2_KEYAGREEMENT
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSm2_key_agreement, mcuxClKey_AgreementFct_t)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClKey_Status_t) mcuxClOsccaSm2_key_agreement(
    mcuxClSession_Handle_t session,
    mcuxClKey_Agreement_t agreement,
    mcuxClKey_Handle_t key,
    mcuxClKey_Handle_t otherKey,
    mcuxClKey_Agreement_AdditionalInput_t additionalInputs[],
    uint32_t numberOfInputs,
    uint8_t * pOut,
    uint32_t * const pOutLength
);
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSm2_KeyAgreement_SelfTest, mcuxClKey_Agreement_SelfTestFct_t)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClKey_Status_t) mcuxClOsccaSm2_KeyAgreement_SelfTest(
    mcuxClSession_Handle_t session,
    mcuxClKey_Agreement_t agreement
);
#endif /* MCUXCL_FEATURE_SM2_KEYAGREEMENT */
#endif /* MCUXCL_FEATURE_SM2_INTERNAL */
 
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClOsccaSm2_Signature_PreHash)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClOsccaSm2_Status_t) mcuxClOsccaSm2_Signature_PreHash(
    mcuxClSession_Handle_t             session,
    mcuxClKey_Handle_t                 key,
    mcuxCl_InputBuffer_t               pIdentifier,
    uint16_t                          identifierSize,
    mcuxCl_Buffer_t                    pPrehash,
    uint32_t * const                  prehashSize
);
 /* mcuxClOsccaSm2_Functions */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* MCUXCLOSCCASM2_FUNCTIONS_H_ */