本頁面由 Cloud Translation API 翻譯而成。

nl::Weave::Profiles::Security::Passcodes

這個命名空間包含在 Weave 中 Weave 安全性設定檔內所有的 Weave 密碼程式庫介面。

摘要

列舉
`@278{ kPasscode_Config1_TEST_ONLY = 0x01, kPasscode_Config2 = 0x02, kPasscodeConfig1_KeyId = WeaveKeyId::kNone }`	列舉密碼加密設定類型。
@279{ kPasscodeEncryptionKeyLen = Platform::Security::AES128BlockCipher::kKeyLength, kPasscodeAuthenticationKeyLen = Platform::Security::SHA1::kHashLength, kPasscodeFingerprintKeyLen = Platform::Security::SHA1::kHashLength, kPasscodeTotalDerivedKeyLen = kPasscodeEncryptionKeyLen + kPasscodeAuthenticationKeyLen, kPasscodePaddedLen = Platform::Security::AES128BlockCipher::kBlockLength, kPasscodeAuthenticatorLen = 8, kPasscodeFingerprintLen = 8, kPasscodeMaxEncryptedLen = sizeof(uint8_t) + 2 * sizeof(uint32_t) + kPasscodePaddedLen + kPasscodeAuthenticatorLen + kPasscodeFingerprintLen, kPasscodeMaxLen = kPasscodePaddedLen, kPasscodeEncKeyDiversifierSize = sizeof(kPasscodeEncKeyDiversifier) + sizeof(uint8_t), kPasscodeFingerprintKeyDiversifierSize = sizeof(kPasscodeFingerprintKeyDiversifier) }	列舉密碼加密通訊協定參數大小。

列舉

@278{
  kPasscode_Config1_TEST_ONLY = 0x01,
  kPasscode_Config2 = 0x02,
  kPasscodeConfig1_KeyId = WeaveKeyId::kNone
}

列舉

密碼加密設定類型。

@279{
  kPasscodeEncryptionKeyLen = Platform::Security::AES128BlockCipher::kKeyLength,
  kPasscodeAuthenticationKeyLen = Platform::Security::SHA1::kHashLength,
  kPasscodeFingerprintKeyLen = Platform::Security::SHA1::kHashLength,
  kPasscodeTotalDerivedKeyLen = kPasscodeEncryptionKeyLen + kPasscodeAuthenticationKeyLen,
  kPasscodePaddedLen = Platform::Security::AES128BlockCipher::kBlockLength,
  kPasscodeAuthenticatorLen = 8,
  kPasscodeFingerprintLen = 8,
  kPasscodeMaxEncryptedLen = sizeof(uint8_t) + 2 * sizeof(uint32_t) + kPasscodePaddedLen +
                                                          kPasscodeAuthenticatorLen + kPasscodeFingerprintLen,
  kPasscodeMaxLen = kPasscodePaddedLen,
  kPasscodeEncKeyDiversifierSize = sizeof(kPasscodeEncKeyDiversifier) + sizeof(uint8_t),
  kPasscodeFingerprintKeyDiversifierSize = sizeof(kPasscodeFingerprintKeyDiversifier)
}

列舉

密碼加密通訊協定參數大小。

Variables
`kPasscodeEncKeyDiversifier = { 0x1A, 0x65, 0x5D, 0x96 }[]`	`const uint8_t` 用於 Weave 密碼加密金鑰產生的金鑰簡化器。
`kPasscodeFingerprintKeyDiversifier = { 0xD1, 0xA1, 0xD9, 0x6C }[]`	`const uint8_t` 用於 Weave 密碼加密金鑰產生的金鑰簡化器。

