ไม่มี:: สาน:: 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 | ฟังก์ชันเรียกกลับข้อผิดพลาดที่สำคัญ |
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 ที่ระบุเป็นหนึ่งในรหัสข้อผิดพลาดที่สำคัญหรือไม่ |
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 ที่มีอยู่ |
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
คุณลักษณะสาธารณะ
กรณีใช้KnownECDHKey
bool CASEUseKnownECDHKey
ExchangeManager
WeaveExchangeManager * ExchangeManager
FabricState
WeaveFabricState * FabricState
IdleSessionTimeout
uint32_t IdleSessionTimeout
InitiatorAllowedCASEConfigs
uint8_t InitiatorAllowedCASEConfigs
InitiatorAllowedCASECเส้นโค้ง
uint8_t InitiatorAllowedCASECurves
InitiatorAllowedKeyExportConfigs
uint8_t InitiatorAllowedKeyExportConfigs
ผู้ริเริ่มCASEConfig
uint32_t InitiatorCASEConfig
ผู้ริเริ่มCASECurveId
uint32_t InitiatorCASECurveId
InitiatorKeyExportConfig
uint8_t InitiatorKeyExportConfig
OnKeyErrorMsgRcvd
KeyErrorMsgRcvdFunct OnKeyErrorMsgRcvd
ฟังก์ชันเรียกกลับข้อผิดพลาดที่สำคัญ
ฟังก์ชันนี้ถูกเรียกเมื่อได้รับข้อความแสดงข้อผิดพลาดที่สำคัญ
OnSessionError
SessionErrorFunct OnSessionError
OnSessionEstablished
SessionEstablishedFunct OnSessionEstablished
ผู้ตอบกลับที่อนุญาตCASEConfigs
uint8_t ResponderAllowedCASEConfigs
ResponderAllowedCASECเส้นโค้ง
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
งานสาธารณะ
ยกเลิกเซสชั่นสถานประกอบการ
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 () วิธีการจะต้องเรียกว่าไม่เกินหนึ่งครั้ง
เมธอดนี้ยอมรับรหัสคีย์ทุกรูปแบบ รวมถึงไม่มี รหัสคีย์ที่ไม่ระบุชื่อคีย์จริงจะถูกละเว้น
รายละเอียด | |||||
---|---|---|---|---|---|
พารามิเตอร์ |
|
คีย์สำรอง
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 )
เริ่มกรณีเซสชัน
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 ที่มีอยู่
รายละเอียด | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
| ||||||||||||||||||||
ส่งกลับค่า |
|
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 )
เริ่มPASSESession
WEAVE_ERROR StartPASESession( WeaveConnection *con, WeaveAuthMode requestedAuthMode, void *reqState, SessionEstablishedFunct onComplete, SessionErrorFunct onError, const uint8_t *pw, uint16_t pwLen )
วิธีนี้เรียกว่าเพื่อสร้างเซสชัน PASE ที่ปลอดภัย
รายละเอียด | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
พารามิเตอร์ |
| ||||||||||||||
ส่งกลับค่า |
|
เริ่มTAKESession
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 )