Google 致力于为黑人社区推动种族平等。查看具体行动。

此页面由 Cloud Translation API 翻译。

加密 - 平台

此模块包含 Crypto 的平台抽象。

摘要

枚举
`anonymous enum{ OT_CRYPTO_KEY_USAGE_NONE = 0, OT_CRYPTO_KEY_USAGE_EXPORT = 1 << 0, OT_CRYPTO_KEY_USAGE_ENCRYPT = 1 << 1, OT_CRYPTO_KEY_USAGE_DECRYPT = 1 << 2, OT_CRYPTO_KEY_USAGE_SIGN_HASH = 1 << 3, OT_CRYPTO_KEY_USAGE_VERIFY_HASH = 1 << 4 }`	枚举定义密钥用法标志。
`otCryptoKeyAlgorithm{ OT_CRYPTO_KEY_ALG_VENDOR, OT_CRYPTO_KEY_ALG_AES_ECB, OT_CRYPTO_KEY_ALG_HMAC_SHA_256, OT_CRYPTO_KEY_ALG_ECDSA }`	枚举定义关键算法。
`otCryptoKeyStorage{ OT_CRYPTO_KEY_STORAGE_VOLATILE, OT_CRYPTO_KEY_STORAGE_PERSISTENT }`	枚举定义密钥存储类型。
`otCryptoKeyType{ OT_CRYPTO_KEY_TYPE_RAW, OT_CRYPTO_KEY_TYPE_AES, OT_CRYPTO_KEY_TYPE_HMAC, OT_CRYPTO_KEY_TYPE_ECDSA }`	枚举定义密钥类型。

类型定义符
`otCryptoContext`	typedef `struct otCryptoContext`
`otCryptoKey`	typedef `struct otCryptoKey`
`otCryptoKeyRef`	typedef `uint32_t` 此数据类型表示键引用。
`otPlatCryptoEcdsaKeyPair`	typedef `struct otPlatCryptoEcdsaKeyPair`
`otPlatCryptoEcdsaPublicKey`	typedef `struct otPlatCryptoEcdsaPublicKey`
`otPlatCryptoEcdsaSignature`	typedef `struct otPlatCryptoEcdsaSignature`
`otPlatCryptoSha256Hash`	typedef `struct otPlatCryptoSha256Hash` 表示 SHA-256 哈希值。

变量
`OT_TOOL_PACKED_END`	`OT_TOOL_PACKED_BEGIN struct otPlatCryptoSha256Hash`

