nl::Weave::WeaveFabricState

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

Declaración reenviada de WeaveFabricState

Resumen

Constructores y destructores
WeaveFabricState(void)

Tipos públicos
PeerIndexType typedef
uint8_t
SessionEndCbFunct)(uint16_t keyId, uint64_t peerNodeId, void *context) typedef
void(*
State enum

Atributos públicos
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

Funciones públicas
AddSharedSessionEndNode(uint64_t endNodeId, uint64_t terminatingNodeId, uint16_t keyId)
AddSharedSessionEndNode(WeaveSessionKey *sessionKey, uint64_t endNodeId)
Este método agrega un nodo final nuevo al registro de nodos finales compartidos.
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)
Este método busca la entrada de la clave de sesión.
FindSharedSession(uint64_t terminatingNodeId, WeaveAuthMode authMode, uint8_t encType)
Busca en la tabla de claves de sesión una clave de sesión compartida establecida que se oriente al nodo de finalización especificado y coincida con el modo de autenticación y el tipo de encriptación determinados.
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)
Este método muestra todos los ID del nodo final que comparten la sesión especificada.
HandleConnectionClosed(WeaveConnection *con)
void
Init(void)
Init(nl::Weave::Profiles::Security::AppKeys::GroupKeyStoreBase *groupKeyStore)
IsFabricAddress(const IPAddress & addr) const
bool
Determina si una dirección IP representa la dirección de un nodo dentro de la estructura local de Weave.
IsLocalFabricAddress(const IPAddress & addr) const
bool
Determina si una dirección IP representa una dirección de estructura de Weave para el nodo local.
IsSharedSession(uint16_t keyId, uint64_t peerNodeId)
bool
Este método verifica si se comparte la sesión segura asociada con el par y keyId especificados.
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)
Restablece una sesión de seguridad de Weave suspendida anteriormente a partir de un estado serializado.
SelectNodeAddress(uint64_t nodeId, uint16_t subnet) const
Muestra una dirección IP que contiene una ULA de Weave para un nodo especificado.
SelectNodeAddress(uint64_t nodeId) const
Muestra una dirección IP que contiene una ULA de Weave para un nodo especificado.
SetDelegate(FabricStateDelegate *aDelegate)
void
Este método configura el objeto delegado.
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)
Suspende y serializa el estado de una sesión de seguridad activa de Weave.

Structs
nl::Weave::WeaveFabricState::SessionEndCbCtxt

Tipos públicos

PeerIndexType

uint8_t PeerIndexType

SessionEndCbFunct

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

Estado

 State

Atributos públicos

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

Estado

uint8_t State

UnencRcvFlags

WeaveSessionState::ReceiveFlagsType UnencRcvFlags[WEAVE_CONFIG_MAX_PEER_NODES]

UseTestKey

bool UseTestKey

Funciones públicas

AddSharedSessionEndNode

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

AddSharedSessionEndNode

WEAVE_ERROR AddSharedSessionEndNode(
  WeaveSessionKey *sessionKey,
  uint64_t endNodeId
)

Este método agrega un nodo final nuevo al registro de nodos finales compartidos.

Detalles
Parámetros
[in] sessionKey
El objeto WeaveSessionKey que representa la sesión para la que se debe agregar el nodo final nuevo.
[in] endNodeId
El ID del nodo de finalización de sesión que se agregará.
Valores que se muestran
WEAVE_ERROR_TOO_MANY_SHARED_SESSION_END_NODES
Si no hay espacio libre para una entrada nueva en la lista de nodos finales compartidos.
WEAVE_NO_ERROR
Si la operación es exitosa.

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
)

Este método busca la entrada de la clave de sesión.

Detalles
Parámetros
[in] keyId
Es el identificador de clave de Weave.
[in] peerNodeId
El identificador de nodo del par.
[in] create
Valor booleano que indica si se debe crear una clave nueva en caso de que no se encuentre la clave especificada.
[out] retRec
Una referencia de puntero a un objeto WeaveSessionKey.
Valores que se muestran
WEAVE_ERROR_WRONG_KEY_TYPE
Si la clave especificada no es un tipo de clave de sesión.
WEAVE_ERROR_INVALID_ARGUMENT
Si los argumentos de entrada tienen valores incorrectos.
WEAVE_ERROR_KEY_NOT_FOUND
Si no se encuentra la clave especificada.
WEAVE_ERROR_TOO_MANY_KEYS
Si no hay una entrada gratuita para crear una nueva clave de sesión.
WEAVE_NO_ERROR
Si la operación es exitosa.

