MdePkg/Include/Dxe/ArchProtocol/Security.h

   1 /** @file
   2   Security Architectural Protocol as defined in the DXE CIS
   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, 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   Module Name:  Security.h
  27
  28   @par Revision Reference:
  29   Version 0.91B.
  30
  31 **/
  32
  33 #ifndef __ARCH_PROTOCOL_SECURITY_H__
  34 #define __ARCH_PROTOCOL_SECURITY_H__
  35
  36 //
  37 // Global ID for the Security Code Architectural Protocol
  38 //
  39 #define EFI_SECURITY_ARCH_PROTOCOL_GUID  \
  40   { 0xA46423E3, 0x4617, 0x49f1, {0xB9, 0xFF, 0xD1, 0xBF, 0xA9, 0x11, 0x58, 0x39 } }
  41
  42 typedef struct _EFI_SECURITY_ARCH_PROTOCOL    EFI_SECURITY_ARCH_PROTOCOL;
  43
  44 /**
  45   The EFI_SECURITY_ARCH_PROTOCOL (SAP) is used to abstract platform-specific
  46   policy from the DXE core response to an attempt to use a file that returns a
  47   given status for the authentication check from the section extraction protocol.
  48
  49   The possible responses in a given SAP implementation may include locking
  50   flash upon failure to authenticate, attestation logging for all signed drivers,
  51   and other exception operations.  The File parameter allows for possible logging
  52   within the SAP of the driver.
  53
  54   If File is NULL, then EFI_INVALID_PARAMETER is returned.
  55
  56   If the file specified by File with an authentication status specified by
  57   AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned.
  58
  59   If the file specified by File with an authentication status specified by
  60   AuthenticationStatus is not safe for the DXE Core to use under any circumstances,
  61   then EFI_ACCESS_DENIED is returned.
  62
  63   If the file specified by File with an authentication status specified by
  64   AuthenticationStatus is not safe for the DXE Core to use right now, but it
  65   might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is
  66   returned.
  67
  68   @param  This The EFI_SECURITY_ARCH_PROTOCOL instance.
  69
  70   @param  AuthenticationStatus This is the authentication type returned from the Section
  71   Extraction protocol.  See the Section Extraction Protocol
  72   Specification for details on this type.
  73
  74   @param  File This is a pointer to the device path of the file that is
  75   being dispatched.  This will optionally be used for logging.
  76
  77   @retval  EFI_SUCCESS The file specified by File did authenticate, and the
  78   platform policy dictates that the DXE Core may use File.
  79
  80   @retval  EFI_INVALID_PARAMETER Driver is NULL.
  81
  82   @retval  EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and
  83   the platform policy dictates that File should be placed
  84   in the untrusted state.   A file may be promoted from
  85   the untrusted to the trusted state at a future time
  86   with a call to the Trust() DXE Service.
  87
  88   @retval  EFI_ACCESS_DENIED The file specified by File did not authenticate, and
  89   the platform policy dictates that File should not be
  90   used for any purpose.
  91
  92 **/
  93 typedef
  94 EFI_STATUS
  95 (EFIAPI *EFI_SECURITY_FILE_AUTHENTICATION_STATE) (
  96   IN EFI_SECURITY_ARCH_PROTOCOL     *This,
  97   IN  UINT32                        AuthenticationStatus,
  98   IN  EFI_DEVICE_PATH_PROTOCOL      *File
  99   )
 100 ;
 101
 102 //
 103 // Interface stucture for the Timer Architectural Protocol
 104 //
 105 /**
 106   @par Protocol Description:
 107
 108   The EFI_SECURITY_ARCH_PROTOCOL is used to abstract platform-specific policy
 109   from the DXE core.  This includes locking flash upon failure to authenticate,
 110   attestation logging, and other exception operations.
 111
 112   The driver that produces the EFI_SECURITY_ARCH_PROTOCOL may also optionally
 113   install the EFI_SECURITY_POLICY_PROTOCOL_GUID onto a new handle with a NULL
 114   interface.  The existence of this GUID in the protocol database means that
 115   the GUIDed Section Extraction Protocol should authenticate the contents of
 116   an Authentication Section.  The expectation is that the GUIDed Section
 117   Extraction protocol will look for the existence of the EFI_SECURITY_POLICY_
 118   PROTOCOL_GUID in the protocol database.  If it exists, then the publication
 119   thereof is taken as an injunction to attempt an authentication of any section
 120   wrapped in an Authentication Section.  See the Firmware File System
 121   Specification for details on the GUIDed Section Extraction Protocol and
 122   Authentication Sections.
 123
 124   @par Protocol Parameters:
 125
 126   FileAuthenticationState - This service is called upon fault with respect to
 127   the authentication of a section of a file.
 128
 129 **/
 130 struct _EFI_SECURITY_ARCH_PROTOCOL {
 131   EFI_SECURITY_FILE_AUTHENTICATION_STATE  FileAuthenticationState;
 132 };
 133
 134 extern EFI_GUID gEfiSecurityArchProtocolGuid;
 135
 136 #endif