หน้านี้ได้รับการแปลโดย Cloud Translation API

nl::Weave::Profiles::Security::AppKeys::GroupKeyStoreBase

นี่คือคลาสนามธรรม

#include <src/lib/profiles/security/WeaveApplicationKeys.h>

คำจำกัดความของคลาสแหล่งเก็บคีย์ของกลุ่ม Weave

สรุป

ระบบจะเรียกใช้ฟังก์ชันในคลาสนี้เพื่อจัดการคีย์กลุ่มแอปพลิเคชัน

การสืบทอด

คลาสย่อยที่รู้จักโดยตรง:
nl::Weave::DeviceLayer::Internal::GroupKeyStoreImpl
nl::Weave::DeviceLayer::Internal::GroupKeyStoreImpl
nl::Weave::DeviceLayer::Internal::GroupKeyStoreImpl}
nl::Weave::Profiles::Security::AppKeys::DummyGroupKeyStore

แอตทริบิวต์ที่ได้รับการปกป้อง
`LastUsedEpochKeyId`	`uint32_t`
`NextEpochKeyStartTime`	`uint32_t`

ฟังก์ชันสาธารณะ
`Clear(void)=0`	`virtual WEAVE_ERROR`
`DeleteGroupKey(uint32_t keyId)=0`	`virtual WEAVE_ERROR`
`DeleteGroupKeysOfAType(uint32_t keyType)=0`	`virtual WEAVE_ERROR`
`DeriveApplicationKey(uint32_t & appKeyId, const uint8_t keySalt, uint8_t saltLen, const uint8_t keyDiversifier, uint8_t diversifierLen, uint8_t *appKey, uint8_t keyBufSize, uint8_t keyLen, uint32_t & appGroupGlobalId)`	`WEAVE_ERROR` ได้รับคีย์แอปพลิเคชัน
`EnumerateGroupKeys(uint32_t keyType, uint32_t *keyIds, uint8_t keyIdsArraySize, uint8_t & keyCount)=0`	`virtual WEAVE_ERROR`
`GetCurrentAppKeyId(uint32_t keyId, uint32_t & curKeyId)`	`WEAVE_ERROR` แสดงรหัสคีย์ปัจจุบัน
`GetCurrentUTCTime(uint32_t & utcTime)`	`virtual WEAVE_ERROR` ดูเวลา UTC ของแพลตฟอร์มปัจจุบันเป็นวินาที
`GetGroupKey(uint32_t keyId, WeaveGroupKey & groupKey)`	`WEAVE_ERROR` รับคีย์กลุ่มแอปพลิเคชัน
`RetrieveGroupKey(uint32_t keyId, WeaveGroupKey & key)=0`	`virtual WEAVE_ERROR`
`StoreGroupKey(const WeaveGroupKey & key)=0`	`virtual WEAVE_ERROR`

ฟังก์ชันที่มีการป้องกัน
`Init(void)`	`void` เริ่มต้นพารามิเตอร์ที่เก็บคีย์ของกลุ่มในเครื่อง
`OnEpochKeysChange(void)`	`void` แสดงรหัสคีย์ปัจจุบัน
`RetrieveLastUsedEpochKeyId(void)=0`	`virtual WEAVE_ERROR`
`StoreLastUsedEpochKeyId(void)=0`	`virtual WEAVE_ERROR`

แอตทริบิวต์ที่ได้รับการปกป้อง

LastUsedEpochKeyId

uint32_t LastUsedEpochKeyId

NextEpochKeyStartTime

uint32_t NextEpochKeyStartTime

ฟังก์ชันสาธารณะ

ล้าง

virtual WEAVE_ERROR Clear(
  void
)=0

DeleteGroupKey

virtual WEAVE_ERROR DeleteGroupKey(
  uint32_t keyId
)=0

DeleteGroupKeysOfAType

virtual WEAVE_ERROR DeleteGroupKeysOfAType(
  uint32_t keyType
)=0

DeriveApplicationKey

WEAVE_ERROR DeriveApplicationKey(
  uint32_t & appKeyId,
  const uint8_t *keySalt,
  uint8_t saltLen,
  const uint8_t *keyDiversifier,
  uint8_t diversifierLen,
  uint8_t *appKey,
  uint8_t keyBufSize,
  uint8_t keyLen,
  uint32_t & appGroupGlobalId
)