函数
`otPlatCryptoAesEncrypt(otCryptoContext aContext, const uint8_t aInput, uint8_t *aOutput)`	`otError` 加密给定数据。
`otPlatCryptoAesFree(otCryptoContext *aContext)`	`otError` 释放 AES 上下文。
`otPlatCryptoAesInit(otCryptoContext *aContext)`	`otError` 初始化 AES 操作。
`otPlatCryptoAesSetKey(otCryptoContext aContext, const otCryptoKey aKey)`	`otError` 为 AES 操作设置密钥。
`otPlatCryptoDestroyKey(otCryptoKeyRef aKeyRef)`	`otError` 销毁存储在 PSA ITS 中的密钥。
`otPlatCryptoEcdsaExportPublicKey(otCryptoKeyRef aKeyRef, otPlatCryptoEcdsaPublicKey *aPublicKey)`	`otError` 从传递的密钥引用中获取关联的公钥。
`otPlatCryptoEcdsaGenerateAndImportKey(otCryptoKeyRef aKeyRef)`	`otError` 在传递引用时生成并导入新的 ECDSA 密钥对。
`otPlatCryptoEcdsaGenerateKey(otPlatCryptoEcdsaKeyPair *aKeyPair)`	`otError` 生成并使用新的 ECDSA 密钥对填充输出缓冲区。
`otPlatCryptoEcdsaGetPublicKey(const otPlatCryptoEcdsaKeyPair aKeyPair, otPlatCryptoEcdsaPublicKey aPublicKey)`	`otError` 从输入上下文获取关联的公钥。
`otPlatCryptoEcdsaSign(const otPlatCryptoEcdsaKeyPair aKeyPair, const otPlatCryptoSha256Hash aHash, otPlatCryptoEcdsaSignature *aSignature)`	`otError` 使用输入上下文中的私钥计算经过哈希处理的消息的 ECDSA 签名。
`otPlatCryptoEcdsaSignUsingKeyRef(otCryptoKeyRef aKeyRef, const otPlatCryptoSha256Hash aHash, otPlatCryptoEcdsaSignature aSignature)`	`otError` 使用传递的密钥引用计算经过哈希处理的消息的 ECDSA 签名。
`otPlatCryptoEcdsaVerify(const otPlatCryptoEcdsaPublicKey aPublicKey, const otPlatCryptoSha256Hash aHash, const otPlatCryptoEcdsaSignature *aSignature)`	`otError` 使用输入上下文中的密钥来验证经过哈希处理的消息的 ECDSA 签名。
`otPlatCryptoEcdsaVerifyUsingKeyRef(otCryptoKeyRef aKeyRef, const otPlatCryptoSha256Hash aHash, const otPlatCryptoEcdsaSignature aSignature)`	`otError` 使用 keyref 验证经过哈希处理的消息的 ECDSA 签名。
`otPlatCryptoExportKey(otCryptoKeyRef aKeyRef, uint8_t aBuffer, size_t aBufferLen, size_t aKeyLen)`	`otError` 导出存储在 PSA ITS 中的密钥。
`otPlatCryptoHasKey(otCryptoKeyRef aKeyRef)`	`bool` 检查通过的密钥引用是否在 PSA ITS 中具有关联的密钥。
`otPlatCryptoHkdfDeinit(otCryptoContext *aContext)`	`otError` 取消初始化 HKDF 上下文。
`otPlatCryptoHkdfExpand(otCryptoContext aContext, const uint8_t aInfo, uint16_t aInfoLength, uint8_t *aOutputKey, uint16_t aOutputKeyLength)`	`otError` 执行 HKDF 展开步骤。
`otPlatCryptoHkdfExtract(otCryptoContext aContext, const uint8_t aSalt, uint16_t aSaltLength, const otCryptoKey *aInputKey)`	`otError` 执行 HKDF 提取步骤。
`otPlatCryptoHkdfInit(otCryptoContext *aContext)`	`otError` 初始化 HKDF 上下文。
`otPlatCryptoHmacSha256Deinit(otCryptoContext *aContext)`	`otError` 取消初始化 HMAC 操作。
`otPlatCryptoHmacSha256Finish(otCryptoContext aContext, uint8_t aBuf, size_t aBufLength)`	`otError` 完成 HMAC 操作。
`otPlatCryptoHmacSha256Init(otCryptoContext *aContext)`	`otError` 初始化 HMAC 操作。
`otPlatCryptoHmacSha256Start(otCryptoContext aContext, const otCryptoKey aKey)`	`otError` 启动 HMAC 操作。
`otPlatCryptoHmacSha256Update(otCryptoContext aContext, const void aBuf, uint16_t aBufLength)`	`otError` 使用新的输入更新 HMAC 操作。
`otPlatCryptoImportKey(otCryptoKeyRef aKeyRef, otCryptoKeyType aKeyType, otCryptoKeyAlgorithm aKeyAlgorithm, int aKeyUsage, otCryptoKeyStorage aKeyPersistence, const uint8_t aKey, size_t aKeyLen)`	`otError` 将密钥导入 PSA ITS。
`otPlatCryptoInit(void)`	`void` 初始化 Crypto 模块。
`otPlatCryptoPbkdf2GenerateKey(const uint8_t aPassword, uint16_t aPasswordLen, const uint8_t aSalt, uint16_t aSaltLen, uint32_t aIterationCounter, uint16_t aKeyLen, uint8_t *aKey)`	`otError` 使用 CMAC (AES-CMAC-PRF-128) 执行 PKCS#5 PBKDF2。
`otPlatCryptoRandomDeinit(void)`	`void` 解初始化加密安全的伪随机数生成器 (CSPRNG)。
`otPlatCryptoRandomGet(uint8_t *aBuffer, uint16_t aSize)`	`otError` 使用能够确保加密安全的随机字节填充给定缓冲区。
`otPlatCryptoRandomInit(void)`	`void` 初始化加密安全的伪随机数生成器 (CSPRNG)。
`otPlatCryptoSha256Deinit(otCryptoContext *aContext)`	`otError` 取消初始化 SHA-256 操作。
`otPlatCryptoSha256Finish(otCryptoContext aContext, uint8_t aHash, uint16_t aHashSize)`	`otError` 完成 SHA-256 操作。
`otPlatCryptoSha256Init(otCryptoContext *aContext)`	`otError` 初始化 SHA-256 操作。
`otPlatCryptoSha256Start(otCryptoContext *aContext)`	`otError` 启动 SHA-256 操作。
`otPlatCryptoSha256Update(otCryptoContext aContext, const void aBuf, uint16_t aBufLength)`	`otError` 使用新输入更新 SHA-256 操作。

结构体
otCryptoContext	存储平台 API 的上下文对象。
otCryptoKey	表示加密操作所需的密钥材料。
otPlatCryptoEcdsaKeyPair	表示 ECDSA 密钥对（公钥和私钥）。
otPlatCryptoEcdsaPublicKey	表示 ECDSA 公钥。
otPlatCryptoEcdsaSignature	表示 ECDSA 签名。
otPlatCryptoSha256Hash	表示 SHA-256 哈希值。

枚举

匿名枚举

 anonymous enum

定义密钥用法标志。

