X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdeModulePkg%2FInclude%2FLibrary%2FSecurityManagementLib.h;h=c6ef8c38b9b797cfca44ed20c631604d2d6a000e;hp=de87d09c54c737f2a6f0a9e83a9719c3088aff7e;hb=9d510e61fceee7b92955ef9a3c20343752d8ce3f;hpb=bc2dfdbcfc11dc785f0cc0ad2f519a63b98f88bc
diff --git a/MdeModulePkg/Include/Library/SecurityManagementLib.h b/MdeModulePkg/Include/Library/SecurityManagementLib.h
index de87d09c54..c6ef8c38b9 100644
--- a/MdeModulePkg/Include/Library/SecurityManagementLib.h
+++ b/MdeModulePkg/Include/Library/SecurityManagementLib.h
@@ -1,16 +1,10 @@
/** @file
- This library class defines a set of interfaces to abstract the policy of
+ This library class defines a set of interfaces to abstract the policy of
security measurement by managing the different security measurement services.
The library instances can be implemented according to the different security policy.
-Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.
-This program and the accompanying materials are licensed and made available under
-the terms and conditions of the BSD License that accompanies this distribution.
-The full text of the license may be found at
-http://opensource.org/licenses/bsd-license.php.
-
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.
+SPDX-License-Identifier: BSD-2-Clause-Patent
**/
@@ -36,33 +30,33 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define EFI_AUTH_OPERATION_IMAGE_REQUIRED 0x80000000
/**
- The security handler is used to abstract platform-specific policy
- from the DXE core response to an attempt to use a file that returns a
- given status for the authentication check from the section extraction protocol.
+ The security handler is used to abstract platform-specific policy
+ from the DXE core response to an attempt to use a file that returns a
+ given status for the authentication check from the section extraction protocol.
- The possible responses in a given SAP implementation may include locking
- flash upon failure to authenticate, attestation logging for all signed drivers,
- and other exception operations. The File parameter allows for possible logging
+ The possible responses in a given SAP implementation may include locking
+ flash upon failure to authenticate, attestation logging for all signed drivers,
+ and other exception operations. The File parameter allows for possible logging
within the SAP of the driver.
-
+
If File is NULL, then EFI_INVALID_PARAMETER is returned.
- If the file specified by File with an authentication status specified by
+ If the file specified by File with an authentication status specified by
AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned.
- If the file specified by File with an authentication status specified by
- AuthenticationStatus is not safe for the DXE Core to use under any circumstances,
+ If the file specified by File with an authentication status specified by
+ AuthenticationStatus is not safe for the DXE Core to use under any circumstances,
then EFI_ACCESS_DENIED is returned.
- If the file specified by File with an authentication status specified by
- AuthenticationStatus is not safe for the DXE Core to use at the time, but it
- might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is
+ If the file specified by File with an authentication status specified by
+ AuthenticationStatus is not safe for the DXE Core to use at the time, but it
+ might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is
returned.
- FileBuffer will be NULL and FileSize will be 0 if the handler being called
+ FileBuffer will be NULL and FileSize will be 0 if the handler being called
did not set EFI_AUTH_OPERATION_IMAGE_REQUIRED when it was registered.
- @param[in] AuthenticationStatus
+ @param[in] AuthenticationStatus
The authentication status returned from the security
measurement services for the input file.
@param[in] File The pointer to the device path of the file that is
@@ -83,7 +77,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
used for any purpose.
**/
-typedef
+typedef
EFI_STATUS
(EFIAPI *SECURITY_FILE_AUTHENTICATION_STATE_HANDLER)(
IN OUT UINT32 AuthenticationStatus,
@@ -117,12 +111,12 @@ RegisterSecurityHandler (
Execute registered handlers until one returns an error and that error is returned.
If none of the handlers return an error, then EFI_SUCCESS is returned.
- Before exectue handler, get the image buffer by file device path if a handler
+ Before exectue handler, get the image buffer by file device path if a handler
requires the image file. And return the image buffer to each handler when exectue handler.
The handlers are executed in same order to their registered order.
- @param[in] AuthenticationStatus
+ @param[in] AuthenticationStatus
This is the authentication type returned from the Section
Extraction protocol. See the Section Extraction Protocol
Specification for details on this type.
@@ -130,9 +124,9 @@ RegisterSecurityHandler (
being dispatched. This will optionally be used for logging.
@retval EFI_SUCCESS The file specified by File authenticated when more
- than one security handler services were registered,
- or the file did not authenticate when no security
- handler service was registered. And the platform policy
+ than one security handler services were registered,
+ or the file did not authenticate when no security
+ handler service was registered. And the platform policy
dictates that the DXE Core may use File.
@retval EFI_INVALID_PARAMETER File is NULL.
@retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and
@@ -152,13 +146,13 @@ ExecuteSecurityHandlers (
);
/**
- The security handler is used to abstracts security-specific functions from the DXE
- Foundation of UEFI Image Verification, Trusted Computing Group (TCG) measured boot,
- User Identity policy for image loading and consoles, and for purposes of
- handling GUIDed section encapsulations.
-
- @param[in] AuthenticationStatus
- The authentication status for the input file.
+ The security handler is used to abstracts security-specific functions from the DXE
+ Foundation of UEFI Image Verification, Trusted Computing Group (TCG) measured boot,
+ User Identity policy for image loading and consoles, and for purposes of
+ handling GUIDed section encapsulations.
+
+ @param[in] AuthenticationStatus
+ The authentication status for the input file.
@param[in] File The pointer to the device path of the file that is
being dispatched. This will optionally be used for logging.
@param[in] FileBuffer A pointer to the buffer with the UEFI file image
@@ -188,7 +182,7 @@ ExecuteSecurityHandlers (
drivers from the device path specified by DevicePath. The
image has been added into the list of the deferred images.
**/
-typedef
+typedef
EFI_STATUS
(EFIAPI *SECURITY2_FILE_AUTHENTICATION_HANDLER) (
IN UINT32 AuthenticationStatus,
@@ -221,16 +215,16 @@ RegisterSecurity2Handler (
);
/**
- Execute registered handlers based on input AuthenticationOperation until
- one returns an error and that error is returned.
-
+ Execute registered handlers based on input AuthenticationOperation until
+ one returns an error and that error is returned.
+
If none of the handlers return an error, then EFI_SUCCESS is returned.
The handlers those satisfy AuthenticationOperation will only be executed.
The handlers are executed in same order to their registered order.
- @param[in] AuthenticationOperation
+ @param[in] AuthenticationOperation
The operation type specifies which handlers will be executed.
- @param[in] AuthenticationStatus
+ @param[in] AuthenticationStatus
The authentication status for the input file.
@param[in] File This is a pointer to the device path of the file that is
being dispatched. This will optionally be used for logging.
@@ -260,7 +254,7 @@ RegisterSecurity2Handler (
@retval EFI_SECURITY_VIOLATION FileBuffer is not NULL and the user has no permission to load
drivers from the device path specified by DevicePath. The
image has been added into the list of the deferred images.
- @retval EFI_INVALID_PARAMETER File and FileBuffer are both NULL.
+ @retval EFI_INVALID_PARAMETER File and FileBuffer are both NULL.
**/
EFI_STATUS
EFIAPI