CSM

缩写词注解

缩写词

解释/描述

中文解释

CSM

Crypto Service Manager

加密服务管理

CRYIF

Crypto Interface

加密接口层

CRYPTO

Crypto Driver

加密驱 动（硬件驱动或者软件驱动）

DET

Default Error Tracer

开发错误检测模块

HSM

Hardware Security Module

硬件中用于计算加密算法 的模块（相当于另外一块CPU）

Job

CsmJob

CSM模块中的 一个加密处理任务，一般每个J ob会引用到一个cryptographic primitive

简介

CSM应提供同步或异步服务，以支持对所有软件模块的基本密码功能的唯一访问。CSM应该提供一个抽象层，它为更高的软件层提供一个标准化的接口来访问这些功能。软件模块所需的功能可能与其他软件模块所需的功能不同。因此，应该可以为每个软件模块单独配置和初始化CSM提供的服务。此配置还包括对CSM服务的同步或异步处理的选择。CSM模块的构建遵循通用方法。如果结构和接口的详细规范限制了CSM的可用性范围，则以通用方式定义接口和结构。这为将来的扩展提供了机会。

image1

图 Crypto架构图

参考资料

[1] AUTOSAR_SWS_CryptoServiceManager.pdf，R19-11

功能描述

基本功能

CSM是一种提供加密功能的服务，它基于一个依赖于软件库或硬件模块的加密驱动程序。此外，混合设置与多个密码驱动程序是可能的。CSM通过CRYIF访问不同的加密驱动程序。

一般功能

CSM通过引入Job的概念来处理加密工作。

Job是已配置的密码原语的实例，对于每个Job，CSM每次只能处理一个实例，但允许不同Job的并行处理，如果一个服务请求正被相应的Job处理，此时来了另一个相同Job的要求，CSM应当返回CRYPTO_E_BUSY。

注意：Job正在被处理意味着相应的加密驱动程序对象正在积极地处理这个Job。当一个Job没有完成，但是加密驱动程序对象没有被激活，这并不意味着这个Job正在被处理。如果配置了异步接口，则CSM模块应提供一个主函数Csm_MainFunction()，该主函数被循环调用，以通过状态机控制Job的处理。

Job状态

将单一的调用函数与加密Job的流方式相结合，需要模式参数，它决定了加密Job的运行模式。此服务操作是一个标志字段，指示操作模式启动、更新或完成，它显式地声明应该执行什么操作。这些操作模式可以混合使用，并同时执行。状态的实际事务是在与这些状态一起工作的层中进行的，即在加密驱动程序中。

image2

图 Job状态图

单调用方法不需要多次调用显式API，只需要调用一次即可。由于单调用的开销小，可以提高性能，所以多用于需要快速处理的小数据输入过程中。当使用流方法(启动、更新、完成)操作时，专用的加密驱动程序对象正在等待进一步的输入(更新)，直到到达完成状态。同时，不能在此加密驱动程序实例上处理其他Job。

同步Job

如果使用同步接口，则接口函数将必要的信息传递给底层加密堆栈模块并等待返回结果。

image3

图 同步任务执行流程图

异步Job

如果使用异步接口，则接口函数只能将必要的信息传递给底层加密堆栈模块，然后等待底层处理完成调用回调函数通知CSM。

image4

图 异步任务执行流程图

Queue相关

Quene，即队列，为CSM内部针对Job设置的一个功能，CSM应在内部完成对其的操作。

CSM可能有多个队列，其中的Job根据其优先级排列，以处理多个加密请求。从CSM队列通过CryIf到加密驱动程序对象的路径称为通道。CSM的每个队列都映射到一个通道，以访问crypto驱动程序对象的crypto原语。队列的大小是可配置的。为了优化加密驱动程序对象的硬件使用，加密驱动程序中还有一个可选的队列。加密驱动程序对象表示独立加密设备(硬件或软件，如AES加速器)的实例。对于具有高优先级的Job，HSM上可以有一个用于快速AES和CMAC计算的通道，该通道在加密驱动程序中的本地AES计算服务上结束。但同时，加密驱动程序对象也可能是软件，例如用于RSA计算，用户能够加密、解密、签名或验证数据。

在同步Job处理中，队列将不起作用。因此，如果选择同步Job处理，则队列大小应该为0。但是，也可以将通道(包括队列)与同步和异步Job一起使用。可以在Csm_MainFunction()中将排队的Job传递给CRYIF。如果Job的状态是活动的，则CSM应假定映射的加密驱动程序实例当前正在处理该Job，而调用者希望继续操作(例如，使用update提供更多数据)，必须在加密驱动程序实例中执行可信性检查。

Key管理功能

Key，即对应的keyid具有配置给出的符号名称。Crypto堆栈API使用来自CSM模块的以下关键元素索引定义：

image5

image6

图 KeyElement示意图

对于包含加密密钥材料的每个密钥元素，应在用于数据交换的配置中指定所提供密钥的格式，例如Csm_KeyElementGet()或Csm_KeyElementSet()。特定密码驱动程序支持的密钥格式是随密码驱动程序一起提供的预配置信息的一部分。

特定于供应商的keyelementid应该启动1000来避免对未来扩展版本的加密堆栈的干扰。关键元素CRYPTO_KE_[…]_ALGORITHM用于配置密钥管理函数的行为，因为它们独立于Job，因此不能像原语那样进行配置。

源文件描述

表 CSM组件文件描述

文件

说明

CSM.c

CSM模块源文件，包含了API函数的实现。

CSM.h

CSM模块头文件，包 含了API函数的扩展声明并定义了配置的数据结构体。

CSM_Cfg.h

定义CSM模块预编译时用到的配置参数。

CSM_Cfg.c

CSM模块配置生成文件。

CSM_Cbk.h

包含CSM供上层调用的API函数的声明

CSM_Internal.h

包含CSM内部的变量和数据结构体的定义

CSM_MemMap.h

CSM编译抽象文件

API接口

类型定义

Csm_ConfigType类型定义

名称

Csm_ConfigType

类型

Structure

范围

无

描述

Csm模块的配置数据结构体

Crypto_InputOutputRedirectionConfigType类型定义

名称

Crypto_InputO utputRedirectionConfigType

类型

Enumeration

范围

CRYPTO_RED IRECT_CONFIG_PRIMARY_INPUT

0x01

CRYPTO_REDIR ECT_CONFIG_SECONDARY_INPUT

0x02

CRYPTO_REDI RECT_CONFIG_TERTIARY_INPUT

0x04

CRYPTO_REDI RECT_CONFIG_PRIMARY_OUTPUT

0x10

CRYPTO_REDIRE CT_CONFIG_SECONDARY_OUTPUT

0x20

描述

Csm模块的配置数据结构体

Crypto_JobType类型定义

名称

Crypto_JobType

类型

Structure

范围

无

描述

Csm模块执行的Job结构类型

Crypto_JobStateType类型定义

名称

Crypto_JobStateType

类型

Enumeration

范围

无

描述

当前job状态的枚举

Crypto_JobPrimitiveInputOutputType类型定义

名称

Crypto_JobPrimitiveInputOutputType

类型

Structure

范围

无

描述

包含依赖于job和密码原语的输入和输出信息的结构体

Crypto_JobInfoType类型定义

名称

Crypto_JobInfoType

类型

Structure

范围

无

描述

包含job信息(jobID和job优先级)的结构体

Crypto_JobPrimitiveInfoType类型定义

名称

Crypto_JobPrimitiveInfoType

类型

Structure

范围

无

描述

包含进一步的信息，这取决于job和密码原语的结构体

Crypto_JobRedirectionInfoType类型定义

名称

Crypto_JobRedirectionInfoType

类型

Structure

范围

无

描述

包含依赖于job和密码原语的输入和输出信息的结构体

Crypto_AlgorithmInfoType类型定义

名称

Crypto_AlgorithmInfoType

类型

Structure

范围

无

描述

决定了精确的算法的结构体。注意， 不是每个算法都需要指定所有字段。AUTOSAR只允许有效的组合

Crypto_ProcessingType类型定义

名称

Crypto_ProcessingType

类型

Enumeration

范围

同步或者异步

描述

决定了Job的处理方式（同步或者异步）

Crypto_PrimitiveInfoType类型定义

名称

Crypto_PrimitiveInfoType

类型

Structure

范围

无

描述

