Security.h File Reference

Data Structures
struct	_EFI_SECURITY_ARCH_PROTOCOL

Macros
#define	EFI_SECURITY_ARCH_PROTOCOL_GUID   { 0xA46423E3, 0x4617, 0x49f1, {0xB9, 0xFF, 0xD1, 0xBF, 0xA9, 0x11, 0x58, 0x39 } }

Typedefs
typedef struct _EFI_SECURITY_ARCH_PROTOCOL	EFI_SECURITY_ARCH_PROTOCOL
typedef EFI_STATUS(EFIAPI *	EFI_SECURITY_FILE_AUTHENTICATION_STATE )(IN CONST EFI_SECURITY_ARCH_PROTOCOL *This, IN UINT32 AuthenticationStatus, IN CONST EFI_DEVICE_PATH_PROTOCOL *File)

Variables
EFI_GUID	gEfiSecurityArchProtocolGuid

Detailed Description

Security Architectural Protocol as defined in PI Specification VOLUME 2 DXE

Used to provide Security services. Specifically, dependening upon the authentication state of a discovered driver in a Firmware Volume, the portable DXE Core Dispatcher will call into the Security Architectural Protocol (SAP) with the authentication state of the driver.

This call-out allows for OEM-specific policy decisions to be made, such as event logging for attested boots, locking flash in response to discovering an unsigned driver or failed signature check, or other exception response.

The SAP can also change system behavior by having the DXE core put a driver in the Schedule-On-Request (SOR) state. This will allow for later disposition of the driver by platform agent, such as Platform BDS.

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

Macro Definition Documentation

#define EFI_SECURITY_ARCH_PROTOCOL_GUID   { 0xA46423E3, 0x4617, 0x49f1, {0xB9, 0xFF, 0xD1, 0xBF, 0xA9, 0x11, 0x58, 0x39 } }

Global ID for the Security Code Architectural Protocol

Typedef Documentation

typedef struct _EFI_SECURITY_ARCH_PROTOCOL EFI_SECURITY_ARCH_PROTOCOL

typedef EFI_STATUS(EFIAPI * EFI_SECURITY_FILE_AUTHENTICATION_STATE)(IN CONST EFI_SECURITY_ARCH_PROTOCOL *This, IN UINT32 AuthenticationStatus, IN CONST EFI_DEVICE_PATH_PROTOCOL *File)

The EFI_SECURITY_ARCH_PROTOCOL (SAP) 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 right now, but it might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is returned.

Parameters

This	The EFI_SECURITY_ARCH_PROTOCOL instance.
AuthenticationStatus	This is the authentication type returned from the Section Extraction protocol. See the Section Extraction Protocol Specification for details on this type.
File	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, and the platform policy dictates that the DXE Core may use File.
EFI_INVALID_PARAMETER	Driver 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.

Variable Documentation

EFI_GUID gEfiSecurityArchProtocolGuid