nl::Weave::WeaveFabricState

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

Declaração de WeaveFabricState aprovada.

Resumo

Construtores e destruidores
WeaveFabricState(void)

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

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

Funções públicas
AddSharedSessionEndNode(uint64_t endNodeId, uint64_t terminatingNodeId, uint16_t keyId)
AddSharedSessionEndNode(WeaveSessionKey *sessionKey, uint64_t endNodeId)
Esse método adiciona um novo nó final ao registro compartilhado.
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)
Esse método encontra a entrada da chave de sessão.
FindSharedSession(uint64_t terminatingNodeId, WeaveAuthMode authMode, uint8_t encType)
Procura na tabela de chaves de sessão uma chave de sessão compartilhada estabelecida que segmente o nó de encerramento especificado e que corresponda ao modo de autenticação e ao tipo de criptografia especificados.
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)
Esse método retorna todos os IDs de nós finais que compartilham uma sessão específica.
HandleConnectionClosed(WeaveConnection *con)
void
Init(void)
Init(nl::Weave::Profiles::Security::AppKeys::GroupKeyStoreBase *groupKeyStore)
IsFabricAddress(const IPAddress & addr) const
bool
Determina se um endereço IP representa um endereço de um nó no tecido do Weave local.
IsLocalFabricAddress(const IPAddress & addr) const
bool
Determina se um endereço IP representa um endereço do tecido do Weave para o nó local.
IsSharedSession(uint16_t keyId, uint64_t peerNodeId)
bool
Esse método verifica se a sessão segura associada ao par e ao keyId especificados está compartilhada.
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)
Restaurar uma sessão de segurança do Weave suspensa anteriormente de um estado serializado.
SelectNodeAddress(uint64_t nodeId, uint16_t subnet) const
Retorna um IPAddress que contém um ULA de Weave para um nó especificado.
SelectNodeAddress(uint64_t nodeId) const
Retorna um IPAddress que contém um ULA de Weave para um nó especificado.
SetDelegate(FabricStateDelegate *aDelegate)
void
Esse método define o 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)
Suspenda e serialize o estado de uma sessão de segurança ativa do Weave.

Estruturas
nl::WeaveFabric::WeaveFabricState::SessionEndCbCtxt

Tipos públicos

Tipo de índice

uint8_t PeerIndexType

SessãoEncerrarCbFunct

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

Estado

 State

Atributos públicos

AutoKeyKeys

bool AutoCreateKeys

DebugFabricId.

uint64_t DebugFabricId

Sub-rede padrão

uint16_t DefaultSubnet

FabricId

uint64_t FabricId

ChaveiroGrupo

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

ListenIPv4Addr.

IPAddress ListenIPv4Addr

ListenIPv6Addr.

IPAddress ListenIPv6Addr

Código de nó local

uint64_t LocalNodeId

Chaves de registro

bool LogKeys

MaxUnencUDPMsgIdRcvd

uint32_t MaxUnencUDPMsgIdRcvd[WEAVE_CONFIG_MAX_PEER_NODES]

MessageLayer

WeaveMessageLayer * MessageLayer

Índices usados mais recentemente

PeerIndexType MostRecentlyUsedIndexes[WEAVE_CONFIG_MAX_PEER_NODES]

Nó

uint64_t NodeId[WEAVE_CONFIG_MAX_PEER_NODES]

Código de pareamento

const char * PairingCode

Estado

uint8_t State

Sinalizações de unencRcv

WeaveSessionState::ReceiveFlagsType UnencRcvFlags[WEAVE_CONFIG_MAX_PEER_NODES]

Usar TestTest

bool UseTestKey

Funções públicas

AddSharedSessionEndNode

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

AddSharedSessionEndNode

WEAVE_ERROR AddSharedSessionEndNode(
  WeaveSessionKey *sessionKey,
  uint64_t endNodeId
)

Esse método adiciona um novo nó final ao registro compartilhado.

Detalhes
Parâmetros
[in] sessionKey
Objeto WeaveSessionKey que representa a sessão a que o novo nó final será adicionado.
[in] endNodeId
O ID do nó do nó final da sessão a ser adicionado.
Valores de retorno
WEAVE_ERROR_TOO_MANY_SHARED_SESSION_END_NODES
Se não houver espaço livre para uma nova entrada na lista de nós finais compartilhados.
WEAVE_NO_ERROR
Em caso de sucesso.

Chave de sessão

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

Estado ClearFabric

void ClearFabricState(
  void
)

CreateFabric

WEAVE_ERROR CreateFabric(
  void
)

Chave da sessão

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

Esse método encontra a entrada da chave de sessão.

Detalhes
Parâmetros
[in] keyId
Identificador de chave de tecido.
[in] peerNodeId
O identificador de nó do terminal.
[in] create
Um valor booleano que indica se a nova chave precisa ser criada se a chave especificada não for encontrada.
[out] retRec
Uma referência de ponteiro para um objeto WeaveSessionKey.
Valores de retorno
WEAVE_ERROR_WRONG_KEY_TYPE
Se a chave especificada não for um tipo de chave de sessão.
WEAVE_ERROR_INVALID_ARGUMENT
Se os argumentos de entrada tiverem valores errados.
WEAVE_ERROR_KEY_NOT_FOUND
Se a chave especificada não for encontrada.
WEAVE_ERROR_TOO_MANY_KEYS
Se não houver entrada gratuita para criar uma nova chave de sessão.
WEAVE_NO_ERROR
Em caso de sucesso.