属性
`OT_CRYPTO_KEY_USAGE_DECRYPT`	密钥用法：AES ECB。
`OT_CRYPTO_KEY_USAGE_ENCRYPT`	密钥用途：加密（由供应商定义）。
`OT_CRYPTO_KEY_USAGE_EXPORT`	密钥用途：密钥可以导出。
`OT_CRYPTO_KEY_USAGE_NONE`	密钥用途：密钥用途为空。
`OT_CRYPTO_KEY_USAGE_SIGN_HASH`	密钥用途：签名哈希。
`OT_CRYPTO_KEY_USAGE_VERIFY_HASH`	密钥用途：验证哈希。

otCryptoKeyAlgorithm

 otCryptoKeyAlgorithm

定义关键算法。

属性
`OT_CRYPTO_KEY_ALG_AES_ECB`	密钥算法：AES ECB。
`OT_CRYPTO_KEY_ALG_ECDSA`	密钥算法：ECDSA。
`OT_CRYPTO_KEY_ALG_HMAC_SHA_256`	密钥算法：HMAC SHA-256。
`OT_CRYPTO_KEY_ALG_VENDOR`	密钥算法：由供应商定义。

otCryptoKeyStorage

 otCryptoKeyStorage

定义密钥存储类型。

属性
`OT_CRYPTO_KEY_STORAGE_PERSISTENT`	密钥持久性：密钥是永久性的。
`OT_CRYPTO_KEY_STORAGE_VOLATILE`	键持久性：键具有易失性。

otCryptoKeyType

 otCryptoKeyType

定义密钥类型。

属性
`OT_CRYPTO_KEY_TYPE_AES`	密钥类型：AES。
`OT_CRYPTO_KEY_TYPE_ECDSA`	密钥类型：ECDSA。
`OT_CRYPTO_KEY_TYPE_HMAC`	密钥类型：HMAC。
`OT_CRYPTO_KEY_TYPE_RAW`	密钥类型：原始数据。

类型定义符

otCryptoContext

struct otCryptoContext otCryptoContext

otCryptoKey

struct otCryptoKey otCryptoKey

otCryptoKeyRef

uint32_t otCryptoKeyRef

此数据类型表示键引用。

otPlatCryptoEcdsaKeyPair

struct otPlatCryptoEcdsaKeyPair otPlatCryptoEcdsaKeyPair

otPlatCryptoEcdsaPublicKey

struct otPlatCryptoEcdsaPublicKey otPlatCryptoEcdsaPublicKey

otPlatCryptoEcdsaSignature

struct otPlatCryptoEcdsaSignature otPlatCryptoEcdsaSignature

otPlatCryptoSha256Hash

struct otPlatCryptoSha256Hash otPlatCryptoSha256Hash

表示 SHA-256 哈希值。

变量

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otPlatCryptoSha256Hash OT_TOOL_PACKED_END

函数

otPlatCryptoAesEncrypt

otError otPlatCryptoAesEncrypt(
  otCryptoContext *aContext,
  const uint8_t *aInput,
  uint8_t *aOutput
)

加密给定数据。

具体说明

参数

`[in] aContext`	AES 操作的上下文。
`[in] aInput`	指向输入缓冲区的指针。
`[in] aOutput`	指向输出缓冲区的指针。

返回值

`OT_ERROR_NONE`	已成功加密“`aInput`”。
`OT_ERROR_FAILED`	未能加密“`aInput`”。
`OT_ERROR_INVALID_ARGS`	`aContext`、`aKey` 或 `aOutput` 为 NULL

otPlatCryptoAesFree

otError otPlatCryptoAesFree(
  otCryptoContext *aContext
)

释放 AES 上下文。

具体说明

参数

[in] aContext

AES 操作的上下文。

返回值

`OT_ERROR_NONE`	已成功释放 AES 上下文。
`OT_ERROR_FAILED`	未能释放 AES 上下文。
`OT_ERROR_INVALID_ARGS`	“`aContext`”原为 NULL

otPlatCryptoAesInit

otError otPlatCryptoAesInit(
  otCryptoContext *aContext
)

初始化 AES 操作。

具体说明

参数

[in] aContext

AES 操作的上下文。

返回值

`OT_ERROR_NONE`	已成功初始化 AES 操作。
`OT_ERROR_FAILED`	无法初始化 AES 操作。
`OT_ERROR_INVALID_ARGS`	“`aContext`”原为 NULL
`OT_ERROR_NO_BUFS`	无法分配上下文。

otPlatCryptoAesSetKey

otError otPlatCryptoAesSetKey(
  otCryptoContext *aContext,
  const otCryptoKey *aKey
)

为 AES 操作设置密钥。

具体说明

参数

`[in] aContext`	AES 操作的上下文。
`[out] aKey`	用于 AES 操作的密钥。

返回值

`OT_ERROR_NONE`	已成功设置用于 AES 操作的密钥。
`OT_ERROR_FAILED`	未能设置用于 AES 操作的密钥。
`OT_ERROR_INVALID_ARGS`	`aContext` 或 `aKey` 为 NULL

otPlatCryptoDestroyKey

otError otPlatCryptoDestroyKey(
  otCryptoKeyRef aKeyRef
)

销毁存储在 PSA ITS 中的密钥。

注意：只有启用 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE 时，OT 核心才会使用此 API。

