MCUX CLNS
MCUX Crypto Library Normal Secure
Loading...
Searching...
No Matches
mcuxClSignature_Functions.h
1/*--------------------------------------------------------------------------*/
2/* Copyright 2020-2023, 2025-2026 NXP */
3/* */
4/* SPDX-License-Identifier: BSD-3-Clause */
5/* */
6/* Redistribution and use in source and binary forms, with or without */
7/* modification, are permitted provided that the following conditions are */
8/* met: */
9/* */
10/* 1. Redistributions of source code must retain the above copyright */
11/* notice, this list of conditions and the following disclaimer. */
12/* */
13/* 2. Redistributions in binary form must reproduce the above copyright */
14/* notice, this list of conditions and the following disclaimer in the */
15/* documentation and/or other materials provided with the distribution. */
16/* */
17/* 3. Neither the name of the copyright holder nor the names of its */
18/* contributors may be used to endorse or promote products derived from */
19/* this software without specific prior written permission. */
20/* */
21/* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS */
22/* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED */
23/* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A */
24/* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT */
25/* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, */
26/* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED */
27/* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR */
28/* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF */
29/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING */
30/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS */
31/* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
32/*--------------------------------------------------------------------------*/
33
34#ifndef MCUXCLSIGNATURE_FUNCTIONS_H_
35#define MCUXCLSIGNATURE_FUNCTIONS_H_
36
37#include <mcuxClConfig.h> // Exported features flags header
38#include <mcuxClCore_Platform.h>
39#include <mcuxClBuffer.h>
40
41#include <mcuxClSession_Types.h>
42#include <mcuxClKey_Types.h>
43#include <mcuxClSignature_Types.h>
44
47
48#ifdef __cplusplus
49extern "C" {
50#endif
51
58
95 uint32_t inSize,
96 mcuxCl_Buffer_t pSignature,
97 uint32_t * const pSignatureSize
98); /* oneshot sign */
99
123 mcuxClSession_Handle_t pSession,
126 uint32_t inSize
127);
128
170 uint32_t inSize,
171 mcuxCl_InputBuffer_t pSignature,
172 uint32_t signatureSize
173); /* oneshot verification */
175
176#ifdef MCUXCL_FEATURE_SIGNATURE_SELFTEST
195MCUX_CSSL_FP_FUNCTION_DECL(mcuxClSignature_selftest)
200); /* selftest */
201#endif /* MCUXCL_FEATURE_SIGNATURE_SELFTEST */
202
203
204#ifdef __cplusplus
205} /* extern "C" */
206#endif
207
208#endif /* MCUXCLSIGNATURE_FUNCTIONS_H_ */
Top-level include file for the mcuxClBuffer component.
Definition of function identifiers for the flow protection mechanism.
Type definitions for the mcuxClKey component.
Type definitions for the mcuxClSession component.
Provides the API for the CSSL flow protection mechanism.
const uint8_t * mcuxCl_InputBuffer_t
Input buffer type.
Definition mcuxClBuffer_Pointer.h:58
uint8_t * mcuxCl_Buffer_t
Input/output buffer type.
Definition mcuxClBuffer_Pointer.h:67
mcuxClKey_Descriptor_t *const mcuxClKey_Handle_t
Key handle type.
Definition mcuxClKey_Types.h:111
mcuxClSession_Descriptor_t *const mcuxClSession_Handle_t
Type for mcuxClSession Handle.
Definition mcuxClSession_Types.h:118
mcuxClSignature_Status_t mcuxClSignature_verify(mcuxClSession_Handle_t session, mcuxClKey_Handle_t key, mcuxClSignature_Mode_t mode, mcuxCl_InputBuffer_t pIn, uint32_t inSize, mcuxCl_InputBuffer_t pSignature, uint32_t signatureSize)
One-shot verification function.
mcuxClSignature_Status_t mcuxClSignature_sign(mcuxClSession_Handle_t session, mcuxClKey_Handle_t key, mcuxClSignature_Mode_t mode, mcuxCl_InputBuffer_t pIn, uint32_t inSize, mcuxCl_Buffer_t pSignature, uint32_t *const pSignatureSize)
One-shot signing function.
mcuxClSignature_Status_t mcuxClSignature_verify_recordParam(mcuxClSession_Handle_t pSession, mcuxClSignature_Mode_t mode, mcuxCl_InputBuffer_t pIn, uint32_t inSize)
Record signature verification parameters for protection.
const mcuxClSignature_TestDescriptor_t *const mcuxClSignature_Test_t
Signature selftest mode/algorithm type.
Definition mcuxClSignature_Types.h:95
uint32_t mcuxClSignature_Status_t
Signature status code.
Definition mcuxClSignature_Types.h:119
const mcuxClSignature_ModeDescriptor_t *const mcuxClSignature_Mode_t
Signature mode/algorithm type.
Definition mcuxClSignature_Types.h:72
#define MCUX_CSSL_FP_FUNCTION_DECL(...)
Declaration of a flow protected function.
Definition mcuxCsslFlowProtection.h:186
#define MCUX_CSSL_FP_PROTECTED_TYPE(resultType)
Based on a given base type, builds a return type with flow protection.
Definition mcuxCsslFlowProtection.h:158