ได้รับคีย์แอปพลิเคชัน

รองรับคีย์แอปพลิเคชัน 3 ประเภท ได้แก่ คีย์แอปพลิเคชันปัจจุบัน การหมุนเวียนคีย์แอปพลิเคชัน และคีย์แอปพลิเคชันแบบคงที่ เมื่อมีการขอคีย์แอปพลิเคชันปัจจุบัน ฟังก์ชันจะค้นหาและใช้คีย์ Epoch ปัจจุบันตามเวลาระบบปัจจุบันและพารามิเตอร์เวลาเริ่มต้นของคีย์ Epoch แต่ละรายการ

รายละเอียด

พารามิเตอร์

`[in,out] keyId`	การอ้างอิงรหัสคีย์ที่ขอ เมื่อมีการขอคีย์แอปพลิเคชันปัจจุบัน ระบบจะอัปเดตช่องนี้เพื่อแสดงประเภทใหม่ (การหมุนเวียนคีย์ของแอปพลิเคชัน) และรหัสคีย์ Epoch จริงที่ใช้สร้างคีย์แอปพลิเคชัน
`[in] keySalt`	ตัวชี้ไปยังบัฟเฟอร์ที่มีค่า Salt ของคีย์แอปพลิเคชัน
`[in] saltLen`	ความยาวของ Salt คีย์แอปพลิเคชัน
`[in] keyDiversifier`	ตัวชี้ไปยังบัฟเฟอร์ที่มีค่าความหลากหลายของคีย์แอปพลิเคชัน
`[in] diversifierLen`	ความยาวของตัวกระจายคีย์แอปพลิเคชัน
`[out] appKey`	ตัวชี้ไปยังบัฟเฟอร์ที่จะเขียนคีย์ที่ได้รับ
`[in] keyBufSize`	ความยาวของบัฟเฟอร์คีย์ที่ให้มา
`[in] keyLen`	ความยาวของเนื้อหาคีย์ที่ขอ
`[out] appGroupGlobalId`	รหัสส่วนกลางของกลุ่มแอปพลิเคชันของคีย์ที่เชื่อมโยง

แสดงผลค่า

`WEAVE_NO_ERROR`	ความสำเร็จ
`WEAVE_ERROR_BUFFER_TOO_SMALL`	หากขนาดบัฟเฟอร์ของคีย์ที่ระบุไม่เพียงพอ
`WEAVE_ERROR_INVALID_KEY_ID`	หากคีย์ที่ขอมีรหัสคีย์ไม่ถูกต้อง
`WEAVE_ERROR_INVALID_ARGUMENT`	หากคีย์สโตร์ของแพลตฟอร์มแสดงพารามิเตอร์คีย์ที่ไม่ถูกต้อง หรือตัวระบุคีย์มีค่าที่ไม่ถูกต้อง
`other`	ข้อผิดพลาดเฉพาะแพลตฟอร์มอื่นๆ ที่แสดงผลโดย API แหล่งเก็บคีย์ของแพลตฟอร์ม

EnumerateGroupKeys

virtual WEAVE_ERROR EnumerateGroupKeys(
  uint32_t keyType,
  uint32_t *keyIds,
  uint8_t keyIdsArraySize,
  uint8_t & keyCount
)=0

GetCurrentAppKeyId

WEAVE_ERROR GetCurrentAppKeyId(
  uint32_t keyId,
  uint32_t & curKeyId
)

แสดงรหัสคีย์ปัจจุบัน

ค้นหาคีย์ Epoch ปัจจุบันตามเวลาระบบปัจจุบันและพารามิเตอร์เวลาเริ่มต้นของคีย์ Epoch แต่ละรายการ หากระบบไม่มีเวลาที่ถูกต้อง ระบบจะแสดงรหัสคีย์ Epoch ที่ใช้ล่าสุด

รายละเอียด

พารามิเตอร์

`[in] keyId`	รหัสคีย์แอปพลิเคชัน
`[out] curKeyId`	รหัสคีย์ปัจจุบันของแอปพลิเคชัน

แสดงผลค่า

