MdePkg/Include/Protocol/Security.h

   1 /** @file
   2   Security Architectural Protocol as defined in PI Specification VOLUME 2 DXE
   3
   4   Used to provide Security services.  Specifically, dependening upon the
   5   authentication state of a discovered driver in a Firmware Volume, the
   6   portable DXE Core Dispatcher will call into the Security Architectural
   7   Protocol (SAP) with the authentication state of the driver.
   8
   9   This call-out allows for OEM-specific policy decisions to be made, such
  10   as event logging for attested boots, locking flash in response to discovering
  11   an unsigned driver or failed signature check, or other exception response.
  12
  13   The SAP can also change system behavior by having the DXE core put a driver
  14   in the Schedule-On-Request (SOR) state.  This will allow for later disposition
  15   of the driver by platform agent, such as Platform BDS.
  16
  17   Copyright (c) 2006 - 2008, Intel Corporation
  18   All rights reserved. This program and the accompanying materials
  19   are licensed and made available under the terms and conditions of the BSD License
  20   which accompanies this distribution.  The full text of the license may be found at
  21   http://opensource.org/licenses/bsd-license.php
  22
  23   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  24   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  25
  26 **/
  27
  28 #ifndef __ARCH_PROTOCOL_SECURITY_H__
  29 #define __ARCH_PROTOCOL_SECURITY_H__
  30
  31 #include <PiDxe.h>
  32
  33 ///
  34 /// Global ID for the Security Code Architectural Protocol
  35 ///
  36 #define EFI_SECURITY_ARCH_PROTOCOL_GUID  \
  37   { 0xA46423E3, 0x4617, 0x49f1, {0xB9, 0xFF, 0xD1, 0xBF, 0xA9, 0x11, 0x58, 0x39 } }
  38
  39 typedef struct _EFI_SECURITY_ARCH_PROTOCOL    EFI_SECURITY_ARCH_PROTOCOL;
  40
  41 /**
  42   The EFI_SECURITY_ARCH_PROTOCOL (SAP) is used to abstract platform-specific
  43   policy from the DXE core response to an attempt to use a file that returns a
  44   given status for the authentication check from the section extraction protocol.
  45
  46   The possible responses in a given SAP implementation may include locking
  47   flash upon failure to authenticate, attestation logging for all signed drivers,
  48   and other exception operations.  The File parameter allows for possible logging
  49   within the SAP of the driver.
  50
  51   If File is NULL, then EFI_INVALID_PARAMETER is returned.
  52
  53   If the file specified by File with an authentication status specified by
  54   AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned.
  55
  56   If the file specified by File with an authentication status specified by
  57   AuthenticationStatus is not safe for the DXE Core to use under any circumstances,
  58   then EFI_ACCESS_DENIED is returned.
  59
  60   If the file specified by File with an authentication status specified by
  61   AuthenticationStatus is not safe for the DXE Core to use right now, but it
  62   might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is
  63   returned.
  64
  65   @param  This             The EFI_SECURITY_ARCH_PROTOCOL instance.
  66   @param  AuthenticationStatus
  67                            This is the authentication type returned from the Section
  68                            Extraction protocol. See the Section Extraction Protocol
  69                            Specification for details on this type.
  70   @param  File             This is a pointer to the device path of the file that is
  71                            being dispatched. This will optionally be used for logging.
  72
  73   @retval EFI_SUCCESS           The file specified by File did authenticate, and the
  74                                 platform policy dictates that the DXE Core may use File.
  75   @retval EFI_INVALID_PARAMETER Driver is NULL.
  76   @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and
  77                                 the platform policy dictates that File should be placed
  78                                 in the untrusted state. A file may be promoted from
  79                                 the untrusted to the trusted state at a future time
  80                                 with a call to the Trust() DXE Service.
  81   @retval EFI_ACCESS_DENIED     The file specified by File did not authenticate, and
  82                                 the platform policy dictates that File should not be
  83                                 used for any purpose.
  84
  85 **/
  86 typedef
  87 EFI_STATUS
  88 (EFIAPI *EFI_SECURITY_FILE_AUTHENTICATION_STATE)(
  89   IN EFI_SECURITY_ARCH_PROTOCOL     *This,
  90   IN  UINT32                        AuthenticationStatus,
  91   IN  EFI_DEVICE_PATH_PROTOCOL      *File
  92   );
  93
  94 //
  95 // Interface stucture for the Timer Architectural Protocol
  96 //
  97 /**
  98   @par Protocol Description:
  99
 100   The EFI_SECURITY_ARCH_PROTOCOL is used to abstract platform-specific policy
 101   from the DXE core.  This includes locking flash upon failure to authenticate,
 102   attestation logging, and other exception operations.
 103
 104   The driver that produces the EFI_SECURITY_ARCH_PROTOCOL may also optionally
 105   install the EFI_SECURITY_POLICY_PROTOCOL_GUID onto a new handle with a NULL
 106   interface.  The existence of this GUID in the protocol database means that
 107   the GUIDed Section Extraction Protocol should authenticate the contents of
 108   an Authentication Section.  The expectation is that the GUIDed Section
 109   Extraction protocol will look for the existence of the EFI_SECURITY_POLICY_
 110   PROTOCOL_GUID in the protocol database.  If it exists, then the publication
 111   thereof is taken as an injunction to attempt an authentication of any section
 112   wrapped in an Authentication Section.  See the Firmware File System
 113   Specification for details on the GUIDed Section Extraction Protocol and
 114   Authentication Sections.
 115
 116   @param FileAuthenticationState
 117   This service is called upon fault with respect to
 118   the authentication of a section of a file.
 119
 120 **/
 121 struct _EFI_SECURITY_ARCH_PROTOCOL {
 122   EFI_SECURITY_FILE_AUTHENTICATION_STATE  FileAuthenticationState;
 123 };
 124
 125 extern EFI_GUID gEfiSecurityArchProtocolGuid;
 126
 127 #endif