nl:: Weave:: WeaveSecurityManager
สรุป
ผู้ผลิตและผู้ทำลาย |
|
---|---|
WeaveSecurityManager(void)
|
ประเภทสาธารณะ |
|
---|---|
KeyErrorMsgRcvdFunct)(uint16_t keyId, uint8_t encType, uint32_t messageId, uint64_t peerNodeId, WEAVE_ERROR keyErr)
|
typedefvoid(*
ประเภทของฟังก์ชันการจัดการข้อความแสดงข้อผิดพลาดที่สำคัญ |
KeyExportCompleteFunct)(WeaveSecurityManager *sm, WeaveConnection *con, void *reqState, uint32_t exportedKeyId, const uint8_t *exportedKey, uint16_t exportedKeyLen)
|
typedefvoid(*
ประเภทของฟังก์ชันการจัดการที่สมบูรณ์ของโปรโตคอลการส่งออกคีย์ |
KeyExportErrorFunct)(WeaveSecurityManager *sm, WeaveConnection *con, void *reqState, WEAVE_ERROR localErr, StatusReport *statusReport)
|
typedefvoid(*
ประเภทของฟังก์ชันการจัดการข้อผิดพลาดของโปรโตคอลการส่งออกคีย์ |
SessionErrorFunct)(WeaveSecurityManager *sm, WeaveConnection *con, void *reqState, WEAVE_ERROR localErr, uint64_t peerNodeId, StatusReport *statusReport)
|
typedefvoid(*
|
SessionEstablishedFunct)(WeaveSecurityManager *sm, WeaveConnection *con, void *reqState, uint16_t sessionKeyId, uint64_t peerNodeId, uint8_t encType)
|
typedefvoid(*
|
State
|
enum |
แอตทริบิวต์สาธารณะ |
|
---|---|
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
|
ฟังก์ชัน Callback สำหรับข้อผิดพลาดของคีย์
|
OnSessionError
|
SessionErrorFunct
|
OnSessionEstablished
|
SessionEstablishedFunct
|
ResponderAllowedCASEConfigs
|
uint8_t
|
ResponderAllowedCASECurves
|
uint8_t
|
ResponderAllowedKeyExportConfigs
|
uint8_t
|
SessionEstablishTimeout
|
uint32_t
|
State
|
uint8_t
|
mCASEEngine
|
|
mKeyExport
|
|
mPASEEngine
|
|
mStartKeyExport_OnComplete
|
โปรโตคอลการส่งออกคีย์ใช้ฟังก์ชัน Callback ที่สมบูรณ์
|
mStartKeyExport_OnError
|
ฟังก์ชัน Callback สำหรับข้อผิดพลาดโปรโตคอลการส่งออกคีย์
|
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 ที่ระบุเป็นหนึ่งในรหัสข้อผิดพลาดที่สำคัญหรือไม่
|
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)
|
วิธีนี้เรียกใช้เพื่อสร้างเซสชัน "เคส" ใหม่หรือ "ค้นหา" ที่มีอยู่
|
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)
ประเภทของฟังก์ชันการจัดการข้อความแสดงข้อผิดพลาดที่สำคัญ
รายละเอียด | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
KeyExportCompleteFunct
void(* KeyExportCompleteFunct)(WeaveSecurityManager *sm, WeaveConnection *con, void *reqState, uint32_t exportedKeyId, const uint8_t *exportedKey, uint16_t exportedKeyLen)
ประเภทของฟังก์ชันการจัดการที่สมบูรณ์ของโปรโตคอลการส่งออกคีย์
รายละเอียด | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
KeyExportErrorFunct
void(* KeyExportErrorFunct)(WeaveSecurityManager *sm, WeaveConnection *con, void *reqState, WEAVE_ERROR localErr, 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
InitiatorCASECurveId
uint32_t InitiatorCASECurveId
InitiatorKeyExportConfig
uint8_t InitiatorKeyExportConfig
OnKeyErrorMsgRcvd
KeyErrorMsgRcvdFunct OnKeyErrorMsgRcvd
ฟังก์ชัน Callback สำหรับข้อผิดพลาดของคีย์
โดยฟังก์ชันนี้จะถูกเรียกเมื่อได้รับข้อความแสดงข้อผิดพลาดเกี่ยวกับคีย์
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
โปรโตคอลการส่งออกคีย์ใช้ฟังก์ชัน Callback ที่สมบูรณ์
โดยฟังก์ชันนี้จะถูกเรียกเมื่อกระบวนการส่งออกคีย์ลับเสร็จสมบูรณ์
mStartKeyExport_OnError
KeyExportErrorFunct mStartKeyExport_OnError
ฟังก์ชัน Callback สำหรับข้อผิดพลาดโปรโตคอลการส่งออกคีย์
โดยฟังก์ชันนี้จะถูกเรียกเมื่อพบข้อผิดพลาดระหว่างกระบวนการส่งออกคีย์
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 )
ยกเลิกการสร้างเซสชันที่อยู่ระหว่างดำเนินการ
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
||||
ผลลัพธ์ |
|
เริ่มต้น
WEAVE_ERROR Init( WeaveExchangeManager & aExchangeMgr, System::Layer & aSystemLayer )
IsKeyError
bool IsKeyError( WEAVE_ERROR err )
ตรวจสอบว่ารหัสข้อผิดพลาด Weave ที่ระบุเป็นหนึ่งในรหัสข้อผิดพลาดที่สำคัญหรือไม่
ฟังก์ชันนี้จะถูกเรียกใช้เพื่อพิจารณาว่าควรส่งข้อความแสดงข้อผิดพลาดของคีย์ไปยังตัวเริ่มข้อความที่ไม่สามารถค้นหาคีย์ที่ถูกต้องในระหว่างการถอดรหัสหรือไม่
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
||||
ผลลัพธ์ |
|
OnEncryptedMsgRcvd
void OnEncryptedMsgRcvd( uint16_t sessionKeyId, uint64_t peerNodeId, uint8_t encType )
ReleaseKey
void ReleaseKey( uint64_t peerNodeId, uint16_t keyId )
ปล่อยการจองคีย์การเข้ารหัสข้อความ
ยกเลิกการจองที่เคยใช้ในคีย์การเข้ารหัสข้อความ
สำหรับการจองทุกรายการที่ดำเนินการบนคีย์ใดคีย์หนึ่ง คุณต้องเรียกเมธอด ReleaseKey() ไม่เกิน 1 ครั้ง
เมธอดนี้ยอมรับรหัสคีย์ทุกรูปแบบ ซึ่งรวมถึง "ไม่มี" ระบบจะไม่สนใจรหัสคีย์ที่ไม่ได้ตั้งชื่อคีย์จริง
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
ReserveKey
void ReserveKey( uint64_t peerNodeId, uint16_t keyId )
จองคีย์การเข้ารหัสข้อความ
การจองคีย์ใช้เพื่อส่งสัญญาณแจ้งว่ามีการใช้คีย์ใดคีย์หนึ่งอยู่และควรเก็บไว้ โปรดทราบว่าการจองคีย์ไม่ได้รับประกันว่าคีย์จะไม่ถูกลบออกโดยการดำเนินการที่ชัดเจน เช่น การรับข้อความ KeyError
สำหรับการจองทุกรายการที่ดำเนินการบนคีย์หนึ่งๆ จะต้องมีการเรียก ReleaseKey() ที่เกี่ยวข้อง
เมธอดนี้ยอมรับรหัสคีย์ทุกรูปแบบ ซึ่งรวมถึง "ไม่มี" ระบบจะไม่สนใจรหัสคีย์ที่ไม่ได้ตั้งชื่อคีย์จริง
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
SendKeyErrorMsg
WEAVE_ERROR SendKeyErrorMsg( WeaveMessageInfo *rcvdMsgInfo, const IPPacketInfo *rcvdMsgPacketInfo, WeaveConnection *con, WEAVE_ERROR keyErr )
ส่งข้อความแสดงข้อผิดพลาดเกี่ยวกับคีย์
ระบบจะเรียกฟังก์ชันนี้เมื่อถอดรหัสข้อความ Weave ไม่สำเร็จเนื่องจากข้อผิดพลาดของคีย์
รายละเอียด | |||||||||
---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||
ผลลัพธ์ |
|
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 )
วิธีนี้เรียกใช้เพื่อสร้างเซสชัน "เคส" ใหม่หรือ "ค้นหา" ที่มีอยู่
รายละเอียด | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||||||||||||||
ผลลัพธ์ |
|
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 ที่ปลอดภัย
รายละเอียด | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||||||||
ผลลัพธ์ |
|
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 ที่ปลอดภัย
รายละเอียด | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
|
||||||||||||||||||||
ผลลัพธ์ |
|
WeaveSecurityManager
WeaveSecurityManager( void )