nl:: Menenun:: WeaveKeyId
#include <src/lib/core/WeaveKeyIds.h>
Definisi ID Weave Key.
Ringkasan
Class ini berisi jenis kunci, flag kunci, definisi kolom ID kunci, dan fungsi API.
Jenis publik |
|
---|---|
@52{
|
enum Kolom, tanda, dan jenis ID kunci Weave Publik. |
Fungsi statis publik |
|
---|---|
ConvertToCurrentAppKeyId(uint32_t keyId)
|
uint32_t
Mengonversi ID kunci grup aplikasi menjadi ID kunci aplikasi saat ini.
|
ConvertToStaticAppKeyId(uint32_t keyId)
|
uint32_t
Konversi ID kunci aplikasi ke ID kunci statis aplikasi.
|
DescribeKey(uint32_t keyId)
|
const char *
Mendekode ID kunci Weave dengan string deskriptif.
|
GetAppGroupLocalNumber(uint32_t keyId)
|
uint8_t
Mendapatkan nomor lokal grup aplikasi yang digunakan untuk mendapatkan kunci aplikasi yang ditentukan.
|
GetAppGroupMasterKeyId(uint32_t keyId)
|
uint32_t
Mendapatkan ID kunci master grup aplikasi yang digunakan untuk mendapatkan kunci aplikasi yang ditentukan.
|
GetEpochKeyId(uint32_t keyId)
|
uint32_t
Mendapatkan ID kunci epoch grup aplikasi yang digunakan untuk mendapatkan kunci aplikasi yang ditentukan.
|
GetEpochKeyNumber(uint32_t keyId)
|
uint8_t
Mendapatkan nomor kunci epoch grup aplikasi yang digunakan untuk mendapatkan kunci aplikasi yang ditentukan.
|
GetRootKeyId(uint32_t keyId)
|
uint32_t
Mendapatkan ID kunci root grup aplikasi yang digunakan untuk mendapatkan kunci aplikasi yang ditentukan.
|
GetRootKeyNumber(uint32_t keyId)
|
uint8_t
Mendapatkan nomor kunci root grup aplikasi yang digunakan untuk mendapatkan kunci aplikasi yang ditentukan.
|
GetType(uint32_t keyId)
|
uint32_t
Mendapatkan jenis kunci Weave dari ID kunci yang ditentukan.
|
IncorporatesAppGroupMasterKey(uint32_t keyId)
|
bool
Menentukan apakah ID kunci grup aplikasi yang ditentukan menggabungkan kunci master grup.
|
IncorporatesEpochKey(uint32_t keyId)
|
bool
Menentukan apakah ID kunci grup aplikasi yang ditentukan menggabungkan kunci epoch.
|
IncorporatesRootKey(uint32_t keyId)
|
bool
Menentukan apakah ID kunci grup aplikasi yang ditentukan menggabungkan kunci root atau tidak.
|
IsAppEpochKey(uint32_t keyId)
|
bool
Menentukan apakah ID kunci yang ditentukan adalah jenis kunci epoch aplikasi.
|
IsAppGroupKey(uint32_t keyId)
|
bool
Menentukan apakah ID kunci yang ditentukan termasuk dalam salah satu jenis kunci grup aplikasi (statis atau rotasi).
|
IsAppGroupMasterKey(uint32_t keyId)
|
bool
Menentukan apakah ID kunci yang ditentukan adalah jenis kunci master grup aplikasi.
|
IsAppRootKey(uint32_t keyId)
|
bool
Menentukan apakah ID kunci yang ditentukan adalah jenis kunci root aplikasi.
|
IsAppRotatingKey(uint32_t keyId)
|
bool
Menentukan apakah ID kunci yang ditentukan adalah jenis rotasi aplikasi.
|
IsAppStaticKey(uint32_t keyId)
|
bool
Menentukan apakah ID kunci yang ditentukan adalah jenis statis aplikasi.
|
IsGeneralKey(uint32_t keyId)
|
bool
Menentukan apakah ID kunci yang ditentukan berjenis umum.
|
IsMessageEncryptionKeyId(uint32_t keyId, bool allowLogicalKeys)
|
bool
Menentukan apakah ID kunci tertentu mengidentifikasi kunci yang cocok untuk enkripsi pesan Weave.
|
IsSameKeyOrGroup(uint32_t keyId1, uint32_t keyId2)
|
bool
Menentukan apakah dua ID kunci mengidentifikasi kunci yang sama, atau untuk kunci yang dirotasi, grup kunci yang sama terlepas dari iterasi hukum tertentu.
|
IsSessionKey(uint32_t keyId)
|
bool
Menentukan apakah ID kunci yang ditentukan berjenis sesi.
|
IsValidKeyId(uint32_t keyId)
|
bool
Tentukan apakah ID kunci memiliki nilai (legal) yang valid.
|
MakeAppGroupMasterKeyId(uint8_t appGroupLocalNumber)
|
uint32_t
Buat ID kunci master grup aplikasi yang diberi nomor lokal grup aplikasi.
|
MakeAppIntermediateKeyId(uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey)
|
uint32_t
Membuat ID kunci perantara aplikasi dengan mempertimbangkan ID kunci konstituen.
|
MakeAppKeyId(uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey)
|
uint32_t
Buat ID kunci grup aplikasi yang diberikan ID kunci konstituen dan informasi lainnya.
|
MakeAppRotatingKeyId(uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey)
|
uint32_t
Buat ID kunci rotasi aplikasi yang diberikan ID kunci konstituen dan informasi lainnya.
|
MakeAppStaticKeyId(uint32_t rootKeyId, uint32_t appGroupMasterKeyId)
|
uint32_t
Membuat ID kunci statis aplikasi yang diberi ID kunci konstituen.
|
MakeEpochKeyId(uint8_t epochKeyNumber)
|
uint32_t
Buat ID kunci root grup aplikasi yang diberi nomor kunci epoch.
|
MakeGeneralKeyId(uint16_t generalKeyNumber)
|
uint16_t
Buat ID kunci umum berdasarkan nomor kunci umum.
|
MakeRootKeyId(uint8_t rootKeyNumber)
|
uint32_t
Buat ID kunci root grup aplikasi yang diberi nomor kunci root.
|
MakeSessionKeyId(uint16_t sessionKeyNumber)
|
uint16_t
Buat ID kunci sesi dengan nomor kunci sesi tertentu.
|
UpdateEpochKeyId(uint32_t keyId, uint32_t epochKeyId)
|
uint32_t
Perbarui ID kunci grup aplikasi dengan nomor kunci epoch baru.
|
UsesCurrentEpochKey(uint32_t keyId)
|
bool
Menentukan apakah ID kunci grup aplikasi yang ditentukan menggunakan kunci epoch "current".
|
Jenis publik
@52
@52
Kolom, tanda, dan jenis ID kunci Weave Publik.
Properti | |
---|---|
kClientRootKey
|
ID kunci root klien. |
kFabricRootKey
|
ID kunci root kain. |
kFabricSecret
|
ID rahasia kain tenun. |
kKeyNumber_Max
|
Nilai maksimum untuk subkolom ID kunci. |
kNone
|
Menenun ID kunci global. ID kunci Weave yang tidak ditentukan. |
kServiceRootKey
|
ID kunci root layanan. |
kType_AppEpochKey
|
Jenis kunci epoch grup aplikasi. |
kType_AppGroupMasterKey
|
Jenis kunci master grup aplikasi. |
kType_AppIntermediateKey
|
Jenis kunci perantara grup aplikasi. |
kType_AppRootKey
|
Jenis kunci Weave (selain jenis enkripsi pesan Weave). |
kType_AppRotatingKey
|
Jenis kunci rotasi aplikasi. |
kType_AppStaticKey
|
Jenis kunci statis aplikasi. |
kType_General
|
Jenis kunci umum. |
kType_None
|
Jenis kunci Weave yang digunakan untuk enkripsi pesan Weave. |
kType_Session
|
Jenis kunci sesi. |
Fungsi statis publik
MengonversiToCurrentAppKeyId
uint32_t ConvertToCurrentAppKeyId( uint32_t keyId )
Mengonversi ID kunci grup aplikasi menjadi ID kunci aplikasi saat ini.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
ID kunci aplikasi saat ini.
|
MengonversiToStaticAppKeyId
uint32_t ConvertToStaticAppKeyId( uint32_t keyId )
Konversi ID kunci aplikasi ke ID kunci statis aplikasi.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
ID kunci statis aplikasi Anda.
|
DeskripsiKunci
const char * DescribeKey( uint32_t keyId )
Mendekode ID kunci Weave dengan string deskriptif.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
Pointer ke string yang dihentikan NULL yang menjelaskan ID kunci yang ditentukan.
|
GetAppGroupLocalNumber
uint8_t GetAppGroupLocalNumber( uint32_t keyId )
Mendapatkan nomor lokal grup aplikasi yang digunakan untuk mendapatkan kunci aplikasi yang ditentukan.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
nomor lokal grup aplikasi.
|
GetAppGroupMasterKeyId
uint32_t GetAppGroupMasterKeyId( uint32_t keyId )
Mendapatkan ID kunci master grup aplikasi yang digunakan untuk mendapatkan kunci aplikasi yang ditentukan.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
ID kunci master grup aplikasi.
|
ID GetEpochKey
uint32_t GetEpochKeyId( uint32_t keyId )
Mendapatkan ID kunci epoch grup aplikasi yang digunakan untuk mendapatkan kunci aplikasi yang ditentukan.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
ID kunci epoch.
|
MendapatkanEpochKeyNumber
uint8_t GetEpochKeyNumber( uint32_t keyId )
Mendapatkan nomor kunci epoch grup aplikasi yang digunakan untuk mendapatkan kunci aplikasi yang ditentukan.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
nomor kunci epoch.
|
ID GetRootKey
uint32_t GetRootKeyId( uint32_t keyId )
Mendapatkan ID kunci root grup aplikasi yang digunakan untuk mendapatkan kunci aplikasi yang ditentukan.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
ID kunci root.
|
MendapatkanRootKeyNumber
uint8_t GetRootKeyNumber( uint32_t keyId )
Mendapatkan nomor kunci root grup aplikasi yang digunakan untuk mendapatkan kunci aplikasi yang ditentukan.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
nomor kunci root.
|
GetType
uint32_t GetType( uint32_t keyId )
Mendapatkan jenis kunci Weave dari ID kunci yang ditentukan.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
jenis ID kunci.
|
MenggabungkanKunciGrupGrupKunci
bool IncorporatesAppGroupMasterKey( uint32_t keyId )
Menentukan apakah ID kunci grup aplikasi yang ditentukan menggabungkan kunci master grup.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
true jika keyId menggabungkan kunci master grup.
|
InkorporasiEpochKey
bool IncorporatesEpochKey( uint32_t keyId )
Menentukan apakah ID kunci grup aplikasi yang ditentukan menggabungkan kunci epoch.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
true jika keyId menggabungkan kunci epoch.
|
MenggabungkanRootRootKey
bool IncorporatesRootKey( uint32_t keyId )
Menentukan apakah ID kunci grup aplikasi yang ditentukan menggabungkan kunci root atau tidak.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
true jika keyId menggabungkan kunci root.
|
IsAppEpochKey
bool IsAppEpochKey( uint32_t keyId )
Menentukan apakah ID kunci yang ditentukan adalah jenis kunci epoch aplikasi.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
true jika keyId jenis kunci epoch aplikasi.
|
KunciGrupAplikasi
bool IsAppGroupKey( uint32_t keyId )
Menentukan apakah ID kunci yang ditentukan termasuk dalam salah satu jenis kunci grup aplikasi (statis atau rotasi).
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
true jika keyId dari jenis kunci statis atau berputar.
|
KunciGrupIsApp
bool IsAppGroupMasterKey( uint32_t keyId )
Menentukan apakah ID kunci yang ditentukan adalah jenis kunci master grup aplikasi.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
true jika keyId dari jenis kunci master grup aplikasi.
|
IsAppRootKunci
bool IsAppRootKey( uint32_t keyId )
Menentukan apakah ID kunci yang ditentukan adalah jenis kunci root aplikasi.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
true jika keyId dari jenis kunci root aplikasi.
|
IsAppRotatingKey
bool IsAppRotatingKey( uint32_t keyId )
Menentukan apakah ID kunci yang ditentukan adalah jenis rotasi aplikasi.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
true jika keyId dari jenis rotasi aplikasi.
|
IsAppStaticKey
bool IsAppStaticKey( uint32_t keyId )
Menentukan apakah ID kunci yang ditentukan adalah jenis statis aplikasi.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
true jika keyId jenis statis aplikasi.
|
Kunci Umum
bool IsGeneralKey( uint32_t keyId )
Menentukan apakah ID kunci yang ditentukan berjenis umum.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
true jika keyId memiliki Jenis umum.
|
IsMessageEncryptionKeyId
bool IsMessageEncryptionKeyId( uint32_t keyId, bool allowLogicalKeys )
Menentukan apakah ID kunci tertentu mengidentifikasi kunci yang cocok untuk enkripsi pesan Weave.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Menampilkan |
true Jika kunci yang diidentifikasi dapat digunakan untuk mengenkripsi pesan Weave.
|
IsSameKeyOrGroup
bool IsSameKeyOrGroup( uint32_t keyId1, uint32_t keyId2 )
Menentukan apakah dua ID kunci mengidentifikasi kunci yang sama, atau untuk kunci yang dirotasi, grup kunci yang sama terlepas dari iterasi hukum tertentu.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Menampilkan |
True jika ID kunci mewakili kunci yang sama.
|
IsSessionKey
bool IsSessionKey( uint32_t keyId )
Menentukan apakah ID kunci yang ditentukan berjenis sesi.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
true jika keyId dari suatu jenis sesi.
|
IDKunci valid
bool IsValidKeyId( uint32_t keyId )
Tentukan apakah ID kunci memiliki nilai (legal) yang valid.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
true jika nilai ID kunci valid.
|
MakeAppGroupMasterKeyId
uint32_t MakeAppGroupMasterKeyId( uint8_t appGroupLocalNumber )
Buat ID kunci master grup aplikasi yang diberi nomor lokal grup aplikasi.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
ID kunci master grup aplikasi.
|
IdKunciAppMakeIntermediate
uint32_t MakeAppIntermediateKeyId( uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey )
Membuat ID kunci perantara aplikasi dengan mempertimbangkan ID kunci konstituen.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
||||||
Menampilkan |
ID kunci perantara aplikasi.
|
IdAppAppKey
uint32_t MakeAppKeyId( uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey )
Buat ID kunci grup aplikasi yang diberikan ID kunci konstituen dan informasi lainnya.
Detail | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||
Menampilkan |
ID kunci grup aplikasi.
|
IdAppAppRotatingKey
uint32_t MakeAppRotatingKeyId( uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey )
Buat ID kunci rotasi aplikasi yang diberikan ID kunci konstituen dan informasi lainnya.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Menampilkan |
ID kunci rotasi aplikasi.
|
IdAppAppStaticKey
uint32_t MakeAppStaticKeyId( uint32_t rootKeyId, uint32_t appGroupMasterKeyId )
Membuat ID kunci statis aplikasi yang diberi ID kunci konstituen.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Menampilkan |
ID kunci statis aplikasi Anda.
|
Id MakeEpochKey
uint32_t MakeEpochKeyId( uint8_t epochKeyNumber )
Buat ID kunci root grup aplikasi yang diberi nomor kunci epoch.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
ID kunci epoch.
|
IdMakeGeneralKey
uint16_t MakeGeneralKeyId( uint16_t generalKeyNumber )
Buat ID kunci umum berdasarkan nomor kunci umum.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
ID kunci umum.
|
IdRootRootKey
uint32_t MakeRootKeyId( uint8_t rootKeyNumber )
Buat ID kunci root grup aplikasi yang diberi nomor kunci root.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
ID kunci root.
|
IDMembuatSesiKunci
uint16_t MakeSessionKeyId( uint16_t sessionKeyNumber )
Buat ID kunci sesi dengan nomor kunci sesi tertentu.
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
ID kunci sesi.
|
UpdateEpochKeyId
uint32_t UpdateEpochKeyId( uint32_t keyId, uint32_t epochKeyId )
Perbarui ID kunci grup aplikasi dengan nomor kunci epoch baru.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Menampilkan |
ID kunci aplikasi Anda.
|
MenggunakanCurrentEpochKey
bool UsesCurrentEpochKey( uint32_t keyId )
Menentukan apakah ID kunci grup aplikasi yang ditentukan menggunakan kunci epoch "current".
Detail | |||
---|---|---|---|
Parameter |
|
||
Menampilkan |
true jika keyId menunjukkan penggunaan kunci epoch saat ini.
|