FindSharedSession

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

Busca en la tabla de claves de sesión una clave de sesión compartida establecida que se oriente al nodo de finalización especificado y coincida con el modo de autenticación y el tipo de encriptación determinados.

Detalles
Parámetros
[in] terminatingNodeId
Es el identificador de nodo del terminador de sesión.
[in] authMode
El modo de autenticación de sesión deseado.
[in] encType
El tipo de encriptación de mensaje deseado.
Valores que se muestran
WeaveSessionKey
* Un puntero a un objeto WeaveSessionKey que representa la sesión compartida correspondiente; o NULL si no se encontró ninguna sesión coincidente.

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
)

Este método muestra todos los ID del nodo final que comparten la sesión especificada.

Detalles
Parámetros
[in] sessionKey
Un puntero para el objeto de clave de sesión.
[in] endNodeIds
Un puntero para el búfer de los IDs de nodo.
[in] endNodeIdsMaxCount
La cantidad máxima de ID de nodo que caben en el búfer.
[out] endNodeIdsCount
Cantidad de IDs de nodo final encontrados que comparten la sesión especificada.
Valores que se muestran
WEAVE_ERROR_BUFFER_TOO_SMALL
Si el búfer de ID del nodo final proporcionado no es lo suficientemente grande.
WEAVE_NO_ERROR
Si la operación es exitosa.

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

Determina si una dirección IP representa la dirección de un nodo dentro de la estructura local de Weave.

IsLocalFabricAddress

bool IsLocalFabricAddress(
  const IPAddress & addr
) const

Determina si una dirección IP representa una dirección de estructura de Weave para el nodo local.

IsSharedSession

bool IsSharedSession(
  uint16_t keyId,
  uint64_t peerNodeId
)

Este método verifica si se comparte la sesión segura asociada con el par y keyId especificados.

Detalles
Parámetros
[in] keyId
Es el identificador de la clave de sesión.
[in] peerNodeId
El identificador de nodo del par.
Valores que se muestran
bool
Si la sesión especificada se compartió o no.

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
)

Restablece una sesión de seguridad de Weave suspendida anteriormente a partir de un estado serializado.

SelectNodeAddress

IPAddress SelectNodeAddress(
  uint64_t nodeId,
  uint16_t subnet
) const

Muestra una dirección IP que contiene una ULA de Weave para un nodo especificado.

Esta variante permite que se especifique una subred.

Detalles
Parámetros
[in] nodeId
El número de ID del nodo en cuestión.
[in] subnet
Es la subred deseada de la ULA.
Valores que se muestran
IPAddress
Un objeto IPAddress.

SelectNodeAddress

IPAddress SelectNodeAddress(
  uint64_t nodeId
) const

Muestra una dirección IP que contiene una ULA de Weave para un nodo especificado.

Esta variante usa la subred predeterminada del nodo local.

Detalles
Parámetros
[in] nodeId
El número de ID del nodo en cuestión.
Valores que se muestran
IPAddress
Un objeto IPAddress.

SetDelegate

void SetDelegate(
  FabricStateDelegate *aDelegate
)

Este método configura el objeto delegado.

Los métodos de devolución de llamada del delegado se invocan cada vez que se cambia el FabricId, es decir, cuando unimos o creamos una tela, o cuando dejamos una tela (borrar el estado de la tela).

Si el delegado ya se configuró, una segunda llamada a este método reemplazará al delegado anterior.

Detalles
Parámetros
[in] aDelegate
Es el objeto delegado. Puede ser NULL si no se requiere un delegado.

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
)

Cierre

WEAVE_ERROR Shutdown(
  void
)

SuspendSession

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

Suspende y serializa el estado de una sesión de seguridad activa de Weave.

Serializa el estado de una sesión de seguridad de Weave identificada en el búfer proporcionado y suspende la sesión para que no se puedan enviar ni recibir más mensajes.

Este método está diseñado para que lo usen los dispositivos que no retienen RAM mientras están suspendidos, lo que les permite conservar el estado de una sesión activa y, por lo tanto, evitar la necesidad de restablecer la sesión cuando se activan.

WeaveFabricState

 WeaveFabricState(
  void
)