2 This file declares Security Architectural PPI.
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
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.
13 Module Name: Security.h
15 @par Revision Reference:
16 This PPI is defined in PEI CIS.
21 #ifndef __SECURITY_PPI_H__
22 #define __SECURITY_PPI_H__
24 #define EFI_PEI_SECURITY_PPI_GUID \
26 0x1388066e, 0x3a57, 0x4efa, {0x98, 0xf3, 0xc1, 0x2f, 0x3a, 0x95, 0x8a, 0x29 } \
29 typedef struct _EFI_PEI_SECURITY_PPI EFI_PEI_SECURITY_PPI
;
32 Allows the platform builder to implement a security policy in response
33 to varying file authentication states.
35 @param PeiServices Pointer to the PEI Services Table.
37 @param This Interface pointer that implements the particular EFI_PEI_SECURITY_PPI instance.
39 @param AuthenticationStatus Status returned by the verification service as part of section extraction.
41 @param FfsFileHeader Pointer to the file under review.
43 @param DeferExecution Pointer to a variable that alerts the PEI Foundation to defer execution of a PEIM.
45 @retval EFI_SUCCESS The service performed its action successfully.
47 @retval EFI_SECURITY_VIOLATION The object cannot be trusted
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
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.
66 @param AuthenticationState
67 Allows the platform builder to implement a security policy in response
68 to varying file authentication states.
71 struct _EFI_PEI_SECURITY_PPI
{
72 EFI_PEI_SECURITY_AUTHENTICATION_STATE AuthenticationState
;
75 extern EFI_GUID gEfiPeiSecurityPpiGuid
;