Macros
#define	EFI_AUTH_OPERATION_NONE 0x00

#define	EFI_AUTH_OPERATION_VERIFY_IMAGE 0x01

#define	EFI_AUTH_OPERATION_DEFER_IMAGE_LOAD 0x02

#define	EFI_AUTH_OPERATION_MEASURE_IMAGE 0x04

#define	EFI_AUTH_OPERATION_CONNECT_POLICY 0x08

#define	EFI_AUTH_OPERATION_AUTHENTICATION_STATE 0x10

#define	EFI_AUTH_OPERATION_IMAGE_REQUIRED 0x80000000

Typedefs
typedef EFI_STATUS(EFIAPI *	SECURITY_FILE_AUTHENTICATION_STATE_HANDLER) (IN OUT UINT32 AuthenticationStatus, IN CONST EFI_DEVICE_PATH_PROTOCOL File, IN VOID FileBuffer, IN UINTN FileSize)

typedef EFI_STATUS(EFIAPI *	SECURITY2_FILE_AUTHENTICATION_HANDLER) (IN UINT32 AuthenticationStatus, IN CONST EFI_DEVICE_PATH_PROTOCOL File, IN VOID FileBuffer, IN UINTN FileSize, IN BOOLEAN BootPolicy)

Functions
EFI_STATUS EFIAPI	RegisterSecurityHandler (IN SECURITY_FILE_AUTHENTICATION_STATE_HANDLER SecurityHandler, IN UINT32 AuthenticationOperation)

EFI_STATUS EFIAPI	ExecuteSecurityHandlers (IN UINT32 AuthenticationStatus, IN CONST EFI_DEVICE_PATH_PROTOCOL *FilePath)

EFI_STATUS EFIAPI	RegisterSecurity2Handler (IN SECURITY2_FILE_AUTHENTICATION_HANDLER Security2Handler, IN UINT32 AuthenticationOperation)

EFI_STATUS EFIAPI	ExecuteSecurity2Handlers (IN UINT32 AuthenticationOperation, IN UINT32 AuthenticationStatus, IN CONST EFI_DEVICE_PATH_PROTOCOL File OPTIONAL, IN VOID FileBuffer, IN UINTN FileSize, IN BOOLEAN BootPolicy)

Detailed Description

This library class defines a set of interfaces to abstract the policy of security measurement by managing the different security measurement services. The library instances can be implemented according to the different security policy.

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

Definition in file SecurityManagementLib.h.

Macro Definition Documentation

◆ EFI_AUTH_OPERATION_AUTHENTICATION_STATE

#define EFI_AUTH_OPERATION_AUTHENTICATION_STATE 0x10

Definition at line 25 of file SecurityManagementLib.h.

◆ EFI_AUTH_OPERATION_CONNECT_POLICY

#define EFI_AUTH_OPERATION_CONNECT_POLICY 0x08

Definition at line 21 of file SecurityManagementLib.h.

◆ EFI_AUTH_OPERATION_DEFER_IMAGE_LOAD

#define EFI_AUTH_OPERATION_DEFER_IMAGE_LOAD 0x02

Definition at line 19 of file SecurityManagementLib.h.

◆ EFI_AUTH_OPERATION_IMAGE_REQUIRED

#define EFI_AUTH_OPERATION_IMAGE_REQUIRED 0x80000000

Image buffer is required by the security handler.

Definition at line 30 of file SecurityManagementLib.h.

◆ EFI_AUTH_OPERATION_MEASURE_IMAGE

#define EFI_AUTH_OPERATION_MEASURE_IMAGE 0x04

Definition at line 20 of file SecurityManagementLib.h.

◆ EFI_AUTH_OPERATION_NONE

#define EFI_AUTH_OPERATION_NONE 0x00

Definition at line 17 of file SecurityManagementLib.h.

◆ EFI_AUTH_OPERATION_VERIFY_IMAGE

