]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
4ca9b6c4 | 2 | Security Architectural Protocol as defined in PI Specification VOLUME 2 DXE\r |
d1f95000 | 3 | \r |
9095d37b LG |
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 | |
d1f95000 | 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 | |
9095d37b | 14 | in the Schedule-On-Request (SOR) state. This will allow for later disposition\r |
d1f95000 | 15 | of the driver by platform agent, such as Platform BDS.\r |
16 | \r | |
9095d37b | 17 | Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r |
9344f092 | 18 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
d1f95000 | 19 | \r |
d1f95000 | 20 | **/\r |
21 | \r | |
22 | #ifndef __ARCH_PROTOCOL_SECURITY_H__\r | |
23 | #define __ARCH_PROTOCOL_SECURITY_H__\r | |
24 | \r | |
99e8ed21 | 25 | ///\r |
26 | /// Global ID for the Security Code Architectural Protocol\r | |
27 | ///\r | |
d1f95000 | 28 | #define EFI_SECURITY_ARCH_PROTOCOL_GUID \\r |
29 | { 0xA46423E3, 0x4617, 0x49f1, {0xB9, 0xFF, 0xD1, 0xBF, 0xA9, 0x11, 0x58, 0x39 } }\r | |
30 | \r | |
2f88bd3a | 31 | typedef struct _EFI_SECURITY_ARCH_PROTOCOL EFI_SECURITY_ARCH_PROTOCOL;\r |
d1f95000 | 32 | \r |
33 | /**\r | |
9095d37b LG |
34 | The EFI_SECURITY_ARCH_PROTOCOL (SAP) is used to abstract platform-specific\r |
35 | policy from the DXE core response to an attempt to use a file that returns a\r | |
36 | given status for the authentication check from the section extraction protocol.\r | |
d1f95000 | 37 | \r |
9095d37b LG |
38 | The possible responses in a given SAP implementation may include locking\r |
39 | flash upon failure to authenticate, attestation logging for all signed drivers,\r | |
40 | and other exception operations. The File parameter allows for possible logging\r | |
d1f95000 | 41 | within the SAP of the driver.\r |
42 | \r | |
43 | If File is NULL, then EFI_INVALID_PARAMETER is returned.\r | |
44 | \r | |
9095d37b | 45 | If the file specified by File with an authentication status specified by\r |
d1f95000 | 46 | AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned.\r |
47 | \r | |
9095d37b LG |
48 | If the file specified by File with an authentication status specified by\r |
49 | AuthenticationStatus is not safe for the DXE Core to use under any circumstances,\r | |
d1f95000 | 50 | then EFI_ACCESS_DENIED is returned.\r |
51 | \r | |
9095d37b LG |
52 | If the file specified by File with an authentication status specified by\r |
53 | AuthenticationStatus is not safe for the DXE Core to use right now, but it\r | |
54 | might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is\r | |
d1f95000 | 55 | returned.\r |
56 | \r | |
57 | @param This The EFI_SECURITY_ARCH_PROTOCOL instance.\r | |
9095d37b | 58 | @param AuthenticationStatus\r |
d1f95000 | 59 | This is the authentication type returned from the Section\r |
60 | Extraction protocol. See the Section Extraction Protocol\r | |
61 | Specification for details on this type.\r | |
62 | @param File This is a pointer to the device path of the file that is\r | |
63 | being dispatched. This will optionally be used for logging.\r | |
64 | \r | |
65 | @retval EFI_SUCCESS The file specified by File did authenticate, and the\r | |
66 | platform policy dictates that the DXE Core may use File.\r | |
67 | @retval EFI_INVALID_PARAMETER Driver is NULL.\r | |
68 | @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and\r | |
69 | the platform policy dictates that File should be placed\r | |
70 | in the untrusted state. A file may be promoted from\r | |
71 | the untrusted to the trusted state at a future time\r | |
72 | with a call to the Trust() DXE Service.\r | |
73 | @retval EFI_ACCESS_DENIED The file specified by File did not authenticate, and\r | |
74 | the platform policy dictates that File should not be\r | |
75 | used for any purpose.\r | |
76 | \r | |
77 | **/\r | |
9095d37b | 78 | typedef\r |
d1f95000 | 79 | EFI_STATUS\r |
8b13229b | 80 | (EFIAPI *EFI_SECURITY_FILE_AUTHENTICATION_STATE)(\r |
f1004231 LG |
81 | IN CONST EFI_SECURITY_ARCH_PROTOCOL *This,\r |
82 | IN UINT32 AuthenticationStatus,\r | |
83 | IN CONST EFI_DEVICE_PATH_PROTOCOL *File\r | |
ed66e1bc | 84 | );\r |
d1f95000 | 85 | \r |
44717a39 | 86 | ///\r |
87 | /// The EFI_SECURITY_ARCH_PROTOCOL is used to abstract platform-specific policy\r | |
9095d37b | 88 | /// from the DXE core. This includes locking flash upon failure to authenticate,\r |
44717a39 | 89 | /// attestation logging, and other exception operations.\r |
90 | ///\r | |
d1f95000 | 91 | struct _EFI_SECURITY_ARCH_PROTOCOL {\r |
2f88bd3a | 92 | EFI_SECURITY_FILE_AUTHENTICATION_STATE FileAuthenticationState;\r |
d1f95000 | 93 | };\r |
94 | \r | |
2f88bd3a | 95 | extern EFI_GUID gEfiSecurityArchProtocolGuid;\r |
d1f95000 | 96 | \r |
97 | #endif\r |