Patch from open source community for CryptoPkg to allow it to build for ARM using...

[mirror_edk2.git] / MdeModulePkg / Include / Library / SecurityManagementLib.h

/** @file\r
  This library class defines a set of interfaces to abstract the policy of \r
  security measurement by managing the different security measurement services.\r
  The library instances can be implemented according to the different security policy.\r
\r
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials are licensed and made available under \r
the terms and conditions of the BSD License that accompanies this distribution.  \r
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
**/\r
\r
#ifndef __SECURITY_MANAGEMENT_LIB_H__\r
#define __SECURITY_MANAGEMENT_LIB_H__\r
\r
#define EFI_AUTH_OPERATION_NONE                0x00\r
#define EFI_AUTH_OPERATION_VERIFY_IMAGE        0x01\r
#define EFI_AUTH_OPERATION_DEFER_IMAGE_LOAD    0x02\r
#define EFI_AUTH_OPERATION_MEASURE_IMAGE       0x04\r
\r
///\r
/// Image buffer is required by the security handler.\r
///\r
#define EFI_AUTH_OPERATION_IMAGE_REQUIRED      0x80000000\r
\r
/**\r
  The security handler is used to abstract platform-specific policy \r
  from the DXE core response to an attempt to use a file that returns a \r
  given status for the authentication check from the section extraction protocol.  \r
\r
  The possible responses in a given SAP implementation may include locking \r
  flash upon failure to authenticate, attestation logging for all signed drivers, \r
  and other exception operations.  The File parameter allows for possible logging \r
  within the SAP of the driver.\r
  \r
  If File is NULL, then EFI_INVALID_PARAMETER is returned.\r
\r
  If the file specified by File with an authentication status specified by \r
  AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned.\r
\r
  If the file specified by File with an authentication status specified by \r
  AuthenticationStatus is not safe for the DXE Core to use under any circumstances, \r
  then EFI_ACCESS_DENIED is returned.\r
\r
  If the file specified by File with an authentication status specified by \r
  AuthenticationStatus is not safe for the DXE Core to use at the time, but it \r
  might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is \r
  returned.\r
\r
  FileBuffer will be NULL and FileSize will be 0 if the handler being called \r
  did not set EFI_AUTH_OPERATION_IMAGE_REQUIRED when it was registered.\r
\r
  @param[in]    AuthenticationStatus \r
                           The authentication status returned from the security\r
                           measurement services for the input file.\r
  @param[in]    File       The pointer to the device path of the file that is\r
                           being dispatched. This will optionally be used for logging.\r
  @param[in]    FileBuffer The file buffer matches the input file device path.\r
  @param[in]    FileSize   The size of File buffer matches the input file device path.\r
\r
  @retval EFI_SUCCESS            The file specified by File did authenticate, and the\r
                                 platform policy dictates that the DXE Core may use File.\r
  @retval EFI_INVALID_PARAMETER  The file is NULL.\r
  @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and\r
                                 the platform policy dictates that File should be placed\r
                                 in the untrusted state. A file may be promoted from\r
                                 the untrusted to the trusted state at a future time\r
                                 with a call to the Trust() DXE Service.\r
  @retval EFI_ACCESS_DENIED      The file specified by File did not authenticate, and\r
                                 the platform policy dictates that File should not be\r
                                 used for any purpose.\r
\r
**/\r
typedef \r
EFI_STATUS\r
(EFIAPI *SECURITY_FILE_AUTHENTICATION_STATE_HANDLER)(\r
  IN  OUT   UINT32                     AuthenticationStatus,\r
  IN  CONST EFI_DEVICE_PATH_PROTOCOL   *File,\r
  IN  VOID                             *FileBuffer,\r
  IN  UINTN                            FileSize\r
  );\r
\r
/**\r
  Register security measurement handler with its operation type. Different\r
  handlers with the same operation can all be registered.\r
\r
  If SecurityHandler is NULL, then ASSERT().\r
  If no enough resources available to register new handler, then ASSERT().\r
  If AuthenticationOperation is not recongnized, then ASSERT().\r
  If the previous register handler can't be executed before the later register handler, then ASSERT().\r
\r
  @param[in]  SecurityHandler           The security measurement service handler to be registered.\r
  @param[in]  AuthenticationOperation   Theoperation type is specified for the registered handler.\r
\r
  @retval EFI_SUCCESS              The handlers were registered successfully.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RegisterSecurityHandler (\r
  IN  SECURITY_FILE_AUTHENTICATION_STATE_HANDLER  SecurityHandler,\r
  IN  UINT32                                      AuthenticationOperation\r
  );\r
\r
/**\r
  Execute registered handlers until one returns an error and that error is returned.\r
  If none of the handlers return an error, then EFI_SUCCESS is returned.\r
\r
  Before exectue handler, get the image buffer by file device path if a handler \r
  requires the image file. And return the image buffer to each handler when exectue handler.\r
\r
  The handlers are executed in same order to their registered order.\r
\r
  @param[in]  AuthenticationStatus \r
                           This is the authentication type returned from the Section\r
                           Extraction protocol. See the Section Extraction Protocol\r
                           Specification for details on this type.\r
  @param[in]  FilePath     This is a pointer to the device path of the file that is\r
                           being dispatched. This will optionally be used for logging.\r
\r
  @retval EFI_SUCCESS            The file specified by File authenticated when more\r
                                 than one security handler services were registered, \r
                                 or the file did not authenticate when no security \r
                                 handler service was registered. And the platform policy \r
                                 dictates that the DXE Core may use File.\r
  @retval EFI_INVALID_PARAMETER  File is NULL.\r
  @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and\r
                                 the platform policy dictates that File should be placed\r
                                 in the untrusted state. A file may be promoted from\r
                                 the untrusted to the trusted state at a future time\r
                                 with a call to the Trust() DXE Service.\r
  @retval EFI_ACCESS_DENIED      The file specified by File did not authenticate, and\r
                                 the platform policy dictates that File should not be\r
                                 used for any purpose.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ExecuteSecurityHandlers (\r
  IN  UINT32                            AuthenticationStatus,\r
  IN  CONST EFI_DEVICE_PATH_PROTOCOL    *FilePath\r
  );\r
\r
#endif\r