FindSharedSession

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

Procura na tabela de chaves de sessão uma chave de sessão compartilhada estabelecida que segmente o nó de encerramento especificado e que corresponda ao modo de autenticação e ao tipo de criptografia especificados.

Detalhes
Parâmetros
[in] terminatingNodeId
O identificador de nó do terminador de sessão.
[in] authMode
O modo de autenticação da sessão desejado.
[in] encType
O tipo de criptografia de mensagem desejado.
Valores de retorno
WeaveSessionKey
* Um ponteiro para um objeto WeaveSessionKey que representa a sessão compartilhada correspondente, ou NULL se nenhuma sessão correspondente for encontrada.

GetFabricState

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

GetPassword (em inglês)

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
)

Esse método retorna todos os IDs de nós finais que compartilham uma sessão específica.

Detalhes
Parâmetros
[in] sessionKey
Um ponteiro para o objeto da chave de sessão.
[in] endNodeIds
Um ponteiro para buffer de IDs de nó.
[in] endNodeIdsMaxCount
O número máximo de IDs de nós que podem caber no buffer.
[out] endNodeIdsCount
Número de IDs de nós finais encontrados que compartilham a sessão especificada.
Valores de retorno
WEAVE_ERROR_BUFFER_TOO_SMALL
Se fornecido, o buffer de IDs do nó final não é grande o suficiente.
WEAVE_NO_ERROR
Em caso de sucesso.

HandleConnectionClosed

void HandleConnectionClosed(
  WeaveConnection *con
)

Init

WEAVE_ERROR Init(
  void
)

Init

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

Endereço da IsFabric

bool IsFabricAddress(
  const IPAddress & addr
) const

Determina se um endereço IP representa um endereço de um nó no tecido do Weave local.

EndereçoLocalLocalFabric

bool IsLocalFabricAddress(
  const IPAddress & addr
) const

Determina se um endereço IP representa um endereço do tecido do Weave para o nó local.

IsSharedSession

bool IsSharedSession(
  uint16_t keyId,
  uint64_t peerNodeId
)

Esse método verifica se a sessão segura associada ao par e ao keyId especificados está compartilhada.

Detalhes
Parâmetros
[in] keyId
O identificador da chave de sessão.
[in] peerNodeId
O identificador de nó do terminal.
Valores de retorno
bool
Indica se a sessão especificada foi ou não compartilhada.

JoinExistingFabric

WEAVE_ERROR JoinExistingFabric(
  const uint8_t *fabricState,
  uint32_t fabricStateLen
)

RegisterSessionEndCallback

WEAVE_ERROR RegisterSessionEndCallback(
  SessionEndCbCtxt *sessionEndCb
)

RemoveIdleSessionKeys

bool RemoveIdleSessionKeys()

RemoverChaveChave

WEAVE_ERROR RemoveSessionKey(
  uint16_t keyId,
  uint64_t peerNodeId
)

RemoverChaveChave

void RemoveSessionKey(
  WeaveSessionKey *sessionKey,
  bool wasIdle
)

RemoveSharedSessionEndNodes

void RemoveSharedSessionEndNodes(
  const WeaveSessionKey *sessionKey
)

RestoreSession

WEAVE_ERROR RestoreSession(
  uint8_t *serializedSession,
  uint16_t serializedSessionLen
)

Restaurar uma sessão de segurança do Weave suspensa anteriormente de um estado serializado.

SelectNodeAddress

IPAddress SelectNodeAddress(
  uint64_t nodeId,
  uint16_t subnet
) const

Retorna um IPAddress que contém um ULA de Weave para um nó especificado.

Com essa variante, é possível especificar uma sub-rede.

Detalhes
Parâmetros
[in] nodeId
O ID do nó em questão.
[in] subnet
A sub-rede desejada do ULA.
Valores de retorno
IPAddress
Um objeto IPAddress.

SelectNodeAddress

IPAddress SelectNodeAddress(
  uint64_t nodeId
) const

Retorna um IPAddress que contém um ULA de Weave para um nó especificado.

Essa variante usa a sub-rede padrão do nó local.

Detalhes
Parâmetros
[in] nodeId
O ID do nó em questão.
Valores de retorno
IPAddress
Um objeto IPAddress.

Delegado

void SetDelegate(
  FabricStateDelegate *aDelegate
)

Esse método define o objeto delegado.

Os métodos de retorno de chamada da delegação são invocados sempre que o FabricId é alterado, ou seja, quando mesclamos/criamos um tecido ou deixamos um tecido (limpa no estado do tecido)

Se o delegado já tiver sido definido anteriormente, uma segunda chamada para esse método substituirá o delegado anterior.

Detalhes
Parâmetros
[in] aDelegate
O objeto delegado. Ela pode ser NULL se nenhum delegado for necessário.

Chavedesessão

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

Chavedesessão

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

Encerramento

WEAVE_ERROR Shutdown(
  void
)

SuspendSession

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

Suspenda e serialize o estado de uma sessão de segurança ativa do Weave.

Serializa o estado de uma sessão de segurança do Weave identificada no buffer fornecido e suspende a sessão para que nenhuma outra mensagem possa ser enviada ou recebida.

Esse método deve ser usado por dispositivos que não retêm RAM durante o sono, permitindo que eles persistam o estado de uma sessão ativa e, assim, evitam a necessidade de restabelecer a sessão quando eles acordam.

WeaveFabricState

 WeaveFabricState(
  void
)