#define EFI_AUTH_OPERATION_VERIFY_IMAGE 0x01

Definition at line 18 of file SecurityManagementLib.h.

Typedef Documentation

◆ SECURITY2_FILE_AUTHENTICATION_HANDLER

typedef EFI_STATUS(EFIAPI * SECURITY2_FILE_AUTHENTICATION_HANDLER) (IN UINT32 AuthenticationStatus, IN CONST EFI_DEVICE_PATH_PROTOCOL *File, IN VOID *FileBuffer, IN UINTN FileSize, IN BOOLEAN BootPolicy)

The security handler is used to abstracts security-specific functions from the DXE Foundation of UEFI Image Verification, Trusted Computing Group (TCG) measured boot, User Identity policy for image loading and consoles, and for purposes of handling GUIDed section encapsulations.

Parameters

[in]	AuthenticationStatus	The authentication status for the input file.
[in]	File	The pointer to the device path of the file that is being dispatched. This will optionally be used for logging.
[in]	FileBuffer	A pointer to the buffer with the UEFI file image
[in]	FileSize	The size of File buffer.
[in]	BootPolicy	A boot policy that was used to call LoadImage() UEFI service.

Return values

EFI_SUCCESS	The file specified by DevicePath and non-NULL FileBuffer did authenticate, and the platform policy dictates that the DXE Foundation may use the file.
EFI_SUCCESS	The device path specified by NULL device path DevicePath and non-NULL FileBuffer did authenticate, and the platform policy dictates that the DXE Foundation may execute the image in FileBuffer.
EFI_SUCCESS	FileBuffer is NULL and current user has permission to start UEFI device drivers on the device path specified by DevicePath.
EFI_SECURITY_VIOLATION	The file specified by DevicePath and FileBuffer did not authenticate, and the platform policy dictates that the file should be placed in the untrusted state. The image has been added to the file execution table.
EFI_ACCESS_DENIED	The file specified by File and FileBuffer did not authenticate, and the platform policy dictates that the DXE Foundation may not use File.
EFI_SECURITY_VIOLATION	FileBuffer is NULL and the user has no permission to start UEFI device drivers on the device path specified by DevicePath.
EFI_SECURITY_VIOLATION	FileBuffer is not NULL and the user has no permission to load drivers from the device path specified by DevicePath. The image has been added into the list of the deferred images.

Definition at line 186 of file SecurityManagementLib.h.

◆ SECURITY_FILE_AUTHENTICATION_STATE_HANDLER

typedef EFI_STATUS(EFIAPI * SECURITY_FILE_AUTHENTICATION_STATE_HANDLER) (IN OUT UINT32 AuthenticationStatus, IN CONST EFI_DEVICE_PATH_PROTOCOL *File, IN VOID *FileBuffer, IN UINTN FileSize)

The security handler is used to abstract platform-specific policy from the DXE core response to an attempt to use a file that returns a given status for the authentication check from the section extraction protocol.

The possible responses in a given SAP implementation may include locking flash upon failure to authenticate, attestation logging for all signed drivers, and other exception operations. The File parameter allows for possible logging within the SAP of the driver.

If File is NULL, then EFI_INVALID_PARAMETER is returned.

If the file specified by File with an authentication status specified by AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned.

If the file specified by File with an authentication status specified by AuthenticationStatus is not safe for the DXE Core to use under any circumstances, then EFI_ACCESS_DENIED is returned.

If the file specified by File with an authentication status specified by AuthenticationStatus is not safe for the DXE Core to use at the time, but it might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is returned.

FileBuffer will be NULL and FileSize will be 0 if the handler being called did not set EFI_AUTH_OPERATION_IMAGE_REQUIRED when it was registered.

Parameters

[in]	AuthenticationStatus	The authentication status returned from the security measurement services for the input file.
[in]	File	The pointer to the device path of the file that is being dispatched. This will optionally be used for logging.
[in]	FileBuffer	The file buffer matches the input file device path.
[in]	FileSize	The size of File buffer matches the input file device path.

