IntelFrameworkPkg/Include/Ppi/Security.h

   1 /** @file
   2   This file declares the Security Architectural PPI.
   3
   4   This PPI is installed by a platform PEIM that abstracts the security policy to the PEI
   5   Foundation, namely the case of a PEIM's authentication state being returned during the PEI section
   6   extraction process.
   7
   8 Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
   9 SPDX-License-Identifier: BSD-2-Clause-Patent
  10
  11   @par Revision Reference:
  12   This PPI is defined in PEI CIS.
  13   Version 0.91.
  14
  15 **/
  16
  17 #ifndef __SECURITY_PPI_H__
  18 #define __SECURITY_PPI_H__
  19
  20 #define EFI_PEI_SECURITY_PPI_GUID \
  21   { \
  22     0x1388066e, 0x3a57, 0x4efa, {0x98, 0xf3, 0xc1, 0x2f, 0x3a, 0x95, 0x8a, 0x29 } \
  23   }
  24
  25 typedef struct _EFI_PEI_SECURITY_PPI  EFI_PEI_SECURITY_PPI;
  26
  27 /**
  28   Allows the platform builder to implement a security policy in response
  29   to varying file authentication states.
  30
  31   @param  PeiServices             The pointer to the PEI Services Table.
  32   @param  This                    Interface pointer that implements the particular
  33                                   EFI_PEI_SECURITY_PPI instance.
  34   @param  AuthenticationStatus    Status returned by the verification service as
  35                                   part of section extraction.
  36   @param  FfsFileHeader           The pointer to the file under review.
  37   @param  DeferExecution          The pointer to a variable that alerts the PEI
  38                                   Foundation to defer execution of a PEIM.
  39
  40   @retval EFI_SUCCESS             The service performed its action successfully.
  41   @retval EFI_SECURITY_VIOLATION  The object cannot be trusted.
  42 **/
  43 typedef
  44 EFI_STATUS
  45 (EFIAPI *FRAMEWORK_EFI_PEI_SECURITY_AUTHENTICATION_STATE)(
  46   IN EFI_PEI_SERVICES             **PeiServices,
  47   IN EFI_PEI_SECURITY_PPI         *This,
  48   IN UINT32                       AuthenticationStatus,
  49   IN EFI_FFS_FILE_HEADER          *FfsFileHeader,
  50   IN OUT BOOLEAN                  *DeferExecution
  51   );
  52
  53 //
  54 // PPI interface structure of Security PPI
  55 //
  56 struct _EFI_PEI_SECURITY_PPI {
  57   FRAMEWORK_EFI_PEI_SECURITY_AUTHENTICATION_STATE  AuthenticationState;
  58 };
  59
  60 extern EFI_GUID gEfiPeiSecurityPpiGuid;
  61
  62 #endif