code clean up for Security.h.
[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / Security.h
1 /** @file
2 This file declares Security Architectural PPI.
3
4 This PPI is installed by some 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, Intel Corporation
9 All rights reserved. This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
13
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16
17 Module Name: Security.h
18
19 @par Revision Reference:
20 This PPI is defined in PEI CIS.
21 Version 0.91.
22
23 **/
24
25 #ifndef __SECURITY_PPI_H__
26 #define __SECURITY_PPI_H__
27
28 #include <PiPei.h>
29
30 #define EFI_PEI_SECURITY_PPI_GUID \
31 { \
32 0x1388066e, 0x3a57, 0x4efa, {0x98, 0xf3, 0xc1, 0x2f, 0x3a, 0x95, 0x8a, 0x29 } \
33 }
34
35 typedef struct _EFI_PEI_SECURITY_PPI EFI_PEI_SECURITY_PPI;
36
37 /**
38 Allows the platform builder to implement a security policy in response
39 to varying file authentication states.
40
41 @param PeiServices Pointer to the PEI Services Table.
42 @param This Interface pointer that implements the particular EFI_PEI_SECURITY_PPI instance.
43 @param AuthenticationStatus Status returned by the verification service as part of section extraction.
44 @param FfsFileHeader Pointer to the file under review.
45 @param DeferExecution Pointer to a variable that alerts the PEI Foundation to defer execution of a PEIM.
46
47 @retval EFI_SUCCESS The service performed its action successfully.
48 @retval EFI_SECURITY_VIOLATION The object cannot be trusted
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 *DeferExecution
58 );
59
60 //
61 // PPI interface structure of Security PPI
62 //
63 struct _EFI_PEI_SECURITY_PPI {
64 EFI_PEI_SECURITY_AUTHENTICATION_STATE AuthenticationState;
65 };
66
67 extern EFI_GUID gEfiPeiSecurityPpiGuid;
68
69 #endif