MdePkg/Include/Ppi/Security.h

   1 /** @file
   2   This file declares Security Architectural PPI.
   3
   4   Copyright (c) 2006, Intel Corporation
   5   All rights reserved. This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13   Module Name:  Security.h
  14
  15   @par Revision Reference:
  16   This PPI is defined in PEI CIS.
  17   Version 0.91.
  18
  19 **/
  20
  21 #ifndef __SECURITY_PPI_H__
  22 #define __SECURITY_PPI_H__
  23
  24 #define EFI_PEI_SECURITY_PPI_GUID \
  25   { \
  26     0x1388066e, 0x3a57, 0x4efa, {0x98, 0xf3, 0xc1, 0x2f, 0x3a, 0x95, 0x8a, 0x29 } \
  27   }
  28
  29 typedef struct _EFI_PEI_SECURITY_PPI  EFI_PEI_SECURITY_PPI;
  30
  31 /**
  32   Allows the platform builder to implement a security policy in response
  33   to varying file authentication states.
  34
  35   @param  PeiServices Pointer to the PEI Services Table.
  36
  37   @param  This Interface pointer that implements the particular EFI_PEI_SECURITY_PPI instance.
  38
  39   @param  AuthenticationStatus Status returned by the verification service as part of section extraction.
  40
  41   @param  FfsFileHeader Pointer to the file under review.
  42
  43   @param  DeferExecution Pointer to a variable that alerts the PEI Foundation to defer execution of a PEIM.
  44
  45   @retval EFI_SUCCESS The service performed its action successfully.
  46
  47   @retval EFI_SECURITY_VIOLATION The object cannot be trusted
  48
  49 **/
  50 typedef
  51 EFI_STATUS
  52 (EFIAPI *EFI_PEI_SECURITY_AUTHENTICATION_STATE) (
  53   IN EFI_PEI_SERVICES             **PeiServices,
  54   IN EFI_PEI_SECURITY_PPI         *This,
  55   IN UINT32                       AuthenticationStatus,
  56   IN EFI_FFS_FILE_HEADER          *FfsFileHeader,
  57   IN OUT BOOLEAN                  *StartCrisisRecovery
  58   );
  59
  60 /**
  61   @par Ppi Description:
  62   This PPI is installed by some platform PEIM that abstracts the security
  63   policy to the PEI Foundation, namely the case of a PEIM¡¯s authentication
  64   state being returned during the PEI section extraction process.
  65
  66   @param AuthenticationState
  67   Allows the platform builder to implement a security policy in response
  68   to varying file authentication states.
  69
  70 **/
  71 struct _EFI_PEI_SECURITY_PPI {
  72   EFI_PEI_SECURITY_AUTHENTICATION_STATE  AuthenticationState;
  73 };
  74
  75 extern EFI_GUID gEfiPeiSecurityPpiGuid;
  76
  77 #endif