65fea56f17cd614bc8908264df980a62e1931468vboxsync Security Architectural Protocol as defined in PI Specification VOLUME 2 DXE
65fea56f17cd614bc8908264df980a62e1931468vboxsync Used to provide Security services. Specifically, dependening upon the
65fea56f17cd614bc8908264df980a62e1931468vboxsync authentication state of a discovered driver in a Firmware Volume, the
65fea56f17cd614bc8908264df980a62e1931468vboxsync portable DXE Core Dispatcher will call into the Security Architectural
65fea56f17cd614bc8908264df980a62e1931468vboxsync Protocol (SAP) with the authentication state of the driver.
65fea56f17cd614bc8908264df980a62e1931468vboxsync This call-out allows for OEM-specific policy decisions to be made, such
65fea56f17cd614bc8908264df980a62e1931468vboxsync as event logging for attested boots, locking flash in response to discovering
65fea56f17cd614bc8908264df980a62e1931468vboxsync an unsigned driver or failed signature check, or other exception response.
65fea56f17cd614bc8908264df980a62e1931468vboxsync The SAP can also change system behavior by having the DXE core put a driver
65fea56f17cd614bc8908264df980a62e1931468vboxsync in the Schedule-On-Request (SOR) state. This will allow for later disposition
65fea56f17cd614bc8908264df980a62e1931468vboxsync of the driver by platform agent, such as Platform BDS.
65fea56f17cd614bc8908264df980a62e1931468vboxsync Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
65fea56f17cd614bc8908264df980a62e1931468vboxsync This program and the accompanying materials
65fea56f17cd614bc8908264df980a62e1931468vboxsync are licensed and made available under the terms and conditions of the BSD License
65fea56f17cd614bc8908264df980a62e1931468vboxsync which accompanies this distribution. The full text of the license may be found at
65fea56f17cd614bc8908264df980a62e1931468vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
65fea56f17cd614bc8908264df980a62e1931468vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
65fea56f17cd614bc8908264df980a62e1931468vboxsync/// Global ID for the Security Code Architectural Protocol
65fea56f17cd614bc8908264df980a62e1931468vboxsync { 0xA46423E3, 0x4617, 0x49f1, {0xB9, 0xFF, 0xD1, 0xBF, 0xA9, 0x11, 0x58, 0x39 } }
65fea56f17cd614bc8908264df980a62e1931468vboxsynctypedef struct _EFI_SECURITY_ARCH_PROTOCOL EFI_SECURITY_ARCH_PROTOCOL;
65fea56f17cd614bc8908264df980a62e1931468vboxsync The EFI_SECURITY_ARCH_PROTOCOL (SAP) is used to abstract platform-specific
65fea56f17cd614bc8908264df980a62e1931468vboxsync policy from the DXE core response to an attempt to use a file that returns a
65fea56f17cd614bc8908264df980a62e1931468vboxsync given status for the authentication check from the section extraction protocol.
65fea56f17cd614bc8908264df980a62e1931468vboxsync The possible responses in a given SAP implementation may include locking
65fea56f17cd614bc8908264df980a62e1931468vboxsync flash upon failure to authenticate, attestation logging for all signed drivers,
65fea56f17cd614bc8908264df980a62e1931468vboxsync and other exception operations. The File parameter allows for possible logging
65fea56f17cd614bc8908264df980a62e1931468vboxsync within the SAP of the driver.
65fea56f17cd614bc8908264df980a62e1931468vboxsync If File is NULL, then EFI_INVALID_PARAMETER is returned.
65fea56f17cd614bc8908264df980a62e1931468vboxsync If the file specified by File with an authentication status specified by
65fea56f17cd614bc8908264df980a62e1931468vboxsync AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned.
65fea56f17cd614bc8908264df980a62e1931468vboxsync If the file specified by File with an authentication status specified by
65fea56f17cd614bc8908264df980a62e1931468vboxsync AuthenticationStatus is not safe for the DXE Core to use under any circumstances,
65fea56f17cd614bc8908264df980a62e1931468vboxsync then EFI_ACCESS_DENIED is returned.
65fea56f17cd614bc8908264df980a62e1931468vboxsync If the file specified by File with an authentication status specified by
65fea56f17cd614bc8908264df980a62e1931468vboxsync AuthenticationStatus is not safe for the DXE Core to use right now, but it
65fea56f17cd614bc8908264df980a62e1931468vboxsync might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is
65fea56f17cd614bc8908264df980a62e1931468vboxsync @param This The EFI_SECURITY_ARCH_PROTOCOL instance.
65fea56f17cd614bc8908264df980a62e1931468vboxsync @param AuthenticationStatus
65fea56f17cd614bc8908264df980a62e1931468vboxsync This is the authentication type returned from the Section
65fea56f17cd614bc8908264df980a62e1931468vboxsync Extraction protocol. See the Section Extraction Protocol
65fea56f17cd614bc8908264df980a62e1931468vboxsync Specification for details on this type.
65fea56f17cd614bc8908264df980a62e1931468vboxsync @param File This is a pointer to the device path of the file that is
65fea56f17cd614bc8908264df980a62e1931468vboxsync being dispatched. This will optionally be used for logging.
65fea56f17cd614bc8908264df980a62e1931468vboxsync @retval EFI_SUCCESS The file specified by File did authenticate, and the
65fea56f17cd614bc8908264df980a62e1931468vboxsync platform policy dictates that the DXE Core may use File.
65fea56f17cd614bc8908264df980a62e1931468vboxsync @retval EFI_INVALID_PARAMETER Driver is NULL.
65fea56f17cd614bc8908264df980a62e1931468vboxsync @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and
65fea56f17cd614bc8908264df980a62e1931468vboxsync the platform policy dictates that File should be placed
65fea56f17cd614bc8908264df980a62e1931468vboxsync in the untrusted state. A file may be promoted from
65fea56f17cd614bc8908264df980a62e1931468vboxsync the untrusted to the trusted state at a future time
65fea56f17cd614bc8908264df980a62e1931468vboxsync with a call to the Trust() DXE Service.
65fea56f17cd614bc8908264df980a62e1931468vboxsync @retval EFI_ACCESS_DENIED The file specified by File did not authenticate, and
65fea56f17cd614bc8908264df980a62e1931468vboxsync the platform policy dictates that File should not be
65fea56f17cd614bc8908264df980a62e1931468vboxsync used for any purpose.