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::GroupKeyStoreImplnl::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)
アプリケーション キーを導出します。
EnumerateGroupKeys(uint32_t keyType, uint32_t *keyIds, uint8_t keyIdsArraySize, uint8_t & keyCount)=0
virtual WEAVE_ERROR
GetCurrentAppKeyId(uint32_t keyId, uint32_t & curKeyId)
現在のキー ID を返します。
GetCurrentUTCTime(uint32_t & utcTime)
virtual WEAVE_ERROR
現在のプラットフォームの UTC 時刻（秒単位）を取得します。
GetGroupKey(uint32_t keyId, WeaveGroupKey & groupKey)
アプリケーション グループ キーを取得します。
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