Remove IntelFrameworkModulePkg

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / Security.h

/** @file\r
  This file declares the Security Architectural PPI.\r
\r
  This PPI is installed by a platform PEIM that abstracts the security policy to the PEI\r
  Foundation, namely the case of a PEIM's authentication state being returned during the PEI section\r
  extraction process.\r
\r
Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Revision Reference:\r
  This PPI is defined in PEI CIS.\r
  Version 0.91.\r
\r
**/\r
\r
#ifndef __SECURITY_PPI_H__\r
#define __SECURITY_PPI_H__\r
\r
#define EFI_PEI_SECURITY_PPI_GUID \\r
  { \\r
    0x1388066e, 0x3a57, 0x4efa, {0x98, 0xf3, 0xc1, 0x2f, 0x3a, 0x95, 0x8a, 0x29 } \\r
  }\r
\r
typedef struct _EFI_PEI_SECURITY_PPI  EFI_PEI_SECURITY_PPI;\r
\r
/**\r
  Allows the platform builder to implement a security policy in response\r
  to varying file authentication states.\r
\r
  @param  PeiServices             The pointer to the PEI Services Table.\r
  @param  This                    Interface pointer that implements the particular\r
                                  EFI_PEI_SECURITY_PPI instance.\r
  @param  AuthenticationStatus    Status returned by the verification service as\r
                                  part of section extraction.\r
  @param  FfsFileHeader           The pointer to the file under review.\r
  @param  DeferExecution          The pointer to a variable that alerts the PEI\r
                                  Foundation to defer execution of a PEIM.\r
\r
  @retval EFI_SUCCESS             The service performed its action successfully.\r
  @retval EFI_SECURITY_VIOLATION  The object cannot be trusted.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *FRAMEWORK_EFI_PEI_SECURITY_AUTHENTICATION_STATE)(\r
  IN EFI_PEI_SERVICES             **PeiServices,\r
  IN EFI_PEI_SECURITY_PPI         *This,\r
  IN UINT32                       AuthenticationStatus,\r
  IN EFI_FFS_FILE_HEADER          *FfsFileHeader,\r
  IN OUT BOOLEAN                  *DeferExecution\r
  );\r
\r
//\r
// PPI interface structure of Security PPI\r
//\r
struct _EFI_PEI_SECURITY_PPI {\r
  FRAMEWORK_EFI_PEI_SECURITY_AUTHENTICATION_STATE  AuthenticationState;\r
};\r
\r
extern EFI_GUID gEfiPeiSecurityPpiGuid;\r
\r
#endif\r