Return values

EFI_SUCCESS	The file specified by File did authenticate, and the platform policy dictates that the DXE Core may use File.
EFI_INVALID_PARAMETER	The file is NULL.
EFI_SECURITY_VIOLATION	The file specified by File did not authenticate, and the platform policy dictates that File should be placed in the untrusted state. A file may be promoted from the untrusted to the trusted state at a future time with a call to the Trust() DXE Service.
EFI_ACCESS_DENIED	The file specified by File did not authenticate, and the platform policy dictates that File should not be used for any purpose.

Definition at line 81 of file SecurityManagementLib.h.

Function Documentation

◆ ExecuteSecurity2Handlers()

EFI_STATUS EFIAPI ExecuteSecurity2Handlers	(	IN UINT32	AuthenticationOperation,
		IN UINT32	AuthenticationStatus,
		IN CONST EFI_DEVICE_PATH_PROTOCOL *File	OPTIONAL,
		IN VOID *	FileBuffer,
		IN UINTN	FileSize,
		IN BOOLEAN	BootPolicy
	)

Execute registered handlers based on input AuthenticationOperation until one returns an error and that error is returned.

If none of the handlers return an error, then EFI_SUCCESS is returned. The handlers those satisfy AuthenticationOperation will only be executed. The handlers are executed in same order to their registered order.

Parameters

[in]	AuthenticationOperation	The operation type specifies which handlers will be executed.
[in]	AuthenticationStatus	The authentication status for the input file.
[in]	File	This is a pointer to the device path of the file that is being dispatched. This will optionally be used for logging.
[in]	FileBuffer	A pointer to the buffer with the UEFI file image
[in]	FileSize	The size of File buffer.
[in]	BootPolicy	A boot policy that was used to call LoadImage() UEFI service.

Return values

EFI_SUCCESS	The file specified by DevicePath and non-NULL FileBuffer did authenticate, and the platform policy dictates that the DXE Foundation may use the file.
EFI_SUCCESS	The device path specified by NULL device path DevicePath and non-NULL FileBuffer did authenticate, and the platform policy dictates that the DXE Foundation may execute the image in FileBuffer.
EFI_SUCCESS	FileBuffer is NULL and current user has permission to start UEFI device drivers on the device path specified by DevicePath.
EFI_SECURITY_VIOLATION	The file specified by DevicePath and FileBuffer did not authenticate, and the platform policy dictates that the file should be placed in the untrusted state. The image has been added to the file execution table.
EFI_ACCESS_DENIED	The file specified by File and FileBuffer did not authenticate, and the platform policy dictates that the DXE Foundation may not use File.
EFI_SECURITY_VIOLATION	FileBuffer is NULL and the user has no permission to start UEFI device drivers on the device path specified by DevicePath.
EFI_SECURITY_VIOLATION	FileBuffer is not NULL and the user has no permission to load drivers from the device path specified by DevicePath. The image has been added into the list of the deferred images.
EFI_INVALID_PARAMETER	File and FileBuffer are both NULL.

Execute registered handlers based on input AuthenticationOperation until one returns an error and that error is returned.

If none of the handlers return an error, then EFI_SUCCESS is returned. The handlers those satisfy AuthenticationOperation will only be executed. The handlers are executed in same order to their registered order.

Parameters

[in]	AuthenticationOperation	The operation type specifies which handlers will be executed.
[in]	AuthenticationStatus	The authentication status for the input file.
[in]	File	This is a pointer to the device path of the file that is being dispatched. This will optionally be used for logging.
[in]	FileBuffer	A pointer to the buffer with the UEFI file image
[in]	FileSize	The size of File buffer.
[in]	BootPolicy	A boot policy that was used to call LoadImage() UEFI service.

Return values