包含有关密码原语的基本信息的结构体

Csm_ConfigIdType类型定义

名称

Csm_ConfigIdType

类型

uint16

范围

0..65535

描述

通过在服务中唯一的数字标识符标识CSM服务配置

CSM服务配置的名称，即容器的名称

Csm_<Service>Config，作为该参数的符号名

输入函数描述

输入模块

API

Det

Det_ReportError

CryIf

CryIf_ProcessJob

CryIf_CancelJob

CryIf_KeyElementSet

CryIf_KeySetValid

CryIf_KeyElementGet

CryIf_KeyElementCopy

CryIf_KeyCopy

CryIf_RandomSeed

CryIf_KeyGenerate

CryIf_KeyExchangeCalcSecret

CryIf_CertificateParse

CryIf_CertificateVerify

静态接口函数定义

Csm_Init函数定义

函数名称：

Csm_Init

函数原型：

FUNC(void, CSM_CODE)

Csm_Init(

P2CONS T(Csm_ConfigType, AUTOMATIC, CSM_APPL_DATA) configPtr

)

服务编号：

0x00

同步/异步：

同步

是 否可重入：

否

输入参数：

configPtr

值域：

无

输入 输出参数：

无

输出参数：

无

返回值：

无

功能概述：

初始化CSM模块

Csm_GetVersionInfo函数定义

函数名称：

C sm_GetVersionInfo

函数原型：

FUNC(void, CSM_CODE)

Cs m_GetVersionInfo(

P2VAR(Std _VersionInfoType, AUTOMATIC, CSM_APPL_DATA) versioninfo

)

服务编号：

0x3b

同步/异步：

同步

是 否可重入：

是

输入参数：

无

值域：

无

输入 输出参数：

无

输出参数：

versioninfo

返回值：

无

功能概述：

返回版本信息

Csm_Hash函数定义

函数名称：

Csm_Hash

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_Hash(

uint32 jobId,

Crypto_ OperationModeType mode,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) dataPtr,

uint32 dataLength,

P2VAR(uint8, AUTOMATIC, CSM_APPL_DATA) resultPtr,

P2VAR(uint32, AUTOMATIC, CSM_APPL_DATA) resultLengthPtr

)

服务编号：

0x5d

同步/异步：

取决于配置

是 否可重入：

否

输入参数：

jobId

值域：

0-CSM_JOB_NUM

mode

无

dataPtr

无

dataLength

无

输入 输出参数：

resultLengthPtr

输出参数：

resultPtr

返回值：

Std_ReturnType

功能概述：

执行哈 希计算并存储结果

Csm_MacGenerate函数定义

函数名称：

Csm_MacGenerate

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_MacGenerate(

uint32 jobId,

Crypto_ OperationModeType mode,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) dataPtr,

uint32 dataLength,

P2VAR(uint8, AUTOMATIC, CSM_APPL_DATA) macPtr,

P2VAR(uint32, AUTOMATIC, CSM_APPL_DATA) macLengthPtr

)

服务编号：

0x60

同步/异步：

取决于配置

是 否可重入：

否

输入参数：

jobId

值域：

0-CSM_JOB_NUM

mode

无

dataPtr

无

dataLength

无

输入 输出参数：

macLengthPtr

输出参数：

macPtr

返回值：

Std_ReturnType

功能概述：

执行 mac计算并存储结果

Csm_MacVerify函数定义

函数名称：

Csm_MacVerify

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_MacVerify(

uint32 jobId,

Crypto_ OperationModeType mode,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) dataPtr,

uint32 dataLength,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) macPtr,

uint32 macLength,

P2VAR(Crypto_ VerifyResultType, AUTOMATIC, CSM_APPL_DATA) verifyPtr

)

服务编号：

0x61

同步/异步：

取决于配置

是 否可重入：

否

输入参数：

jobId

值域：

0-CSM_JOB_NUM

mode

无

dataPtr

无

dataLength

无

macPtr

无

macLength

无

输入 输出参数：

无

输出参数：

verifyPtr

返回值：

Std_ReturnType

功能概述：

执行mac验证计 算并存储验证结果

Csm_Encrypt函数定义

函数名称：

Csm_Encrypt

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_Encrypt(

uint32 jobId,

Crypto_ OperationModeType mode,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) dataPtr,

uint32 dataLength,

P2VAR(uint8, AUTOMATIC, CSM_APPL_DATA) resultPtr,

P2VAR(uint32, AUTOMATIC, CSM_APPL_DATA) resultLengthPtr

)

服务编号：

0x5e

同步/异步：

取决于配置

是 否可重入：

否

输入参数：

jobId

值域：

0-CSM_JOB_NUM

mode

无

dataPtr

无

dataLength

无

输入 输出参数：

resultLengthPtr

输出参数：

resultPtr

返回值：

Std_ReturnType

功能概述：

执行加 密计算并存储结果

Csm_Decrypt函数定义

函数名称：

Csm_Decrypt

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_Decrypt(

uint32 jobId,

Crypto_ OperationModeType mode,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) dataPtr,

uint32 dataLength,

P2VAR(uint8, AUTOMATIC, CSM_APPL_DATA) resultPtr,

P2VAR(uint32, AUTOMATIC, CSM_APPL_DATA) resultLengthPtr

)

服务编号：

0x5f

同步/异步：

取决于配置

是 否可重入：

否

输入参数：

jobId

值域：

0-CSM_JOB_NUM

mode

无

dataPtr

无

dataLength

无

输入 输出参数：

resultLengthPtr

输出参数：

resultPtr

返回值：

Std_ReturnType

功能概述：

执行解 密计算并存储结果

Csm_AEADEncrypt函数定义

函数名称：

Csm_AEADEncrypt

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_AEADEncrypt(

uint32 jobId,

Crypto_ OperationModeType mode,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) plaintextPtr,

uint32 plaintextLength,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) a ssociatedDataPtr,

uint32 asso ciatedDataLength,

P2VAR(uint8, AUTOMATIC, CSM_APPL_DATA) ciphertextPtr,

P2VAR(uint32, AUTOMATIC, CSM_APPL_DATA) cip hertextLengthPtr,

P2VAR(uint8, AUTOMATIC, CSM_APPL_DATA) tagPtr,

P2VAR(uint32, AUTOMATIC, CSM_APPL_DATA) tagLengthPtr

)

服务编号：

0x62

同步/异步：

取决于配置

是 否可重入：

否

输入参数：

jobId

值域：

0-CSM_JOB_NUM

mode

无

plaintextPtr

无

plaintextLength

无

associatedDataPtr

无

ass ociatedDataLength

无

输入 输出参数：

ci phertextLengthPtr

tagLengthPtr

输出参数：

ciphertextPtr

tagPtr

返回值：

Std_ReturnType

功能概述：

执行AEAD加 密计算并存储结果

Csm_AEADDecrypt函数定义

函数名称：

Csm_AEADDecrypt

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_AEADDecrypt(

uint32 jobId,

Crypto_ OperationModeType mode,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) ciphertextPtr,

uint32 ciphertextLength,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) a ssociatedDataPtr,

uint32 asso ciatedDataLength,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) tagPtr,

uint32 tagLength,

P2VAR(uint8, AUTOMATIC, CSM_APPL_DATA) plaintextPtr,

P2VAR(uint32, AUTOMATIC, CSM_APPL_DATA) pl aintextLengthPtr,

P2VAR(Crypto_ VerifyResultType, AUTOMATIC, CSM_APPL_DATA) verifyPtr

)

服务编号：

0x63

同步/异步：

取决于配置

是 否可重入：

否

输入参数：

jobId

值域：

0-CSM_JOB_NUM

mode

无

ciphertextPtr

无

ciphertextLength

无

associatedDataPtr

无

ass ociatedDataLength

无

tagPtr

无

tagLength

无

输入 输出参数：

plaintextPtr

输出参数：

p laintextLengthPtr

verifyPtr

返回值：

Std_ReturnType

功能概述：

执行AEAD解 密计算并存储结果

Csm_SignatureGenerate函数定义

函数名称：

Csm_ SignatureGenerate

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_S ignatureGenerate(

uint32 jobId,

Crypto_ OperationModeType mode,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) dataPtr,

uint32 dataLength,

P2VAR(uint8, AUTOMATIC, CSM_APPL_DATA) resultPtr,