函式
`DecryptPasscode(const uint8_t encPasscode, size_t encPasscodeLen, uint8_t passcodeBuf, size_t passcodeBufSize, size_t & passcodeLen, GroupKeyStoreBase *groupKeyStore)`	`WEAVE_ERROR` 將使用 Nest 密碼加密配置加密的密碼解密。
`DecryptPasscode(const uint8_t encPasscode, size_t encPasscodeLen, const uint8_t encKey, const uint8_t authKey, const uint8_t fingerprintKey, uint8_t *passcodeBuf, size_t passcodeBufSize, size_t & passcodeLen)`	`WEAVE_ERROR` 將使用 Nest 密碼加密配置加密的密碼解密。
`EncryptPasscode(uint8_t config, uint32_t keyId, uint32_t nonce, const uint8_t passcode, size_t passcodeLen, uint8_t encPasscode, size_t encPasscodeBufSize, size_t & encPasscodeLen, GroupKeyStoreBase *groupKeyStore)`	`WEAVE_ERROR` 使用 Nest 密碼加密配置加密密碼。
`EncryptPasscode(uint8_t config, uint32_t keyId, uint32_t nonce, const uint8_t passcode, size_t passcodeLen, const uint8_t encKey, const uint8_t authKey, const uint8_t fingerprintKey, uint8_t *encPasscode, size_t encPasscodeBufSize, size_t & encPasscodeLen)`	`WEAVE_ERROR` 使用 Nest 密碼加密配置加密密碼。
`GetEncryptedPasscodeConfig(const uint8_t *encPasscode, size_t encPasscodeLen, uint8_t & config)`	`WEAVE_ERROR` 取得加密密碼的設定類型。
`GetEncryptedPasscodeFingerprint(const uint8_t encPasscode, size_t encPasscodeLen, uint8_t fingerprintBuf, size_t fingerprintBufSize, size_t & fingerprintLen)`	`WEAVE_ERROR` 取得與加密密碼相關聯的指紋值。
`GetEncryptedPasscodeKeyId(const uint8_t *encPasscode, size_t encPasscodeLen, uint32_t & keyId)`	`WEAVE_ERROR` 取得用來加密加密密碼的金鑰 ID。
`GetEncryptedPasscodeNonce(const uint8_t *encPasscode, size_t encPasscodeLen, uint32_t & nonce)`	`WEAVE_ERROR` 取得與已加密密碼相關聯的 Nonce 值。
`IsSupportedPasscodeEncryptionConfig(uint8_t config)`	`bool` 如果密碼加密/解密 API 支援提供的密碼加密設定，則傳回 true。

結構
nl::Weave::Profiles::Security::Passcodes::EncryptedPasscodeStruct

列舉

@278

 @278

密碼加密設定類型。

屬性

屬性
`kPasscodeConfig1_KeyId`	用於測試密碼設定 #1 的虛擬金鑰 ID。
`kPasscode_Config1_TEST_ONLY`	密碼加密設定 #1 未使用加密和密鑰來驗證和指紋密碼。這項設定「應該」用於「測試」用途。
`kPasscode_Config2`	密碼加密設定 #2 採用 AES-128-ECB 加密技術，具備 8 位元組 HMAC-SHA-1 完整性和 8 位元組 HMAC-SHA-1 指紋。

kPasscodeConfig1_KeyId

用於測試密碼設定 #1 的虛擬金鑰 ID。

kPasscode_Config1_TEST_ONLY

密碼加密設定 #1 未使用加密和密鑰來驗證和指紋密碼。

這項設定「應該」用於「測試」用途。

kPasscode_Config2

密碼加密設定 #2 採用 AES-128-ECB 加密技術，具備 8 位元組 HMAC-SHA-1 完整性和 8 位元組 HMAC-SHA-1 指紋。

@279

 @279

密碼加密通訊協定參數大小。