具体说明

参数

[in] aKeyRef

要销毁的密钥引用

返回值

`OT_ERROR_NONE`	已成功销毁密钥。
`OT_ERROR_FAILED`	未能销毁密钥。

otPlatCryptoEcdsaExportPublicKey

otError otPlatCryptoEcdsaExportPublicKey(
  otCryptoKeyRef aKeyRef,
  otPlatCryptoEcdsaPublicKey *aPublicKey
)

从传递的密钥引用中获取关联的公钥。

公钥的存储方式因所使用的加密后端库 (OPENTHREAD_CONFIG_CRYPTO_LIB) 而异。

此 API 必须确保以未压缩曲线点的字节序列表示形式返回公钥（RFC 6605 - 第 4 节）

注意：只有启用 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE 时，OT 核心才会使用此 API。

具体说明

参数

`[in] aKeyRef`	对存储密钥对的槽位的键引用。
`[out] aPublicKey`	指向用于存储公钥的 ECDSA 公钥结构的指针。

返回值

`OT_ERROR_NONE`	已成功检索公钥，并且已更新 `aBuffer`。
`OT_ERROR_PARSE`	无法解析密钥对 DER 格式（格式无效）。
`OT_ERROR_INVALID_ARGS`	`aContext` 为 NULL。

otPlatCryptoEcdsaGenerateAndImportKey

otError otPlatCryptoEcdsaGenerateAndImportKey(
  otCryptoKeyRef aKeyRef
)

在传递引用时生成并导入新的 ECDSA 密钥对。

注意：只有启用 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE 时，OT 核心才会使用此 API。

具体说明

参数

[in] aKeyRef

对存储密钥对的槽位的键引用。

返回值

`OT_ERROR_NONE`	已成功生成新密钥对。
`OT_ERROR_NO_BUFS`	未能为生成密钥分配缓冲区。
`OT_ERROR_NOT_CAPABLE`	不支持此功能。
`OT_ERROR_FAILED`	未能生成密钥对。

otPlatCryptoEcdsaGenerateKey

otError otPlatCryptoEcdsaGenerateKey(
  otPlatCryptoEcdsaKeyPair *aKeyPair
)

生成并使用新的 ECDSA 密钥对填充输出缓冲区。

具体说明

参数

[out] aKeyPair

指向 ECDSA 密钥对结构的指针，用于存储生成的密钥对。

返回值

`OT_ERROR_NONE`	已成功生成新密钥对。
`OT_ERROR_NO_BUFS`	未能为生成密钥分配缓冲区。
`OT_ERROR_NOT_CAPABLE`	不支持此功能。
`OT_ERROR_FAILED`	未能生成密钥对。

otPlatCryptoEcdsaGetPublicKey

otError otPlatCryptoEcdsaGetPublicKey(
  const otPlatCryptoEcdsaKeyPair *aKeyPair,
  otPlatCryptoEcdsaPublicKey *aPublicKey
)

从输入上下文获取关联的公钥。

具体说明

参数

`[in] aKeyPair`	指向存储密钥对的 ECDSA 密钥对结构的指针。
`[out] aPublicKey`	指向用于存储公钥的 ECDSA 公钥结构的指针。

返回值

`OT_ERROR_NONE`	已成功检索公钥，并且已更新 `aBuffer`。
`OT_ERROR_PARSE`	无法解析密钥对 DER 格式（格式无效）。
`OT_ERROR_INVALID_ARGS`	`aContext` 为 NULL。

otPlatCryptoEcdsaSign

otError otPlatCryptoEcdsaSign(
  const otPlatCryptoEcdsaKeyPair *aKeyPair,
  const otPlatCryptoSha256Hash *aHash,
  otPlatCryptoEcdsaSignature *aSignature
)

使用输入上下文中的私钥计算经过哈希处理的消息的 ECDSA 签名。

使用 RFC 6979 中的确定性数字签名生成过程。

具体说明

参数

`[in] aKeyPair`	指向存储密钥对的 ECDSA 密钥对结构的指针。
`[in] aHash`	指向用于存储签名计算哈希值的 SHA-256 哈希结构的指针。
`[out] aSignature`	指向 ECDSA 签名结构的指针，用于输出计算得出的签名。

返回值

`OT_ERROR_NONE`	已成功计算签名，已更新 `aSignature`。
`OT_ERROR_PARSE`	无法解析密钥对 DER 格式（格式无效）。
`OT_ERROR_NO_BUFS`	未能为签名计算分配缓冲区。
`OT_ERROR_INVALID_ARGS`	`aContext` 为 NULL。

otPlatCryptoEcdsaSignUsingKeyRef

otError otPlatCryptoEcdsaSignUsingKeyRef(
  otCryptoKeyRef aKeyRef,
  const otPlatCryptoSha256Hash *aHash,
  otPlatCryptoEcdsaSignature *aSignature
)

使用传递的密钥引用计算经过哈希处理的消息的 ECDSA 签名。

使用 RFC 6979 中的确定性数字签名生成过程。