P2VAR(uint32, AUTOMATIC, CSM_APPL_DATA) resultLengthPtr

)

服务编号：

0x76

同步/异步：

取决于配置

是 否可重入：

否

输入参数：

jobId

值域：

0-CSM_JOB_NUM

mode

无

dataPtr

无

dataLength

无

输入 输出参数：

resultLengthPtr

输出参数：

resultPtr

返回值：

Std_ReturnType

功能概述：

生 成签名并存储结果

Csm_ SignatureVerify函数定义

函数名称：

Cs m_SignatureVerify

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm _SignatureVerify(

uint32 jobId,

Crypto_ OperationModeType mode,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) dataPtr,

uint32 dataLength,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) signaturePtr,

uint32 signatureLength,

P2VAR(Crypto_ VerifyResultType, AUTOMATIC, CSM_APPL_DATA) verifyPtr

)

服务编号：

0x64

同步/异步：

取决于配置

是 否可重入：

否

输入参数：

jobId

值域：

0-CSM_JOB_NUM

mode

无

dataPtr

无

dataLength

无

signaturePtr

无

signatureLength

无

输入 输出参数：

无

输出参数：

verifyPtr

返回值：

Std_ReturnType

功能概述：

验证签 名并存储验证结果

Csm_RandomGenerate函数定义

函数名称：

C sm_RandomGenerate

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Cs m_RandomGenerate(

uint32 jobId,

P2VAR(uint8, AUTOMATIC, CSM_APPL_DATA) resultPtr,

P2VAR(uint32, AUTOMATIC, CSM_APPL_DATA) resultLengthPtr

)

服务编号：

0x72

同步/异步：

取决于配置

是 否可重入：

否

输入参数：

jobId

值域：

0-CSM_JOB_NUM

resultPtr

无

resultLengthPtr

无

输入 输出参数：

resultLengthPtr

输出参数：

resultPtr

返回值：

Std_ReturnType

功能概述：

随机 数生成并储存结果

Csm_KeyElementSet函数定义

函数名称：

Csm_KeyElementSet

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

C sm_KeyElementSet(

uint32 keyId,

uint32 keyElementId,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) keyPtr,

uint32 keyLength

)

服务编号：

0x78

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

keyElementId

无

keyPtr

无

keyLength

无

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

将给定的密 钥元素字节设置为 由keyId标识的密钥

Csm_KeySetValid函数定义

函数名称：

Csm_KeySetValid

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_KeySetValid(

uint32 keyId

)

服务编号：

0x67

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

将ke yId标识的密钥的密 钥状态设置为valid

Csm_KeyElementGet函数定义

函数名称：

Csm_KeyElementGet

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

C sm_KeyElementGet(

uint32 keyId,

uint32 keyElementId,

P2VAR(uint8, AUTOMATIC, CSM_APPL_DATA) keyPtr,

P2VAR(uint32, AUTOMATIC, CSM_APPL_DATA) keyLengthPtr

)

服务编号：

0x68

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

keyElementId

无

输入 输出参数：

keyLengthPtr

输出参数：

keyPtr

返回值：

Std_ReturnType

功能概述：

获取指定的key元素

Csm_KeyElementCopy函数定义

函数名称：

C sm_KeyElementCopy

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Cs m_KeyElementCopy(

CONST(uint32, CSM_APPL_DATA) keyId,

CONST(uint32, CSM_APPL_DATA) keyElementId,

CONST(uint32, CSM_APPL_DATA) targetKeyId,

CONST(uint32, CSM_APPL_DATA) t argetKeyElementId

)

服务编号：

0x71

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

keyElementId

无

targetKeyId

0-CSM_KEY_NUM

t argetKeyElementId

无

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

将一个key Element从keyId-> keyElementId复 制到targetKeyId-> t argetKeyElementId

Csm_KeyCopy函数定义

函数名称：

Csm_KeyCopy

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_KeyCopy(

CONST(uint32, CSM_APPL_DATA) keyId,

CONST(uint32, CSM_APPL_DATA) targetKeyId

)

服务编号：

0x73

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

targetKeyId

0-CSM_KEY_NUM

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

将一个Key的 所有元素从一个键 复制到一个目标键

Csm_KeyElementCopyPartial函数定义

函数名称：

Csm_Key ElementCopyPartial

函数原型：

FU NC(Std_ReturnType, CSM_CODE)

Csm_KeyE lementCopyPartial(

uint32 keyId,

uint32 keyElementId,

uint32 keyEl ementSourceOffset,

uint32 keyEl ementTargetOffset,

uint32 key ElementCopyLength,

uint32 targetKeyId,

uint32 targetKeyElementId

)

服务编号：

0x79

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

keyElementId

无

keyE lementSourceOffset

无

keyE lementTargetOffset

无

ke yElementCopyLength

无

targetKeyId

0-CSM_KEY_NUM

targetKeyElementId

无

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

将密钥元素复制 到同一加密驱动程序 中的另一个密钥元素

Csm_RandomSeed函数定义

函数名称：

Csm_RandomSeed

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_RandomSeed(

uint32 keyId,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) seedPtr,

uint32 seedLength

)

服务编号：

0x69

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

seedPtr

无

seedLength

无

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

提供随机数

CryIf_KeyGenerate函数定义

函数名称：

Csm_KeyGenerate

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_KeyGenerate(

uint32 keyId

)

服务编号：

0x6a

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

将密钥生成函 数分配给已配置的 密码驱动程序对象

Csm_KeyDerive函数定义

函数名称：

Csm_KeyDerive

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_KeyDerive(

uint32 keyId,

uint32 targetKeyId

)

服务编号：

0x6b

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

targetKeyId

0-CSM_KEY_NUM

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

通过使用由ke yId标识的给定键中 的键元素派生新key

Csm_KeyExchangeCalcPubVal函数定义

函数名称：

Csm_KeyE xchangeCalcPubVal

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_KeyEx changeCalcPubVal(

uint32 keyId,

P2VAR(uint8, AUTOMATIC, CSM_APPL_DATA) publicValuePtr,

P2VAR(uint32, AUTOMATIC, CSM_APPL_DATA) pub licValueLengthPtr

)

服务编号：

0x6c

同步/异步：

同步

是 否可重入：

是

输入参数：

keyId

值域：

0-CSM_KEY_NUM

输入 输出参数：

pub licValueLengthPtr

输出参数：

publicValuePtr

返回值：

Std_ReturnType

功能概述：

将 密钥交换公共值计 算函数分配给配置 好的密码驱动对象

Csm_KeyExchangeCalcSecret函数定义

函数名称：

Csm_K eyExchangeCalcSecret

函数原型：

FUNC(Std_ReturnType, CSM_CODE)

Csm_Ke yExchangeCalcSecret(

uint32 keyId,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) pa rtnerPublicValuePtr,

uint32 part nerPublicValueLength

)

服务编号：

0x6d

同 步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

p artnerPublicValuePtr

无

part nerPublicValueLength

无

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

使用密钥id和伙伴 公钥标识的密钥材料计 算密钥交换的共享密钥

Csm_JobKeySetValid函数定义

函数名称：

C sm_JobKeySetValid

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Cs m_JobKeySetValid(

uint32 jobId,

uint32 keyId

)

服务编号：

0x7a

同步/异步：

同步

是 否可重入：

是

输入参数：

keyId

值域：

0-CSM_KEY_NUM

jobId

0-CSM_JOB_NUM

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

将ke yId标识的密钥的密 钥状态设置为valid

Csm_JobRandomSeed函数定义

函数名称：

C sm_JobKeyGenerate

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Cs m_JobKeyGenerate(

uint32 jobId,

uint32 keyId

)

服务编号：

0x7c

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

jobId

0-CSM_JOB_NUM

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

生成新的密钥 材料并将其存储在 keyId标识的密钥中

Csm_JobKeyGenerate函数定义

函数名称：

C sm_JobKeyGenerate

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Cs m_JobKeyGenerate(

uint32 jobId,

uint32 keyId

)

服务编号：

0x7c

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

jobId

0-CSM_JOB_NUM

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

生成新的密钥 材料并将其存储在 keyId标识的密钥中

Csm_JobKeyDerive函数定义

函数名称：

Csm_JobKeyDerive

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_JobKeyDerive(

uint32 jobId,

uint32 keyId,

uint32 targetKeyId

)

服务编号：

0x7d

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

