Formalize comments for Protocols and PPIs.

[mirror_edk2.git] / MdePkg / Include / Ppi / Security2.h

/** @file\r
  This file declares Pei Security2 PPI.\r
\r
  This PPI is installed by some platform PEIM that abstracts the security \r
  policy to the PEI Foundation, namely the case of a PEIM's authentication \r
  state being returned during the PEI section extraction process.\r
\r
  Copyright (c) 2006 - 2008, Intel Corporation\r
  All rights reserved. This program and the accompanying materials                          \r
  are licensed and made available under the terms and conditions of the BSD License         \r
  which accompanies this distribution.  The full text of the license may be found at        \r
  http://opensource.org/licenses/bsd-license.php                                            \r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
  @par Revision Reference:\r
  This PPI is defined in PI.\r
  Version 1.0.\r
\r
**/\r
\r
#ifndef __SECURITY2_PPI_H__\r
#define __SECURITY2_PPI_H__\r
\r
#define EFI_PEI_SECURITY2_PPI_GUID \\r
  { 0xdcd0be23, 0x9586, 0x40f4, { 0xb6, 0x43, 0x6, 0x52, 0x2c, 0xed, 0x4e, 0xde } }\r
\r
\r
typedef struct _EFI_PEI_SECURITY2_PPI  EFI_PEI_SECURITY2_PPI;\r
\r
/**\r
  Allows the platform builder to implement a security policy \r
  in response to varying file authentication states.\r
\r
  This service is published by some platform PEIM. The purpose of\r
  this service is to expose a given platform's policy-based\r
  response to the PEI Foundation. For example, if there is a PEIM\r
  in a GUIDed encapsulation section and the extraction of the PEI\r
  file section yields an authentication failure, there is no a\r
  priori policy in the PEI Foundation. Specifically, this\r
  situation leads to the question whether PEIMs that are either\r
  not in GUIDed sections or are in sections whose authentication\r
  fails should still be executed.\r
\r
  @param PeiServices             An indirect pointer to the PEI Services\r
                                 Table published by the PEI Foundation.\r
  @param This                    Interface pointer that implements the\r
                                 particular EFI_PEI_SECURITY2_PPI instance.\r
  @param AuthenticationStatus    Authentication status of the file.\r
  @param FvHandle                Handle of the volume in which the file\r
                                 resides. This allows different policies\r
                                 depending on different firmware volumes.\r
  @param FileHandle              Handle of the file under review.\r
  @param DeferExecution          Pointer to a variable that alerts the\r
                                 PEI Foundation to defer execution of a\r
                                 PEIM.\r
\r
  @retval EFI_SUCCESS            The service performed its action successfully.\r
  @retval EFI_SECURITY_VIOLATION The object cannot be trusted.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *EFI_PEI_SECURITY_AUTHENTICATION_STATE)(\r
  IN CONST  EFI_PEI_SERVICES      **PeiServices,\r
  IN CONST  EFI_PEI_SECURITY2_PPI *This,\r
  IN UINT32                       AuthenticationStatus,\r
  IN EFI_PEI_FV_HANDLE            FvHandle,\r
  IN EFI_PEI_FV_HANDLE            FileHandle,\r
  IN OUT    BOOLEAN               *DeferExecution\r
);\r
\r
///\r
/// This PPI is a means by which the platform builder can indicate\r
/// a response to a PEIM's authentication state. This can be in\r
/// the form of a requirement for the PEI Foundation to skip a\r
/// module using the DeferExecution Boolean output in the\r
/// AuthenticationState() member function. Alternately, the\r
/// Security PPI can invoke something like a cryptographic PPI\r
/// that hashes the PEIM contents to log attestations, for which\r
/// the FileHandle parameter in AuthenticationState() will be\r
/// useful. If this PPI does not exist, PEIMs will be considered\r
/// trusted.\r
///\r
struct _EFI_PEI_SECURITY2_PPI {\r
  EFI_PEI_SECURITY_AUTHENTICATION_STATE   AuthenticationState;\r
};\r
\r
\r
extern EFI_GUID gEfiPeiSecurity2PpiGuid;\r
\r
#endif\r