EdkCompatibilityPkg/Foundation/Core/Dxe/ArchProtocol/Security/Security.h

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