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