注意：只有启用 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE 时，OT 核心才会使用此 API。

具体说明

参数

`[in] aKeyRef`	对存储密钥对的槽位的键引用。
`[in] aHash`	指向用于存储签名计算哈希值的 SHA-256 哈希结构的指针。
`[out] aSignature`	指向 ECDSA 签名结构的指针，用于输出计算得出的签名。

返回值

`OT_ERROR_NONE`	已成功计算签名，已更新 `aSignature`。
`OT_ERROR_PARSE`	无法解析密钥对 DER 格式（格式无效）。
`OT_ERROR_NO_BUFS`	未能为签名计算分配缓冲区。
`OT_ERROR_INVALID_ARGS`	`aContext` 为 NULL。

otPlatCryptoEcdsaVerify

otError otPlatCryptoEcdsaVerify(
  const otPlatCryptoEcdsaPublicKey *aPublicKey,
  const otPlatCryptoSha256Hash *aHash,
  const otPlatCryptoEcdsaSignature *aSignature
)

使用输入上下文中的密钥来验证经过哈希处理的消息的 ECDSA 签名。

具体说明

参数

`[in] aPublicKey`	指向用于存储签名验证公钥的 ECDSA 公钥结构的指针。
`[in] aHash`	指向用于存储签名验证哈希值的 SHA-256 哈希结构的指针。
`[in] aSignature`	指向存储要验证的签名值的 ECDSA 签名结构的指针。

返回值

`OT_ERROR_NONE`	签名已成功通过验证。
`OT_ERROR_SECURITY`	签名无效。
`OT_ERROR_INVALID_ARGS`	密钥或哈希值无效。
`OT_ERROR_NO_BUFS`	未能为签名验证分配缓冲区。

otPlatCryptoEcdsaVerifyUsingKeyRef

otError otPlatCryptoEcdsaVerifyUsingKeyRef(
  otCryptoKeyRef aKeyRef,
  const otPlatCryptoSha256Hash *aHash,
  const otPlatCryptoEcdsaSignature *aSignature
)

使用 keyref 验证经过哈希处理的消息的 ECDSA 签名。

注意：只有启用 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE 时，OT 核心才会使用此 API。

具体说明

参数

`[in] aKeyRef`	对存储密钥对的槽位的键引用。
`[in] aHash`	指向用于存储签名验证哈希值的 SHA-256 哈希结构的指针。
`[in] aSignature`	指向存储要验证的签名值的 ECDSA 签名结构的指针。

返回值

`OT_ERROR_NONE`	签名已成功通过验证。
`OT_ERROR_SECURITY`	签名无效。
`OT_ERROR_INVALID_ARGS`	密钥或哈希值无效。
`OT_ERROR_NO_BUFS`	未能为签名验证分配缓冲区。

otPlatCryptoExportKey

otError otPlatCryptoExportKey(
  otCryptoKeyRef aKeyRef,
  uint8_t *aBuffer,
  size_t aBufferLen,
  size_t *aKeyLen
)

导出存储在 PSA ITS 中的密钥。

注意：只有启用 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE 时，OT 核心才会使用此 API。

具体说明

参数

`[in] aKeyRef`	用于加密操作的密钥引用。
`[out] aBuffer`	指向需要将密钥导出到的缓冲区的指针。
`[in] aBufferLen`	为存储所导出密钥而传递的缓冲区的长度。
`[out] aKeyLen`	用于返回所导出密钥长度的指针。

返回值

`OT_ERROR_NONE`	已成功导出“`aKeyRef`”。
`OT_ERROR_FAILED`	未能导出“`aKeyRef`”。
`OT_ERROR_INVALID_ARGS`	“`aBuffer`”原为 NULL

otPlatCryptoHasKey

bool otPlatCryptoHasKey(
  otCryptoKeyRef aKeyRef
)

检查通过的密钥引用是否在 PSA ITS 中具有关联的密钥。

注意：只有启用 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE 时，OT 核心才会使用此 API。

具体说明

参数

[in] aKeyRef

要检查的按键参考。

返回值

`TRUE`	有一个与 `aKeyRef` 关联的键。
`FALSE`	没有与 `aKeyRef` 相关联的密钥。

otPlatCryptoHkdfDeinit

otError otPlatCryptoHkdfDeinit(
  otCryptoContext *aContext
)

取消初始化 HKDF 上下文。

具体说明

参数

[in] aContext

HKDF 操作的上下文。

返回值

`OT_ERROR_NONE`	已成功取消初始化 HKDF 操作。
`OT_ERROR_FAILED`	未能取消初始化 HKDF 操作。
`OT_ERROR_INVALID_ARGS`	“`aContext`”原为 NULL

otPlatCryptoHkdfExpand

otError otPlatCryptoHkdfExpand(
  otCryptoContext *aContext,
  const uint8_t *aInfo,
  uint16_t aInfoLength,
  uint8_t *aOutputKey,
  uint16_t aOutputKeyLength
)

执行 HKDF 展开步骤。

具体说明

