MdePkg/Include/Protocol/Security2.h

   1 /** @file
   2   Security2 Architectural Protocol as defined in PI Specification1.2.1 VOLUME 2 DXE
   3
   4   Abstracts security-specific functions from the DXE Foundation of UEFI Image Verification,
   5   Trusted Computing Group (TCG) measured boot, and User Identity policy for image loading and
   6   consoles. This protocol must be produced by a boot service or runtime DXE driver.
   7
   8   This protocol is optional and must be published prior to the EFI_SECURITY_ARCH_PROTOCOL.
   9   As a result, the same driver must publish both of these interfaces.
  10
  11   When both Security and Security2 Architectural Protocols are published, LoadImage must use
  12   them in accordance with the following rules:
  13     The Security2 protocol must be used on every image being loaded.
  14     The Security protocol must be used after the Securiy2 protocol and only on images that
  15     have been read using Firmware Volume protocol.
  16
  17   When only Security architectural protocol is published, LoadImage must use it on every image
  18   being loaded.
  19
  20   Copyright (c) 2012 - 2018, Intel Corporation. All rights reserved.<BR>
  21   SPDX-License-Identifier: BSD-2-Clause-Patent
  22
  23 **/
  24
  25 #ifndef __ARCH_PROTOCOL_SECURITY2_H__
  26 #define __ARCH_PROTOCOL_SECURITY2_H__
  27
  28 ///
  29 /// Global ID for the Security2 Code Architectural Protocol
  30 ///
  31 #define EFI_SECURITY2_ARCH_PROTOCOL_GUID \
  32   { 0x94ab2f58, 0x1438, 0x4ef1, {0x91, 0x52, 0x18, 0x94, 0x1a, 0x3a, 0x0e, 0x68 } }
  33
  34 typedef struct _EFI_SECURITY2_ARCH_PROTOCOL EFI_SECURITY2_ARCH_PROTOCOL;
  35
  36 /**
  37   The DXE Foundation uses this service to measure and/or verify a UEFI image.
  38
  39   This service abstracts the invocation of Trusted Computing Group (TCG) measured boot, UEFI
  40   Secure boot, and UEFI User Identity infrastructure. For the former two, the DXE Foundation
  41   invokes the FileAuthentication() with a DevicePath and corresponding image in
  42   FileBuffer memory. The TCG measurement code will record the FileBuffer contents into the
  43   appropriate PCR. The image verification logic will confirm the integrity and provenance of the
  44   image in FileBuffer of length FileSize . The origin of the image will be DevicePath in
  45   these cases.
  46   If the FileBuffer is NULL, the interface will determine if the DevicePath can be connected
  47   in order to support the User Identification policy.
  48
  49   @param  This             The EFI_SECURITY2_ARCH_PROTOCOL instance.
  50   @param  File             A pointer to the device path of the file that is
  51                            being dispatched. This will optionally be used for logging.
  52   @param  FileBuffer       A pointer to the buffer with the UEFI file image.
  53   @param  FileSize         The size of the file.
  54   @param  BootPolicy       A boot policy that was used to call LoadImage() UEFI service. If
  55                            FileAuthentication() is invoked not from the LoadImage(),
  56                            BootPolicy must be set to FALSE.
  57
  58   @retval EFI_SUCCESS             The file specified by DevicePath and non-NULL
  59                                   FileBuffer did authenticate, and the platform policy dictates
  60                                   that the DXE Foundation may use the file.
  61   @retval EFI_SUCCESS             The device path specified by NULL device path DevicePath
  62                                   and non-NULL FileBuffer did authenticate, and the platform
  63                                   policy dictates that the DXE Foundation may execute the image in
  64                                   FileBuffer.
  65   @retval EFI_SUCCESS             FileBuffer is NULL and current user has permission to start
  66                                   UEFI device drivers on the device path specified by DevicePath.
  67   @retval EFI_SECURITY_VIOLATION  The file specified by DevicePath and FileBuffer did not
  68                                   authenticate, and the platform policy dictates that the file should be
  69                                   placed in the untrusted state. The image has been added to the file
  70                                   execution table.
  71   @retval EFI_ACCESS_DENIED       The file specified by File and FileBuffer did not
  72                                   authenticate, and the platform policy dictates that the DXE
  73                                   Foundation may not use File.
  74   @retval EFI_SECURITY_VIOLATION  FileBuffer is NULL and the user has no
  75                                   permission to start UEFI device drivers on the device path specified
  76                                   by DevicePath.
  77   @retval EFI_SECURITY_VIOLATION  FileBuffer is not NULL and the user has no permission to load
  78                                   drivers from the device path specified by DevicePath. The
  79                                   image has been added into the list of the deferred images.
  80 **/
  81 typedef EFI_STATUS (EFIAPI *EFI_SECURITY2_FILE_AUTHENTICATION)(
  82   IN CONST EFI_SECURITY2_ARCH_PROTOCOL *This,
  83   IN CONST EFI_DEVICE_PATH_PROTOCOL    *File  OPTIONAL,
  84   IN VOID                              *FileBuffer,
  85   IN UINTN                             FileSize,
  86   IN BOOLEAN                           BootPolicy
  87   );
  88
  89 ///
  90 /// The EFI_SECURITY2_ARCH_PROTOCOL is used to abstract platform-specific policy from the
  91 /// DXE Foundation. This includes measuring the PE/COFF image prior to invoking, comparing the
  92 /// image against a policy (whether a white-list/black-list of public image verification keys
  93 /// or registered hashes).
  94 ///
  95 struct _EFI_SECURITY2_ARCH_PROTOCOL {
  96   EFI_SECURITY2_FILE_AUTHENTICATION    FileAuthentication;
  97 };
  98
  99 extern EFI_GUID  gEfiSecurity2ArchProtocolGuid;
 100
 101 #endif