EFI_SUCCESS	The file specified by DevicePath and non-NULL FileBuffer did authenticate, and the platform policy dictates that the DXE Foundation may use the file.
EFI_SUCCESS	The device path specified by NULL device path DevicePath and non-NULL FileBuffer did authenticate, and the platform policy dictates that the DXE Foundation may execute the image in FileBuffer.
EFI_SUCCESS	FileBuffer is NULL and current user has permission to start UEFI device drivers on the device path specified by DevicePath.
EFI_SECURITY_VIOLATION	The file specified by File or FileBuffer did not authenticate, and the platform policy dictates that the file should be placed in the untrusted state.
EFI_SECURITY_VIOLATION	FileBuffer FileBuffer is NULL and the user has no permission to start UEFI device drivers on the device path specified by DevicePath.
EFI_SECURITY_VIOLATION	FileBuffer is not NULL and the user has no permission to load drivers from the device path specified by DevicePath. The image has been added into the list of the deferred images.
EFI_ACCESS_DENIED	The file specified by File did not authenticate, and the platform policy dictates that the DXE Foundation may not use File.
EFI_INVALID_PARAMETER	File and FileBuffer are both NULL.

Definition at line 480 of file DxeSecurityManagementLib.c.

◆ ExecuteSecurityHandlers()

EFI_STATUS EFIAPI ExecuteSecurityHandlers	(	IN UINT32	AuthenticationStatus,
		IN CONST EFI_DEVICE_PATH_PROTOCOL *	FilePath
	)

Execute registered handlers until one returns an error and that error is returned. If none of the handlers return an error, then EFI_SUCCESS is returned.

Before exectue handler, get the image buffer by file device path if a handler requires the image file. And return the image buffer to each handler when exectue handler.

The handlers are executed in same order to their registered order.

Parameters

[in]	AuthenticationStatus	This is the authentication type returned from the Section Extraction protocol. See the Section Extraction Protocol Specification for details on this type.
[in]	FilePath	This is a pointer to the device path of the file that is being dispatched. This will optionally be used for logging.

Return values

EFI_SUCCESS	The file specified by File authenticated when more than one security handler services were registered, or the file did not authenticate when no security handler service was registered. And the platform policy dictates that the DXE Core may use File.
EFI_INVALID_PARAMETER	File is NULL.
EFI_SECURITY_VIOLATION	The file specified by File did not authenticate, and the platform policy dictates that File should be placed in the untrusted state. A file may be promoted from the untrusted to the trusted state at a future time with a call to the Trust() DXE Service.
EFI_ACCESS_DENIED	The file specified by File did not authenticate, and the platform policy dictates that File should not be used for any purpose.

Execute registered handlers until one returns an error and that error is returned. If none of the handlers return an error, then EFI_SUCCESS is returned.

Before exectue handler, get the image buffer by file device path if a handler requires the image file. And return the image buffer to each handler when exectue handler.

The handlers are executed in same order to their registered order.

Parameters

[in]	AuthenticationStatus	This is the authentication type returned from the Section Extraction protocol. See the Section Extraction Protocol Specification for details on this type.
[in]	FilePath	This is a pointer to the device path of the file that is being dispatched. This will optionally be used for logging.

Return values

EFI_SUCCESS	The file specified by File did authenticate when more than one security handler services were registered, or the file did not authenticate when no security handler service was registered. And the platform policy dictates that the DXE Core may use File.
EFI_INVALID_PARAMETER	File is NULL.
EFI_SECURITY_VIOLATION	The file specified by File did not authenticate, and the platform policy dictates that File should be placed in the untrusted state. A file may be promoted from the untrusted to the trusted state at a future time with a call to the Trust() DXE Service.
EFI_ACCESS_DENIED	The file specified by File did not authenticate, and the platform policy dictates that File should not be used for any purpose.

Definition at line 211 of file DxeSecurityManagementLib.c.