`WEAVE_NO_ERROR`	ความสำเร็จ
`WEAVE_ERROR_INVALID_KEY_ID`	หากรหัสคีย์อินพุตมีค่าที่ไม่ถูกต้อง
`WEAVE_ERROR_KEY_NOT_FOUND`	หากไม่พบคีย์ Epoch ในแหล่งเก็บคีย์ของแพลตฟอร์ม
`other`	ข้อผิดพลาดเฉพาะแพลตฟอร์มอื่นๆ ที่แสดงผลโดย API แหล่งเก็บคีย์ของแพลตฟอร์ม

GetCurrentUTCTime

virtual WEAVE_ERROR GetCurrentUTCTime(
  uint32_t & utcTime
)

ดูเวลา UTC ของแพลตฟอร์มปัจจุบันเป็นวินาที

รายละเอียด

พารามิเตอร์

[out] utcTime

การอ้างอิงค่าเวลา

แสดงผลค่า

`WEAVE_NO_ERROR`	ความสำเร็จ
`#WEAVE_SYSTEM_ERROR_NOT_SUPPORTED`	หากแพลตฟอร์มไม่รองรับนาฬิกาแบบเรียลไทม์
`#WEAVE_SYSTEM_ERROR_REAL_TIME_NOT_SYNCED`	หากนาฬิกาแบบเรียลไทม์ของระบบไม่ซิงค์กับแหล่งที่มาเวลาที่แม่นยำ
`other`	รหัสข้อผิดพลาดอื่นๆ ของ Weave หรือแพลตฟอร์ม

GetGroupKey

WEAVE_ERROR GetGroupKey(
  uint32_t keyId,
  WeaveGroupKey & groupKey
)

รับคีย์กลุ่มแอปพลิเคชัน

ฟังก์ชันนี้จะดึงหรือดึงคีย์กลุ่มแอปพลิเคชัน ประเภทคีย์ที่ฟังก์ชันนี้รองรับ ได้แก่ Fabric Secret, Root key, Epoch key, Group Master Key และ In-middle key

รายละเอียด

พารามิเตอร์

`[in] keyId`	รหัสคีย์กลุ่ม
`[out] groupKey`	การอ้างอิงไปยังออบเจ็กต์คีย์กลุ่ม

แสดงผลค่า

`WEAVE_NO_ERROR`	ความสำเร็จ
`WEAVE_ERROR_INVALID_KEY_ID`	หากคีย์ที่ขอมีรหัสคีย์ไม่ถูกต้อง
`WEAVE_ERROR_INVALID_ARGUMENT`	หากแหล่งเก็บคีย์แพลตฟอร์มแสดงพารามิเตอร์คีย์ที่ไม่ถูกต้อง
`other`	ข้อผิดพลาดเฉพาะแพลตฟอร์มอื่นๆ ที่แสดงผลโดย API แหล่งเก็บคีย์ของแพลตฟอร์ม

RetrieveGroupKey

virtual WEAVE_ERROR RetrieveGroupKey(
  uint32_t keyId,
  WeaveGroupKey & key
)=0

StoreGroupKey

virtual WEAVE_ERROR StoreGroupKey(
  const WeaveGroupKey & key
)=0

ฟังก์ชันที่มีการป้องกัน

เริ่มต้น

void Init(
  void
)

เริ่มต้นพารามิเตอร์ที่เก็บคีย์ของกลุ่มในเครื่อง

OnEpochKeysChange

void OnEpochKeysChange(
  void
)

แสดงรหัสคีย์ปัจจุบัน

ตั้งค่าตัวแปรสมาชิกที่เชื่อมโยงกับคีย์ Epoch เป็นค่าเริ่มต้นเมื่อมีการเปลี่ยนแปลง (ลบหรือจัดเก็บ) กับชุดคีย์ Epoch ของแอปพลิเคชัน และเป็นความรับผิดชอบของคลาสย่อยที่ใช้ฟังก์ชัน StoreGroupKey(), DeleteGroupKey() และ DeleteGroupKeysOfAType() เพื่อเรียกใช้เมธอดนี้

RetrieveLastUsedEpochKeyId

virtual WEAVE_ERROR RetrieveLastUsedEpochKeyId(
  void
)=0

StoreLastUsedEpochKeyId

virtual WEAVE_ERROR StoreLastUsedEpochKeyId(
  void
)=0