jobId

0-CSM_JOB_NUM

targetKeyId

无

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

使用由ke yId标识的给定键中 的键元素派生新键

Csm_JobKeyExchangeCalcPubVal函数定义

函数名称：

Csm_JobKeyE xchangeCalcPubVal

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_JobKeyEx changeCalcPubVal(

uint32 jobId,

uint32 keyId,

P2VAR(uint8, AUTOMATIC, CSM_APPL_DATA) publicValuePtr,

P2VAR(uint32, AUTOMATIC, CSM_APPL_DATA) pub licValueLengthPtr

)

服务编号：

0x7e

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

计算 密钥交换的当前用 户的公钥，并将公 钥存储在公钥指针 所指向的内存位置

Csm_JobKeyExchangeCalcSecret函数定义

函数名称：

Csm_JobKeyE xchangeCalcSecret

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_JobKeyEx changeCalcSecret(

uint32 jobId,

uint32 keyId,

P2CONST(uint8, AUTOMATIC, CSM_APPL_DATA) partn erPublicValuePtr,

uint32 partner PublicValueLength

)

服务编号：

0x7f

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

使用密钥 id和伙伴公钥标识 的密钥材料计算密 钥交换的共享密钥

Csm_CancelJob函数定义

函数名称：

Csm_CancelJob

函数原型：

FUN C(Std_ReturnType, CSM_CODE)

Csm_CancelJob(

uint32 Job,

Crypto_ OperationModeType mode

)

服务编号：

0x6f

同步/异步：

同步

是 否可重入：

否

输入参数：

keyId

值域：

0-CSM_KEY_NUM

输入 输出参数：

无

输出参数：

无

返回值：

Std_ReturnType

功能概述：

取消job

Csm_CallbackNotification函数定义

函数名称：

Csm_Cal lbackNotification

函数原型：

void Csm_Cal lbackNotification ( Crypto_JobType* Job, Crypto_ResultType result )

服务编号：

0x70

同步/异步：

同步

是 否可重入：

是

输入参数：

result

值域：

无

Job

无

输入 输出参数：

无

输出参数：

无

返回值：

无

功能概述：

通知CSM Job已 经完成，这个函数 由底层(CRYIF)使用

Csm_MainFunction函数定义

函数名称：

Csm_MainFunction

函数原型：

FUNC(void, CSM_CODE)

Csm_MainFunction(

void

)

服务编号：

0x01

同步/异步：

取决于配置

是 否可重入：

否

输入参数：

无

值域：

无

输入 输出参数：

无

输出参数：

无

返回值：

无

功能概述：

循环调用API来 处理请求的job。C sm_MainFunction将 检查要传递给底层 CRYIF的job的队列

可配置函数

无。

配置

CsmGeneral

image7

图 CsmGeneral容器配置图

表 CsmGeneral属性描述

UI名称

描述

CsmAsymPrivateKeyMaxLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

所有算法的非对称公钥的最大长度(以字节为单位)

无

CsmAsymPublicKeyMaxLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

所有算法的非对称密钥的最大长度(以字节为单位)

依赖关系

无

CsmDevErrorDetect

取值范围

TRUE/FALSE

默认取值

FALSE

参数描述

打开或关闭开发错误检测和通知

true：启用检测和通知。

false：禁用检测和通知

依赖关系

无

CsmMainFunctionPeriod

取值范围

0 .. INF

默认取值

无

参数描述

指定主函数Csm_MainFunction的周期(以秒为单位)。

依赖关系

无

CsmUseDeprecated

取值范围

TRUE/FALSE

默认取值

FALSE

参数描述

决定不支持的接口是否为应使用。

true：使用不赞成的接口。

false：使用普通接口。

依赖关系

无

CsmVersionInfoApi

取值范围

TRUE/FALSE

默认取值

FALSE

参数描述

切换以启用和禁用Csm_GetVersionInfo ()

True： API Csm_GetVersionInfo()是可用的。

False：Csm_GetVersionInfo()不可用。

依赖关系

无

CsmInclude

image8

图 CsmInclude容器配置图

表 CsmInclude属性描述

UI名称

描述

I ncludeName

取值范围

无

默认取值

无

参数描述

用户包含外部头文 件，主要包含CallCal lBack函数的声明文件

依赖关系

无

CsmJob

image9

图 CsmJob容器配置图 表 CsmJob属性描述

UI名称

描述

CsmJobId

取值范围

0 .. 4294967295

参数描述

CSMjob的标识符。实际配置的标识符集应该是连续的、无间隙的。

依赖关系

无

CsmJobId

取值范围

0 .. 4294967295

默认取值

无

参数描述

CSMjob的标识符。实际配置的标识符集应该是连续的、无间隙的。

依赖关系

无

CsmJobPrimitiveCallbackUpdateNotification

取值范围

TRUE/FALSE

默认取值

FALSE

参数描述

此参数指示，如果更新操作已完成，是否应调用回调函数。

依赖关系

无

CsmJobPriority

取值范围

0 .. 4294967295

默认取值

无

参数描述

job的优先级。

值越高，job的优先级越高。

依赖关系

无

CsmProcessingMode

取值范围

CRYPTO_PROCESSING_ASYNC

默认取值

无

CRYPTO_PROCESSING_SYNC

参数描述

确定该job的接口应使用的方式。同步处理返回结果，而异步处理返回而不处理job。相应的回调将通知调用者。

依赖关系

无

CsmInOutRedirectionRef

取值范围

无

默认取值

无

参数描述

此参数引用使用的重定向

依赖关系

CsmInOutRedirections

CsmJobKeyRef

取值范围

无

默认取值

无

参数描述

这个参数指的是CsmPrimitive的应使用键。

可以为不同的job使用CsmKey

依赖关系

CsmKey

CsmJobPrimitiveCallbackRef

取值范围

无

默认取值

无

参数描述

此参数引用使用的CsmCallback。

当加密job完成时，将调用所引用的CsmCallback。

依赖关系

当CsmProcessingMode配置为ASYN异步模式

CsmJobPrimitiveRef

取值范围

无

默认取值

无

参数描述

此参数引用所使用的CsmPrimitive。

不同的job可以引用一个CsmPrimitive。所引用的CsmPrimitive提供了关于实际密码例程的详细信息。

依赖关系

CsmPrimitives

CsmJobQueueRef

取值范围

无

默认取值

无

参数描述

这个参数指的是队列。

如果底层加密驱动程序对象忙，则使用该队列。队列也引用所使用的通道。

依赖关系

CsmQueue

CsmKey

image10

图 CsmKey容器配置图

表 CsmKey属性描述

UI名称

描述

参数描述

默认取值

依赖关系

CsmKeyId

取值范围

0 .. 4294967295

无

无

参数描述

CsmKey的标识符。实际配置的标识符集应该是连续的、无间隙的。

依赖关系

无

CsmKeyUsePort

取值范围

TRUE/FALSE

FALSE

无

参数描述

Key需要RTE接口吗？<br>True：此键使用的RTE接口<br>False：此键没有使用的RTE接口

依赖关系

无

CsmKeyRef

取值范围

无

无

CryIfKey

参数描述

此参数引用所使用的CryIfKey。底层的CryIfKey指的是加密驱动程序中的一个特定的加密密钥。

依赖关系

CryIfKey

CsmQueue

image11

图 CsmQueue容器配置图

表 CsmQueue属性描述

UI名称

描述

Cs mQueueSize

取值范围

1 .. 4294967295

默认取值

无

参数描述

CsmQueue的 大小。如果由于硬件 繁忙而无法由底层硬 件处理job，则job将 保留在优先队列中。

如果队列已满， 则将拒绝下一个job。

依赖关系

无

Csm ChannelRef

取值范围

无

默认取值

无

参数描述

指 底层的密码接口通道

依赖关系

CryIfChannel

CsmInOutRedirection

image12

图 CsmInOutRedirection容器配置图

表 CsmInOutRedirection属性描述

UI名称

描述

CsmInputKeyElementId

取值范围

0 .. 4294967295

默认取值

无

参数描述

用作输入的元素的标识符

依赖关系

无

CsmOutputKeyElementId

取值范围

0 .. 4294967295

默认取值

无

参数描述

用作输出的元素的标识符

依赖关系

无

CsmSecondaryInputKeyElementId

取值范围

0 .. 4294967295

默认取值

