TianoCore EDK2 master
No Matches

Data Fields

UINT8 KeyAttributeIdentifierType
UINT8 KeyAttributeIdentifierCount
VOID * KeyAttributeIdentifier
UINT16 KeyAttributeInstance
UINT16 KeyAttributeType
UINT16 KeyAttributeValueSize
VOID * KeyAttributeValue
EFI_STATUS KeyAttributeStatus

Detailed Description

Definition at line 284 of file Kms.h.

Field Documentation

◆ KeyAttributeIdentifier

VOID* EFI_KMS_KEY_ATTRIBUTE::KeyAttributeIdentifier

Pointer to an array of KeyAttributeIdentifierType elements. For string types, there must not be a null-termination element at the end of the array.

Definition at line 300 of file Kms.h.

◆ KeyAttributeIdentifierCount

UINT8 EFI_KMS_KEY_ATTRIBUTE::KeyAttributeIdentifierCount

The length of the KeyAttributeIdentifier field in units defined by KeyAttributeIdentifierType field. This field is limited to the range 0 to 255.

Definition at line 295 of file Kms.h.

◆ KeyAttributeIdentifierType

UINT8 EFI_KMS_KEY_ATTRIBUTE::KeyAttributeIdentifierType

The data type used for the KeyAttributeIdentifier field. Values for this field are defined by the EFI_KMS_DATA_TYPE constants, except that EFI_KMS_DATA_TYPE_BINARY is not valid for this field.

Definition at line 290 of file Kms.h.

◆ KeyAttributeInstance

UINT16 EFI_KMS_KEY_ATTRIBUTE::KeyAttributeInstance

The instance number of this attribute. If there is only one instance, the value is set to one. If this value is set to 0xFFFF (all binary 1's) then this field should be ignored if an output or treated as a wild card matching any value if it is an input. If the attribute is stored with this field, it will match any attribute request regardless of the setting of the field in the request. If set to 0xFFFF in the request, it will match any attribute with the same KeyAttributeIdentifier.

Definition at line 309 of file Kms.h.

◆ KeyAttributeStatus


KeyAttributeStatusSpecifies the results of KMS operations performed with this attribute. This field is used to indicate the status of individual operations when a KMS function is called with multiple EFI_KMS_KEY_ATTRIBUTE structures. KeyAttributeStatus codes returned for the individual key attribute requests are: EFI_SUCCESS Successfully processed this request. EFI_WARN_STALE_DATA Successfully processed this request, however, the key's parameters exceed internal policies/limits and should be replaced. EFI_COMPROMISED_DATA Successfully processed this request, but the key may have been compromised and must be replaced. EFI_UNSUPPORTED Key attribute format is not supported by the service. EFI_OUT_OF_RESOURCES Could not allocate resources for the request processing. EFI_TIMEOUT Timed out waiting for device or key server. EFI_DEVICE_ERROR Device or key server error. EFI_INVALID_PARAMETER A field in the EFI_KMS_KEY_ATTRIBUTE structure is invalid. EFI_NOT_FOUND The key attribute does not exist on the KMS.

Definition at line 342 of file Kms.h.

◆ KeyAttributeType


The data type of the KeyAttributeValue (e.g. struct, bool, etc.). See the list of KeyAttributeType definitions.

Definition at line 314 of file Kms.h.

◆ KeyAttributeValue


Pointer to a key attribute value for the attribute specified by the KeyAttributeIdentifier field. If the KeyAttributeValueSize field is zero, then this field must be NULL.

Definition at line 324 of file Kms.h.

◆ KeyAttributeValueSize


The size in bytes of the KeyAttribute field. A value of zero for this field indicates that no key attribute value is available.

Definition at line 319 of file Kms.h.

The documentation for this struct was generated from the following file: