Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

nl ::織り:: WeaveSecurityManager

概要

コンストラクタとデストラクタ

WeaveSecurityManager (void)

パブリックタイプ

KeyErrorMsgRcvdFunct )(uint16_t keyId, uint8_t encType, uint32_t messageId, uint64_t peerNodeId, WEAVE_ERROR keyErr) typedef
void(*
キーエラーメッセージ処理機能の種類。
KeyExportCompleteFunct )(WeaveSecurityManager *sm, WeaveConnection *con, void *reqState, uint32_t exportedKeyId, const uint8_t *exportedKey, uint16_t exportedKeyLen) typedef
void(*
キーエクスポートプロトコルの完全な処理機能のタイプ。
KeyExportErrorFunct )(WeaveSecurityManager *sm, WeaveConnection *con, void *reqState, WEAVE_ERROR localErr, StatusReport *statusReport) typedef
void(*
キーエクスポートプロトコルのエラー処理機能のタイプ。
SessionErrorFunct )(WeaveSecurityManager *sm, WeaveConnection *con, void *reqState, WEAVE_ERROR localErr, uint64_t peerNodeId, StatusReport *statusReport) typedef
void(*
SessionEstablishedFunct )(WeaveSecurityManager *sm, WeaveConnection *con, void *reqState, uint16_t sessionKeyId, uint64_t peerNodeId, uint8_t encType) typedef
void(*
State列挙型

パブリック属性

CASEUseKnownECDHKey
bool
ExchangeManager
FabricState
IdleSessionTimeout
uint32_t
InitiatorAllowedCASEConfigs
uint8_t
InitiatorAllowedCASECurves
uint8_t
InitiatorAllowedKeyExportConfigs
uint8_t
InitiatorCASEConfig
uint32_t
InitiatorCASECurveId
uint32_t
InitiatorKeyExportConfig
uint8_t
OnKeyErrorMsgRcvd
キーエラーコールバック関数。
OnSessionError
SessionErrorFunct
OnSessionEstablished
SessionEstablishedFunct
ResponderAllowedCASEConfigs
uint8_t
ResponderAllowedCASECurves
uint8_t
ResponderAllowedKeyExportConfigs
uint8_t
SessionEstablishTimeout
uint32_t
State
uint8_t
mCASEEngine
mKeyExport
mPASEEngine
mStartKeyExport_OnComplete
キーエクスポートプロトコルの完全なコールバック関数。
mStartKeyExport_OnError
キーエクスポートプロトコルエラーコールバック関数。
mStartKeyExport_ReqState
void *
mStartSecureSession_OnComplete
SessionEstablishedFunct
mStartSecureSession_OnError
SessionErrorFunct
mStartSecureSession_ReqState
void *
mTAKEEngine

公共機能

CancelSessionEstablishment (void *reqState)
進行中のセッションの確立をキャンセルします。
Init ( WeaveExchangeManager & aExchangeMgr, System::Layer & aSystemLayer)
IsKeyError ( WEAVE_ERROR err)
bool
指定されたWeaveエラーコードが主要なエラーコードの1つであるかどうかを確認します。
OnEncryptedMsgRcvd (uint16_t sessionKeyId, uint64_t peerNodeId, uint8_t encType)
void
ReleaseKey (uint64_t peerNodeId, uint16_t keyId)
void
メッセージ暗号化キーの予約を解除します。
ReserveKey (uint64_t peerNodeId, uint16_t keyId)
void
メッセージ暗号化キーを予約します。
SendKeyErrorMsg ( WeaveMessageInfo *rcvdMsgInfo, const IPPacketInfo *rcvdMsgPacketInfo, WeaveConnection *con, WEAVE_ERROR keyErr)
キーエラーメッセージを送信します。
SetCASEAuthDelegate ( WeaveCASEAuthDelegate *delegate)
void
SetKeyExportDelegate ( WeaveKeyExportDelegate *delegate)
void
SetTAKEAuthDelegate ( WeaveTAKEChallengerAuthDelegate *delegate)
void
SetTAKETokenAuthDelegate ( WeaveTAKETokenAuthDelegate *delegate)
void
Shutdown (void)
StartCASESession ( WeaveConnection *con, uint64_t peerNodeId, const IPAddress & peerAddr, uint16_t peerPort, WeaveAuthMode requestedAuthMode, void *reqState, SessionEstablishedFunct onComplete, SessionErrorFunct onError, WeaveCASEAuthDelegate *authDelegate, uint64_t terminatingNodeId)
このメソッドは、新しいCASEセッションを確立するか、既存のCASEセッションを見つけるために呼び出されます。
StartKeyExport ( WeaveConnection *con, uint64_t peerNodeId, const IPAddress & peerAddr, uint16_t peerPort, uint32_t keyId, bool signMessage, void *reqState, KeyExportCompleteFunct onComplete, KeyExportErrorFunct onError, WeaveKeyExportDelegate *keyExportDelegate)
StartPASESession ( WeaveConnection *con, WeaveAuthMode requestedAuthMode, void *reqState, SessionEstablishedFunct onComplete, SessionErrorFunct onError, const uint8_t *pw, uint16_t pwLen)
このメソッドは、安全なPASEセッションを確立するために呼び出されます。
StartTAKESession ( WeaveConnection *con, WeaveAuthMode requestedAuthMode, void *reqState, SessionEstablishedFunct onComplete, SessionErrorFunct onError, bool encryptAuthPhase, bool encryptCommPhase, bool timeLimitedIK, bool sendChallengerId, WeaveTAKEChallengerAuthDelegate *authDelegate)
このメソッドは、安全なTAKEセッションを確立するために呼び出されます。

パブリックタイプ

KeyErrorMsgRcvdFunct

void(* KeyErrorMsgRcvdFunct)(uint16_t keyId, uint8_t encType, uint32_t messageId, uint64_t peerNodeId, WEAVE_ERROR keyErr)

キーエラーメッセージ処理機能の種類。

詳細
パラメーター
[in] keyId
暗号化キーにより、ピアからのキーエラーメッセージ応答が発生しました。
[in] encType
KEYIDに関連付けられている暗号化タイプ。
[in] messageId
ウィーブメッセージの識別子により、ピアからキーエラー応答が発生しました。
[in] peerNodeId
キーエラーメッセージを送信したWeaveノードの識別子。
[in] keyErr
ピアから受信したエラーコード。

KeyExportCompleteFunct

void(* KeyExportCompleteFunct)(WeaveSecurityManager *sm, WeaveConnection *con, void *reqState, uint32_t exportedKeyId, const uint8_t *exportedKey, uint16_t exportedKeyLen)

キーエクスポートプロトコルの完全な処理機能のタイプ。

詳細
パラメーター
[in] sm
ポインタWeaveSecurityManagerのオブジェクト。
[in] con
ポインタWeaveConnectionのオブジェクト。
[in] reqState
キーエクスポートリクエスターの状態へのポインター。
[in] keyId
エクスポートされたキーID。
[in] exportedKey
エクスポートされた秘密鍵へのポインター。
[in] exportedKeyLen
エクスポートされた秘密鍵の長さへの参照。

KeyExportErrorFunct

void(* KeyExportErrorFunct)(WeaveSecurityManager *sm, WeaveConnection *con, void *reqState, WEAVE_ERROR localErr, StatusReport *statusReport)

キーエクスポートプロトコルのエラー処理機能のタイプ。

詳細
パラメーター
[in] sm
ポインタWeaveSecurityManagerのオブジェクト。
[in] con
ポインタWeaveConnectionのオブジェクト。
[in] reqState
キーエクスポートリクエスターの状態へのポインター。
[in] localErr
キーエクスポートプロトコル中にWEAVE_ERRORが発生しました。
[in] statusReport
ピアからエラーステータスを受信した場合のStatusReportオブジェクトへのポインタ。

SessionErrorFunct

void(* SessionErrorFunct)(WeaveSecurityManager *sm, WeaveConnection *con, void *reqState, WEAVE_ERROR localErr, uint64_t peerNodeId, StatusReport *statusReport)

SessionEstablishedFunct

void(* SessionEstablishedFunct)(WeaveSecurityManager *sm, WeaveConnection *con, void *reqState, uint16_t sessionKeyId, uint64_t peerNodeId, uint8_t encType)

状態

 State

パブリック属性

CASEUseKnownECDHKey

bool CASEUseKnownECDHKey

ExchangeManager

WeaveExchangeManager * ExchangeManager

FabricState

WeaveFabricState * FabricState

IdleSessionTimeout

uint32_t IdleSessionTimeout

InitiatorAllowedCASEConfigs

uint8_t InitiatorAllowedCASEConfigs

InitiatorAllowedCASECurves

uint8_t InitiatorAllowedCASECurves

InitiatorAllowedKeyExportConfigs

uint8_t InitiatorAllowedKeyExportConfigs

InitiatorCASEConfig

uint32_t InitiatorCASEConfig

イニシエーターCASECurveId

uint32_t InitiatorCASECurveId

InitiatorKeyExportConfig

uint8_t InitiatorKeyExportConfig

OnKeyErrorMsgRcvd

KeyErrorMsgRcvdFunct OnKeyErrorMsgRcvd

キーエラーコールバック関数。

この関数は、キーエラーメッセージを受信したときに呼び出されます。

OnSessionError

SessionErrorFunct OnSessionError

OnSessionEstablished

SessionEstablishedFunct OnSessionEstablished

ResponderAllowedCASEConfigs

uint8_t ResponderAllowedCASEConfigs

ResponderAllowedCASECurves

uint8_t ResponderAllowedCASECurves

ResponderAllowedKeyExportConfigs

uint8_t ResponderAllowedKeyExportConfigs

SessionEstablishTimeout

uint32_t SessionEstablishTimeout

状態

uint8_t State

mCASEEngine

WeaveCASEEngine * mCASEEngine

mKeyExport

WeaveKeyExport * mKeyExport

mPASEEngine

WeavePASEEngine * mPASEEngine

mStartKeyExport_OnComplete

KeyExportCompleteFunct mStartKeyExport_OnComplete

キーエクスポートプロトコルの完全なコールバック関数。

この関数は、秘密鍵のエクスポートプロセスが完了すると呼び出されます。

mStartKeyExport_OnError

KeyExportErrorFunct mStartKeyExport_OnError

キーエクスポートプロトコルエラーコールバック関数。

この関数は、キーのエクスポートプロセス中にエラーが発生したときに呼び出されます。

mStartKeyExport_ReqState

void * mStartKeyExport_ReqState

mStartSecureSession_OnComplete

SessionEstablishedFunct mStartSecureSession_OnComplete

mStartSecureSession_OnError

SessionErrorFunct mStartSecureSession_OnError

mStartSecureSession_ReqState

void * mStartSecureSession_ReqState

mTAKEEngine

WeaveTAKEEngine * mTAKEEngine

公共機能

CancelSessionEstablishment

WEAVE_ERROR CancelSessionEstablishment(
  void *reqState
)

進行中のセッション確立をキャンセルします。

詳細
パラメーター
[in] reqState
セッションの開始時にアプリケーションによって提供された値と一致するポインター値。
戻り値
WEAVE_NO_ERROR
一致する進行中のセッション確立が見つかり、キャンセルされた場合。
WEAVE_ERROR_INCORRECT_STATE
進行中のセッション確立がなかった場合、または進行中のセッションが指定された要求状態ポインターと一致しなかった場合。

初期化

WEAVE_ERROR Init(
  WeaveExchangeManager & aExchangeMgr,
  System::Layer & aSystemLayer
)

IsKeyError

bool IsKeyError(
  WEAVE_ERROR err
)

指定されたWeaveエラーコードが主要なエラーコードの1つであるかどうかを確認します。

この関数は、デコード中に正しいキーを見つけられなかったメッセージの開始者にキーエラーメッセージを送信する必要があるかどうかを判断するために呼び出されます。

詳細
パラメーター
[in] err
織りエラーコード。
戻り値
true
指定した場合、ウィーブエラーコードは重要なエラーです。
false
さもないと。

OnEncryptedMsgRcvd

void OnEncryptedMsgRcvd(
  uint16_t sessionKeyId,
  uint64_t peerNodeId,
  uint8_t encType
)

ReleaseKey

void ReleaseKey(
  uint64_t peerNodeId,
  uint16_t keyId
)

メッセージ暗号化キーの予約を解除します。

以前にメッセージ暗号化キーに設定されていた予約を解放します。

特定のキーの上に置かれ、すべての予約については、 ReleaseKey()メソッドは複数回呼ばれてはなりません。

このメソッドは、None を含む任意の形式のキー ID を受け入れます。実際のキーに名前を付けていないキーIDは無視されます。

詳細
パラメーター
[in] peerNodeId
キーが共有されたピアのウィーブノードID。
[in] keyId
予約を解除する必要があるキーのID。

ReserveKey

void ReserveKey(
  uint64_t peerNodeId,
  uint16_t keyId
)

メッセージ暗号化キーを予約します。

キー予約は、特定のキーがアクティブに使用されており、保持する必要があることを通知するために使用されます。キーに予約を入れても、KeyErrorメッセージの受信などの明示的なアクションによってキーが削除されないことを保証するものではないことに注意してください。

特定のキーの上に配置されたすべての予約のために対応する呼び出しReleaseKey()を行わなければなりません。

このメソッドは、Noneを含む任意の形式のキーIDを受け入れます。実際のキーに名前を付けていないキーIDは無視されます。

詳細
パラメーター
[in] peerNodeId
キーが共有されたピアのウィーブノードID。
[in] keyId
予約するキーの ID。

SendKeyErrorMsg

WEAVE_ERROR SendKeyErrorMsg(
  WeaveMessageInfo *rcvdMsgInfo,
  const IPPacketInfo *rcvdMsgPacketInfo,
  WeaveConnection *con,
  WEAVE_ERROR keyErr
)

キーエラーメッセージを送信します。

この関数は、受信したウィーブメッセージのデコードがキーエラーのために失敗したときに呼び出されます。

詳細
パラメーター
[in] rcvdMsgInfo
受信したWeaveメッセージのメッセージ情報へのポインタ。
[in] rcvdMsgPacketInfo
受信したWeaveメッセージのIPPacketInfoオブジェクトへのポインター。
[in] con
ポインタWeaveConnectionのオブジェクト。
[in] keyErr
キーエラーコードを織ります。
戻り値
WEAVE_ERROR_NO_MEMORY
新しい交換コンテキストまたは新しいメッセージバッファにメモリを割り当てることができなかった場合。
WEAVE_ERROR_BUFFER_TOO_SMALL
バッファが小さすぎる場合
WEAVE_NO_ERROR
メソッドが成功した場合。

SetCASEAuthDelegate

void SetCASEAuthDelegate(
  WeaveCASEAuthDelegate *delegate
)

SetKeyExportDelegate

void SetKeyExportDelegate(
  WeaveKeyExportDelegate *delegate
)

SetTAKEAuthDelegate

void SetTAKEAuthDelegate(
  WeaveTAKEChallengerAuthDelegate *delegate
)

SetTAKETokenAuthDelegate

void SetTAKETokenAuthDelegate(
  WeaveTAKETokenAuthDelegate *delegate
)

シャットダウン

WEAVE_ERROR Shutdown(
  void
)

StartCASESession

WEAVE_ERROR StartCASESession(
  WeaveConnection *con,
  uint64_t peerNodeId,
  const IPAddress & peerAddr,
  uint16_t peerPort,
  WeaveAuthMode requestedAuthMode,
  void *reqState,
  SessionEstablishedFunct onComplete,
  SessionErrorFunct onError,
  WeaveCASEAuthDelegate *authDelegate,
  uint64_t terminatingNodeId
)

このメソッドは、新しいCASEセッションを確立するか、既存のCASEセッションを見つけるために呼び出されます。

詳細
パラメーター
[in] con
ポインタWeaveConnectionのオブジェクト。
[in] peerNodeId
ピアのノード識別子。
[in] peerAddr
ピアノードのIPアドレス。
[in] peerPort
ピアノードのポート。
[in] requestedAuthMode
ピアを認証するための望ましい手段。これは、CASE認証モードの1つである必要があります。
[in] reqState
リクエスタの状態へのポインタ。
[in] onComplete
要求されたセキュアセッションが確立されると呼び出されるコールバック関数へのポインタ。
[in] onError
要求されたセッションの確立が失敗した場合に呼び出されるコールバック関数へのポインター。
[in] authDelegate
CASE認証デリゲートオブジェクトへのポインタ。
[in] terminatingNodeId
セッション終了ノードのノード識別子。この入力がkNodeIdNotSpecifiedと異なる場合、共有セキュアセッションが要求されたことを示します。
戻り値
WEAVE_NO_ERROR
成功時。

StartKeyExport

WEAVE_ERROR StartKeyExport(
  WeaveConnection *con,
  uint64_t peerNodeId,
  const IPAddress & peerAddr,
  uint16_t peerPort,
  uint32_t keyId,
  bool signMessage,
  void *reqState,
  KeyExportCompleteFunct onComplete,
  KeyExportErrorFunct onError,
  WeaveKeyExportDelegate *keyExportDelegate
)

StartPASESession

WEAVE_ERROR StartPASESession(
  WeaveConnection *con,
  WeaveAuthMode requestedAuthMode,
  void *reqState,
  SessionEstablishedFunct onComplete,
  SessionErrorFunct onError,
  const uint8_t *pw,
  uint16_t pwLen
)

このメソッドは、安全なPASEセッションを確立するために呼び出されます。

詳細
パラメーター
[in] con
ポインタWeaveConnectionのオブジェクト。
[in] requestedAuthMode
ピアを認証するための望ましい手段。これは、PASE認証モードの1つである必要があります。
[in] reqState
リクエスター状態へのポインター。
[in] onComplete
要求されたセキュアセッションが確立されると呼び出されるコールバック関数へのポインタ。
[in] onError
要求されたセッションの確立が失敗した場合に呼び出されるコールバック関数へのポインター。
[in] pw
PASEシークレットパスワードへのポインタ。
[in] pwLen
PASEシークレットパスワードの長さ。
戻り値
WEAVE_NO_ERROR
成功時。

StartTAKESession

WEAVE_ERROR StartTAKESession(
  WeaveConnection *con,
  WeaveAuthMode requestedAuthMode,
  void *reqState,
  SessionEstablishedFunct onComplete,
  SessionErrorFunct onError,
  bool encryptAuthPhase,
  bool encryptCommPhase,
  bool timeLimitedIK,
  bool sendChallengerId,
  WeaveTAKEChallengerAuthDelegate *authDelegate
)

このメソッドは、安全なTAKEセッションを確立するために呼び出されます。

詳細
パラメーター
[in] con
ポインタWeaveConnectionのオブジェクト。
[in] requestedAuthMode
ピアを認証するための望ましい手段。これは、TAKE 認証モードの 1 つである必要があります。
[in] reqState
リクエスター状態へのポインター。
[in] onComplete
要求されたセキュアセッションが確立されると呼び出されるコールバック関数へのポインタ。
[in] onError
要求されたセッションの確立が失敗した場合に呼び出されるコールバック関数へのポインター。
[in] encryptAuthPhase
プロトコル認証フェーズを暗号化する必要があるかどうかを示すブールフラグ。
[in] encryptCommPhase
プロトコル通信フェーズを暗号化する必要があるかどうかを示すブールフラグ。
[in] timeLimitedIK
識別キー(IK)に時間制限があるかどうかを示すブールフラグ。
[in] sendChallengerId
チャレンジャーIDをメッセージに含める必要があるかどうかを示すブールフラグ。含まれていない場合、WeaveノードID値がチャレンジャーIDとして使用されます。
[in] authDelegate
TAKEチャレンジャー認証デリゲートオブジェクトへのポインター。
戻り値
WEAVE_NO_ERROR
成功時。

WeaveSecurityManager

 WeaveSecurityManager(
  void
)