屬性
`kPasscodeAuthenticationKeyLen`	密碼驗證 (SHA-1) 金鑰長度，
`kPasscodeAuthenticatorLen`	密碼驗證器長度。
`kPasscodeEncKeyDiversifierSize`	密碼加密應用程式金鑰多樣性大小。
`kPasscodeEncryptionKeyLen`	密碼加密 (AES-128) 金鑰長度。
`kPasscodeFingerprintKeyDiversifierSize`	密碼指紋金鑰多樣器大小。
`kPasscodeFingerprintKeyLen`	密碼指紋 (SHA-1) 金鑰長度。
`kPasscodeFingerprintLen`	密碼指紋長度。
`kPasscodeMaxEncryptedLen`	加密密碼的長度上限。
`kPasscodeMaxLen`	未加密密碼長度的上限。
`kPasscodePaddedLen`	密碼長度 (填至 AES-128 區塊長度)。
`kPasscodeTotalDerivedKeyLen`	密碼總長度 (加密和完整性) 金鑰長度。

Variables

kPasscodeEncKeyDiversifier

const uint8_t kPasscodeEncKeyDiversifier[] = { 0x1A, 0x65, 0x5D, 0x96 }

用於 Weave 密碼加密金鑰產生的金鑰簡化器。

這個值代表「Nest 密碼 EK 和 AK」詞組中 SHA-1 HASH 的前 4 個位元組。

kPasscodeFingerprintKeyDiversifier

const uint8_t kPasscodeFingerprintKeyDiversifier[] = { 0xD1, 0xA1, 0xD9, 0x6C }

用於 Weave 密碼加密金鑰產生的金鑰簡化器。

這個值代表「Nest 密碼 EK 和 AK」詞組中 SHA-1 HASH 的前 4 個位元組。

函式

DecryptPasscode

WEAVE_ERROR DecryptPasscode(
  const uint8_t *encPasscode,
  size_t encPasscodeLen,
  uint8_t *passcodeBuf,
  size_t passcodeBufSize,
  size_t & passcodeLen,
  GroupKeyStoreBase *groupKeyStore
)

將使用 Nest 密碼加密配置加密的密碼解密。

詳細說明

參數

`[in] encPasscode`	加密密碼緩衝區的指標。
`[in] encPasscodeLen`	加密密碼長度。
`[in] passcodeBuf`	指向接收已解密密碼的緩衝區指標。
`[in] passcodeBufSize`	PassBuf 指向的緩衝區大小。
`[out] passcodeLen`	設定為已解密密碼的長度。
`[in] groupKeyStore`	群組金鑰儲存庫物件的指標。

傳回值

`WEAVE_NO_ERROR`	成功時。
`WEAVE_ERROR_UNSUPPORTED_PASSCODE_CONFIG`	不支援指定的密碼設定。
`WEAVE_ERROR_PASSCODE_AUTHENTICATION_FAILED`	密碼驗證失敗時，
`WEAVE_ERROR_PASSCODE_FINGERPRINT_FAILED`	密碼指紋檢查失敗。
`WEAVE_ERROR_INVALID_KEY_ID`	如果要求的金鑰 ID 無效。
`WEAVE_ERROR_BUFFER_TOO_SMALL`	如果提供的密碼緩衝區太小。
`WEAVE_ERROR_INVALID_ARGUMENT`	如果加密密碼過短或過長，或是未提供指向群組金鑰庫的指標，或平台金鑰儲存區傳回無效的金鑰參數。
`other`	平台金鑰儲存庫 API 傳回的其他平台專屬錯誤。

DecryptPasscode

WEAVE_ERROR DecryptPasscode(
  const uint8_t *encPasscode,
  size_t encPasscodeLen,
  const uint8_t *encKey,
  const uint8_t *authKey,
  const uint8_t *fingerprintKey,
  uint8_t *passcodeBuf,
  size_t passcodeBufSize,
  size_t & passcodeLen
)

將使用 Nest 密碼加密配置加密的密碼解密。

詳細說明

參數

