Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

このページは Cloud Translation API によって翻訳されました。

nl::Weave::Profiles::Security::AppKeys::GroupKeyStoreBase

これは抽象クラスです。

#include <src/lib/profiles/security/WeaveApplicationKeys.h>

Weave グループキーストアクラスの定義。

概要

このクラスの関数は、アプリケーショングループキーを管理するために呼び出されます。

継承

直系の既知のサブクラス:
nl::Weave::DeviceLayer::Internal::GroupKeyStoreImpl
nl::Weave::DeviceLayer::Internal::GroupKeyStoreImpl
nl::Weave::DeviceLayer::Internal::GroupKeyStoreImpl
nl::Weave::Profiles::Security::AppKeys::DummyGroupKeyStore

プロテクト属性
`LastUsedEpochKeyId`	`uint32_t`
`NextEpochKeyStartTime`	`uint32_t`

パブリック関数
`Clear(void)=0`	`virtual WEAVE_ERROR`
`DeleteGroupKey(uint32_t keyId)=0`	`virtual WEAVE_ERROR`
`DeleteGroupKeysOfAType(uint32_t keyType)=0`	`virtual WEAVE_ERROR`
`DeriveApplicationKey(uint32_t & appKeyId, const uint8_t keySalt, uint8_t saltLen, const uint8_t keyDiversifier, uint8_t diversifierLen, uint8_t *appKey, uint8_t keyBufSize, uint8_t keyLen, uint32_t & appGroupGlobalId)`	`WEAVE_ERROR` アプリケーションキーを取得します。
`EnumerateGroupKeys(uint32_t keyType, uint32_t *keyIds, uint8_t keyIdsArraySize, uint8_t & keyCount)=0`	`virtual WEAVE_ERROR`
`GetCurrentAppKeyId(uint32_t keyId, uint32_t & curKeyId)`	`WEAVE_ERROR` 現在の鍵 ID を返します。
`GetCurrentUTCTime(uint32_t & utcTime)`	`virtual WEAVE_ERROR` 現在のプラットフォームの UTC 時間を秒単位で取得します。
`GetGroupKey(uint32_t keyId, WeaveGroupKey & groupKey)`	`WEAVE_ERROR` アプリケーショングループキーを取得します。
`RetrieveGroupKey(uint32_t keyId, WeaveGroupKey & key)=0`	`virtual WEAVE_ERROR`
`StoreGroupKey(const WeaveGroupKey & key)=0`	`virtual WEAVE_ERROR`

プロテクト関数
`Init(void)`	`void` ローカルグループキーストアパラメータを初期化します。
`OnEpochKeysChange(void)`	`void` 現在の鍵 ID を返します。
`RetrieveLastUsedEpochKeyId(void)=0`	`virtual WEAVE_ERROR`
`StoreLastUsedEpochKeyId(void)=0`	`virtual WEAVE_ERROR`

プロテクト属性

LastUsedEpochKeyId

uint32_t LastUsedEpochKeyId

NextEpochKeyStartTime

uint32_t NextEpochKeyStartTime

パブリック関数

クリア

virtual WEAVE_ERROR Clear(
  void
)=0

DeleteGroupKey

virtual WEAVE_ERROR DeleteGroupKey(
  uint32_t keyId
)=0

DeleteGroupKeysOfAType

virtual WEAVE_ERROR DeleteGroupKeysOfAType(
  uint32_t keyType
)=0

DeriveApplicationKey

WEAVE_ERROR DeriveApplicationKey(
  uint32_t & appKeyId,
  const uint8_t *keySalt,
  uint8_t saltLen,
  const uint8_t *keyDiversifier,
  uint8_t diversifierLen,
  uint8_t *appKey,
  uint8_t keyBufSize,
  uint8_t keyLen,
  uint32_t & appGroupGlobalId
)

アプリケーションキーを取得します。

現在のアプリケーションキー、ローテーションアプリケーションキー、静的アプリケーションキーの 3 種類のアプリケーションキーがサポートされています。現在のアプリキーが要求されると、この関数は現在のシステム時間と各エポックキーの開始時間パラメータに基づいて、現在のエポックキーを見つけて使用します。

詳細

パラメータ

`[in,out] keyId`	リクエストされた鍵 ID への参照。現在のアプリケーションキーがリクエストされると、このフィールドは新しいタイプ（ローテーションアプリケーションキー）と、アプリケーションキーの生成に使用された実際のエポックキー ID を反映するように更新されます。
`[in] keySalt`	アプリケーションキーのソルト値を持つバッファへのポインタ。
`[in] saltLen`	アプリケーションキーのソルトの長さ。
`[in] keyDiversifier`	アプリケーションキー多様器値を持つバッファへのポインタ。
`[in] diversifierLen`	アプリケーションキーの多様化子の長さ。
`[out] appKey`	派生キーが書き込まれるバッファへのポインタ。
`[in] keyBufSize`	指定されたキーバッファの長さ。
`[in] keyLen`	リクエストされた鍵マテリアルの長さ。
`[out] appGroupGlobalId`	関連付けられた鍵のアプリケーショングループのグローバル ID。