无

参数描述

用作辅助输入的键元素的标识符

依赖关系

无

CsmSecondaryOutputKeyElementId

取值范围

0 .. 4294967295

默认取值

无

参数描述

用作辅助输出的键元素的标识符

依赖关系

无

CsmTertiaryInputKeyElementId

取值范围

0 .. 4294967295

默认取值

无

参数描述

用作第三级输入的关键元素的标识符

依赖关系

无

CsmInputKeyRef

取值范围

无

默认取值

无

参数描述

这个参数指的是作输入的key

依赖关系

CsmKey

CsmOutputKeyRef

取值范围

无

默认取值

无

参数描述

此参数引用用作输出的键

依赖关系

CsmKey

CsmSecondaryOutputKeyRef

取值范围

无

默认取值

无

参数描述

这个参数指的是作辅助输出的键

依赖关系

CsmKey

CsmTertiaryInputKeyRef

取值范围

无

默认取值

无

参数描述

这个参数指的是用作第三级输入的键

依赖关系

CsmKey

CsmPrimitives

image13

图 CsmPrimitives容器配置图

表 CsmPrimitives属性描述

UI名称

描述

Csm Primitives

取值范围

无

默认取值

无

参数描述

用于配置 CsmPrimitives的容器

依赖关系

无

包含内容

CsmAEA DDecrypt

CsmAEA DEncrypt

Cs mDecrypt

Cs mEncrypt

CsmHash

CsmJob Certific ateParse

CsmJobC ertifica teVerify

CsmJobK eyDerive

Cs mJobKeyE xchangeC alcPubVa

Csm JobKeyEx changeCa lcSecret

C smJobKey Generate

C smJobKey SetValid

CsmJobRa ndomSeed

CsmMac Generate

CsmM acVerify

C smRandom Generate

CsmS ignature Generate

Cs mSignatu reVerify

CsmHashConfig

UI名称

描述

CsmHashAlgorithmFamily

取值范围

CRYPTO_ALGOFAM_BLAKE_1_256 0x0F

默认取值

无

CRYPTO_ALGOFAM_BLAKE_1_512 0x10

CRYPTO_ALGOFAM_BLAKE_2s_256 0x11

CRYPTO_ALGOFAM_BLAKE_2s_512 0x12

CRYPTO_ALGOFAM_CUSTOM 0xFF

CRYPTO_ALGOFAM_RIPEMD160 0x0E

CRYPTO_ALGOFAM_SHA1 0x01

CRYPTO_ALGOFAM_SHA2_224 0x02

CRYPTO_ALGOFAM_SHA2_256 0x03

CRYPTO_ALGOFAM_SHA2_384 0x04

CRYPTO_ALGOFAM_SHA2_512 0x05

CRYPTO_ALGOFAM_SHA2_512_224 0x06

CRYPTO_ALGOFAM_SHA2_512_256 0x07

CRYPTO_ALGOFAM_SHA3_224 0x08

CRYPTO_ALGOFAM_SHA3_256 0x09

CRYPTO_ALGOFAM_SHA3_384 0x0A

CRYPTO_ALGOFAM_SHA3_512 0x0B

CRYPTO_ALGOFAM_SHA3_SHAKE128 0x0C

CRYPTO_ALGOFAM_SHA3_SHAKE256 0x0D

参数描述

确定用于加密服务的算法族。这个参数定义了算法最重要的部分

依赖关系

无

CsmHashAlgorithmFamilyCustom

取值范围

无

默认取值

无

参数描述

这是自定义算法族的名称

CRYPTO_ALGOFAM_CUSTOM被用作csmhashalg族。

依赖关系

无

CsmHashAlgorithmMode

取值范围

CRYPTO_ALGOMODE_CUSTOM 0xFF

默认取值

0x00

CRYPTO_ALGOMODE_NOT_SET 0x00

参数描述

确定加密服务使用的算法模式

依赖关系

无

CsmHashAlgorithmModeCustom

取值范围

无

默认取值

无

参数描述

自定义原语模式的名称

依赖关系

无

CsmHashAlgorithmSecondaryFamily

取值范围

CRYPTO_ALGOMODE_CUSTOM 0xFF

默认取值

0x00

CRYPTO_ALGOMODE_NOT_SET 0x00

参数描述

确定用于加密服务的算法族

依赖关系

无

CsmHashAlgorithmSecondaryFamilyCustom

取值范围

无

默认取值

无

参数描述

这是自定义算法族的第二个名字

将CRYPTO_ALGOFAM_CUSTOM设置为

CsmHashAlgorithmSecondaryFamily。

依赖关系

无

CsmHashDataMaxLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输入数据长度的最大大小(以字节为单位)

依赖关系

无

CsmHashResultLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输出哈希长度的大小(以字节为单位)

依赖关系

无

CsmMacGenerateConfig

UI名称

描述

CsmMacGenerateAlgorithmFamily

取值范围

CRYPTO_ALGOFAM_3DES 0x13

默认取值

无

CRYPTO_ALGOFAM_AES 0x14

CRYPTO_ALGOFAM_BLAKE_1_256 0x0F

CRYPTO_ALGOFAM_BLAKE_1_512 0x10

CRYPTO_ALGOFAM_BLAKE_2s_256 0x11

CRYPTO_ALGOFAM_BLAKE_2s_512 0x12

CRYPTO_ALGOFAM_CHACHA 0x15

CRYPTO_ALGOFAM_CUSTOM 0xFF

CRYPTO_ALGOFAM_RIPEMD160 0x0E

CRYPTO_ALGOFAM_RNG 0x1B

CRYPTO_ALGOFAM_SHA1 0x01

CRYPTO_ALGOFAM_SHA2_224 0x02

CRYPTO_ALGOFAM_SHA2_256 0x03

CRYPTO_ALGOFAM_SHA2_384 0x04

CRYPTO_ALGOFAM_SHA2_512 0x05

CRYPTO_ALGOFAM_SHA2_512_224 0x06

CRYPTO_ALGOFAM_SHA2_512_256 0x07

CRYPTO_ALGOFAM_SHA3_224 0x08

CRYPTO_ALGOFAM_SHA3_256 0x09

CRYPTO_ALGOFAM_SHA3_384 0x0A

CRYPTO_ALGOFAM_SHA3_512 0x0B

CRYPTO_ALGOFAM_SHA3_SHAKE128 0x0C

CRYPTO_ALGOFAM_SHA3_SHAKE256 0x0D

CRYPTO_ALGOFAM_SIPHASH 0x1C

参数描述

确定用于加密服务的算法族。这个参数定义了算法最重要的部分。

依赖关系

无

CsmMacGenerateAlgorithmFamilyCustom

取值范围

无

默认取值

无

参数描述

如果使用的是CRYPTO_ALGOFAM_CUSTOM，那么这是自定义算法族的名称

CsmMacGenerateAlgorithmFamily

依赖关系

无

CsmMacGenerateAlgorithmKeyLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

确定加密服务使用的算法模式

依赖关系

无

CsmMacGenerateAlgorithmMode

取值范围

CRYPTO_ALGOMODE_CMAC 0x10

默认取值

无

CRYPTO_ALGOMODE_CTRDRBG 0x12

CRYPTO_ALGOMODE_CUSTOM 0xFF

CRYPTO_ALGOMODE_GMAC 0x11

CRYPTO_ALGOMODE_HMAC 0x0f

CRYPTO_ALGOMODE_NOT_SET 0x00

CRYPTO_ALGOMODE_SIPHASH_2_4 0x17

CRYPTO_ALGOMODE_SIPHASH_4_8 0x18

参数描述

确定加密服务使用的算法模式

依赖关系

无

CsmMacGenerateAlgorithmModeCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义算法模式的名称

依赖关系

无

CsmMacGenerateAlgorithmSecondaryFamily

取值范围

CRYPTO_ALGOFAM_NOT_SET 0x00

默认取值

0x00

CRYPTO_ALGOMODE_CUSTOM 0xFF

参数描述

确定用于加密服务的辅助算法族

依赖关系

无

CsmMacGenerateAlgorithmSecondaryFamilyCustom

取值范围

无

默认取值

无

参数描述

这是自定义算法族的第二个名字

将CRYPTO_ALGOFAM_CUSTOM设置为

CsmHashAlgorithmSecondaryFamilyCustom。

依赖关系

无

CsmMacGenerateDataMaxLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输入数据长度的最大大小(以字节为单位)

依赖关系

无

CsmMacGenerateResultLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输出MAC长度的大小(以字节为单位)

依赖关系

无

CsmMacVerifyConfig

UI名称

描述

CsmMacVerifyAlgorithmFamily

取值范围

CRYPTO_ALGOFAM_3DES 0x13

默认取值

无

CRYPTO_ALGOFAM_AES 0x14

CRYPTO_ALGOFAM_BLAKE_1_256 0x0F

CRYPTO_ALGOFAM_BLAKE_1_512 0x10

CRYPTO_ALGOFAM_BLAKE_2s_256 0x11

CRYPTO_ALGOFAM_BLAKE_2s_512 0x12

CRYPTO_ALGOFAM_CHACHA 0x15

CRYPTO_ALGOFAM_RIPEMD160 0x0E

CRYPTO_ALGOFAM_RNG 0x1B

CRYPTO_ALGOFAM_SHA1 0x01

CRYPTO_ALGOFAM_SHA2_224 0x02

CRYPTO_ALGOFAM_SHA2_256 0x03

CRYPTO_ALGOFAM_SHA2_384 0x04

CRYPTO_ALGOFAM_SHA2_512 0x05

CRYPTO_ALGOFAM_SHA2_512_224 0x06

CRYPTO_ALGOFAM_SHA2_512_256 0x07

CRYPTO_ALGOFAM_SHA3_224 0x08

CRYPTO_ALGOFAM_SHA3_256 0x09

CRYPTO_ALGOFAM_SHA3_384 0x0A

CRYPTO_ALGOFAM_SHA3_512 0x0B

CRYPTO_ALGOFAM_SHA3_SHAKE128 0x0C

CRYPTO_ALGOFAM_SHA3_SHAKE256 0x0D

CRYPTO_ALGOFAM_SIPHASH 0x1C

CRYPTO_ALGOMODE_CUSTOM 0xFF

参数描述

确定用于加密服务的算法族。这个参数定义了算法最重要的部分。

依赖关系

无

CsmMacVerifyAlgorithmFamilyCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义算法族的名称

依赖关系

无

CsmMacVerifyAlgorithmKeyLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

MAC密钥的大小(以字节为单位)

依赖关系

无

CsmMacVerifyAlgorithmMode

取值范围

CRYPTO_ALGOMODE_CMAC 0x10

默认取值

无

CRYPTO_ALGOMODE_CTRDRBG 0x12

CRYPTO_ALGOMODE_CUSTOM 0xFF

CRYPTO_ALGOMODE_GMAC 0x11

CRYPTO_ALGOMODE_HMAC 0x0f

CRYPTO_ALGOMODE_NOT_SET 0x00

CRYPTO_ALGOMODE_SIPHASH_2_4 0x17

CRYPTO_ALGOMODE_SIPHASH_4_8 0x18

参数描述

确定加密服务使用的算法模式

依赖关系

无

CsmMacVerifyAlgorithmModeCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义算法模式的名称

依赖关系

无

CsmMacVerifyAlgorithmSecondaryFamily

取值范围

CRYPTO_ALGOFAM_NOT_SET 0x00

默认取值

0x00

CRYPTO_ALGOMODE_CUSTOM 0xFF

参数描述

确定用于加密服务的辅助算法族

依赖关系

无

CsmMacVerifyAlgorithmSecondaryFamilyCustom

取值范围

无

默认取值

无

参数描述

这是自定义算法族的第二个名字

将CRYPTO_ALGOFAM_CUSTOM设置为

CsmHashAlgorithmSecondaryFamilyCustom。

依赖关系

无

CsmMacVerifyCompareLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输入数据长度的最大大小(以字节为单位)

依赖关系

无

CsmMacVerifyDataMaxLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输出MAC长度的大小(以字节为单位)

依赖关系

无

CsmEncryptConfig

UI名称

描述

CsmEn cryptAlgor ithmFamily

取值范围

CRYPTO_ALGOFAM_3DES 0x13

CRYPTO_ALGOFAM_AES 0x14

CRYPTO_ALGOFAM_CHACHA 0x15

CRYPTO_ALGOFAM_CUSTOM 0xFF

CRYPTO_ALGOFAM_ECIES 0x1D

CRYPTO_ALGOFAM_RSA 0x16

默 认取值

无

参数描述

确定用于加 密服务的算法族。这个参数 定义了算法最重要的部分。

依赖关系

无

C smEncryptA lgorithmFa milyCustom

取值范围

无

默 认取值

无

参数描述

这是自定义算法族的名称

使用CRYPTO_ALGOFAM_CUSTO M作为csmencryptalgmfamily

依赖关系

无

CsmEncry ptAlgorith mKeyLength

取值范围

1 .. 4294967295

默 认取值
无 |

参数描述

加密 密钥的大小(以字节为单位)

依赖关系

无

Csm EncryptAlg orithmMode

取值范围

CRYPTO_ALGOMODE_12ROUNDS 0x0d

CRYPTO_ALGOMODE_20ROUNDS 0x0e

CRYPTO_ALGOMODE_8ROUNDS 0x0c

CRYPTO_ALGOMODE_CBC 0x02

CRYPTO_ALGOMODE_CFB 0x03

CRYPTO_ALGOMODE_CTR 0x05

CRYPTO_ALGOMODE_CUSTOM 0xFF

CRYPTO_ALGOMODE_ECB 0x01

CRYPTO_ALGOMODE_NOT_SET 0x00

CRYPTO_ALGOMODE_OFB 0x04

C RYPTO_ALGOMODE_RSAES_OAEP 0x08

CRYPTO_ ALGOMODE_RSAES_PKCS1_v1_5

0x09

CRYPTO_ALGOMODE_XTS 0x06

默 认取值

无

参数描述

确 定加密服务使用的算法模式

依赖关系

无

CsmEncryp tAlgorithm ModeCustom

取值范围

无

默 认取值

无

参数描述

用于加密服 务的自定义算法模式的名称

依赖关系

无

CsmE ncryptAlgo rithmSecon daryFamily

取值范围

CRYPTO_ALGOFAM_NOT_SET 0x00

CRYPTO_ALGOMODE_CUSTOM 0xFF

默 认取值

0x00

参数描述

确定 用于加密服务的辅助算法族

依赖关系

无

CsmEncrypt AlgorithmS econdaryFa milyCustom

取值范围

无

默 认取值
无 |

参数描述

用于加密服务 的自定义辅助算法族的名称

依赖关系

无

Csm EncryptDat aMaxLength

取值范围

1 .. 4294967295

默 认取值
无 |

参数描述

输入数据长度 的最大大小(以字节为单位)

依赖关系

无

CsmEn cryptResul tMaxLength

取值范围

1 .. 4294967295

默 认取值
无 |

参数描述

输输出密码长度 的最大大小(以字节为单位)

依赖关系

无

CsmDecryptConfig

UI名称

描述

CsmDecryptAlgorithmFamily

取值范围

CRYPTO_ALGOFAM_3DES 0x13

默认取值

无

CRYPTO_ALGOFAM_AES 0x14

CRYPTO_ALGOFAM_CHACHA 0x15

CRYPTO_ALGOFAM_CUSTOM 0xFF

CRYPTO_ALGOFAM_ECIES 0x1D

CRYPTO_ALGOFAM_RSA 0x16

参数描述

确定用于加密服务的算法族。这个参数定义了算法最重要的部分。

依赖关系

无

CsmDecryptAlgorithmFamilyCustom

取值范围

无

默认取值

无

参数描述

如果使用CRYPTO_ALGOFAM_CUSTOM作为csmdecryptalgfamily，则自定义算法组的名称。

依赖关系

无

CsmDecryptAlgorithmKeyLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

加密密钥的大小(以字节为单位)

依赖关系

无

CsmDecryptAlgorithmMode

取值范围

CRYPTO_ALGOMODE_12ROUNDS 0x0d

默认取值

无

CRYPTO_ALGOMODE_20ROUNDS 0x0e

CRYPTO_ALGOMODE_8ROUNDS 0x0c

CRYPTO_ALGOMODE_CBC 0x02

CRYPTO_ALGOMODE_CFB 0x03

CRYPTO_ALGOMODE_CTR 0x05

CRYPTO_ALGOMODE_CUSTOM 0xFF

