Functions
EFI_STATUS EFIAPI	GetVariableKey (OUT VOID *VariableKey, IN OUT UINTN VariableKeySize)

EFI_STATUS EFIAPI	RegenerateVariableKey (VOID)

EFI_STATUS EFIAPI	LockVariableKeyInterface (VOID)

Detailed Description

Public definitions for Variable Key Library.

Copyright (c) 2020, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Function Documentation

EFI_STATUS EFIAPI GetVariableKey	(	OUT VOID **	VariableKey,
		IN OUT UINTN *	VariableKeySize
	)

Retrieves the key for integrity and/or confidentiality of variables.

Parameters

[out]	VariableKey	A pointer to pointer for the variable key buffer.
[in,out]	VariableKeySize	The size in bytes of the variable key.

Return values

EFI_SUCCESS	The variable key was returned.
EFI_DEVICE_ERROR	An error occurred while attempting to get the variable key.
EFI_ACCESS_DENIED	The function was invoked after locking the key interface.
EFI_UNSUPPORTED	The variable key is not supported in the current boot configuration.

EFI_STATUS EFIAPI LockVariableKeyInterface ( VOID )

Locks the regenerate key interface.

Return values

EFI_SUCCESS	The key interface was locked successfully.
EFI_UNSUPPORTED	Locking the key interface is not supported in the current boot configuration.
Others	An error occurred while attempting to lock the key interface.

EFI_STATUS EFIAPI RegenerateVariableKey ( VOID )

Regenerates the variable key.

Return values

EFI_SUCCESS	The variable key was regenerated successfully.
EFI_DEVICE_ERROR	An error occurred while attempting to regenerate the key.
EFI_ACCESS_DENIED	The function was invoked after locking the key interface.
EFI_UNSUPPORTED	Key regeneration is not supported in the current boot configuration.