]>
Commit | Line | Data |
---|---|---|
d1f95000 | 1 | /** @file\r |
2 | Security Architectural Protocol as defined in the DXE CIS\r | |
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 | |
17 | Copyright (c) 2006, Intel Corporation \r | |
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 | @par Revision Reference:\r |
27 | Version 0.91B.\r | |
28 | \r | |
29 | **/\r | |
30 | \r | |
31 | #ifndef __ARCH_PROTOCOL_SECURITY_H__\r | |
32 | #define __ARCH_PROTOCOL_SECURITY_H__\r | |
33 | \r | |
34 | //\r | |
35 | // Global ID for the Security Code Architectural Protocol\r | |
36 | //\r | |
37 | #define EFI_SECURITY_ARCH_PROTOCOL_GUID \\r | |
38 | { 0xA46423E3, 0x4617, 0x49f1, {0xB9, 0xFF, 0xD1, 0xBF, 0xA9, 0x11, 0x58, 0x39 } }\r | |
39 | \r | |
40 | typedef struct _EFI_SECURITY_ARCH_PROTOCOL EFI_SECURITY_ARCH_PROTOCOL;\r | |
41 | \r | |
42 | /**\r | |
43 | The EFI_SECURITY_ARCH_PROTOCOL (SAP) is used to abstract platform-specific \r | |
44 | policy from the DXE core response to an attempt to use a file that returns a \r | |
45 | given status for the authentication check from the section extraction protocol. \r | |
46 | \r | |
47 | The possible responses in a given SAP implementation may include locking \r | |
48 | flash upon failure to authenticate, attestation logging for all signed drivers, \r | |
49 | and other exception operations. The File parameter allows for possible logging \r | |
50 | within the SAP of the driver.\r | |
51 | \r | |
52 | If File is NULL, then EFI_INVALID_PARAMETER is returned.\r | |
53 | \r | |
54 | If the file specified by File with an authentication status specified by \r | |
55 | AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned.\r | |
56 | \r | |
57 | If the file specified by File with an authentication status specified by \r | |
58 | AuthenticationStatus is not safe for the DXE Core to use under any circumstances, \r | |
59 | then EFI_ACCESS_DENIED is returned.\r | |
60 | \r | |
61 | If the file specified by File with an authentication status specified by \r | |
62 | AuthenticationStatus is not safe for the DXE Core to use right now, but it \r | |
63 | might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is \r | |
64 | returned.\r | |
65 | \r | |
66 | @param This The EFI_SECURITY_ARCH_PROTOCOL instance.\r | |
67 | @param AuthenticationStatus \r | |
68 | This is the authentication type returned from the Section\r | |
69 | Extraction protocol. See the Section Extraction Protocol\r | |
70 | Specification for details on this type.\r | |
71 | @param File This is a pointer to the device path of the file that is\r | |
72 | being dispatched. This will optionally be used for logging.\r | |
73 | \r | |
74 | @retval EFI_SUCCESS The file specified by File did authenticate, and the\r | |
75 | platform policy dictates that the DXE Core may use File.\r | |
76 | @retval EFI_INVALID_PARAMETER Driver is NULL.\r | |
77 | @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and\r | |
78 | the platform policy dictates that File should be placed\r | |
79 | in the untrusted state. A file may be promoted from\r | |
80 | the untrusted to the trusted state at a future time\r | |
81 | with a call to the Trust() DXE Service.\r | |
82 | @retval EFI_ACCESS_DENIED The file specified by File did not authenticate, and\r | |
83 | the platform policy dictates that File should not be\r | |
84 | used for any purpose.\r | |
85 | \r | |
86 | **/\r | |
87 | typedef \r | |
88 | EFI_STATUS\r | |
89 | (EFIAPI *EFI_SECURITY_FILE_AUTHENTICATION_STATE) (\r | |
90 | IN EFI_SECURITY_ARCH_PROTOCOL *This,\r | |
91 | IN UINT32 AuthenticationStatus,\r | |
92 | IN EFI_DEVICE_PATH_PROTOCOL *File\r | |
93 | )\r | |
94 | ;\r | |
95 | \r | |
96 | //\r | |
97 | // Interface stucture for the Timer Architectural Protocol\r | |
98 | //\r | |
99 | /**\r | |
100 | @par Protocol Description:\r | |
101 | \r | |
102 | The EFI_SECURITY_ARCH_PROTOCOL is used to abstract platform-specific policy\r | |
103 | from the DXE core. This includes locking flash upon failure to authenticate, \r | |
104 | attestation logging, and other exception operations.\r | |
105 | \r | |
106 | The driver that produces the EFI_SECURITY_ARCH_PROTOCOL may also optionally \r | |
107 | install the EFI_SECURITY_POLICY_PROTOCOL_GUID onto a new handle with a NULL \r | |
108 | interface. The existence of this GUID in the protocol database means that \r | |
109 | the GUIDed Section Extraction Protocol should authenticate the contents of \r | |
110 | an Authentication Section. The expectation is that the GUIDed Section \r | |
111 | Extraction protocol will look for the existence of the EFI_SECURITY_POLICY_ \r | |
112 | PROTOCOL_GUID in the protocol database. If it exists, then the publication \r | |
113 | thereof is taken as an injunction to attempt an authentication of any section \r | |
114 | wrapped in an Authentication Section. See the Firmware File System \r | |
115 | Specification for details on the GUIDed Section Extraction Protocol and \r | |
116 | Authentication Sections.\r | |
117 | \r | |
118 | @par Protocol Parameters:\r | |
119 | \r | |
120 | FileAuthenticationState - This service is called upon fault with respect to \r | |
121 | the authentication of a section of a file.\r | |
122 | \r | |
123 | **/\r | |
124 | struct _EFI_SECURITY_ARCH_PROTOCOL {\r | |
125 | EFI_SECURITY_FILE_AUTHENTICATION_STATE FileAuthenticationState;\r | |
126 | };\r | |
127 | \r | |
128 | extern EFI_GUID gEfiSecurityArchProtocolGuid;\r | |
129 | \r | |
130 | #endif\r |