nl::Weave::WeaveFabricState

#include <src/lib/core/WeaveFabricState.h>

WeaveFabricState の前方宣言。

概要

コンストラクタとデストラクタ
WeaveFabricState(void)

公開タイプ
PeerIndexType typedef
uint8_t
SessionEndCbFunct)(uint16_t keyId, uint64_t peerNodeId, void *context) typedef
void(*
State enum

パブリック属性
AutoCreateKeys
bool
DebugFabricId
uint64_t
DefaultSubnet
uint16_t
FabricId
uint64_t
GroupKeyStore
ListenIPv4Addr
IPAddress
ListenIPv6Addr
IPAddress
LocalNodeId
uint64_t
LogKeys
bool
MaxUnencUDPMsgIdRcvd[WEAVE_CONFIG_MAX_PEER_NODES]
uint32_t
MessageLayer
MostRecentlyUsedIndexes[WEAVE_CONFIG_MAX_PEER_NODES]
PeerIndexType
NodeId[WEAVE_CONFIG_MAX_PEER_NODES]
uint64_t
PairingCode
const char *
State
uint8_t
UnencRcvFlags[WEAVE_CONFIG_MAX_PEER_NODES]
WeaveSessionState::ReceiveFlagsType
UseTestKey
bool

パブリック関数
AddSharedSessionEndNode(uint64_t endNodeId, uint64_t terminatingNodeId, uint16_t keyId)
AddSharedSessionEndNode(WeaveSessionKey *sessionKey, uint64_t endNodeId)
このメソッドは、共有エンドノード レコードに新しいエンドノードを追加します。
AllocSessionKey(uint64_t peerNodeId, uint16_t keyId, WeaveConnection *boundCon, WeaveSessionKey *& sessionKey)
ClearFabricState(void)
void
CreateFabric(void)
FindSessionKey(uint16_t keyId, uint64_t peerNodeId, bool create, WeaveSessionKey *& retRec)
このメソッドは、セッション キーエントリを検索します。
FindSharedSession(uint64_t terminatingNodeId, WeaveAuthMode authMode, uint8_t encType)
セッション鍵テーブルで、指定された終了ノードをターゲットとし、指定された認証モードと暗号化タイプに一致する確立済みの共有セッション鍵を検索します。
GetFabricState(uint8_t *buf, uint32_t bufSize, uint32_t & fabricStateLen)
GetPassword(uint8_t pwSrc, const char *& ps, uint16_t & pwLen)
GetSessionKey(uint16_t keyId, uint64_t peerNodeId, WeaveSessionKey *& outSessionKey)
GetSessionState(uint64_t remoteNodeId, uint16_t keyId, uint8_t encType, WeaveConnection *con, WeaveSessionState & outSessionState)
GetSharedSessionEndNodeIds(const WeaveSessionKey *sessionKey, uint64_t *endNodeIds, uint8_t endNodeIdsBufSize, uint8_t & endNodeIdsCount)
このメソッドは、指定されたセッションを共有するすべてのエンドノード ID を返します。
HandleConnectionClosed(WeaveConnection *con)
void
Init(void)
Init(nl::Weave::Profiles::Security::AppKeys::GroupKeyStoreBase *groupKeyStore)
IsFabricAddress(const IPAddress & addr) const
bool
IP アドレスがローカル Weave ファブリック内のノードのアドレスを表すかどうかを示します。
IsLocalFabricAddress(const IPAddress & addr) const
bool
IP アドレスがローカルノードの Weave ファブリック アドレスを表すかどうかを示します。
IsSharedSession(uint16_t keyId, uint64_t peerNodeId)
bool
このメソッドは、指定されたピアと keyId に関連付けられたセキュア セッションが共有されているかどうかをチェックします。
JoinExistingFabric(const uint8_t *fabricState, uint32_t fabricStateLen)
RegisterSessionEndCallback(SessionEndCbCtxt *sessionEndCb)
RemoveIdleSessionKeys()
bool
RemoveSessionKey(uint16_t keyId, uint64_t peerNodeId)
RemoveSessionKey(WeaveSessionKey *sessionKey, bool wasIdle)
void
RemoveSharedSessionEndNodes(const WeaveSessionKey *sessionKey)
void
RestoreSession(uint8_t *serializedSession, uint16_t serializedSessionLen)
以前に中断した Weave セキュリティ セッションをシリアル化された状態から復元します。
SelectNodeAddress(uint64_t nodeId, uint16_t subnet) const
指定したノードの Weave ULA を含む IPAddress を返します。
SelectNodeAddress(uint64_t nodeId) const
指定したノードの Weave ULA を含む IPAddress を返します。
SetDelegate(FabricStateDelegate *aDelegate)
void
このメソッドはデリゲート オブジェクトを設定します。
SetSessionKey(uint16_t keyId, uint64_t peerNodeId, uint8_t encType, WeaveAuthMode authMode, const WeaveEncryptionKey *encKey)
SetSessionKey(WeaveSessionKey *sessionKey, uint8_t encType, WeaveAuthMode authMode, const WeaveEncryptionKey *encKey)
Shutdown(void)
SuspendSession(uint16_t keyId, uint64_t peerNodeId, uint8_t *buf, uint16_t bufSize, uint16_t & serializedSessionLen)
アクティブな Weave セキュリティ セッションを一時停止して、状態をシリアル化します。

構造体
nl::Weave::WeaveFabricState::SessionEndCbCtxt

公開タイプ

PeerIndexType

uint8_t PeerIndexType

SessionEndCbFunct

void(* SessionEndCbFunct)(uint16_t keyId, uint64_t peerNodeId, void *context)

州

 State

パブリック属性

AutoCreateKeys

bool AutoCreateKeys

DebugFabricId

uint64_t DebugFabricId

DefaultSubnet

uint16_t DefaultSubnet

FabricId

uint64_t FabricId

GroupKeyStore

nl::Weave::Profiles::Security::AppKeys::GroupKeyStoreBase * GroupKeyStore

ListenIPv4Addr

IPAddress ListenIPv4Addr

ListenIPv6Addr

IPAddress ListenIPv6Addr

LocalNodeId

uint64_t LocalNodeId

LogKeys

bool LogKeys

MaxUnencUDPMsgIdRcvd

uint32_t MaxUnencUDPMsgIdRcvd[WEAVE_CONFIG_MAX_PEER_NODES]

MessageLayer

WeaveMessageLayer * MessageLayer

MostRecentlyUsedIndexes

PeerIndexType MostRecentlyUsedIndexes[WEAVE_CONFIG_MAX_PEER_NODES]

NodeId

uint64_t NodeId[WEAVE_CONFIG_MAX_PEER_NODES]

PairingCode

const char * PairingCode

州

uint8_t State

UnencRcvFlags

WeaveSessionState::ReceiveFlagsType UnencRcvFlags[WEAVE_CONFIG_MAX_PEER_NODES]

UseTestKey

bool UseTestKey

パブリック関数

AddSharedSessionEndNode

WEAVE_ERROR AddSharedSessionEndNode(
  uint64_t endNodeId,
  uint64_t terminatingNodeId,
  uint16_t keyId
)

AddSharedSessionEndNode

WEAVE_ERROR AddSharedSessionEndNode(
  WeaveSessionKey *sessionKey,
  uint64_t endNodeId
)

このメソッドは、共有エンドノードのレコードに新しいエンドノードを追加します。

詳細
パラメータ
[in] sessionKey
新しいエンドノードを追加するセッションを表す WeaveSessionKey オブジェクト。
[in] endNodeId
追加するセッション終了ノードのノード ID。
戻り値
WEAVE_ERROR_TOO_MANY_SHARED_SESSION_END_NODES
共有エンドノード リストに新しいエントリ用の空き容量がない場合。
WEAVE_NO_ERROR
成功時。

AllocSessionKey

WEAVE_ERROR AllocSessionKey(
  uint64_t peerNodeId,
  uint16_t keyId,
  WeaveConnection *boundCon,
  WeaveSessionKey *& sessionKey
)

ClearFabricState

void ClearFabricState(
  void
)

CreateFabric

WEAVE_ERROR CreateFabric(
  void
)

FindSessionKey

WEAVE_ERROR FindSessionKey(
  uint16_t keyId,
  uint64_t peerNodeId,
  bool create,
  WeaveSessionKey *& retRec
)

このメソッドは、セッション キーエントリを検索します。

詳細
パラメータ
[in] keyId
Weave 鍵識別子。
[in] peerNodeId
ピアのノード ID。
[in] create
指定されたキーが見つからない場合に新しいキーを作成するかどうかを示すブール値。
[out] retRec
WeaveSessionKey オブジェクトへのポインタ参照。
戻り値
WEAVE_ERROR_WRONG_KEY_TYPE
指定されたキーがセッション キータイプでない場合。
WEAVE_ERROR_INVALID_ARGUMENT
入力引数の値が正しくない場合。
WEAVE_ERROR_KEY_NOT_FOUND
指定されたキーが見つからない場合。
WEAVE_ERROR_TOO_MANY_KEYS
新しいセッションキーを作成するための空きエントリがない場合。
WEAVE_NO_ERROR
成功時。

FindSharedSession

WeaveSessionKey * FindSharedSession(
  uint64_t terminatingNodeId,
  WeaveAuthMode authMode,
  uint8_t encType
)

セッション鍵テーブルで、指定された終了ノードをターゲットとし、指定された認証モードと暗号化タイプに一致する確立済みの共有セッション鍵を検索します。

詳細
パラメータ
[in] terminatingNodeId
セッション ターミネータのノード ID。
[in] authMode
目的のセッション認証モード。
[in] encType
目的のメッセージ暗号化タイプ。
戻り値
WeaveSessionKey
* 一致する共有セッションを表す WeaveSessionKey オブジェクトへのポインタ。一致するセッションが見つからなかった場合は NULL を返します。

GetFabricState

WEAVE_ERROR GetFabricState(
  uint8_t *buf,
  uint32_t bufSize,
  uint32_t & fabricStateLen
)

GetPassword

WEAVE_ERROR GetPassword(
  uint8_t pwSrc,
  const char *& ps,
  uint16_t & pwLen
)

GetSessionKey

WEAVE_ERROR GetSessionKey(
  uint16_t keyId,
  uint64_t peerNodeId,
  WeaveSessionKey *& outSessionKey
)

GetSessionState

WEAVE_ERROR GetSessionState(
  uint64_t remoteNodeId,
  uint16_t keyId,
  uint8_t encType,
  WeaveConnection *con,
  WeaveSessionState & outSessionState
)

GetSharedSessionEndNodeIds

WEAVE_ERROR GetSharedSessionEndNodeIds(
  const WeaveSessionKey *sessionKey,
  uint64_t *endNodeIds,
  uint8_t endNodeIdsBufSize,
  uint8_t & endNodeIdsCount
)

このメソッドは、指定されたセッションを共有するすべてのエンドノード ID を返します。

詳細
パラメータ
[in] sessionKey
セッション キー オブジェクトへのポインタ。
[in] endNodeIds
ノード ID のバッファへのポインタ。
[in] endNodeIdsMaxCount
バッファに格納できるノード ID の最大数。
[out] endNodeIdsCount
指定されたセッションを共有する、検出されたエンドノード ID の数。
戻り値
WEAVE_ERROR_BUFFER_TOO_SMALL
指定された場合、終了ノード ID バッファのサイズが十分ではありません。
WEAVE_NO_ERROR
成功時。

HandleConnectionClosed

void HandleConnectionClosed(
  WeaveConnection *con
)

init

WEAVE_ERROR Init(
  void
)

init

WEAVE_ERROR Init(
  nl::Weave::Profiles::Security::AppKeys::GroupKeyStoreBase *groupKeyStore
)

IsFabricAddress

bool IsFabricAddress(
  const IPAddress & addr
) const

IP アドレスがローカル Weave ファブリック内のノードのアドレスを表すかどうかを判別します。

IsLocalFabricAddress

bool IsLocalFabricAddress(
  const IPAddress & addr
) const

IP アドレスがローカルノードの Weave ファブリック アドレスを表すかどうかを示します。

IsSharedSession

bool IsSharedSession(
  uint16_t keyId,
  uint64_t peerNodeId
)

このメソッドは、指定されたピアと keyId に関連付けられたセキュア セッションが共有されているかどうかをチェックします。

詳細
パラメータ
[in] keyId
セッションキーの識別子。
[in] peerNodeId
ピアのノード ID。
戻り値
bool
指定したセッションが共有されているかどうか。

JoinExistingFabric

WEAVE_ERROR JoinExistingFabric(
  const uint8_t *fabricState,
  uint32_t fabricStateLen
)

RegisterSessionEndCallback

WEAVE_ERROR RegisterSessionEndCallback(
  SessionEndCbCtxt *sessionEndCb
)

RemoveIdleSessionKeys

bool RemoveIdleSessionKeys()

RemoveSessionKey

WEAVE_ERROR RemoveSessionKey(
  uint16_t keyId,
  uint64_t peerNodeId
)

RemoveSessionKey

void RemoveSessionKey(
  WeaveSessionKey *sessionKey,
  bool wasIdle
)

RemoveSharedSessionEndNodes

void RemoveSharedSessionEndNodes(
  const WeaveSessionKey *sessionKey
)

RestoreSession

WEAVE_ERROR RestoreSession(
  uint8_t *serializedSession,
  uint16_t serializedSessionLen
)

以前に中断した Weave セキュリティ セッションをシリアル化された状態から復元します。

SelectNodeAddress

IPAddress SelectNodeAddress(
  uint64_t nodeId,
  uint16_t subnet
) const

指定したノードの Weave ULA を含む IPAddress を返します。

このバリアントによってサブネットを指定できます。

詳細
パラメータ
[in] nodeId
該当するノードのノード ID 番号。
[in] subnet
ULA の目的のサブネット。
戻り値
IPAddress
IPAddress オブジェクト。

SelectNodeAddress

IPAddress SelectNodeAddress(
  uint64_t nodeId
) const

指定したノードの Weave ULA を含む IPAddress を返します。

このバリアントは、ローカルノードのデフォルト サブネットを使用します。

詳細
パラメータ
[in] nodeId
該当するノードのノード ID 番号。
戻り値
IPAddress
IPAddress オブジェクト。

SetDelegate

void SetDelegate(
  FabricStateDelegate *aDelegate
)

このメソッドはデリゲート オブジェクトを設定します。

デリゲートのコールバック メソッドは、FabricId が変更されたとき（ファブリックの参加/作成時、ファブリックの終了時（ファブリックのクリア状態））に呼び出されます

すでにデリゲートが設定されている場合は、このメソッドを再度呼び出すと、以前のデリゲートが上書きされます。

詳細
パラメータ
[in] aDelegate
委譲オブジェクト。デリゲートが不要な場合は、NULL にすることもできます。

SetSessionKey

WEAVE_ERROR SetSessionKey(
  uint16_t keyId,
  uint64_t peerNodeId,
  uint8_t encType,
  WeaveAuthMode authMode,
  const WeaveEncryptionKey *encKey
)

SetSessionKey

WEAVE_ERROR SetSessionKey(
  WeaveSessionKey *sessionKey,
  uint8_t encType,
  WeaveAuthMode authMode,
  const WeaveEncryptionKey *encKey
)

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

SuspendSession

WEAVE_ERROR SuspendSession(
  uint16_t keyId,
  uint64_t peerNodeId,
  uint8_t *buf,
  uint16_t bufSize,
  uint16_t & serializedSessionLen
)

アクティブな Weave セキュリティ セッションを一時停止して、状態をシリアル化します。

識別された Weave セキュリティ セッションの状態を、指定されたバッファにシリアル化し、それ以上のメッセージの送受信ができないようにセッションを一時停止します。

このメソッドは、スリープ中に RAM を保持しないデバイスで使用することを目的としています。これにより、アクティブなセッションの状態が維持され、復帰時にセッションを再確立する必要がなくなります。

WeaveFabricState

 WeaveFabricState(
  void
)