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 تعداد

السمات العامة
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)
تعرض هذه الطريقة جميع أرقام تعريف العُقد النهائية التي تشترك في جلسة محدّدة.
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
تتحقّق هذه الطريقة مما إذا تمت مشاركة الجلسة الآمنة المرتبطة بالنظير ومعرّف المفتاح المحدّدَين.
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
يعرض IPAddress الذي يحتوي على Weave ULA لعقدة محددة.
SelectNodeAddress(uint64_t nodeId) const
يعرض IPAddress الذي يحتوي على Weave ULA لعقدة محددة.
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
رقم تعريف العقدة لعقدة نهاية الجلسة المطلوب إضافتها.
قيم الإرجاع
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
معرِّف العقدة المعنيّة.
[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
معرِّف العقدة لفاصل الجلسة.
[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
)

تعرض هذه الطريقة جميع أرقام تعريف العُقد النهائية التي تشترك في جلسة محدّدة.

التفاصيل
المعلمات
[in] sessionKey
مؤشر يوجّه إلى كائن مفتاح الجلسة
[in] endNodeIds
يشير هذا المصطلح إلى مؤشر للمخزن المؤقت لأرقام تعريف العُقد.
[in] endNodeIdsMaxCount
الحد الأقصى لعدد أرقام تعريف العُقد التي يمكن احتواؤها في المخزن المؤقت.
[out] endNodeIdsCount
عدد أرقام تعريف العُقد النهائية التي تم العثور عليها والتي تشترك في جلسة محدّدة.
قيم الإرجاع
WEAVE_ERROR_BUFFER_TOO_SMALL
إذا كان المخزن المؤقت لأرقام تعريف العُقد النهائية الذي تم تقديمه ليس كبيرًا بما فيه الكفاية.
WEAVE_NO_ERROR
عند النجاح.

HandleConnectionClosed

void HandleConnectionClosed(
  WeaveConnection *con
)

إعداد

WEAVE_ERROR Init(
  void
)

إعداد

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
)

تتحقّق هذه الطريقة مما إذا كانت تتم مشاركة الجلسة الآمنة المرتبطة بالنظير المحدّد ومعرّف المفتاح.

التفاصيل
المعلمات
[in] keyId
معرِّف مفتاح الجلسة.
[in] peerNodeId
معرِّف العقدة المعنيّة.
قيم الإرجاع
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

يعرض IPAddress الذي يحتوي على Weave ULA لعقدة محددة.

يتيح هذا الصيغة تحديد شبكة فرعية.

التفاصيل
المعلمات
[in] nodeId
رقم تعريف العُقدة للعقدة المعنية.
[in] subnet
الشبكة الفرعية المطلوبة ULA.
قيم الإرجاع
IPAddress
عنصر IPAddress.

SelectNodeAddress

IPAddress SelectNodeAddress(
  uint64_t nodeId
) const

يعرض IPAddress الذي يحتوي على Weave ULA لعقدة محددة.

تستخدم هذه الصيغة الشبكة الفرعية التلقائية للعقدة المحلية.

التفاصيل
المعلمات
[in] nodeId
رقم تعريف العُقدة للعقدة المعنية.
قيم الإرجاع
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 المحددة في المخزن المؤقت المقدم وتعليق الجلسة بحيث لا يمكن إرسال رسائل أخرى أو استلامها.

والغرض من هذه الطريقة هو أن تستخدمها الأجهزة التي لا تحتفظ بذاكرة الوصول العشوائي أثناء النوم، مما يسمح لها بالحفاظ على حالة الجلسة النشطة وبالتالي تجنب الحاجة إلى إعادة إنشاء الجلسة عند تنشيطها.

WeaveFabricState

 WeaveFabricState(
  void
)