หน้านี้ได้รับการแปลโดย 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, คีย์รูท, คีย์ Epoch, คีย์ต้นแบบของกลุ่ม และคีย์กลาง

รายละเอียด

พารามิเตอร์

`[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

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

Init

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