◆ RegisterSecurity2Handler()

EFI_STATUS EFIAPI RegisterSecurity2Handler	(	IN SECURITY2_FILE_AUTHENTICATION_HANDLER	Security2Handler,
		IN UINT32	AuthenticationOperation
	)

Register security measurement handler with its operation type. Different handlers with the same operation can all be registered.

If SecurityHandler is NULL, then ASSERT(). If no enough resources available to register new handler, then ASSERT(). If AuthenticationOperation is not recongnized, then ASSERT(). If AuthenticationOperation is EFI_AUTH_OPERATION_NONE, then ASSERT(). If the previous register handler can't be executed before the later register handler, then ASSERT().

Parameters

[in]	Security2Handler	The security measurement service handler to be registered.
[in]	AuthenticationOperation	The operation type is specified for the registered handler.

Return values

EFI_SUCCESS The handlers were registered successfully.

Register security measurement handler with its operation type. Different handlers with the same operation can all be registered.

If Security2Handler is NULL, then ASSERT(). If no enough resources available to register new handler, then ASSERT(). If AuthenticationOperation is not recongnized, then ASSERT(). If AuthenticationOperation is EFI_AUTH_OPERATION_NONE, then ASSERT(). If the previous register handler can't be executed before the later register handler, then ASSERT().

Parameters

[in]	Security2Handler	The security measurement service handler to be registered.
[in]	AuthenticationOperation	The operation type is specified for the registered handler.

Return values

EFI_SUCCESS The handlers were registered successfully.

Definition at line 401 of file DxeSecurityManagementLib.c.

◆ RegisterSecurityHandler()

EFI_STATUS EFIAPI RegisterSecurityHandler	(	IN SECURITY_FILE_AUTHENTICATION_STATE_HANDLER	SecurityHandler,
		IN UINT32	AuthenticationOperation
	)

Register security measurement handler with its operation type. Different handlers with the same operation can all be registered.

If SecurityHandler is NULL, then ASSERT(). If no enough resources available to register new handler, then ASSERT(). If AuthenticationOperation is not recongnized, then ASSERT(). If the previous register handler can't be executed before the later register handler, then ASSERT().

Parameters

[in]	SecurityHandler	The security measurement service handler to be registered.
[in]	AuthenticationOperation	Theoperation type is specified for the registered handler.

Return values

EFI_SUCCESS The handlers were registered successfully.

Register security measurement handler with its operation type. The different handler with the same operation can all be registered.

If SecurityHandler is NULL, then ASSERT(). If no enough resources available to register new handler, then ASSERT(). If AuthenticationOperation is not recongnized, then ASSERT(). If the previous register handler can't be executed before the later register handler, then ASSERT().

Parameters

[in]	SecurityHandler	Security measurement service handler to be registered.
[in]	AuthenticationOperation	Operation type is specified for the registered handler.

Return values

EFI_SUCCESS The handlers were registered successfully.

Definition at line 142 of file DxeSecurityManagementLib.c.

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ EFI_AUTH_OPERATION_AUTHENTICATION_STATE

◆ EFI_AUTH_OPERATION_CONNECT_POLICY

◆ EFI_AUTH_OPERATION_DEFER_IMAGE_LOAD

◆ EFI_AUTH_OPERATION_IMAGE_REQUIRED

◆ EFI_AUTH_OPERATION_MEASURE_IMAGE

◆ EFI_AUTH_OPERATION_NONE

◆ EFI_AUTH_OPERATION_VERIFY_IMAGE

Typedef Documentation

◆ SECURITY2_FILE_AUTHENTICATION_HANDLER

◆ SECURITY_FILE_AUTHENTICATION_STATE_HANDLER

Function Documentation

◆ ExecuteSecurity2Handlers()

◆ ExecuteSecurityHandlers()

◆ RegisterSecurity2Handler()

◆ RegisterSecurityHandler()