CRYPTO_ALGOMODE_ECB 0x01

CRYPTO_ALGOMODE_OFB 0x04

CRYPTO_ALGOMODE_RSAES_OAEP 0x08

CRYPTO_ALGOMODE_RSAES_PKCS1_v1_5

0x09

CRYPTO_ALGOMODE_XTS 0x06

参数描述

确定加密服务使用的算法模式

依赖关系

无

CsmDecryptAlgorithmModeCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义算法模式的名称

依赖关系

无

CsmDecryptAlgorithmSecondaryFamily

取值范围

CRYPTO_ALGOFAM_NOT_SET 0x00

默认取值

0x00

CRYPTO_ALGOMODE_CUSTOM 0xFF

参数描述

确定用于加密服务的辅助算法族

依赖关系

无

CsmDecryptAlgorithmSecondaryFamilyCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义辅助算法族的名称

依赖关系

无

CsmDecryptDataMaxLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输入数据长度的最大大小(以字节为单位)

依赖关系

无

CsmDecryptResultMaxLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输输出密码长度的最大大小(以字节为单位)

依赖关系

无

CsmAEADEncryptConfig

UI名称

描述

CsmAEADEn cryptAlgor ithmFamily

取值范围

CRYPTO_ALGOFAM_3DES 0x13

CRYPTO_ALGOFAM_AES 0x14

CRYPTO_ALGOFAM_CUSTOM 0xFF

默认取值

无

参数描述

确定用于加密服 务的算法族。这个参数定 义了算法最重要的部分。

依赖关系

无

CsmAE ADEncryptA lgorithmFa milyCustom

取值范围

无

默认取值

无

参数描述

如果使用CRYPTO_ALG OFAM_CUSTOM作为CsmAEADE ncryptAlgorithmFamily， 则自定义算法组的名称。

依赖关系

无

Cs mAEADEncry ptAlgorith mKeyLength

取值范围

1 .. 4294967295

默认取值
无 |

参数描述

AEAD加密密 钥的大小(以字节为单位)

依赖关系

无

CsmAEAD EncryptAlg orithmMode

取值范围

CRYPTO_ALGOMODE_CUSTOM 0xFF

CRYPTO_ALGOMODE_GCM 0x07

默认取值

无

参数描述

确定 加密服务使用的算法模式

依赖关系

无

Csm AEADEncryp tAlgorithm ModeCustom

取值范围

无

默认取值

无

参数描述

用于加密服务 的自定义算法模式的名称

依赖关系

无

CsmAEAD EncryptAss ociatedDat aMaxLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

确定用 于加密服务的辅助算法族

依赖关系

无

Csm AEADEncryp tCiphertex tMaxLength

取值范围

1 .. 4294967295

默认取值
无 |

参数描述

输出密文长度的 最大大小(以字节为单位)

依赖关系

无

Cs mAEADEncry ptPlaintex tMaxLength

取值范围

1 .. 4294967295

默认取值
无 |

参数描述

输入明文长度的 最大大小(以字节为单位)

依赖关系

无

Csm AEADEncryp tTagLength

取值范围

1 .. 4294967295

默认取值
无 |

参数描述

输出标记长 度的大小(以字节为单位)

依赖关系

无

CsmAEADEnc ryptKeyRef

取值范围

无

默认取值
无 |

参数描述

此参数引 用用于该加密原语的密钥

依赖关系

CsmKey

Cs mAEADEncry ptQueueRef

取值范围

无

默认取值
无 |

参数描述

此参数引 用用于该加密原语的队列

依赖关系

CsmQueue

CsmAEADDecryptConfig

UI名称

描述

CsmAEADDecryptAlgorithmFamily

取值范围

CRYPTO_ALGOFAM_3DES 0x13

默认取值

无

CRYPTO_ALGOFAM_AES 0x14

CRYPTO_ALGOFAM_CUSTOM 0xFF

参数描述

确定用于加密服务的算法族。 这个参数定义了算法最重要的部分。

依赖关系

无

CsmAEADDecryptAlgorithmFamilyCustom

取值范围

无

如果使用CRYPTO_ALGOFAM_CUSTOM 作为Csm AEADDecryptAlgorithmFamily， 则自定义算法组的名称。

依赖关系

无

CsmAEADDecryptAlgorithmKeyLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

AEAD解密密钥的大小(以字节为单位)

依赖关系

无

CsmAEADDecryptAlgorithmModeCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义算法模式的名称

依赖关系

无

CsmAEADDecryptAssociatedDataMaxLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输入相关数据长度的最大 大小(以字节为单位)

依赖关系

无

CsmAEADDecryptCiphertextMaxLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输入密文的最大大小 (以字节为单位)

依赖关系

无

CsmAEADDecryptPlaintextMaxLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输出明文长度的大小 (以字节为单位)

依赖关系

无

CsmAEADDecryptTagLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输入标记长度的大小 (以位为单位)

依赖关系

无

CsmAEADDecryptKeyRef

取值范围

无

默认取值

无

参数描述

此参数引用用于该 解密原语的密钥

依赖关系

CsmKey

CsmAEADDecryptQueueRef

取值范围

无

默认取值

无

参数描述

此参数引用用于该 解密原语的队列

依赖关系

CsmQueue

CsmSignatureGenerateConfig

UI名称

描述

CsmSignatureGenerateAlgorithmFamily

取值范围

CRYPTO_ALGOFAM_BRAINPOOL 0x15

默认取值

无

CRYPTO_ALGOFAM_ECCNIST 0x16

CRYPTO_ALGOFAM_3DES 0x13

CRYPTO_ALGOFAM_AES 0x14

CRYPTO_ALGOFAM_CUSTOM 0xFF

参数描述

确定用于加密服务的算法族。这个参数 定义了算法最重要的部分。

依赖关系

无

CsmSignatureGenerateAlgorithmFamilyCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义算法族的名称。

这是自定义算法族的名称

这里使用的是CRYPTO_ALGOFAM_CUSTOM

CsmSignatureGenerateAlgorithmFamily

依赖关系

无

CsmSignatureGenerateAlgorithmMode

取值范围

CRYPTO_ALGOMODE_CUSTOM 0xFF

默认取值

无

CRYPTO_ALGOMODE_NOT_SET 0x00

CRYPTO_ALGOMODE_RSASSA_PKCS1_v1_5 0x0b

CRYPTO_ALGOMODE_RSASSA_PSS 0x0a

参数描述

确定加密服务使用的算法模式

依赖关系

无

CsmSignatureGenerateAlgorithmModeCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义算法模式的名称

依赖关系

无

CsmSignatureGenerateAlgorithmSecondaryFamily

取值范围

CRYPTO_ALGOFAM_BLAKE_1_256 0x0F

默认取值

无

CRYPTO_ALGOFAM_BLAKE_1_512 0x10

CRYPTO_ALGOFAM_BLAKE_2s_256 0x11

CRYPTO_ALGOFAM_BLAKE_2s_512 0x12

CRYPTO_ALGOFAM_CUSTOM 0xFF

CRYPTO_ALGOFAM_NOT_SET 0x00

CRYPTO_ALGOFAM_RIPEMD160 0x0E

CRYPTO_ALGOFAM_SHA1 0x01

CRYPTO_ALGOFAM_SHA2_224 0x02

CRYPTO_ALGOFAM_SHA2_256 0x03

CRYPTO_ALGOFAM_SHA2_384 0x04

CRYPTO_ALGOFAM_SHA2_512 0x05

CRYPTO_ALGOFAM_SHA2_512_224 0x06

CRYPTO_ALGOFAM_SHA2_512_256 0x07

CRYPTO_ALGOFAM_SHA3_224 0x08

CRYPTO_ALGOFAM_SHA3_256 0x09

CRYPTO_ALGOFAM_SHA3_384 0x0A

CRYPTO_ALGOFAM_SHA3_512 0x0B

CRYPTO_ALGOFAM_SHA3_SHAKE128 0x0C

CRYPTO_ALGOFAM_SHA3_SHAKE256 0x0D

参数描述

确定加密服务使用的算法模式

依赖关系

无

CsmSignatureGenerateAlgorithmSecondaryFamilyCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义辅助算法族的名称。 这是自定义算法族的第二个名字

将CRYPTO_ALGOFAM_CUSTOM设置为

CsmSignatureGenerateAlgorithm SecondaryFamily。

