nl:: Weave:: WeaveKeyId
#include <src/lib/core/WeaveKeyIds.h>
Định nghĩa của giá trị nhận dạng Weave Key.
Tóm tắt
Lớp này chứa các loại khoá, cờ khoá, định nghĩa trường mã khoá và các hàm API.
Loại công khai |
|
---|---|
@52{
|
enum Các trường, cờ và loại mã khoá công khai của Weave. |
Hàm tĩnh công khai |
|
---|---|
ConvertToCurrentAppKeyId(uint32_t keyId)
|
uint32_t
Chuyển đổi mã khoá nhóm ứng dụng thành mã khoá hiện tại của ứng dụng.
|
ConvertToStaticAppKeyId(uint32_t keyId)
|
uint32_t
Chuyển đổi mã nhận dạng khoá ứng dụng thành mã nhận dạng khoá tĩnh của ứng dụng.
|
DescribeKey(uint32_t keyId)
|
const char *
Giải mã giá trị nhận dạng khoá Weave bằng một chuỗi mô tả.
|
GetAppGroupLocalNumber(uint32_t keyId)
|
uint8_t
Lấy số cục bộ của nhóm ứng dụng được dùng để lấy khoá ứng dụng được chỉ định.
|
GetAppGroupMasterKeyId(uint32_t keyId)
|
uint32_t
Lấy mã nhận dạng khoá chính của nhóm ứng dụng được dùng để lấy khoá ứng dụng được chỉ định.
|
GetEpochKeyId(uint32_t keyId)
|
uint32_t
Nhận mã nhận dạng khoá thời gian bắt đầu của hệ thống của nhóm ứng dụng được dùng để lấy khoá ứng dụng được chỉ định.
|
GetEpochKeyNumber(uint32_t keyId)
|
uint8_t
Lấy số khoá thời gian bắt đầu của nhóm ứng dụng được dùng để lấy khoá ứng dụng đã chỉ định.
|
GetRootKeyId(uint32_t keyId)
|
uint32_t
Lấy mã nhận dạng khoá gốc của nhóm ứng dụng được dùng để lấy khoá ứng dụng được chỉ định.
|
GetRootKeyNumber(uint32_t keyId)
|
uint8_t
Lấy số khoá gốc của nhóm ứng dụng đã được dùng để lấy khoá ứng dụng được chỉ định.
|
GetType(uint32_t keyId)
|
uint32_t
Lấy loại khoá Weave của mã khoá đã chỉ định.
|
IncorporatesAppGroupMasterKey(uint32_t keyId)
|
bool
Xác định xem mã khoá nhóm ứng dụng được chỉ định có kết hợp khoá chính của nhóm hay không.
|
IncorporatesEpochKey(uint32_t keyId)
|
bool
Xác định xem mã khoá nhóm ứng dụng được chỉ định có kết hợp khoá thời gian bắt đầu của hệ thống hay không.
|
IncorporatesRootKey(uint32_t keyId)
|
bool
Xác định xem mã khoá nhóm ứng dụng được chỉ định có kết hợp khoá gốc hay không.
|
IsAppEpochKey(uint32_t keyId)
|
bool
Xác định xem mã khoá được chỉ định có phải là loại khoá thời gian bắt đầu của ứng dụng hay không.
|
IsAppGroupKey(uint32_t keyId)
|
bool
Xác định xem mã nhận dạng khoá được chỉ định có thuộc một trong các loại khoá của nhóm ứng dụng hay không (tĩnh hoặc xoay).
|
IsAppGroupMasterKey(uint32_t keyId)
|
bool
Xác định xem mã nhận dạng khoá được chỉ định có phải là loại khoá chính của nhóm ứng dụng hay không.
|
IsAppRootKey(uint32_t keyId)
|
bool
Xác định xem mã nhận dạng khoá được chỉ định có phải là loại khoá gốc của ứng dụng hay không.
|
IsAppRotatingKey(uint32_t keyId)
|
bool
Xác định xem mã nhận dạng khoá được chỉ định có thuộc kiểu xoay ứng dụng hay không.
|
IsAppStaticKey(uint32_t keyId)
|
bool
Xác định xem mã nhận dạng khoá được chỉ định có thuộc loại tĩnh ứng dụng hay không.
|
IsGeneralKey(uint32_t keyId)
|
bool
Xác định xem mã nhận dạng khoá được chỉ định có thuộc loại chung hay không.
|
IsMessageEncryptionKeyId(uint32_t keyId, bool allowLogicalKeys)
|
bool
Xác định xem mã khoá nhất định có xác định khoá phù hợp để mã hoá thông báo Weave hay không.
|
IsSameKeyOrGroup(uint32_t keyId1, uint32_t keyId2)
|
bool
Xác định xem hai mã nhận dạng khoá có xác định cùng một khoá hay không, hay trong trường hợp các khoá xoay vòng, cùng một nhóm khoá độc lập với mọi thời gian bắt đầu của hệ thống.
|
IsSessionKey(uint32_t keyId)
|
bool
Xác định xem mã nhận dạng khoá được chỉ định có thuộc loại phiên hay không.
|
IsValidKeyId(uint32_t keyId)
|
bool
Xác định xem giá trị nhận dạng khoá có giá trị (hợp pháp) hay không.
|
MakeAppGroupMasterKeyId(uint8_t appGroupLocalNumber)
|
uint32_t
Tạo mã khoá chính của nhóm ứng dụng được cấp số cục bộ của nhóm ứng dụng.
|
MakeAppIntermediateKeyId(uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey)
|
uint32_t
Tạo mã khoá trung gian của ứng dụng do mã nhận dạng khoá cấu thành được cung cấp.
|
MakeAppKeyId(uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey)
|
uint32_t
Tạo mã khoá của nhóm ứng dụng dựa trên mã nhận dạng khoá cấu thành và các thông tin khác.
|
MakeAppRotatingKeyId(uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey)
|
uint32_t
Tạo mã nhận dạng khoá xoay vòng ứng dụng dựa trên mã nhận dạng khoá cấu thành và các thông tin khác.
|
MakeAppStaticKeyId(uint32_t rootKeyId, uint32_t appGroupMasterKeyId)
|
uint32_t
Tạo mã nhận dạng khoá tĩnh của ứng dụng do mã nhận dạng khoá cấu thành được cung cấp.
|
MakeEpochKeyId(uint8_t epochKeyNumber)
|
uint32_t
Tạo mã khoá gốc của nhóm ứng dụng dựa trên số khoá thời gian bắt đầu của hệ thống.
|
MakeGeneralKeyId(uint16_t generalKeyNumber)
|
uint16_t
Xây dựng mã nhận dạng khoá chung dựa vào số khoá chung.
|
MakeRootKeyId(uint8_t rootKeyNumber)
|
uint32_t
Tạo mã khoá gốc của nhóm ứng dụng bằng số khoá gốc đã cho.
|
MakeSessionKeyId(uint16_t sessionKeyNumber)
|
uint16_t
Tạo mã khoá phiên đã cung cấp số khoá phiên.
|
UpdateEpochKeyId(uint32_t keyId, uint32_t epochKeyId)
|
uint32_t
Cập nhật mã khoá nhóm ứng dụng bằng số khoá thời gian bắt đầu của hệ thống mới.
|
UsesCurrentEpochKey(uint32_t keyId)
|
bool
Xác định xem mã khoá nhóm ứng dụng được chỉ định có sử dụng khoá thời gian bắt đầu của hệ thống "hiện tại" hay không.
|
Loại công khai
@52
@52
Các trường, cờ và loại mã khoá công khai của Weave.
Thuộc tính | |
---|---|
kClientRootKey
|
Mã khoá gốc của ứng dụng. |
kFabricRootKey
|
Mã khoá gốc Fabric. |
kFabricSecret
|
Mã bí mật của vải dệt. |
kKeyNumber_Max
|
Giá trị tối đa cho trường con của mã khoá. |
kNone
|
Dệt nhận dạng khoá chung. Mã khoá Weave không xác định. |
kServiceRootKey
|
Mã khoá gốc của dịch vụ. |
kType_AppEpochKey
|
Loại khoá thời gian bắt đầu của nhóm ứng dụng. |
kType_AppGroupMasterKey
|
Loại khoá chính của nhóm ứng dụng. |
kType_AppIntermediateKey
|
Loại khoá trung gian của nhóm ứng dụng. |
kType_AppRootKey
|
Các loại khoá kết hợp (ngoài các loại mã hoá thư dạng Dệt). |
kType_AppRotatingKey
|
Loại khoá xoay ứng dụng. |
kType_AppStaticKey
|
Loại khoá tĩnh của ứng dụng. |
kType_General
|
Loại khoá chung. |
kType_None
|
Các loại khoá dệt dùng để mã hoá thư dạng Weave. |
kType_Session
|
Loại khoá phiên. |
Hàm tĩnh công khai
ConvertToCurrentAppKeyId
uint32_t ConvertToCurrentAppKeyId( uint32_t keyId )
Chuyển đổi mã khoá nhóm ứng dụng thành mã khoá hiện tại của ứng dụng.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
mã nhận dạng khoá hiện tại của ứng dụng.
|
ConvertToStaticAppKeyId
uint32_t ConvertToStaticAppKeyId( uint32_t keyId )
Chuyển đổi mã nhận dạng khoá ứng dụng thành mã nhận dạng khoá tĩnh của ứng dụng.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
mã khoá tĩnh của ứng dụng.
|
DescribeKey
const char * DescribeKey( uint32_t keyId )
Giải mã giá trị nhận dạng khoá Weave bằng một chuỗi mô tả.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
Con trỏ đến một chuỗi kết thúc có giá trị NULL, dùng để mô tả mã nhận dạng khoá được chỉ định.
|
GetAppGroupLocalNumber
uint8_t GetAppGroupLocalNumber( uint32_t keyId )
Lấy số cục bộ của nhóm ứng dụng được dùng để lấy khoá ứng dụng được chỉ định.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
số địa phương của nhóm ứng dụng.
|
GetAppGroupMasterKeyId
uint32_t GetAppGroupMasterKeyId( uint32_t keyId )
Lấy mã nhận dạng khoá chính của nhóm ứng dụng được dùng để lấy khoá ứng dụng được chỉ định.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
mã khoá chính của nhóm ứng dụng.
|
GetEpochKeyId
uint32_t GetEpochKeyId( uint32_t keyId )
Nhận mã nhận dạng khoá thời gian bắt đầu của hệ thống của nhóm ứng dụng được dùng để lấy khoá ứng dụng được chỉ định.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
mã nhận dạng khoá thời gian bắt đầu của hệ thống.
|
GetEpochKeyNumber
uint8_t GetEpochKeyNumber( uint32_t keyId )
Lấy số khoá thời gian bắt đầu của nhóm ứng dụng được dùng để lấy khoá ứng dụng đã chỉ định.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
số khoá thời gian bắt đầu của hệ thống.
|
GetRootKeyId
uint32_t GetRootKeyId( uint32_t keyId )
Lấy mã nhận dạng khoá gốc của nhóm ứng dụng được dùng để lấy khoá ứng dụng được chỉ định.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
giá trị nhận dạng khoá gốc.
|
GetRootKeyNumber
uint8_t GetRootKeyNumber( uint32_t keyId )
Lấy số khoá gốc của nhóm ứng dụng đã được dùng để lấy khoá ứng dụng được chỉ định.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
số khoá gốc.
|
GetType
uint32_t GetType( uint32_t keyId )
Lấy loại khoá Weave của mã khoá đã chỉ định.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
của mã nhận dạng khoá.
|
IncorporatesAppGroupMasterKey
bool IncorporatesAppGroupMasterKey( uint32_t keyId )
Xác định xem mã khoá nhóm ứng dụng được chỉ định có kết hợp khoá chính của nhóm hay không.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
true nếu keyId kết hợp khoá chính của nhóm.
|
IncorporatesEpochKey
bool IncorporatesEpochKey( uint32_t keyId )
Xác định xem mã khoá nhóm ứng dụng được chỉ định có kết hợp khoá thời gian bắt đầu của hệ thống hay không.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
true nếu keyId kết hợp khoá epoch.
|
IncorporatesRootKey
bool IncorporatesRootKey( uint32_t keyId )
Xác định xem mã khoá nhóm ứng dụng được chỉ định có kết hợp khoá gốc hay không.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
true nếu keyId kết hợp khoá gốc.
|
IsAppEpochKey
bool IsAppEpochKey( uint32_t keyId )
Xác định xem mã khoá được chỉ định có phải là loại khoá thời gian bắt đầu của ứng dụng hay không.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
true nếu mã khoá của một loại khoá thời gian bắt đầu của ứng dụng.
|
IsAppGroupKey
bool IsAppGroupKey( uint32_t keyId )
Xác định xem mã nhận dạng khoá được chỉ định có thuộc một trong các loại khoá của nhóm ứng dụng hay không (tĩnh hoặc xoay).
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
true nếu keyId thuộc loại khoá xoay hoặc tĩnh.
|
IsAppGroupMasterKey
bool IsAppGroupMasterKey( uint32_t keyId )
Xác định xem mã nhận dạng khoá được chỉ định có phải là loại khoá chính của nhóm ứng dụng hay không.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
true nếu mã khoá của một loại khoá chính của nhóm ứng dụng.
|
IsAppRootKey
bool IsAppRootKey( uint32_t keyId )
Xác định xem mã nhận dạng khoá được chỉ định có phải là loại khoá gốc của ứng dụng hay không.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
true nếu mã khoá của một loại khoá gốc ứng dụng.
|
IsAppRotatingKey
bool IsAppRotatingKey( uint32_t keyId )
Xác định xem mã nhận dạng khoá được chỉ định có thuộc kiểu xoay ứng dụng hay không.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
true nếu mã phím của một loại xoay ứng dụng.
|
IsAppStaticKey
bool IsAppStaticKey( uint32_t keyId )
Xác định xem mã nhận dạng khoá được chỉ định có thuộc loại tĩnh ứng dụng hay không.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
true nếu mã nhận dạng khoá của một loại tĩnh ứng dụng.
|
IsGeneralKey
bool IsGeneralKey( uint32_t keyId )
Xác định xem mã nhận dạng khoá được chỉ định có thuộc loại chung hay không.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
true nếu keyId có loại General.
|
IsMessageEncryptionKeyId
bool IsMessageEncryptionKeyId( uint32_t keyId, bool allowLogicalKeys )
Xác định xem mã khoá nhất định có xác định khoá phù hợp để mã hoá thông báo Weave hay không.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các tham số |
|
||||
Trả về |
true Nếu khoá đã xác định có thể dùng để mã hoá thông báo của Weave.
|
IsSameKeyOrGroup
bool IsSameKeyOrGroup( uint32_t keyId1, uint32_t keyId2 )
Xác định xem hai mã nhận dạng khoá có xác định cùng một khoá hay không, hay trong trường hợp các khoá xoay vòng, cùng một nhóm khoá độc lập với mọi thời gian bắt đầu của hệ thống.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các tham số |
|
||||
Trả về |
Đúng nếu các mã nhận dạng khoá đại diện cho cùng một khoá.
|
IsSessionKey
bool IsSessionKey( uint32_t keyId )
Xác định xem mã nhận dạng khoá được chỉ định có thuộc loại phiên hay không.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
true nếu mã nhận dạng khoá của một loại phiên.
|
IsValidKeyId
bool IsValidKeyId( uint32_t keyId )
Xác định xem giá trị nhận dạng khoá có giá trị (hợp pháp) hay không.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
true nếu giá trị mã nhận dạng khoá hợp lệ.
|
MakeAppGroupMasterKeyId
uint32_t MakeAppGroupMasterKeyId( uint8_t appGroupLocalNumber )
Tạo mã khoá chính của nhóm ứng dụng được cấp số cục bộ của nhóm ứng dụng.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
mã khoá chính của nhóm ứng dụng.
|
MakeAppIntermediateKeyId
uint32_t MakeAppIntermediateKeyId( uint32_t rootKeyId, uint32_t epochKeyId, bool useCurrentEpochKey )
Tạo mã khoá trung gian của ứng dụng do mã nhận dạng khoá cấu thành được cung cấp.
Thông tin chi tiết | |||||||
---|---|---|---|---|---|---|---|
Các tham số |
|
||||||
Trả về |
mã khoá trung gian của ứng dụng.
|
MakeAppKeyId
uint32_t MakeAppKeyId( uint32_t keyType, uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey )
Tạo mã khoá của nhóm ứng dụng dựa trên mã nhận dạng khoá cấu thành và các thông tin khác.
Thông tin chi tiết | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Các tham số |
|
||||||||||
Trả về |
mã khoá nhóm ứng dụng.
|
MakeAppRotatingKeyId
uint32_t MakeAppRotatingKeyId( uint32_t rootKeyId, uint32_t epochKeyId, uint32_t appGroupMasterKeyId, bool useCurrentEpochKey )
Tạo mã nhận dạng khoá xoay vòng ứng dụng dựa trên mã nhận dạng khoá cấu thành và các thông tin khác.
Thông tin chi tiết | |||||||||
---|---|---|---|---|---|---|---|---|---|
Các tham số |
|
||||||||
Trả về |
mã nhận dạng khoá xoay ứng dụng.
|
MakeAppStaticKeyId
uint32_t MakeAppStaticKeyId( uint32_t rootKeyId, uint32_t appGroupMasterKeyId )
Tạo mã nhận dạng khoá tĩnh của ứng dụng do mã nhận dạng khoá cấu thành được cung cấp.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các tham số |
|
||||
Trả về |
mã khoá tĩnh của ứng dụng.
|
MakeEpochKeyId
uint32_t MakeEpochKeyId( uint8_t epochKeyNumber )
Tạo mã khoá gốc của nhóm ứng dụng dựa trên số khoá thời gian bắt đầu của hệ thống.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
mã nhận dạng khoá thời gian bắt đầu của hệ thống.
|
MakeGeneralKeyId
uint16_t MakeGeneralKeyId( uint16_t generalKeyNumber )
Xây dựng mã nhận dạng khoá chung dựa vào số khoá chung.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
mã khoá chung.
|
MakeRootKeyId
uint32_t MakeRootKeyId( uint8_t rootKeyNumber )
Tạo mã khoá gốc của nhóm ứng dụng bằng số khoá gốc đã cho.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
giá trị nhận dạng khoá gốc.
|
MakeSessionKeyId
uint16_t MakeSessionKeyId( uint16_t sessionKeyNumber )
Tạo mã khoá phiên đã cung cấp số khoá phiên.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
ID khoá phiên.
|
UpdateEpochKeyId
uint32_t UpdateEpochKeyId( uint32_t keyId, uint32_t epochKeyId )
Cập nhật mã khoá nhóm ứng dụng bằng số khoá thời gian bắt đầu của hệ thống mới.
Thông tin chi tiết | |||||
---|---|---|---|---|---|
Các tham số |
|
||||
Trả về |
mã khoá ứng dụng.
|
UsesCurrentEpochKey
bool UsesCurrentEpochKey( uint32_t keyId )
Xác định xem mã khoá nhóm ứng dụng được chỉ định có sử dụng khoá thời gian bắt đầu của hệ thống "hiện tại" hay không.
Thông tin chi tiết | |||
---|---|---|---|
Các tham số |
|
||
Trả về |
true nếu keyId cho biết việc sử dụng khoá epoch hiện tại.
|