-/*++\r
-\r
-Copyright (c) 2006, 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
-Module Name:\r
-\r
- SecurityStub.c\r
-\r
-Abstract:\r
+/** @file\r
+ This driver supports platform security service.\r
\r
- This driver supports platform security service\r
+ Copyright (c) 2006 - 2007, 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
---*/\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
-//\r
-// Include common header file for this module.\r
-//\r
-#include "CommonHeader.h"\r
\r
#include "SecurityStub.h"\r
\r
SecurityStubAuthenticateState \r
};\r
\r
-//\r
-// Worker functions\r
-//\r
-EFI_STATUS\r
-EFIAPI\r
-SecurityStubAuthenticateState (\r
- IN EFI_SECURITY_ARCH_PROTOCOL *This,\r
- IN UINT32 AuthenticationStatus,\r
- IN EFI_DEVICE_PATH_PROTOCOL *File\r
- )\r
-/*++\r
-\r
-Routine Description:\r
\r
+/**\r
The EFI_SECURITY_ARCH_PROTOCOL (SAP) is used to abstract platform-specific \r
policy 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
might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is \r
returned.\r
\r
-Arguments:\r
-\r
- This - The EFI_SECURITY_ARCH_PROTOCOL instance.\r
-\r
- AuthenticationStatus - 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
-\r
- File - 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
-Returns:\r
-\r
- EFI_SUCCESS - The file specified by File did authenticate, and the \r
- platform policy dictates that the DXE Core may use File.\r
-\r
- EFI_INVALID_PARAMETER - File is NULL.\r
-\r
- 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
-\r
- 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
+ @param This The EFI_SECURITY_ARCH_PROTOCOL instance.\r
+ @param 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 File 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 did authenticate, and the\r
+ platform policy dictates that the DXE Core may use File.\r
+ @retval EFI_INVALID_PARAMETER Driver 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
+EFI_STATUS\r
+EFIAPI\r
+SecurityStubAuthenticateState (\r
+ IN EFI_SECURITY_ARCH_PROTOCOL *This,\r
+ IN UINT32 AuthenticationStatus,\r
+ IN EFI_DEVICE_PATH_PROTOCOL *File\r
+ )\r
{\r
if (File == NULL) {\r
return EFI_INVALID_PARAMETER;\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+ The user Entry Point for DXE driver. The user code starts with this function\r
+ as the real entry point for the image goes into a library that calls this \r
+ function.\r
+\r
+ @param[in] ImageHandle The firmware allocated handle for the EFI image. \r
+ @param[in] SystemTable A pointer to the EFI System Table.\r
+ \r
+ @retval EFI_SUCCESS The entry point is executed successfully.\r
+ @retval other Some error occurs when executing this entry point.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
SecurityStubInitialize (\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Initialize the state information for the Security Architectural Protocol\r
-\r
-Arguments:\r
-\r
- ImageHandle of the loaded driver\r
- Pointer to the System Table\r
-\r
-Returns:\r
-\r
- Status\r
-\r
- EFI_SUCCESS - successful installation of the service\r
- EFI_OUT_OF_RESOURCES - cannot allocate protocol data structure\r
- EFI_DEVICE_ERROR - cannot create the timer service\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
\r
projects / mirror_edk2.git / blobdiff