`[in] encPasscode`	加密密碼緩衝區的指標。
`[in] encPasscodeLen`	加密密碼長度。
`[in] encKey`	指向用來加密密碼的金鑰指標。金鑰的長度必須與與指定設定相關聯的加密演算法相符。
`[in] authKey`	指向用來驗證密碼的金鑰指標。金鑰的長度必須與與指定設定相關聯的驗證演算法相符。
`[in] fingerprintKey`	指向用來產生密碼指紋的金鑰指標。金鑰的長度必須與與指定設定相關聯的指紋演算法相符。
`[in] passcodeBuf`	指向接收已解密密碼的緩衝區指標。
`[in] passcodeBufSize`	PassBuf 指向的緩衝區大小。
`[out] passcodeLen`	設定為已解密密碼的長度。

傳回值

`WEAVE_NO_ERROR`	成功時。
`WEAVE_ERROR_UNSUPPORTED_PASSCODE_CONFIG`	不支援指定的密碼設定。
`WEAVE_ERROR_PASSCODE_AUTHENTICATION_FAILED`	密碼驗證失敗時，
`WEAVE_ERROR_PASSCODE_FINGERPRINT_FAILED`	密碼指紋檢查失敗。
`WEAVE_ERROR_BUFFER_TOO_SMALL`	如果提供的密碼緩衝區太小。
`WEAVE_ERROR_INVALID_ARGUMENT`	強化的密碼長度過短或過長。

EncryptPasscode

WEAVE_ERROR EncryptPasscode(
  uint8_t config,
  uint32_t keyId,
  uint32_t nonce,
  const uint8_t *passcode,
  size_t passcodeLen,
  uint8_t *encPasscode,
  size_t encPasscodeBufSize,
  size_t & encPasscodeLen,
  GroupKeyStoreBase *groupKeyStore
)

使用 Nest 密碼加密配置加密密碼。

詳細說明

參數

`[in] config`	要使用的密碼加密設定。
`[in] keyId`	要求的密碼加密金鑰 ID。
`[in] nonce`	指派給加密密碼的專屬值。
`[in] passcode`	指向要加密密碼的指標。
`[in] passcodeLen`	密碼長度。
`[out] encPasscode`	指向緩衝區的指標，用於儲存加密密碼。
`[in] encPasscodeBufSize`	加密密碼儲存空間的緩衝區大小。
`[out] encPasscodeLen`	加密密碼長度。
`[in] groupKeyStore`	群組金鑰儲存庫物件的指標。

傳回值

`WEAVE_NO_ERROR`	成功時。
`WEAVE_ERROR_UNSUPPORTED_PASSCODE_CONFIG`	不支援指定的密碼設定。
`WEAVE_ERROR_BUFFER_TOO_SMALL`	如果提供的輸出緩衝區對加密密碼而言太小。
`WEAVE_ERROR_INVALID_KEY_ID`	如果要求的金鑰 ID 無效。
`WEAVE_ERROR_INVALID_ARGUMENT`	如果提供的密碼太短或太長；或者並未提供指向群組金鑰庫的指標，或平台金鑰儲存庫傳回無效的金鑰參數。
`other`	平台金鑰儲存庫 API 傳回的其他平台專屬錯誤。

EncryptPasscode

WEAVE_ERROR EncryptPasscode(
  uint8_t config,
  uint32_t keyId,
  uint32_t nonce,
  const uint8_t *passcode,
  size_t passcodeLen,
  const uint8_t *encKey,
  const uint8_t *authKey,
  const uint8_t *fingerprintKey,
  uint8_t *encPasscode,
  size_t encPasscodeBufSize,
  size_t & encPasscodeLen
)

使用 Nest 密碼加密配置加密密碼。

詳細說明

參數