参数

`[in] aContext`	HKDF 操作的操作上下文。
`[in] aInfo`	指向信息序列的指针。
`[in] aInfoLength`	信息序列的长度。
`[out] aOutputKey`	指向输出键的指针。
`[in] aOutputKeyLength`	输出键缓冲区的大小。

返回值

`OT_ERROR_NONE`	HKDF 扩展成功。
`OT_ERROR_FAILED`	HKDF 展开失败。
`OT_ERROR_INVALID_ARGS`	“`aContext`”原为 NULL

otPlatCryptoHkdfExtract

otError otPlatCryptoHkdfExtract(
  otCryptoContext *aContext,
  const uint8_t *aSalt,
  uint16_t aSaltLength,
  const otCryptoKey *aInputKey
)

执行 HKDF 提取步骤。

具体说明

参数

`[in] aContext`	HKDF 操作的操作上下文。
`[in] aSalt`	指向 HKDF 的盐的指针。
`[in] aSaltLength`	盐长度。
`[in] aInputKey`	指向输入键的指针。

返回值

`OT_ERROR_NONE`	HKDF 提取成功。
`OT_ERROR_FAILED`	HKDF 提取失败。

otPlatCryptoHkdfInit

otError otPlatCryptoHkdfInit(
  otCryptoContext *aContext
)

初始化 HKDF 上下文。

具体说明

参数

[in] aContext

HKDF 操作的上下文。

返回值

`OT_ERROR_NONE`	已成功初始化 AES 操作。
`OT_ERROR_FAILED`	无法初始化 AES 操作。
`OT_ERROR_INVALID_ARGS`	“`aContext`”原为 NULL

otPlatCryptoHmacSha256Deinit

otError otPlatCryptoHmacSha256Deinit(
  otCryptoContext *aContext
)

取消初始化 HMAC 操作。

具体说明

参数

[in] aContext

HMAC 操作的上下文。

返回值

`OT_ERROR_NONE`	HMAC 操作已成功取消初始化。
`OT_ERROR_FAILED`	未能未初始化的 HMAC 操作。
`OT_ERROR_INVALID_ARGS`	“`aContext`”原为 NULL

otPlatCryptoHmacSha256Finish

otError otPlatCryptoHmacSha256Finish(
  otCryptoContext *aContext,
  uint8_t *aBuf,
  size_t aBufLength
)

完成 HMAC 操作。

具体说明

参数

`[in] aContext`	HMAC 操作的上下文。
`[out] aBuf`	指向输出缓冲区的指针。
`[in] aBufLength`	`aBuf` 的长度（以字节为单位）。

返回值

`OT_ERROR_NONE`	已成功完成 HMAC 操作。
`OT_ERROR_FAILED`	未能完成 HMAC 操作。
`OT_ERROR_INVALID_ARGS`	`aContext` 或 `aBuf` 为 NULL

otPlatCryptoHmacSha256Init

otError otPlatCryptoHmacSha256Init(
  otCryptoContext *aContext
)

初始化 HMAC 操作。

具体说明

参数

[in] aContext

HMAC 操作的上下文。

返回值

`OT_ERROR_NONE`	已成功初始化 HMAC 操作。
`OT_ERROR_FAILED`	未能初始化 HMAC 操作。
`OT_ERROR_INVALID_ARGS`	“`aContext`”原为 NULL

otPlatCryptoHmacSha256Start

otError otPlatCryptoHmacSha256Start(
  otCryptoContext *aContext,
  const otCryptoKey *aKey
)

启动 HMAC 操作。

具体说明

参数

`[in] aContext`	HMAC 操作的上下文。
`[in] aKey`	要用于 HMAC 操作的密钥材料。

返回值

`OT_ERROR_NONE`	已成功启动 HMAC 操作。
`OT_ERROR_FAILED`	未能启动 HMAC 操作。
`OT_ERROR_INVALID_ARGS`	`aContext` 或 `aKey` 为 NULL

otPlatCryptoHmacSha256Update

otError otPlatCryptoHmacSha256Update(
  otCryptoContext *aContext,
  const void *aBuf,
  uint16_t aBufLength
)

使用新的输入更新 HMAC 操作。

具体说明

参数

`[in] aContext`	HMAC 操作的上下文。
`[in] aBuf`	指向输入缓冲区的指针。
`[in] aBufLength`	`aBuf` 的长度（以字节为单位）。

返回值

`OT_ERROR_NONE`	成功使用新的输入操作更新了 HMAC。
`OT_ERROR_FAILED`	未能更新 HMAC 操作。
`OT_ERROR_INVALID_ARGS`	`aContext` 或 `aBuf` 为 NULL

otPlatCryptoImportKey

otError otPlatCryptoImportKey(
  otCryptoKeyRef *aKeyRef,
  otCryptoKeyType aKeyType,
  otCryptoKeyAlgorithm aKeyAlgorithm,
  int aKeyUsage,
  otCryptoKeyStorage aKeyPersistence,
  const uint8_t *aKey,
  size_t aKeyLen
)

将密钥导入 PSA ITS。

注意：如果针对 aKeyPersistence 传递 OT_CRYPTO_KEY_STORAGE_PERSISTENT，则 aKeyRef 为输入值，平台应使用给定的 aKeyRef，且不得对其进行更改。

如果针对 aKeyPersistence 传递 OT_CRYPTO_KEY_STORAGE_VOLATILE，然后输出 aKeyRef，则初始值无关紧要，并且平台 API 必须对其进行更新以返回新的密钥引用。

具体说明

参数

`[in,out] aKeyRef`	指向要用于加密操作的密钥引用的指针。
`[in] aKeyType`	密钥的密钥类型编码。
`[in] aKeyAlgorithm`	密钥的密钥算法编码。
`[in] aKeyUsage`	密钥的密钥用途编码（`OT_CRYPTO_KEY_USAGE_*` 的组合）。
`[in] aKeyPersistence`	此密钥的密钥持久性
`[in] aKey`	要导入的实际密钥。
`[in] aKeyLen`	要导入的密钥的长度。

返回值

`OT_ERROR_NONE`	已成功导入密钥。
`OT_ERROR_FAILED`	未能导入密钥。
`OT_ERROR_INVALID_ARGS`	`aKey` 已设置为 NULL。

只有在启用 OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE 后，OT 核心才会使用此 API。

otPlatCryptoInit

void otPlatCryptoInit(
  void
)

初始化 Crypto 模块。

otPlatCryptoPbkdf2GenerateKey

otError otPlatCryptoPbkdf2GenerateKey(
  const uint8_t *aPassword,
  uint16_t aPasswordLen,
  const uint8_t *aSalt,
  uint16_t aSaltLen,
  uint32_t aIterationCounter,
  uint16_t aKeyLen,
  uint8_t *aKey
)

使用 CMAC (AES-CMAC-PRF-128) 执行 PKCS#5 PBKDF2。

具体说明

参数

`[in] aPassword`	生成密钥时使用的密码。
`[in] aPasswordLen`	密码长度。
`[in] aSalt`	生成密钥时使用的盐。
`[in] aSaltLen`	盐的长度。
`[in] aIterationCounter`	迭代计数。
`[in] aKeyLen`	生成的密钥的长度（以字节为单位）。
`[out] aKey`	指向所生成密钥的指针。

返回值

`OT_ERROR_NONE`	已成功生成新密钥对。
`OT_ERROR_NO_BUFS`	未能为生成密钥分配缓冲区。
`OT_ERROR_NOT_CAPABLE`	不支持此功能。
`OT_ERROR_FAILED`	未能生成密钥。

otPlatCryptoRandomDeinit

void otPlatCryptoRandomDeinit(
  void
)

解初始化加密安全的伪随机数生成器 (CSPRNG)。

otPlatCryptoRandomGet

otError otPlatCryptoRandomGet(
  uint8_t *aBuffer,
  uint16_t aSize
)

使用能够确保加密安全的随机字节填充给定缓冲区。

具体说明

参数

`[out] aBuffer`	指向要用随机字节填充的缓冲区的指针。
`[in] aSize`	缓冲区大小（要填充的字节数）。

返回值

`OT_ERROR_NONE`	已成功用随机值填充缓冲区。
`OT_ERROR_FAILED`	操作失败，

otPlatCryptoRandomInit

void otPlatCryptoRandomInit(
  void
)

初始化加密安全的伪随机数生成器 (CSPRNG)。

otPlatCryptoSha256Deinit

otError otPlatCryptoSha256Deinit(
  otCryptoContext *aContext
)

取消初始化 SHA-256 操作。

具体说明

参数

[in] aContext

SHA-256 操作的上下文。

返回值

`OT_ERROR_NONE`	已成功取消初始化 SHA-256 操作。
`OT_ERROR_FAILED`	未能取消初始化 SHA-256 操作。
`OT_ERROR_INVALID_ARGS`	“`aContext`”原为 NULL

otPlatCryptoSha256Finish

otError otPlatCryptoSha256Finish(
  otCryptoContext *aContext,
  uint8_t *aHash,
  uint16_t aHashSize
)

完成 SHA-256 操作。

具体说明

参数

`[in] aContext`	SHA-256 操作的上下文。
`[in] aHash`	指向输出缓冲区的指针，其中需要存储哈希。
`[in] aHashSize`	`aHash` 的长度（以字节为单位）。

返回值

`OT_ERROR_NONE`	已成功完成 SHA-256 操作。
`OT_ERROR_FAILED`	未能完成 SHA-256 操作。
`OT_ERROR_INVALID_ARGS`	`aContext` 或 `aHash` 为 NULL

otPlatCryptoSha256Init

otError otPlatCryptoSha256Init(
  otCryptoContext *aContext
)

初始化 SHA-256 操作。

具体说明

参数

[in] aContext

SHA-256 操作的上下文。

返回值