戻り値

`WEAVE_NO_ERROR`	成功時。
`WEAVE_ERROR_BUFFER_TOO_SMALL`	指定されたキーバッファサイズでは不十分な場合。
`WEAVE_ERROR_INVALID_KEY_ID`	リクエストされた鍵に無効な鍵 ID がある場合。
`WEAVE_ERROR_INVALID_ARGUMENT`	プラットフォームキーストアが無効なキーパラメータを返した場合、またはキー識別子に無効な値がある場合。
`other`	プラットフォームキーストア API から返されるその他のプラットフォーム固有のエラー。

EnumerateGroupKeys

virtual WEAVE_ERROR EnumerateGroupKeys(
  uint32_t keyType,
  uint32_t *keyIds,
  uint8_t keyIdsArraySize,
  uint8_t & keyCount
)=0

GetCurrentAppKeyId

WEAVE_ERROR GetCurrentAppKeyId(
  uint32_t keyId,
  uint32_t & curKeyId
)

現在の鍵 ID を返します。

現在のシステム時刻と各エポックキーの開始時間パラメータに基づいて現在のエポックキーを検索します。システムに有効で正確な時刻がない場合は、最後に使用されたエポック鍵 ID が返されます。

詳細

パラメータ

`[in] keyId`	アプリケーションキー ID。
`[out] curKeyId`	アプリケーションの現在の鍵 ID。

戻り値

`WEAVE_NO_ERROR`	成功時。
`WEAVE_ERROR_INVALID_KEY_ID`	入力鍵 ID に無効な値がある場合。
`WEAVE_ERROR_KEY_NOT_FOUND`	プラットフォームキーストアでエポックキーが見つからない場合。
`other`	プラットフォームキーストア API から返されるその他のプラットフォーム固有のエラー。

GetCurrentUTCTime

virtual WEAVE_ERROR GetCurrentUTCTime(
  uint32_t & utcTime
)

現在のプラットフォームの UTC 時間を秒単位で取得します。

詳細

パラメータ

[out] utcTime

時刻の値への参照。

戻り値

`WEAVE_NO_ERROR`	成功時。
`#WEAVE_SYSTEM_ERROR_NOT_SUPPORTED`	プラットフォームがリアルタイムクロックをサポートしていない場合。
`#WEAVE_SYSTEM_ERROR_REAL_TIME_NOT_SYNCED`	システムのリアルタイムクロックが正確なタイムソースに同期していない場合。
`other`	Weave またはプラットフォームのその他のエラーコード。

GetGroupKey

WEAVE_ERROR GetGroupKey(
  uint32_t keyId,
  WeaveGroupKey & groupKey
)

アプリケーショングループキーを取得します。

この関数は、アプリケーショングループキーを導出または取得します。この関数でサポートされている鍵のタイプは、ファブリックシークレット、ルート鍵、エポック鍵、グループマスター鍵、中間鍵です。

詳細

パラメータ

`[in] keyId`	グループ鍵 ID。
`[out] groupKey`	グループキーオブジェクトへの参照。

戻り値

`WEAVE_NO_ERROR`	成功時。
`WEAVE_ERROR_INVALID_KEY_ID`	リクエストされた鍵に無効な鍵 ID がある場合。
`WEAVE_ERROR_INVALID_ARGUMENT`	プラットフォームキーストアが無効なキーパラメータを返した場合。
`other`	プラットフォームキーストア API から返されるその他のプラットフォーム固有のエラー。

RetrieveGroupKey

virtual WEAVE_ERROR RetrieveGroupKey(
  uint32_t keyId,
  WeaveGroupKey & key
)=0

StoreGroupKey

virtual WEAVE_ERROR StoreGroupKey(
  const WeaveGroupKey & key
)=0

プロテクト関数

init

void Init(
  void
)

ローカルグループキーストアパラメータを初期化します。

OnEpochKeysChange

void OnEpochKeysChange(
  void
)

現在の鍵 ID を返します。

アプリケーションエポックキーのセットに変更（削除または保存）が発生した場合、エポックキーに関連付けられているメンバー変数をデフォルト値に設定します。このメソッドの呼び出しは、StoreGroupKey()、DeleteGroupKey()、DeleteGroupKeysOfAType() 関数を実装するサブクラスが行います。

RetrieveLastUsedEpochKeyId

virtual WEAVE_ERROR RetrieveLastUsedEpochKeyId(
  void
)=0

StoreLastUsedEpochKeyId

virtual WEAVE_ERROR StoreLastUsedEpochKeyId(
  void
)=0