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

この名前空間には、Weave セキュリティ プロファイル内の Weave パスコード ライブラリ用の Weave 内のすべてのインターフェースが含まれます。

概要

列挙型

@278{
  kPasscode_Config1_TEST_ONLY = 0x01,
  kPasscode_Config2 = 0x02,
  kPasscodeConfig1_KeyId = WeaveKeyId::kNone
}
enum
Weave のパスコード暗号化構成タイプ
@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)
}
enum
Weave のパスコード暗号化プロトコル パラメータのサイズ。

変数

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)
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)
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)
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)
Nest パスコード暗号化スキームを使用してパスコードを暗号化します。
GetEncryptedPasscodeConfig(const uint8_t *encPasscode, size_t encPasscodeLen, uint8_t & config)
暗号化されたパスコードの構成タイプを取得します。
GetEncryptedPasscodeFingerprint(const uint8_t *encPasscode, size_t encPasscodeLen, uint8_t *fingerprintBuf, size_t fingerprintBufSize, size_t & fingerprintLen)
暗号化されたパスコードに関連付けられているフィンガープリント値を取得します。
GetEncryptedPasscodeKeyId(const uint8_t *encPasscode, size_t encPasscodeLen, uint32_t & keyId)
暗号化されたパスコードの暗号化に使用された鍵の ID を取得します。
GetEncryptedPasscodeNonce(const uint8_t *encPasscode, size_t encPasscodeLen, uint32_t & nonce)
暗号化されたパスコードに関連付けられているノンス値を取得します。
IsSupportedPasscodeEncryptionConfig(uint8_t config)
bool
指定されたパスコード暗号化構成がパスコード暗号化/復号 API でサポートされている場合、true を返します。

構造体

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

列挙型

@278

 @278

Weave のパスコード暗号化構成タイプ

プロパティ
kPasscodeConfig1_KeyId

テスト パスコード構成 #1 に使用されるダミー鍵 ID。

kPasscode_Config1_TEST_ONLY

パスコード暗号化構成 #1 では、パスコードの認証とフィンガープリントに暗号鍵を使用していません。

この構成はテスト目的でのみ使用すべきです。

kPasscode_Config2

パスコード暗号化構成 #2 は、8 バイトの HMAC-SHA-1 整合性と 8 バイトの HMAC-SHA-1 フィンガープリントによる AES-128-ECB 暗号化を使用しています。

@279

 @279

Weave のパスコード暗号化プロトコル パラメータのサイズ。

プロパティ
kPasscodeAuthenticationKeyLen

パスコード認証(SHA-1)鍵の長さ。

kPasscodeAuthenticatorLen

パスコード認証システムの長さ。

kPasscodeEncKeyDiversifierSize

パスコード暗号化アプリケーション鍵の多様化子のサイズ。

kPasscodeEncryptionKeyLen

パスコード暗号化(AES-128)鍵の長さ。

kPasscodeFingerprintKeyDiversifierSize

パスコードのフィンガープリントキーの多様性サイズ。

kPasscodeFingerprintKeyLen

パスコード フィンガープリント(SHA-1)鍵の長さ。

kPasscodeFingerprintLen

パスコードのフィンガープリントの長さ。

kPasscodeMaxEncryptedLen

暗号化されたパスコードの最大長。

kPasscodeMaxLen

暗号化されていないパスコードの最大長。

kPasscodePaddedLen

パスコードの長さ(AES-128 ブロックの長さでパディングされます)。

kPasscodeTotalDerivedKeyLen

パスコードの鍵の合計長(暗号化と完全性)。

変数

kPasscodeEncKeyDiversifier

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

Weave パスコードの暗号鍵の導出に使用される鍵多様化器。

この値は、「Nest Passcode EK and AK」の SHA-1 HASH の最初の 4 バイトを表しますありません。

kPasscodeFingerprintKeyDiversifier

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

Weave パスコードの暗号鍵の導出に使用される鍵多様化器。

この値は、「Nest Passcode EK and 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
passcodeBuf が指すバッファのサイズ。
[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
passcodeBuf が指すバッファのサイズ。
[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
encPasscode が指すバッファのサイズ。
[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
フィンガープリント Buf が指すバッファのサイズ。
[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
)

暗号化されたパスコードに関連付けられているノンス値を取得します。

詳細
パラメータ
[in] encPasscode
暗号化されたパスコードを含むバッファへのポインタ。
[in] encPasscodeLen
暗号化されたパスコードの長さ。
[out] nonce
暗号化されたパスコードに関連付けられたノンス値。

IsSupportedPasscodeEncryptionConfig

bool IsSupportedPasscodeEncryptionConfig(
  uint8_t config
)

指定されたパスコード暗号化構成がパスコード暗号化/復号 API でサポートされている場合、true を返します。