`[in] config`	要使用的 Weave 密碼加密設定。
`[in] keyId`	要求的密碼加密金鑰 ID。
`[in] nonce`	指派給密碼的專屬值。
`[in] passcode`	指向要加密密碼的指標。
`[in] passcodeLen`	密碼長度。
`[in] encKey`	指向用來加密密碼的金鑰指標。金鑰的長度必須與與指定設定相關聯的加密演算法相符。
`[in] authKey`	指向用來驗證密碼的金鑰指標。金鑰的長度必須與與指定設定相關聯的驗證演算法相符。
`[in] fingerprintKey`	指向用來產生密碼指紋的金鑰指標。金鑰的長度必須與與指定設定相關聯的指紋演算法相符。
`[out] encPasscode`	指向存放已加密密碼的緩衝區指標。這個緩衝區大小必須至少為 kPasscodeMaxEncryptedLen。
`[in] encPasscodeBufSize`	透過 encPass 指定的緩衝區大小。
`[out] encPasscodeLen`	加密密碼長度。

傳回值

`WEAVE_NO_ERROR`	成功時。
`WEAVE_ERROR_UNSUPPORTED_PASSCODE_CONFIG`	不支援指定的密碼設定。
`WEAVE_ERROR_BUFFER_TOO_SMALL`	如果提供的輸出緩衝區對加密密碼而言太小。
`WEAVE_ERROR_INVALID_ARGUMENT`	如果提供的密碼過短或過長。

GetEncryptedPasscodeConfig

WEAVE_ERROR GetEncryptedPasscodeConfig(
  const uint8_t *encPasscode,
  size_t encPasscodeLen,
  uint8_t & config
)

取得加密密碼的設定類型。

詳細說明

參數

`[in] encPasscode`	指向包含已加密密碼的緩衝區。
`[in] encPasscodeLen`	加密密碼的長度。
`[out] config`	加密密碼使用的 Weave 密碼加密設定。

GetEncryptedPasscodeFingerprint

WEAVE_ERROR GetEncryptedPasscodeFingerprint(
  const uint8_t *encPasscode,
  size_t encPasscodeLen,
  uint8_t *fingerprintBuf,
  size_t fingerprintBufSize,
  size_t & fingerprintLen
)

取得與加密密碼相關聯的指紋值。

詳細說明

參數

`[in] encPasscode`	指向包含已加密密碼的緩衝區。
`[in] encPasscodeLen`	加密密碼的長度。
`[in] fingerprintBuf`	用於接收指紋值的緩衝區。
`[in] fingerprintBufSize`	FingerprintBuf 所指的緩衝區大小。
`[out] fingerprintLen`	傳回的指紋值長度。

GetEncryptedPasscodeKeyId

WEAVE_ERROR GetEncryptedPasscodeKeyId(
  const uint8_t *encPasscode,
  size_t encPasscodeLen,
  uint32_t & keyId
)

取得用來加密加密密碼的金鑰 ID。

詳細說明

參數

`[in] encPasscode`	指向包含已加密密碼的緩衝區。
`[in] encPasscodeLen`	加密密碼的長度。
`[out] keyId`	用來加密已加密密碼的金鑰 ID。

GetEncryptedPasscodeNonce

WEAVE_ERROR GetEncryptedPasscodeNonce(
  const uint8_t *encPasscode,
  size_t encPasscodeLen,
  uint32_t & nonce
)

取得與已加密密碼相關聯的 Nonce 值。

詳細說明

參數

`[in] encPasscode`	指向包含已加密密碼的緩衝區。
`[in] encPasscodeLen`	加密密碼的長度。
`[out] nonce`	與加密密碼相關聯的 Nonce 值。

IsSupportedPasscodeEncryptionConfig

bool IsSupportedPasscodeEncryptionConfig(
  uint8_t config
)

如果密碼加密/解密 API 支援提供的密碼加密設定，則傳回 true。

nl::Weave::Profiles::Security::Passcodes

摘要

列舉

Variables

函式

結構

列舉

@278

@279

Variables

kPasscodeEncKeyDiversifier

kPasscodeFingerprintKeyDiversifier

函式

DecryptPasscode

DecryptPasscode

EncryptPasscode

EncryptPasscode

GetEncryptedPasscodeConfig

GetEncryptedPasscodeFingerprint

GetEncryptedPasscodeKeyId

GetEncryptedPasscodeNonce

IsSupportedPasscodeEncryptionConfig