]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
4ca9b6c4 | 2 | Security Architectural Protocol as defined in PI Specification VOLUME 2 DXE\r |
d1f95000 | 3 | \r |
4 | Used to provide Security services. Specifically, dependening upon the \r | |
5 | authentication state of a discovered driver in a Firmware Volume, the \r | |
6 | portable DXE Core Dispatcher will call into the Security Architectural \r | |
7 | Protocol (SAP) with the authentication state of the driver.\r | |
8 | \r | |
9 | This call-out allows for OEM-specific policy decisions to be made, such\r | |
10 | as event logging for attested boots, locking flash in response to discovering\r | |
11 | an unsigned driver or failed signature check, or other exception response.\r | |
12 | \r | |
13 | The SAP can also change system behavior by having the DXE core put a driver\r | |
14 | in the Schedule-On-Request (SOR) state. This will allow for later disposition \r | |
15 | of the driver by platform agent, such as Platform BDS.\r | |
16 | \r | |
4ca9b6c4 | 17 | Copyright (c) 2006 - 2008, Intel Corporation \r |
d1f95000 | 18 | All rights reserved. This program and the accompanying materials \r |
19 | are licensed and made available under the terms and conditions of the BSD License \r | |
20 | which accompanies this distribution. The full text of the license may be found at \r | |
21 | http://opensource.org/licenses/bsd-license.php \r | |
22 | \r | |
23 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
24 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
25 | \r | |
d1f95000 | 26 | **/\r |
27 | \r | |
28 | #ifndef __ARCH_PROTOCOL_SECURITY_H__\r | |
29 | #define __ARCH_PROTOCOL_SECURITY_H__\r | |
30 | \r | |
99e8ed21 | 31 | ///\r |
32 | /// Global ID for the Security Code Architectural Protocol\r | |
33 | ///\r | |
d1f95000 | 34 | #define EFI_SECURITY_ARCH_PROTOCOL_GUID \\r |
35 | { 0xA46423E3, 0x4617, 0x49f1, {0xB9, 0xFF, 0xD1, 0xBF, 0xA9, 0x11, 0x58, 0x39 } }\r | |
36 | \r | |
37 | typedef struct _EFI_SECURITY_ARCH_PROTOCOL EFI_SECURITY_ARCH_PROTOCOL;\r | |
38 | \r | |
39 | /**\r | |
40 | The EFI_SECURITY_ARCH_PROTOCOL (SAP) is used to abstract platform-specific \r | |
41 | policy from the DXE core response to an attempt to use a file that returns a \r | |
42 | given status for the authentication check from the section extraction protocol. \r | |
43 | \r | |
44 | The possible responses in a given SAP implementation may include locking \r | |
45 | flash upon failure to authenticate, attestation logging for all signed drivers, \r | |
46 | and other exception operations. The File parameter allows for possible logging \r | |
47 | within the SAP of the driver.\r | |
48 | \r | |
49 | If File is NULL, then EFI_INVALID_PARAMETER is returned.\r | |
50 | \r | |
51 | If the file specified by File with an authentication status specified by \r | |
52 | AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned.\r | |
53 | \r | |
54 | If the file specified by File with an authentication status specified by \r | |
55 | AuthenticationStatus is not safe for the DXE Core to use under any circumstances, \r | |
56 | then EFI_ACCESS_DENIED is returned.\r | |
57 | \r | |
58 | If the file specified by File with an authentication status specified by \r | |
59 | AuthenticationStatus is not safe for the DXE Core to use right now, but it \r | |
60 | might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is \r | |
61 | returned.\r | |
62 | \r | |
63 | @param This The EFI_SECURITY_ARCH_PROTOCOL instance.\r | |
64 | @param AuthenticationStatus \r | |
65 | This is the authentication type returned from the Section\r | |
66 | Extraction protocol. See the Section Extraction Protocol\r | |
67 | Specification for details on this type.\r | |
68 | @param File This is a pointer to the device path of the file that is\r | |
69 | being dispatched. This will optionally be used for logging.\r | |
70 | \r | |
71 | @retval EFI_SUCCESS The file specified by File did authenticate, and the\r | |
72 | platform policy dictates that the DXE Core may use File.\r | |
73 | @retval EFI_INVALID_PARAMETER Driver is NULL.\r | |
74 | @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and\r | |
75 | the platform policy dictates that File should be placed\r | |
76 | in the untrusted state. A file may be promoted from\r | |
77 | the untrusted to the trusted state at a future time\r | |
78 | with a call to the Trust() DXE Service.\r | |
79 | @retval EFI_ACCESS_DENIED The file specified by File did not authenticate, and\r | |
80 | the platform policy dictates that File should not be\r | |
81 | used for any purpose.\r | |
82 | \r | |
83 | **/\r | |
84 | typedef \r | |
85 | EFI_STATUS\r | |
8b13229b | 86 | (EFIAPI *EFI_SECURITY_FILE_AUTHENTICATION_STATE)(\r |
f1004231 LG |
87 | IN CONST EFI_SECURITY_ARCH_PROTOCOL *This,\r |
88 | IN UINT32 AuthenticationStatus,\r | |
89 | IN CONST EFI_DEVICE_PATH_PROTOCOL *File\r | |
ed66e1bc | 90 | );\r |
d1f95000 | 91 | \r |
44717a39 | 92 | ///\r |
93 | /// The EFI_SECURITY_ARCH_PROTOCOL is used to abstract platform-specific policy\r | |
94 | /// from the DXE core. This includes locking flash upon failure to authenticate, \r | |
95 | /// attestation logging, and other exception operations.\r | |
96 | ///\r | |
d1f95000 | 97 | struct _EFI_SECURITY_ARCH_PROTOCOL {\r |
98 | EFI_SECURITY_FILE_AUTHENTICATION_STATE FileAuthenticationState;\r | |
99 | };\r | |
100 | \r | |
101 | extern EFI_GUID gEfiSecurityArchProtocolGuid;\r | |
102 | \r | |
103 | #endif\r |