`OT_ERROR_NONE`	已成功初始化 SHA-256 操作。
`OT_ERROR_FAILED`	未能初始化 SHA-256 操作。
`OT_ERROR_INVALID_ARGS`	“`aContext`”原为 NULL

otPlatCryptoSha256Start

otError otPlatCryptoSha256Start(
  otCryptoContext *aContext
)

启动 SHA-256 操作。

具体说明

参数

[in] aContext

SHA-256 操作的上下文。

返回值

`OT_ERROR_NONE`	已成功启动 SHA-256 操作。
`OT_ERROR_FAILED`	未能启动 SHA-256 操作。
`OT_ERROR_INVALID_ARGS`	“`aContext`”原为 NULL

otPlatCryptoSha256Update

otError otPlatCryptoSha256Update(
  otCryptoContext *aContext,
  const void *aBuf,
  uint16_t aBufLength
)

使用新输入更新 SHA-256 操作。

具体说明

参数

`[in] aContext`	SHA-256 操作的上下文。
`[in] aBuf`	指向输入缓冲区的指针。
`[in] aBufLength`	`aBuf` 的长度（以字节为单位）。

返回值

`OT_ERROR_NONE`	已成功使用新的输入操作更新 SHA-256。
`OT_ERROR_FAILED`	未能更新 SHA-256 操作。
`OT_ERROR_INVALID_ARGS`	`aContext` 或 `aBuf` 为 NULL

宏

OT_CRYPTO_ECDSA_MAX_DER_SIZE

 OT_CRYPTO_ECDSA_MAX_DER_SIZE 125

表示 DER 格式的 EDCSA 密钥对的缓冲区大小上限（以字节为单位）。

OT_CRYPTO_ECDSA_PUBLIC_KEY_SIZE

 OT_CRYPTO_ECDSA_PUBLIC_KEY_SIZE 64

表示 EDCSA 公钥的缓冲区空间（以字节为单位）。

OT_CRYPTO_ECDSA_SIGNATURE_SIZE

 OT_CRYPTO_ECDSA_SIGNATURE_SIZE 64

表示 EDCSA 签名的缓冲区空间（以字节为单位）。

OT_CRYPTO_PBDKF2_MAX_SALT_SIZE

 OT_CRYPTO_PBDKF2_MAX_SALT_SIZE 30

PBKDF2 SALT 长度上限：盐前缀 (6) + 扩展 panid (8) + 网络名称 (16)

OT_CRYPTO_SHA256_HASH_SIZE

 OT_CRYPTO_SHA256_HASH_SIZE 32

SHA256 哈希的长度（以字节为单位）。

资源

OpenThread API 参考文档源自 GitHub 上提供的源代码。如需了解详情，或者为我们的文档做贡献，请参阅资源。

加密 - 平台

摘要

枚举

类型定义符

变量

函数

结构体

枚举

匿名枚举

otCryptoKeyAlgorithm

otCryptoKeyStorage

otCryptoKeyType

类型定义符

otCryptoContext

otCryptoKey

otCryptoKeyRef

otPlatCryptoEcdsaKeyPair

otPlatCryptoEcdsaPublicKey

otPlatCryptoEcdsaSignature

otPlatCryptoSha256Hash

变量

OT_TOOL_PACKED_END

函数

otPlatCryptoAesEncrypt

otPlatCryptoAesFree

otPlatCryptoAesInit

otPlatCryptoAesSetKey

otPlatCryptoDestroyKey

otPlatCryptoEcdsaExportPublicKey

otPlatCryptoEcdsaGenerateAndImportKey

otPlatCryptoEcdsaGenerateKey

otPlatCryptoEcdsaGetPublicKey

otPlatCryptoEcdsaSign

otPlatCryptoEcdsaSignUsingKeyRef

otPlatCryptoEcdsaVerify

otPlatCryptoEcdsaVerifyUsingKeyRef

otPlatCryptoExportKey

otPlatCryptoHasKey

otPlatCryptoHkdfDeinit

otPlatCryptoHkdfExpand

otPlatCryptoHkdfExtract

otPlatCryptoHkdfInit

otPlatCryptoHmacSha256Deinit

otPlatCryptoHmacSha256Finish

otPlatCryptoHmacSha256Init

otPlatCryptoHmacSha256Start

otPlatCryptoHmacSha256Update

otPlatCryptoImportKey

otPlatCryptoInit

otPlatCryptoPbkdf2GenerateKey

otPlatCryptoRandomDeinit

otPlatCryptoRandomGet

otPlatCryptoRandomInit

otPlatCryptoSha256Deinit

otPlatCryptoSha256Finish

otPlatCryptoSha256Init

otPlatCryptoSha256Start

otPlatCryptoSha256Update

宏

OT_CRYPTO_ECDSA_MAX_DER_SIZE

OT_CRYPTO_ECDSA_PUBLIC_KEY_SIZE

OT_CRYPTO_ECDSA_SIGNATURE_SIZE

OT_CRYPTO_PBDKF2_MAX_SALT_SIZE

OT_CRYPTO_SHA256_HASH_SIZE

资源