依赖关系

无

CsmSignatureGenerateDataMaxLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输入数据长度的大小(以字节为单位)

依赖关系

无

CsmSignatureGenerateKeyLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

Sign的大小以字节为单位生成密钥

依赖关系

无

CsmSignatureGenerateResultLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输出签名长度的大小(以字节为单位)

依赖关系

无

CsmSignatureVerifyConfig

UI名称

描述

CsmSignatureVerifyAlgorithmFamily

取值范围

CRYPTO_ALGOFAM_BRAINPOOL 0x15

默认取值

无

CRYPTO_ALGOFAM_ECCNIST 0x16

CRYPTO_ALGOFAM_3DES 0x13

CRYPTO_ALGOFAM_AES 0x14

CRYPTO_ALGOFAM_CUSTOM 0xFF

参数描述

确定用于加密服务的算法族。这个参数 定义了算法最重要的部分。

依赖关系

无

CsmSignatureVerifyAlgorithmFamilyCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义算法族的名称。

这是自定义算法族的名称

这里使用的是CRYPTO_ALGOFAM_CUSTOM

CsmSignatureVerifyAlgorithmFamily

依赖关系

无

CsmSignatureVerifyAlgorithmMode

取值范围

CRYPTO_ALGOMODE_CUSTOM 0xFF

默认取值

无

CRYPTO_ALGOMODE_NOT_SET 0x00

CRYPTO_ALGOMODE_RSASSA_PKCS1_v1_5 0x0b

CRYPTO_ALGOMODE_RSASSA_PSS 0x0a

参数描述

确定加密服务使用的算法模式

依赖关系

无

CsmSignatureVerifyAlgorithmModeCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义算法模式的名称

依赖关系

无

CsmSignatureVerifyAlgorithmSecondaryFamily

取值范围

CRYPTO_ALGOFAM_BLAKE_1_256 0x0F

默认取值

无

CRYPTO_ALGOFAM_BLAKE_1_512 0x10

CRYPTO_ALGOFAM_BLAKE_2s_256 0x11

CRYPTO_ALGOFAM_BLAKE_2s_512 0x12

CRYPTO_ALGOFAM_CUSTOM 0xFF

CRYPTO_ALGOFAM_NOT_SET 0x00

CRYPTO_ALGOFAM_RIPEMD160 0x0E

CRYPTO_ALGOFAM_SHA1 0x01

CRYPTO_ALGOFAM_SHA2_224 0x02

CRYPTO_ALGOFAM_SHA2_256 0x03

CRYPTO_ALGOFAM_SHA2_384 0x04

CRYPTO_ALGOFAM_SHA2_512 0x05

CRYPTO_ALGOFAM_SHA2_512_224 0x06

CRYPTO_ALGOFAM_SHA2_512_256 0x07

CRYPTO_ALGOFAM_SHA3_224 0x08

CRYPTO_ALGOFAM_SHA3_256 0x09

CRYPTO_ALGOFAM_SHA3_384 0x0A

CRYPTO_ALGOFAM_SHA3_512 0x0B

CRYPTO_ALGOFAM_SHA3_SHAKE128 0x0C

CRYPTO_ALGOFAM_SHA3_SHAKE256 0x0D

参数描述

确定加密服务使用的算法模式

依赖关系

无

CsmSignatureVerifyAlgorithmSecondaryFamilyCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义辅助算法族的名称。 这是自定义算法族的第二个名字

将CRYPTO_ALGOFAM_CUSTOM设置为

CsmSignatureVerifyAlgorithmFamily。

依赖关系

无

CsmSignatureVerifyCompareLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

输入数据长度的大小(以字节为单位)

依赖关系

无

CsmSignatureVerifyDataMaxLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

Sign的大小以字节为单位生成密钥

依赖关系

无

CsmSignatureVerifyKeyLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

Sign验证密钥的大小(以字节为单位)

依赖关系

无

CsmRandomGenerateConfig

UI名称

描述

CsmRandomGenerateAlgorithmFamily

取值范围

CRYPTO_ALGOFAM_3DES 0x13

默认取值

无

CRYPTO_ALGOFAM_AES 0x14

CRYPTO_ALGOFAM_BLAKE_1_256 0x0F

CRYPTO_ALGOFAM_BLAKE_1_512 0x10

CRYPTO_ALGOFAM_BLAKE_2s_256 0x11

CRYPTO_ALGOFAM_BLAKE_2s_512 0x12

CRYPTO_ALGOFAM_CHACHA 0x15

CRYPTO_ALGOFAM_CUSTOM 0xFF

CRYPTO_ALGOFAM_RIPEMD160 0x0E

CRYPTO_ALGOFAM_RNG 0x1B

CRYPTO_ALGOFAM_SHA1 0x01

CRYPTO_ALGOFAM_SHA2_224 0x02

CRYPTO_ALGOFAM_SHA2_256 0x03

CRYPTO_ALGOFAM_SHA2_384 0x04

CRYPTO_ALGOFAM_SHA2_512 0x05

CRYPTO_ALGOFAM_SHA2_512_224 0x06

CRYPTO_ALGOFAM_SHA2_512_256 0x07

CRYPTO_ALGOFAM_SHA3_224 0x08

CRYPTO_ALGOFAM_SHA3_256 0x09

CRYPTO_ALGOFAM_SHA3_384 0x0A

CRYPTO_ALGOFAM_SHA3_512 0x0B

CRYPTO_ALGOFAM_SHA3_SHAKE128 0x0C

CRYPTO_ALGOFAM_SHA3_SHAKE256 0x0D

参数描述

确定用于加密服务的算法族。这个参数 定义了算法最重要的部分。

依赖关系

无

CsmRandomGenerateAlgorithmFamilyCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义算法族的名称。

这是自定义算法族的名称

这里使用的是CRYPTO_ALGOFAM_CUSTOM

CsmRandomAlgorithmFamily

依赖关系

无

CsmRandomGenerateAlgorithmMode

取值范围

CRYPTO_ALGOMODE_CMAC 0x10

默认取值

无

CRYPTO_ALGOMODE_CTRDRBG 0x12

CRYPTO_ALGOMODE_CUSTOM 0xFF

CRYPTO_ALGOMODE_GMAC 0x11

CRYPTO_ALGOMODE_HMAC 0x0f

CRYPTO_ALGOMODE_NOT_SET 0x00

CRYPTO_ALGOMODE_SIPHASH_2_4 0x17

CRYPTO_ALGOMODE_SIPHASH_4_8 0x18

参数描述

确定加密服务使用的算法模式

依赖关系

无

CsmRandomGenerateAlgorithmModeCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义算法模式的名称。 这是自定义算法族的名称

这里使用的是CRYPTO_ALGOFAM_CUSTOM

CsmRandomGenerateAlgorithmFamily。

依赖关系

无

CsmRandomGenerateAlgorithmSecondaryFamily

取值范围

CRYPTO_ALGOFAM_CUSTOM 0xFF

默认取值

无

CRYPTO_ALGOFAM_NOT_SET 0x00

参数描述

确定用于加密服务的算法族

依赖关系

无

CsmRandomGenerateAlgorithmSecondaryFamilyCustom

取值范围

无

默认取值

无

参数描述

用于加密服务的自定义辅助算法族的名 称。这是自定义算法族的第二个名字

将CRYPTO_ALGOFAM_CUSTOM设置为

CsmRandomGenerateResultLength

取值范围

1 .. 4294967295

默认取值

无

参数描述

随机生成密钥的大小(以字节为单位)

依赖关系

无

CsmJobKeySetValid

UI名称

描述

CsmJobK eySetValid

取值范围

无

默认 取值

无

参数描述

KeySetValid原语的配置

依赖关系

无

CsmCallback

image14

图 CsmPCallback容器配置图

表 CsmPCallback属性描述

UI名称

描述

CsmCa llbackFunc

取值范围

无

默认 取值

无

参数描述

在异 步操作完成时调用的回调函数。

必 须将相应的job配置为异步处理。

依赖关系

无

Csm CallbackId

取值范围

0 .. 4294967295

默认 取值

无

参数描述

回调 函数的标识符。实际配置的标识 符集应该是连续的、无间隙的。

依赖关系

此ID是按照0开始按升序方式自动 生成，需要保证配置的CallBack 函数个数必须小于异步Job的个数