Contributed-under: TianoCore Contribution Agreement 1.0
[mirror_edk2.git] / SecurityPkg / SecurityPkg.dec
1 ## @file SecurityPkg.dec
2 # This package includes the security drivers, defintions(including PPIs/PROTOCOLs/GUIDs
3 # and library classes) and libraries instances.
4 #
5 # Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>
6 # This program and the accompanying materials are licensed and made available under
7 # the terms and conditions of the BSD License which accompanies this distribution.
8 # The full text of the license may be found at
9 # http://opensource.org/licenses/bsd-license.php
10 #
11 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 #
14 ##
15
16 [Defines]
17 DEC_SPECIFICATION = 0x00010005
18 PACKAGE_NAME = SecurityPkg
19 PACKAGE_GUID = 24369CAC-6AA6-4fb8-88DB-90BF061668AD
20 PACKAGE_VERSION = 0.93
21
22 [Includes]
23 Include
24
25 [LibraryClasses]
26 ## @libraryclass Provides hash interfaces from different implementations.
27 #
28 HashLib|Include/Library/HashLib.h
29
30 ## @libraryclass Provides a platform specific interface to detect physically present user.
31 #
32 PlatformSecureLib|Include/Library/PlatformSecureLib.h
33
34 ## @libraryclass Provides interfaces to handle TPM 1.2 request.
35 #
36 TcgPhysicalPresenceLib|Include/Library/TcgPhysicalPresenceLib.h
37
38 ## @libraryclass Provides interfaces for other modules to send TPM 2.0 command.
39 #
40 Tpm2CommandLib|Include/Library/Tpm2CommandLib.h
41
42 ## @libraryclass Provides interfaces on how to access TPM 2.0 hardware device.
43 #
44 Tpm2DeviceLib|Include/Library/Tpm2DeviceLib.h
45
46 ## @libraryclass Provides interfaces for other modules to send TPM 1.2 command.
47 #
48 Tpm12CommandLib|Include/Library/Tpm12CommandLib.h
49
50 ## @libraryclass Provides interfaces on how to access TPM 1.2 hardware device.
51 #
52 Tpm12DeviceLib|Include/Library/Tpm12DeviceLib.h
53
54 ## @libraryclass Provides TPM Interface Specification (TIS) interfaces for TPM command.
55 #
56 TpmCommLib|Include/Library/TpmCommLib.h
57
58 ## @libraryclass Provides common interfaces about TPM measurement for other modules.
59 #
60 TpmMeasurementLib|Include/Library/TpmMeasurementLib.h
61
62 ## @libraryclass Provides interfaces to handle TPM 2.0 request.
63 #
64 TrEEPhysicalPresenceLib|Include/Library/TrEEPhysicalPresenceLib.h
65
66 [Guids]
67 ## Security package token space guid
68 # Include/Guid/SecurityPkgTokenSpace.h
69 gEfiSecurityPkgTokenSpaceGuid = { 0xd3fb176, 0x9569, 0x4d51, { 0xa3, 0xef, 0x7d, 0x61, 0xc6, 0x4f, 0xea, 0xba }}
70
71 ## Guid acted as the authenticated variable store header's signature, and to specify the variable list entries put in the EFI system table.
72 # Include/Guid/AuthenticatedVariableFormat.h
73 gEfiAuthenticatedVariableGuid = { 0xaaf32c78, 0x947b, 0x439a, { 0xa1, 0x80, 0x2e, 0x14, 0x4e, 0xc3, 0x77, 0x92 } }
74
75 ## GUID used to "SecureBootEnable" variable for the Secure Boot feature enable/disable.
76 # This variable is used for allowing a physically present user to disable Secure Boot via firmware setup without the possession of PKpriv.
77 # Include/Guid/AuthenticatedVariableFormat.h
78 gEfiSecureBootEnableDisableGuid = { 0xf0a30bc7, 0xaf08, 0x4556, { 0x99, 0xc4, 0x0, 0x10, 0x9, 0xc9, 0x3a, 0x44 } }
79
80 ## GUID used to "CustomMode" variable for two Secure Boot modes feature: "Custom" and "Standard".
81 # Standard Secure Boot mode is the default mode as UEFI Spec's description.
82 # Custom Secure Boot mode allows for more flexibility as specified in the following:
83 # Can enroll or delete PK without existing PK's private key.
84 # Can enroll or delete KEK without existing PK's private key.
85 # Can enroll or delete signature from DB/DBX without KEK's private key.
86 # Include/Guid/AuthenticatedVariableFormat.h
87 gEfiCustomModeEnableGuid = { 0xc076ec0c, 0x7028, 0x4399, { 0xa0, 0x72, 0x71, 0xee, 0x5c, 0x44, 0x8b, 0x9f } }
88
89 ## GUID used to "VendorKeysNv" variable to record the out of band secure boot keys modification.
90 # This variable is a read-only NV varaible that indicates whether someone other than the platform vendor has used a
91 # mechanism not defined by the UEFI Specification to transition the system to setup mode or to update secure boot keys.
92 # Include/Guid/AuthenticatedVariableFormat.h
93 gEfiVendorKeysNvGuid = { 0x9073e4e0, 0x60ec, 0x4b6e, { 0x99, 0x3, 0x4c, 0x22, 0x3c, 0x26, 0xf, 0x3c } }
94
95 ## GUID used to "certdb" variable to store the signer's certificates for common variables with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute.
96 # Include/Guid/AuthenticatedVariableFormat.h
97 gEfiCertDbGuid = { 0xd9bee56e, 0x75dc, 0x49d9, { 0xb4, 0xd7, 0xb5, 0x34, 0x21, 0xf, 0x63, 0x7a } }
98
99 ## Hob GUID used to pass a TCG_PCR_EVENT from a TPM PEIM to a TPM DXE Driver.
100 # Include/Guid/TcgEventHob.h
101 gTcgEventEntryHobGuid = { 0x2b9ffb52, 0x1b13, 0x416f, { 0xa8, 0x7b, 0xbc, 0x93, 0xd, 0xef, 0x92, 0xa8 }}
102
103 ## HOB GUID used to pass all PEI measured FV info to DXE Driver.
104 # Include/Guid/MeasuredFvHob.h
105 gMeasuredFvHobGuid = { 0xb2360b42, 0x7173, 0x420a, { 0x86, 0x96, 0x46, 0xca, 0x6b, 0xab, 0x10, 0x60 }}
106
107 ## GUID used to "PhysicalPresence" variable and "PhysicalPresenceFlags" variable for TPM request and response.
108 # Include/Guid/PhysicalPresenceData.h
109 gEfiPhysicalPresenceGuid = { 0xf6499b1, 0xe9ad, 0x493d, { 0xb9, 0xc2, 0x2f, 0x90, 0x81, 0x5c, 0x6c, 0xbc }}
110
111 ## GUID used for form browser, password credential and provider identifier.
112 # Include/Guid/PwdCredentialProviderHii.h
113 gPwdCredentialProviderGuid = { 0x78b9ec8b, 0xc000, 0x46c5, { 0xac, 0x93, 0x24, 0xa0, 0xc1, 0xbb, 0x0, 0xce }}
114
115 ## GUID used for form browser, USB credential and provider identifier.
116 # Include/Guid/UsbCredentialProviderHii.h
117 gUsbCredentialProviderGuid = { 0xd0849ed1, 0xa88c, 0x4ba6, { 0xb1, 0xd6, 0xab, 0x50, 0xe2, 0x80, 0xb7, 0xa9 }}
118
119 ## GUID used for FormSet guid and user profile variable.
120 # Include/Guid/UserIdentifyManagerHii.h
121 gUserIdentifyManagerGuid = { 0x3ccd3dd8, 0x8d45, 0x4fed, { 0x96, 0x2d, 0x2b, 0x38, 0xcd, 0x82, 0xb3, 0xc4 }}
122
123 ## GUID used for FormSet.
124 # Include/Guid/UserProfileManagerHii.h
125 gUserProfileManagerGuid = { 0xc35f272c, 0x97c2, 0x465a, { 0xa2, 0x16, 0x69, 0x6b, 0x66, 0x8a, 0x8c, 0xfe }}
126
127 ## GUID used for FormSet.
128 # Include/Guid/TcgConfigHii.h
129 gTcgConfigFormSetGuid = { 0xb0f901e4, 0xc424, 0x45de, { 0x90, 0x81, 0x95, 0xe2, 0xb, 0xde, 0x6f, 0xb5 }}
130
131 ## GUID used for FormSet.
132 # Include/Guid/SecureBootConfigHii.h
133 gSecureBootConfigFormSetGuid = { 0x5daf50a5, 0xea81, 0x4de2, {0x8f, 0x9b, 0xca, 0xbd, 0xa9, 0xcf, 0x5c, 0x14}}
134
135 ## GUID used to "TrEEPhysicalPresence" variable and "TrEEPhysicalPresenceFlags" variable for TPM2 request and response.
136 # Include/Guid/TrEEPhysicalPresenceData.h
137 gEfiTrEEPhysicalPresenceGuid = { 0xf24643c2, 0xc622, 0x494e, { 0x8a, 0xd, 0x46, 0x32, 0x57, 0x9c, 0x2d, 0x5b }}
138
139 ## GUID value used for PcdTpmInstanceGuid to indicate TPM is disabled.
140 # Include/Guid/TpmInstance.h
141 gEfiTpmDeviceInstanceNoneGuid = { 0x00000000, 0x0000, 0x0000, { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 } }
142
143 ## GUID value used for PcdTpmInstanceGuid to indicate TPM 1.2 device is selected to support.
144 # Include/Guid/TpmInstance.h
145 gEfiTpmDeviceInstanceTpm12Guid = { 0x8b01e5b6, 0x4f19, 0x46e8, { 0xab, 0x93, 0x1c, 0x53, 0x67, 0x1b, 0x90, 0xcc } }
146
147 ## GUID value used for PcdTpmInstanceGuid to indicate discrete TPM 2.0 device is selected to support.
148 # Include/Guid/TpmInstance.h
149 gEfiTpmDeviceInstanceTpm20DtpmGuid = { 0x286bf25a, 0xc2c3, 0x408c, { 0xb3, 0xb4, 0x25, 0xe6, 0x75, 0x8b, 0x73, 0x17 } }
150
151 ## GUID used to select supported TPM instance from UI.
152 # Include/Guid/TpmInstance.h
153 gEfiTpmDeviceSelectedGuid = { 0x7f4158d3, 0x74d, 0x456d, { 0x8c, 0xb2, 0x1, 0xf9, 0xc8, 0xf7, 0x9d, 0xaa } }
154
155 ## GUID used for FormSet and config variable.
156 # Include/Guid/TrEEConfigHii.h
157 gTrEEConfigFormSetGuid = {0xc54b425f, 0xaa79, 0x48b4, { 0x98, 0x1f, 0x99, 0x8b, 0x3c, 0x4b, 0x64, 0x1c }}
158
159 [Ppis]
160 ## Include/Ppi/LockPhysicalPresence.h
161 gPeiLockPhysicalPresencePpiGuid = { 0xef9aefe5, 0x2bd3, 0x4031, { 0xaf, 0x7d, 0x5e, 0xfe, 0x5a, 0xbb, 0x9a, 0xd } }
162
163 ## Include/Ppi/TpmInitialized.h
164 gPeiTpmInitializedPpiGuid = { 0xe9db0d58, 0xd48d, 0x47f6, { 0x9c, 0x6e, 0x6f, 0x40, 0xe8, 0x6c, 0x7b, 0x41 }}
165
166 ## Include/Ppi/FirmwareVolumeInfoMeasurementExcluded.h
167 gEfiPeiFirmwareVolumeInfoMeasurementExcludedPpiGuid = { 0x6e056ff9, 0xc695, 0x4364, { 0x9e, 0x2c, 0x61, 0x26, 0xf5, 0xce, 0xea, 0xae } }
168
169 [PcdsFixedAtBuild]
170 ## Pcd for OptionRom.
171 # Image verification policy settings:
172 # ALWAYS_EXECUTE 0x00000000
173 # NEVER_EXECUTE 0x00000001
174 # ALLOW_EXECUTE_ON_SECURITY_VIOLATION 0x00000002
175 # DEFER_EXECUTE_ON_SECURITY_VIOLATION 0x00000003
176 # DENY_EXECUTE_ON_SECURITY_VIOLATION 0x00000004
177 # QUERY_USER_ON_SECURITY_VIOLATION 0x00000005
178 # NOTE: Do NOT use QUERY_USER_ON_SECURITY_VIOLATION and ALLOW_EXECUTE_ON_SECURITY_VIOLATION since
179 # it violates the UEFI specification and has been removed.
180 gEfiSecurityPkgTokenSpaceGuid.PcdOptionRomImageVerificationPolicy|0x04|UINT32|0x00000001
181
182 ## Pcd for removable media.
183 # Removable media include CD-ROM, Floppy, USB and network.
184 # Image verification policy settings:
185 # ALWAYS_EXECUTE 0x00000000
186 # NEVER_EXECUTE 0x00000001
187 # ALLOW_EXECUTE_ON_SECURITY_VIOLATION 0x00000002
188 # DEFER_EXECUTE_ON_SECURITY_VIOLATION 0x00000003
189 # DENY_EXECUTE_ON_SECURITY_VIOLATION 0x00000004
190 # QUERY_USER_ON_SECURITY_VIOLATION 0x00000005
191 # NOTE: Do NOT use QUERY_USER_ON_SECURITY_VIOLATION and ALLOW_EXECUTE_ON_SECURITY_VIOLATION since
192 # it violates the UEFI specification and has been removed.
193 gEfiSecurityPkgTokenSpaceGuid.PcdRemovableMediaImageVerificationPolicy|0x04|UINT32|0x00000002
194
195 ## Pcd for fixed media.
196 # Fixed media include hard disk.
197 # Image verification policy settings:
198 # ALWAYS_EXECUTE 0x00000000
199 # NEVER_EXECUTE 0x00000001
200 # ALLOW_EXECUTE_ON_SECURITY_VIOLATION 0x00000002
201 # DEFER_EXECUTE_ON_SECURITY_VIOLATION 0x00000003
202 # DENY_EXECUTE_ON_SECURITY_VIOLATION 0x00000004
203 # QUERY_USER_ON_SECURITY_VIOLATION 0x00000005
204 # NOTE: Do NOT use QUERY_USER_ON_SECURITY_VIOLATION and ALLOW_EXECUTE_ON_SECURITY_VIOLATION since
205 # it violates the UEFI specification and has been removed.
206 gEfiSecurityPkgTokenSpaceGuid.PcdFixedMediaImageVerificationPolicy|0x04|UINT32|0x00000003
207
208 ## Defer Image Load policy settings.
209 # The policy is bitwise.
210 # If bit is set, the image from corresponding device will be trust when loading.
211 #
212 # IMAGE_UNKNOWN 0x00000001
213 # IMAGE_FROM_FV 0x00000002
214 # IMAGE_FROM_OPTION_ROM 0x00000004
215 # IMAGE_FROM_REMOVABLE_MEDIA 0x00000008
216 # IMAGE_FROM_FIXED_MEDIA 0x00000010
217 gEfiSecurityPkgTokenSpaceGuid.PcdDeferImageLoadPolicy|0x0000001F|UINT32|0x0000004
218
219 ## The token file name used to save credential in USB credential provider driver.
220 # The specified file should be saved at the root directory of USB storage disk.
221 gEfiSecurityPkgTokenSpaceGuid.PcdFixedUsbCredentialProviderTokenFileName|L"Token.bin"|VOID*|0x00000005
222
223 ## The size of Append variable buffer. This buffer is reserved for runtime use, OS can append data into one existing variable.
224 gEfiSecurityPkgTokenSpaceGuid.PcdMaxAppendVariableSize|0x2000|UINT32|0x30000005
225
226 ## This PCD specifies the type of TCG platform that contains TPM chip.
227 # This PCD is only avaiable when PcdTpmPhysicalPresence is TRUE.
228 # If 0, TCG platform type is PC client.
229 # If 1, TCG platform type is server.
230 gEfiSecurityPkgTokenSpaceGuid.PcdTpmPlatformClass|0|UINT8|0x00000006
231
232 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
233 ## This PCD indicates the presence or absence of the platform operator.
234 gEfiSecurityPkgTokenSpaceGuid.PcdTpmPhysicalPresence|TRUE|BOOLEAN|0x00010001
235
236 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
237 ## This PCD indicates whether to set TPM physicalPresenceLifetimeLock bit.
238 # Once this bit is set, it can not be cleared (It is locked for TPM life time).
239 gEfiSecurityPkgTokenSpaceGuid.PcdPhysicalPresenceLifetimeLock|FALSE|BOOLEAN|0x00010003
240
241 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
242 ## This PCD is used to specify the default value for physicalPresenceCMDEnable bit when setting physicalPresenceLifetimeLock bit.
243 # If PcdPhysicalPresenceCmdEnable is set to TRUE, physicalPresenceCMDEnable bit will be set, else this bit will be cleared.
244 gEfiSecurityPkgTokenSpaceGuid.PcdPhysicalPresenceCmdEnable|TRUE|BOOLEAN|0x00010004
245
246 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
247 ## This PCD is used to specify the default value for physicalPresenceHWEnable bit when setting physicalPresenceLifetimeLock bit.
248 # If PcdPhysicalPresenceHwEnable is set to TRUE, physicalPresenceHWEnable bit will be set, else this bit will be cleared.
249 gEfiSecurityPkgTokenSpaceGuid.PcdPhysicalPresenceHwEnable|TRUE|BOOLEAN|0x00010005
250
251 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
252 ## This PCD indicates if debugger exists.
253 gEfiSecurityPkgTokenSpaceGuid.PcdFirmwareDebuggerInitialized|FALSE|BOOLEAN|0x00010009
254
255 ## This PCD indicates the TPM2 initialization policy.
256 # 0: No initialization needed - most likely used for chipset SRTM solution, in which TPM is already initialized.
257 # 1: Initialization needed.
258 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2InitializationPolicy|1|UINT8|0x0001000A
259
260 ## This PCD indicates the TPM initialization policy.
261 # 0: No initialization needed - most likely used for chipset SRTM solution, in which TPM is already initialized.
262 # 1: Initialization needed.
263 gEfiSecurityPkgTokenSpaceGuid.PcdTpmInitializationPolicy|1|UINT8|0x0001000B
264
265 ## This PCD indicates the TPM2 SelfTest policy.
266 # 0: No SelfTest needed - most likely used for fTPM, because it might already be tested.
267 # 1: SelfTest needed.
268 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2SelfTestPolicy|1|UINT8|0x0001000C
269
270 ## This PCD indicates the TPM2 SCRTM policy.
271 # 0: No SCRTM needed - In this case, it is already done.
272 # 1: SCRTM done by BIOS.
273 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2ScrtmPolicy|1|UINT8|0x0001000D
274
275 ## This PCD indicates the TPM SCRTM policy.
276 # 0: No SCRTM needed - In this case, it is already done.
277 # 1: SCRTM done by BIOS.
278 gEfiSecurityPkgTokenSpaceGuid.PcdTpmScrtmPolicy|1|UINT8|0x0001000E
279
280 ## Guid name to identify TPM instance
281 # TPM_DEVICE_INTERFACE_NONE means disable
282 # TPM_DEVICE_INTERFACE_TPM12 means TPM1.2 DTPM
283 # TPM_DEVICE_INTERFACE_DTPM2 means TPM2 DTPM
284 gEfiSecurityPkgTokenSpaceGuid.PcdTpmInstanceGuid |{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }|VOID*|0x0001000F
285
286 ## This PCD indicates the TPM2 Hash mask.
287 # BIT0: SHA1
288 # BIT1: SHA256
289 # BIT2: SHA384
290 # BIT3: SHA512
291 # If this bit is set, that means this algorithm is needed to extend to PCR.
292 # If this bit is clear, that means this algorithm is NOT needed to extend to PCR.
293 # 0xFFFFFFFF means extend all.
294 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2HashMask|0xFFFFFFFF|UINT32|0x00010010
295
296 ## This PCD indicates if BIOS auto detect TPM1.2 or dTPM2.0.
297 # 0: No auto detection.
298 # 1: Auto detection.
299 gEfiSecurityPkgTokenSpaceGuid.PcdTpmAutoDetection|TRUE|BOOLEAN|0x00010011
300
301 ## This PCD indicates TPM base address.
302 gEfiSecurityPkgTokenSpaceGuid.PcdTpmBaseAddress|0xFED40000|UINT64|0x00010012
303
304 ## Provides one or more SHA 256 Hashes of the RSA 2048 public keys used to verify Recovery and Capsule Update images
305 #
306 # @Prompt One or more SHA 256 Hashes of RSA 2048 bit public keys used to verify Recovery and Capsule Update images
307 #
308 gEfiSecurityPkgTokenSpaceGuid.PcdRsa2048Sha256PublicKeyBuffer|{0x91, 0x29, 0xc4, 0xbd, 0xea, 0x6d, 0xda, 0xb3, 0xaa, 0x6f, 0x50, 0x16, 0xfc, 0xdb, 0x4b, 0x7e, 0x3c, 0xd6, 0xdc, 0xa4, 0x7a, 0x0e, 0xdd, 0xe6, 0x15, 0x8c, 0x73, 0x96, 0xa2, 0xd4, 0xa6, 0x4d}|VOID*|0x00010013
309