60f1c0a0e353d8edb1720241f5dde2fa026cf3f4
[mirror_edk2.git] / SecurityPkg / SecurityPkg.dec
1 ## @file SecurityPkg.dec
2 # Provides security features that conform to TCG/UEFI industry standards
3 #
4 # The security features include secure boot, measured boot and user identification.
5 # It also provides the definitions(including PPIs/PROTOCOLs/GUIDs and library classes)
6 # and libraries instances, which are used for those features.
7 #
8 # Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>
9 # (C) Copyright 2015 Hewlett Packard Enterprise Development LP <BR>
10 # Copyright (c) 2017, Microsoft Corporation. All rights reserved. <BR>
11 # This program and the accompanying materials are licensed and made available under
12 # the terms and conditions of the BSD License which accompanies this distribution.
13 # The full text of the license may be found at
14 # http://opensource.org/licenses/bsd-license.php
15 #
16 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
17 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #
19 ##
20
21 [Defines]
22 DEC_SPECIFICATION = 0x00010005
23 PACKAGE_NAME = SecurityPkg
24 PACKAGE_UNI_FILE = SecurityPkg.uni
25 PACKAGE_GUID = 4EFC4F66-6219-4427-B780-FB99F470767F
26 PACKAGE_VERSION = 0.98
27
28 [Includes]
29 Include
30
31 [LibraryClasses]
32 ## @libraryclass Provides hash interfaces from different implementations.
33 #
34 HashLib|Include/Library/HashLib.h
35
36 ## @libraryclass Provides a platform specific interface to detect physically present user.
37 #
38 PlatformSecureLib|Include/Library/PlatformSecureLib.h
39
40 ## @libraryclass Provides interfaces to handle TPM 1.2 request.
41 #
42 TcgPhysicalPresenceLib|Include/Library/TcgPhysicalPresenceLib.h
43
44 ## @libraryclass Provides support for TCG PP >= 128 Vendor Specific PPI Operation.
45 #
46 TcgPpVendorLib|Include/Library/TcgPpVendorLib.h
47
48 ## @libraryclass Provides interfaces for other modules to send TPM 2.0 command.
49 #
50 Tpm2CommandLib|Include/Library/Tpm2CommandLib.h
51
52 ## @libraryclass Provides interfaces on how to access TPM 2.0 hardware device.
53 #
54 Tpm2DeviceLib|Include/Library/Tpm2DeviceLib.h
55
56 ## @libraryclass Provides interfaces for other modules to send TPM 1.2 command.
57 #
58 Tpm12CommandLib|Include/Library/Tpm12CommandLib.h
59
60 ## @libraryclass Provides interfaces on how to access TPM 1.2 hardware device.
61 #
62 Tpm12DeviceLib|Include/Library/Tpm12DeviceLib.h
63
64 ## @libraryclass Provides TPM Interface Specification (TIS) interfaces for TPM command.
65 #
66 TpmCommLib|Include/Library/TpmCommLib.h
67
68 ## @libraryclass Provides support for TCG Physical Presence Interface (PPI) specification
69 # >= 128 Vendor Specific PPI Operation.
70 #
71 Tcg2PpVendorLib|Include/Library/TcgPpVendorLib.h
72
73 ## @libraryclass Handle TPM 2.0 physical presence request from OS.
74 #
75 Tcg2PhysicalPresenceLib|Include/Library/Tcg2PhysicalPresenceLib.h
76
77 ## @libraryclass Provides interfaces about TCG storage generic commond.
78 #
79 TcgStorageCoreLib|Include/Library/TcgStorageCoreLib.h
80
81 ## @libraryclass Provides interfaces about TCG storage Opal generic commond.
82 #
83 TcgStorageOpalLib|Include/Library/TcgStorageOpalLib.h
84
85 [Guids]
86 ## Security package token space guid.
87 # Include/Guid/SecurityPkgTokenSpace.h
88 gEfiSecurityPkgTokenSpaceGuid = { 0xd3fb176, 0x9569, 0x4d51, { 0xa3, 0xef, 0x7d, 0x61, 0xc6, 0x4f, 0xea, 0xba }}
89
90 ## GUID used to "SecureBootEnable" variable for the Secure Boot feature enable/disable.
91 # This variable is used for allowing a physically present user to disable Secure Boot via firmware setup without the possession of PKpriv.
92 # Include/Guid/AuthenticatedVariableFormat.h
93 gEfiSecureBootEnableDisableGuid = { 0xf0a30bc7, 0xaf08, 0x4556, { 0x99, 0xc4, 0x0, 0x10, 0x9, 0xc9, 0x3a, 0x44 } }
94
95 ## GUID used to "CustomMode" variable for two Secure Boot modes feature: "Custom" and "Standard".
96 # Standard Secure Boot mode is the default mode as UEFI Spec's description.
97 # Custom Secure Boot mode allows for more flexibility as specified in the following:
98 # Can enroll or delete PK without existing PK's private key.
99 # Can enroll or delete KEK without existing PK's private key.
100 # Can enroll or delete signature from DB/DBX without KEK's private key.
101 # Include/Guid/AuthenticatedVariableFormat.h
102 gEfiCustomModeEnableGuid = { 0xc076ec0c, 0x7028, 0x4399, { 0xa0, 0x72, 0x71, 0xee, 0x5c, 0x44, 0x8b, 0x9f } }
103
104 ## GUID used to "VendorKeysNv" variable to record the out of band secure boot keys modification.
105 # This variable is a read-only NV variable that indicates whether someone other than the platform vendor has used a
106 # mechanism not defined by the UEFI Specification to transition the system to setup mode or to update secure boot keys.
107 # Include/Guid/AuthenticatedVariableFormat.h
108 gEfiVendorKeysNvGuid = { 0x9073e4e0, 0x60ec, 0x4b6e, { 0x99, 0x3, 0x4c, 0x22, 0x3c, 0x26, 0xf, 0x3c } }
109
110 ## GUID used to "certdb"/"certdbv" variable to store the signer's certificates for common variables with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute.
111 # Include/Guid/AuthenticatedVariableFormat.h
112 gEfiCertDbGuid = { 0xd9bee56e, 0x75dc, 0x49d9, { 0xb4, 0xd7, 0xb5, 0x34, 0x21, 0xf, 0x63, 0x7a } }
113
114 ## Hob GUID used to pass a TCG_PCR_EVENT from a TPM PEIM to a TPM DXE Driver.
115 # Include/Guid/TcgEventHob.h
116 gTcgEventEntryHobGuid = { 0x2b9ffb52, 0x1b13, 0x416f, { 0xa8, 0x7b, 0xbc, 0x93, 0xd, 0xef, 0x92, 0xa8 }}
117
118 ## Hob GUID used to pass a TCG_PCR_EVENT_2 from a TPM2 PEIM to a TPM2 DXE Driver.
119 ## Include/Guid/TcgEventHob.h
120 gTcgEvent2EntryHobGuid = { 0xd26c221e, 0x2430, 0x4c8a, { 0x91, 0x70, 0x3f, 0xcb, 0x45, 0x0, 0x41, 0x3f }}
121
122 ## HOB GUID used to record TPM device error.
123 # Include/Guid/TcgEventHob.h
124 gTpmErrorHobGuid = { 0xef598499, 0xb25e, 0x473a, { 0xbf, 0xaf, 0xe7, 0xe5, 0x7d, 0xce, 0x82, 0xc4 }}
125
126 ## HOB GUID used to record TPM2 startup locality
127 ## Include/Guid/TcgEventHob.h
128 gTpm2StartupLocalityHobGuid = { 0x397b0c9, 0x22e8, 0x459e, { 0xa4, 0xff, 0x99, 0xbc, 0x65, 0x27, 0x9, 0x29 }}
129
130 ## HOB GUID used to pass all PEI measured FV info to DXE Driver.
131 # Include/Guid/MeasuredFvHob.h
132 gMeasuredFvHobGuid = { 0xb2360b42, 0x7173, 0x420a, { 0x86, 0x96, 0x46, 0xca, 0x6b, 0xab, 0x10, 0x60 }}
133
134 ## GUID used to "PhysicalPresence" variable and "PhysicalPresenceFlags" variable for TPM request and response.
135 # Include/Guid/PhysicalPresenceData.h
136 gEfiPhysicalPresenceGuid = { 0xf6499b1, 0xe9ad, 0x493d, { 0xb9, 0xc2, 0x2f, 0x90, 0x81, 0x5c, 0x6c, 0xbc }}
137
138 ## GUID used to "Tcg2PhysicalPresence" variable and "Tcg2PhysicalPresenceFlags" variable for TPM2 request and response.
139 # Include/Guid/Tcg2PhysicalPresenceData.h
140 gEfiTcg2PhysicalPresenceGuid = { 0xaeb9c5c1, 0x94f1, 0x4d02, { 0xbf, 0xd9, 0x46, 0x2, 0xdb, 0x2d, 0x3c, 0x54 }}
141
142 ## GUID used for form browser, password credential and provider identifier.
143 # Include/Guid/PwdCredentialProviderHii.h
144 gPwdCredentialProviderGuid = { 0x78b9ec8b, 0xc000, 0x46c5, { 0xac, 0x93, 0x24, 0xa0, 0xc1, 0xbb, 0x0, 0xce }}
145
146 ## GUID used for form browser, USB credential and provider identifier.
147 # Include/Guid/UsbCredentialProviderHii.h
148 gUsbCredentialProviderGuid = { 0xd0849ed1, 0xa88c, 0x4ba6, { 0xb1, 0xd6, 0xab, 0x50, 0xe2, 0x80, 0xb7, 0xa9 }}
149
150 ## GUID used for FormSet guid and user profile variable.
151 # Include/Guid/UserIdentifyManagerHii.h
152 gUserIdentifyManagerGuid = { 0x3ccd3dd8, 0x8d45, 0x4fed, { 0x96, 0x2d, 0x2b, 0x38, 0xcd, 0x82, 0xb3, 0xc4 }}
153
154 ## GUID used for FormSet.
155 # Include/Guid/UserProfileManagerHii.h
156 gUserProfileManagerGuid = { 0xc35f272c, 0x97c2, 0x465a, { 0xa2, 0x16, 0x69, 0x6b, 0x66, 0x8a, 0x8c, 0xfe }}
157
158 ## GUID used for FormSet.
159 # Include/Guid/TcgConfigHii.h
160 gTcgConfigFormSetGuid = { 0xb0f901e4, 0xc424, 0x45de, { 0x90, 0x81, 0x95, 0xe2, 0xb, 0xde, 0x6f, 0xb5 }}
161
162 ## GUID used for FormSet and config variable.
163 # Include/Guid/Tcg2ConfigHii.h
164 gTcg2ConfigFormSetGuid = {0x6339d487, 0x26ba, 0x424b, { 0x9a, 0x5d, 0x68, 0x7e, 0x25, 0xd7, 0x40, 0xbc }}
165
166 ## GUID used for FormSet.
167 # Include/Guid/SecureBootConfigHii.h
168 gSecureBootConfigFormSetGuid = { 0x5daf50a5, 0xea81, 0x4de2, {0x8f, 0x9b, 0xca, 0xbd, 0xa9, 0xcf, 0x5c, 0x14}}
169
170 ## GUID value used for PcdTpmInstanceGuid to indicate TPM is disabled.
171 # Include/Guid/TpmInstance.h
172 gEfiTpmDeviceInstanceNoneGuid = { 0x00000000, 0x0000, 0x0000, { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 } }
173
174 ## GUID value used for PcdTpmInstanceGuid to indicate TPM 1.2 device is selected to support.
175 # Include/Guid/TpmInstance.h
176 gEfiTpmDeviceInstanceTpm12Guid = { 0x8b01e5b6, 0x4f19, 0x46e8, { 0xab, 0x93, 0x1c, 0x53, 0x67, 0x1b, 0x90, 0xcc } }
177
178 ## GUID value used for PcdTpmInstanceGuid to indicate discrete TPM 2.0 device is selected to support.
179 # Include/Guid/TpmInstance.h
180 gEfiTpmDeviceInstanceTpm20DtpmGuid = { 0x286bf25a, 0xc2c3, 0x408c, { 0xb3, 0xb4, 0x25, 0xe6, 0x75, 0x8b, 0x73, 0x17 } }
181
182 ## GUID used to select supported TPM instance from UI.
183 # Include/Guid/TpmInstance.h
184 gEfiTpmDeviceSelectedGuid = { 0x7f4158d3, 0x74d, 0x456d, { 0x8c, 0xb2, 0x1, 0xf9, 0xc8, 0xf7, 0x9d, 0xaa } }
185
186 ## Include/OpalPasswordExtraInfoVariable.h
187 gOpalExtraInfoVariableGuid = {0x44a2ad5d, 0x612c, 0x47b3, {0xb0, 0x6e, 0xc8, 0xf5, 0x0b, 0xfb, 0xf0, 0x7d}}
188
189
190 [Ppis]
191 ## The PPI GUID for that TPM physical presence should be locked.
192 # Include/Ppi/LockPhysicalPresence.h
193 gPeiLockPhysicalPresencePpiGuid = { 0xef9aefe5, 0x2bd3, 0x4031, { 0xaf, 0x7d, 0x5e, 0xfe, 0x5a, 0xbb, 0x9a, 0xd } }
194
195 ## The PPI GUID for that TPM is initialized.
196 # Include/Ppi/TpmInitialized.h
197 gPeiTpmInitializedPpiGuid = { 0xe9db0d58, 0xd48d, 0x47f6, { 0x9c, 0x6e, 0x6f, 0x40, 0xe8, 0x6c, 0x7b, 0x41 }}
198
199 ## The PPI GUID for that TPM initialization is done. TPM initialization may be success or fail.
200 # Include/Ppi/TpmInitialized.h
201 gPeiTpmInitializationDonePpiGuid = { 0xa030d115, 0x54dd, 0x447b, { 0x90, 0x64, 0xf2, 0x6, 0x88, 0x3d, 0x7c, 0xcc }}
202
203 ## Include/Ppi/FirmwareVolumeInfoMeasurementExcluded.h
204 gEfiPeiFirmwareVolumeInfoMeasurementExcludedPpiGuid = { 0x6e056ff9, 0xc695, 0x4364, { 0x9e, 0x2c, 0x61, 0x26, 0xf5, 0xce, 0xea, 0xae } }
205
206 ## Include/Ppi/FirmwareVolumeInfoPrehashedFV.h
207 gEdkiiPeiFirmwareVolumeInfoPrehashedFvPpiGuid = { 0x3ce1e631, 0x7008, 0x477c, { 0xad, 0xa7, 0x5d, 0xcf, 0xc7, 0xc1, 0x49, 0x4b } }
208
209 #
210 # [Error.gEfiSecurityPkgTokenSpaceGuid]
211 # 0x80000001 | Invalid value provided.
212 # 0x80000002 | Reserved bits must be set to zero.
213 # 0x80000003 | Incorrect progress or error code provided.
214 #
215
216 [PcdsFixedAtBuild, PcdsPatchableInModule]
217 ## Image verification policy for removable media which includes CD-ROM, Floppy, USB and network.
218 # Only following values are valid:<BR><BR>
219 # NOTE: Do NOT use 0x5 and 0x2 since it violates the UEFI specification and has been removed.<BR>
220 # 0x00000000 Always trust the image.<BR>
221 # 0x00000001 Never trust the image.<BR>
222 # 0x00000002 Allow execution when there is security violation.<BR>
223 # 0x00000003 Defer execution when there is security violation.<BR>
224 # 0x00000004 Deny execution when there is security violation.<BR>
225 # 0x00000005 Query user when there is security violation.<BR>
226 # @Prompt Set policy for the image from removable media.
227 # @ValidRange 0x80000001 | 0x00000000 - 0x00000005
228 gEfiSecurityPkgTokenSpaceGuid.PcdRemovableMediaImageVerificationPolicy|0x04|UINT32|0x00000002
229
230 ## Image verification policy for fixed media which includes hard disk.
231 # Only following values are valid:<BR><BR>
232 # NOTE: Do NOT use 0x5 and 0x2 since it violates the UEFI specification and has been removed.<BR>
233 # 0x00000000 Always trust the image.<BR>
234 # 0x00000001 Never trust the image.<BR>
235 # 0x00000002 Allow execution when there is security violation.<BR>
236 # 0x00000003 Defer execution when there is security violation.<BR>
237 # 0x00000004 Deny execution when there is security violation.<BR>
238 # 0x00000005 Query user when there is security violation.<BR>
239 # @Prompt Set policy for the image from fixed media.
240 # @ValidRange 0x80000001 | 0x00000000 - 0x00000005
241 gEfiSecurityPkgTokenSpaceGuid.PcdFixedMediaImageVerificationPolicy|0x04|UINT32|0x00000003
242
243 ## Defer Image Load policy settings. The policy is bitwise.
244 # If a bit is set, the image from corresponding device will be trusted when loading. Or
245 # the image will be deferred. The deferred image will be checked after user is identified.<BR><BR>
246 # BIT0 - Image from unknown device. <BR>
247 # BIT1 - Image from firmware volume.<BR>
248 # BIT2 - Image from OptionRom.<BR>
249 # BIT3 - Image from removable media which includes CD-ROM, Floppy, USB and network.<BR>
250 # BIT4 - Image from fixed media device which includes hard disk.<BR>
251 # @Prompt Set policy whether trust image before user identification.
252 # @ValidRange 0x80000002 | 0x00000000 - 0x0000001F
253 gEfiSecurityPkgTokenSpaceGuid.PcdDeferImageLoadPolicy|0x0000001F|UINT32|0x0000004
254
255 ## Null-terminated Unicode string of the file name that is the default name to save USB credential.
256 # The specified file should be saved at the root directory of USB storage disk.
257 # @Prompt File name to save credential.
258 gEfiSecurityPkgTokenSpaceGuid.PcdFixedUsbCredentialProviderTokenFileName|L"Token.bin"|VOID*|0x00000005
259
260 ## The size of Append variable buffer. This buffer is reserved for runtime use, OS can append data into one existing variable.
261 # Note: This PCD is not been used.
262 # @Prompt Max variable size for append operation.
263 gEfiSecurityPkgTokenSpaceGuid.PcdMaxAppendVariableSize|0x2000|UINT32|0x30000005
264
265 ## Specifies the type of TCG platform that contains TPM chip.<BR><BR>
266 # If 0, TCG platform type is PC client.<BR>
267 # If 1, TCG platform type is PC server.<BR>
268 # @Prompt Select platform type.
269 # @ValidRange 0x80000001 | 0x00 - 0x1
270 gEfiSecurityPkgTokenSpaceGuid.PcdTpmPlatformClass|0|UINT8|0x00000006
271
272 ## Progress Code for TPM device subclass definitions.<BR><BR>
273 # EFI_PERIPHERAL_TPM = (EFI_PERIPHERAL | 0x000D0000) = 0x010D0000<BR>
274 # @Prompt Status Code for TPM device definitions
275 # @ValidList 0x80000003 | 0x010D0000
276 gEfiSecurityPkgTokenSpaceGuid.PcdStatusCodeSubClassTpmDevice|0x010D0000|UINT32|0x00000007
277
278 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
279 ## Image verification policy for OptionRom. Only following values are valid:<BR><BR>
280 # NOTE: Do NOT use 0x5 and 0x2 since it violates the UEFI specification and has been removed.<BR>
281 # 0x00000000 Always trust the image.<BR>
282 # 0x00000001 Never trust the image.<BR>
283 # 0x00000002 Allow execution when there is security violation.<BR>
284 # 0x00000003 Defer execution when there is security violation.<BR>
285 # 0x00000004 Deny execution when there is security violation.<BR>
286 # 0x00000005 Query user when there is security violation.<BR>
287 # @Prompt Set policy for the image from OptionRom.
288 # @ValidRange 0x80000001 | 0x00000000 - 0x00000005
289 gEfiSecurityPkgTokenSpaceGuid.PcdOptionRomImageVerificationPolicy|0x04|UINT32|0x00000001
290
291 ## Indicates the presence or absence of the platform operator during firmware booting.
292 # If platform operator is not physical presence during boot. TPM will be locked and the TPM commands
293 # that required operator physical presence can not run.<BR><BR>
294 # TRUE - The platform operator is physically present.<BR>
295 # FALSE - The platform operator is not physically present.<BR>
296 # @Prompt Physical presence of the platform operator.
297 gEfiSecurityPkgTokenSpaceGuid.PcdTpmPhysicalPresence|TRUE|BOOLEAN|0x00010001
298
299 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
300 ## Indicates whether TPM physical presence is locked during platform initialization.
301 # Once it is locked, it can not be unlocked for TPM life time.<BR><BR>
302 # TRUE - Lock TPM physical presence asserting method.<BR>
303 # FALSE - Not lock TPM physical presence asserting method.<BR>
304 # @Prompt Lock TPM physical presence asserting method.
305 gEfiSecurityPkgTokenSpaceGuid.PcdPhysicalPresenceLifetimeLock|FALSE|BOOLEAN|0x00010003
306
307 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
308 ## Indicates whether the platform supports the software method of asserting physical presence.<BR><BR>
309 # TRUE - Supports the software method of asserting physical presence.<BR>
310 # FALSE - Does not support the software method of asserting physical presence.<BR>
311 # @Prompt Enable software method of asserting physical presence.
312 gEfiSecurityPkgTokenSpaceGuid.PcdPhysicalPresenceCmdEnable|TRUE|BOOLEAN|0x00010004
313
314 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
315 ## Indicates whether the platform supports the hardware method of asserting physical presence.<BR><BR>
316 # TRUE - Supports the hardware method of asserting physical presence.<BR>
317 # FALSE - Does not support the hardware method of asserting physical presence.<BR>
318 # @Prompt Enable hardware method of asserting physical presence.
319 gEfiSecurityPkgTokenSpaceGuid.PcdPhysicalPresenceHwEnable|TRUE|BOOLEAN|0x00010005
320
321 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
322 ## This PCD indicates if debugger exists. <BR><BR>
323 # TRUE - Firmware debugger exists.<BR>
324 # FALSE - Firmware debugger doesn't exist.<BR>
325 # @Prompt Firmware debugger status.
326 gEfiSecurityPkgTokenSpaceGuid.PcdFirmwareDebuggerInitialized|FALSE|BOOLEAN|0x00010009
327
328 ## This PCD indicates the initialization policy for TPM 2.0.<BR><BR>
329 # If 0, no initialization needed - most likely used for chipset SRTM solution, in which TPM is already initialized.<BR>
330 # If 1, initialization needed.<BR>
331 # @Prompt TPM 2.0 device initialization policy.<BR>
332 # @ValidRange 0x80000001 | 0x00 - 0x1
333 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2InitializationPolicy|1|UINT8|0x0001000A
334
335 ## This PCD indicates the initialization policy for TPM 1.2.<BR><BR>
336 # If 0, no initialization needed - most likely used for chipset SRTM solution, in which TPM is already initialized.<BR>
337 # If 1, initialization needed.<BR>
338 # @Prompt TPM 1.2 device initialization policy.
339 # @ValidRange 0x80000001 | 0x00 - 0x1
340 gEfiSecurityPkgTokenSpaceGuid.PcdTpmInitializationPolicy|1|UINT8|0x0001000B
341
342 ## This PCD indicates the TPM 2.0 SelfTest policy.<BR><BR>
343 # if 0, no SelfTest needed - most likely used for fTPM, because it might already be tested.<BR>
344 # if 1, SelfTest needed.<BR>
345 # @Prompt TPM 2.0 device selftest.
346 # @ValidRange 0x80000001 | 0x00 - 0x1
347 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2SelfTestPolicy|1|UINT8|0x0001000C
348
349 ## This PCD indicates Static Core Root of Trust for Measurement (SCRTM) policy using TPM 2.0.<BR><BR>
350 # if 0, no SCRTM measurement needed - In this case, it is already done.<BR>
351 # if 1, SCRTM measurement done by BIOS.<BR>
352 # @Prompt SCRTM policy setting for TPM 2.0 device.
353 # @ValidRange 0x80000001 | 0x00 - 0x1
354 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2ScrtmPolicy|1|UINT8|0x0001000D
355
356 ## This PCD indicates Static Core Root of Trust for Measurement (SCRTM) policy using TPM 1.2.<BR><BR>
357 # if 0, no SCRTM measurement needed - In this case, it is already done.<BR>
358 # if 1, SCRTM measurement done by BIOS.<BR>
359 # @Prompt SCRTM policy setting for TPM 1.2 device
360 # @ValidRange 0x80000001 | 0x00 - 0x1
361 gEfiSecurityPkgTokenSpaceGuid.PcdTpmScrtmPolicy|1|UINT8|0x0001000E
362
363 ## Guid name to identify TPM instance.<BR><BR>
364 # TPM_DEVICE_INTERFACE_NONE means disable.<BR>
365 # TPM_DEVICE_INTERFACE_TPM12 means TPM 1.2 DTPM.<BR>
366 # TPM_DEVICE_INTERFACE_DTPM2 means TPM 2.0 DTPM.<BR>
367 # Other GUID value means other TPM 2.0 device.<BR>
368 # @Prompt TPM device type identifier
369 gEfiSecurityPkgTokenSpaceGuid.PcdTpmInstanceGuid |{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }|VOID*|0x0001000F
370
371 ## This PCD indicates if BIOS auto detect TPM1.2 or dTPM2.0.<BR><BR>
372 # FALSE - No auto detection.<BR>
373 # TRUE - Auto detection.<BR>
374 # @Prompt TPM type detection.
375 gEfiSecurityPkgTokenSpaceGuid.PcdTpmAutoDetection|TRUE|BOOLEAN|0x00010011
376
377 ## This PCD indicates TPM base address.<BR><BR>
378 # @Prompt TPM device address.
379 gEfiSecurityPkgTokenSpaceGuid.PcdTpmBaseAddress|0xFED40000|UINT64|0x00010012
380
381 ## This PCR means the OEM configurated number of PCR banks.
382 # 0 means dynamic get from supported HASH algorithm
383 # @Prompt OEM configurated number of PCR banks.
384 gEfiSecurityPkgTokenSpaceGuid.PcdTcg2NumberOfPCRBanks|0x0|UINT32|0x00010015
385
386 ## Provides one or more SHA 256 Hashes of the RSA 2048 public keys used to verify Recovery and Capsule Update images
387 # WARNING: The default value is treated as test key. Please do not use default value in the production.
388 # @Prompt One or more SHA 256 Hashes of RSA 2048 bit public keys used to verify Recovery and Capsule Update images
389 #
390 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
391
392 ## Provides one PKCS7 cert used to verify Recovery and Capsule Update images
393 # WARNING: The default value is treated as test key. Please do not use default value in the production.
394 # @Prompt One PKCS7 cert used to verify Recovery and Capsule Update images
395 #
396 gEfiSecurityPkgTokenSpaceGuid.PcdPkcs7CertBuffer|{0x30, 0x82, 0x03, 0xec, 0x30, 0x82, 0x02, 0xd4, 0xa0, 0x03, 0x02, 0x01, 0x02, 0x02, 0x09, 0x00, 0xc0, 0x91, 0xc5, 0xe2, 0xb7, 0x66, 0xc0, 0xf8, 0x30, 0x0d, 0x06, 0x09, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x01, 0x01, 0x0b, 0x05, 0x00, 0x30, 0x81, 0x82, 0x31, 0x0b, 0x30, 0x09, 0x06, 0x03, 0x55, 0x04, 0x06, 0x13, 0x02, 0x43, 0x4e, 0x31, 0x0b, 0x30, 0x09, 0x06, 0x03, 0x55, 0x04, 0x08, 0x0c, 0x02, 0x53, 0x48, 0x31, 0x0b, 0x30, 0x09, 0x06, 0x03, 0x55, 0x04, 0x07, 0x0c, 0x02, 0x53, 0x48, 0x31, 0x12, 0x30, 0x10, 0x06, 0x03, 0x55, 0x04, 0x0a, 0x0c, 0x09, 0x54, 0x69, 0x61, 0x6e, 0x6f, 0x43, 0x6f, 0x72, 0x65, 0x31, 0x0e, 0x30, 0x0c, 0x06, 0x03, 0x55, 0x04, 0x0b, 0x0c, 0x05, 0x45, 0x44, 0x4b, 0x49, 0x49, 0x31, 0x11, 0x30, 0x0f, 0x06, 0x03, 0x55, 0x04, 0x03, 0x0c, 0x08, 0x54, 0x65, 0x73, 0x74, 0x52, 0x6f, 0x6f, 0x74, 0x31, 0x22, 0x30, 0x20, 0x06, 0x09, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x01, 0x09, 0x01, 0x16, 0x13, 0x65, 0x64, 0x6b, 0x69, 0x69, 0x40, 0x74, 0x69, 0x61, 0x6e, 0x6f, 0x63, 0x6f, 0x72, 0x65, 0x2e, 0x6f, 0x72, 0x67, 0x30, 0x1e, 0x17, 0x0d, 0x31, 0x37, 0x30, 0x34, 0x31, 0x30, 0x30, 0x38, 0x32, 0x37, 0x34, 0x30, 0x5a, 0x17, 0x0d, 0x31, 0x37, 0x30, 0x35, 0x31, 0x30, 0x30, 0x38, 0x32, 0x37, 0x34, 0x30, 0x5a, 0x30, 0x81, 0x82, 0x31, 0x0b, 0x30, 0x09, 0x06, 0x03, 0x55, 0x04, 0x06, 0x13, 0x02, 0x43, 0x4e, 0x31, 0x0b, 0x30, 0x09, 0x06, 0x03, 0x55, 0x04, 0x08, 0x0c, 0x02, 0x53, 0x48, 0x31, 0x0b, 0x30, 0x09, 0x06, 0x03, 0x55, 0x04, 0x07, 0x0c, 0x02, 0x53, 0x48, 0x31, 0x12, 0x30, 0x10, 0x06, 0x03, 0x55, 0x04, 0x0a, 0x0c, 0x09, 0x54, 0x69, 0x61, 0x6e, 0x6f, 0x43, 0x6f, 0x72, 0x65, 0x31, 0x0e, 0x30, 0x0c, 0x06, 0x03, 0x55, 0x04, 0x0b, 0x0c, 0x05, 0x45, 0x44, 0x4b, 0x49, 0x49, 0x31, 0x11, 0x30, 0x0f, 0x06, 0x03, 0x55, 0x04, 0x03, 0x0c, 0x08, 0x54, 0x65, 0x73, 0x74, 0x52, 0x6f, 0x6f, 0x74, 0x31, 0x22, 0x30, 0x20, 0x06, 0x09, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x01, 0x09, 0x01, 0x16, 0x13, 0x65, 0x64, 0x6b, 0x69, 0x69, 0x40, 0x74, 0x69, 0x61, 0x6e, 0x6f, 0x63, 0x6f, 0x72, 0x65, 0x2e, 0x6f, 0x72, 0x67, 0x30, 0x82, 0x01, 0x22, 0x30, 0x0d, 0x06, 0x09, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x01, 0x01, 0x01, 0x05, 0x00, 0x03, 0x82, 0x01, 0x0f, 0x00, 0x30, 0x82, 0x01, 0x0a, 0x02, 0x82, 0x01, 0x01, 0x00, 0xb9, 0x29, 0x29, 0x6c, 0x60, 0x0c, 0xd7, 0x23, 0xf6, 0x7d, 0xee, 0xf0, 0x62, 0xff, 0xd9, 0xc9, 0xaa, 0x55, 0x8c, 0x81, 0x95, 0x56, 0x3f, 0xb7, 0x56, 0x53, 0xb0, 0xc2, 0x82, 0x12, 0xc5, 0x3b, 0x75, 0x23, 0xb9, 0x4d, 0xd6, 0xc4, 0x55, 0x73, 0xf3, 0xaa, 0x95, 0xa8, 0x1b, 0xf3, 0x93, 0x7e, 0x9e, 0x40, 0xe4, 0x1d, 0x22, 0x9c, 0x93, 0x07, 0x0b, 0xd7, 0xaa, 0x5b, 0xd7, 0xe4, 0x1a, 0x21, 0x84, 0xd7, 0x63, 0x59, 0x03, 0x50, 0x1f, 0xf5, 0x14, 0x55, 0x93, 0x91, 0x9b, 0xf5, 0x52, 0xb0, 0xbf, 0x0e, 0x5c, 0x68, 0x3b, 0x59, 0x52, 0x98, 0x96, 0x56, 0xe1, 0xab, 0xc4, 0x43, 0xbb, 0x05, 0x57, 0x78, 0x45, 0x01, 0x9f, 0x58, 0x15, 0x53, 0x0e, 0x11, 0x94, 0x2f, 0x0e, 0xf1, 0xa6, 0x19, 0xa2, 0x6e, 0x86, 0x39, 0x2b, 0x33, 0x8d, 0xc7, 0xc5, 0xeb, 0xee, 0x1e, 0x33, 0xd3, 0x32, 0x94, 0xc1, 0x59, 0xc4, 0x0c, 0x97, 0x0b, 0x12, 0x48, 0x5f, 0x33, 0xf6, 0x60, 0x74, 0x7d, 0x57, 0xc2, 0x13, 0x2d, 0x7d, 0xa9, 0x87, 0xa3, 0x35, 0xea, 0x91, 0x83, 0x3f, 0x67, 0x7a, 0x92, 0x1f, 0x01, 0x53, 0x9f, 0x62, 0x5f, 0x99, 0x12, 0xfd, 0x73, 0x1b, 0x2d, 0x9e, 0x2b, 0x6c, 0x34, 0x49, 0xaf, 0x4f, 0x07, 0x8f, 0xc0, 0xe9, 0x6b, 0x9e, 0x5f, 0x79, 0x35, 0xda, 0x2a, 0x5c, 0x88, 0xee, 0xf6, 0x48, 0x61, 0xda, 0x96, 0xe3, 0x48, 0x46, 0xa0, 0x94, 0x1c, 0x9d, 0xf6, 0x5c, 0x87, 0x0e, 0xef, 0x74, 0x09, 0x91, 0x0d, 0x3d, 0x5a, 0xe7, 0xc5, 0x4c, 0x8a, 0x7a, 0xac, 0xa1, 0x85, 0xb6, 0x67, 0x44, 0x17, 0x55, 0x52, 0x3a, 0xe8, 0x11, 0x4d, 0x58, 0xa2, 0x93, 0x00, 0x62, 0xea, 0x7b, 0x80, 0xed, 0xcf, 0xbd, 0xdf, 0x75, 0x80, 0x4b, 0xb9, 0x65, 0x63, 0xad, 0x0b, 0x4d, 0x74, 0xfa, 0x59, 0x02, 0x03, 0x01, 0x00, 0x01, 0xa3, 0x63, 0x30, 0x61, 0x30, 0x1d, 0x06, 0x03, 0x55, 0x1d, 0x0e, 0x04, 0x16, 0x04, 0x14, 0x16, 0xaa, 0xd6, 0x8e, 0x1b, 0x2d, 0x43, 0xf3, 0x2d, 0xb0, 0x24, 0xad, 0x36, 0x65, 0x3f, 0xb2, 0xfa, 0xb1, 0x2c, 0xed, 0x30, 0x1f, 0x06, 0x03, 0x55, 0x1d, 0x23, 0x04, 0x18, 0x30, 0x16, 0x80, 0x14, 0x16, 0xaa, 0xd6, 0x8e, 0x1b, 0x2d, 0x43, 0xf3, 0x2d, 0xb0, 0x24, 0xad, 0x36, 0x65, 0x3f, 0xb2, 0xfa, 0xb1, 0x2c, 0xed, 0x30, 0x0f, 0x06, 0x03, 0x55, 0x1d, 0x13, 0x01, 0x01, 0xff, 0x04, 0x05, 0x30, 0x03, 0x01, 0x01, 0xff, 0x30, 0x0e, 0x06, 0x03, 0x55, 0x1d, 0x0f, 0x01, 0x01, 0xff, 0x04, 0x04, 0x03, 0x02, 0x01, 0x86, 0x30, 0x0d, 0x06, 0x09, 0x2a, 0x86, 0x48, 0x86, 0xf7, 0x0d, 0x01, 0x01, 0x0b, 0x05, 0x00, 0x03, 0x82, 0x01, 0x01, 0x00, 0x95, 0xde, 0xdf, 0xa4, 0x14, 0xdb, 0x92, 0x22, 0x78, 0x1a, 0xbd, 0x31, 0x9d, 0x1e, 0xd7, 0x2f, 0x0a, 0x10, 0x11, 0x5d, 0x74, 0x61, 0xe8, 0x30, 0xc4, 0xf3, 0x15, 0xe9, 0x30, 0x54, 0xf4, 0xbb, 0x0c, 0x04, 0x78, 0x13, 0x5d, 0x2c, 0xdd, 0x8c, 0x92, 0x90, 0xd1, 0x9c, 0xd0, 0xd0, 0x18, 0xa3, 0xa3, 0xfc, 0x8c, 0x28, 0x5a, 0xd4, 0x91, 0x4d, 0x08, 0xc3, 0xf6, 0x1a, 0xc8, 0xdd, 0xa6, 0x08, 0x58, 0xe2, 0x15, 0x95, 0xfb, 0x2d, 0x2d, 0x8a, 0xb1, 0x30, 0x80, 0xbd, 0x9a, 0xb6, 0xe1, 0x2c, 0x20, 0x3e, 0xdd, 0xc4, 0xc7, 0x55, 0x65, 0xcf, 0x28, 0x17, 0xf4, 0xee, 0xda, 0xbe, 0x77, 0x70, 0xd5, 0x52, 0xd6, 0x15, 0x7a, 0xfb, 0xad, 0xaf, 0xfd, 0xd5, 0x45, 0x90, 0x5a, 0xe6, 0x31, 0x42, 0xd7, 0x84, 0xb3, 0x49, 0x56, 0x6a, 0xd3, 0x47, 0xf3, 0xbf, 0x68, 0x60, 0x8b, 0x0f, 0xe2, 0xaf, 0xf4, 0xe3, 0xec, 0x12, 0xb9, 0xe2, 0x3a, 0x16, 0x11, 0x4e, 0x4d, 0x73, 0x79, 0xaf, 0x47, 0x85, 0x4c, 0x76, 0x26, 0x9e, 0x8b, 0x32, 0xc0, 0x8e, 0xc2, 0xdc, 0x27, 0xa6, 0xef, 0xac, 0x93, 0x9e, 0xa1, 0x5e, 0xcf, 0x34, 0x45, 0xe0, 0x2a, 0xc7, 0x9d, 0x4d, 0xd7, 0xd7, 0x37, 0x72, 0x97, 0xf8, 0x58, 0xf9, 0xb6, 0x35, 0x48, 0xf1, 0xd1, 0x0a, 0x72, 0x7f, 0xfd, 0x4d, 0x7c, 0xe9, 0xcc, 0xd8, 0x48, 0x1b, 0x49, 0x52, 0x53, 0xde, 0x51, 0x01, 0x53, 0x35, 0xbc, 0x90, 0xcd, 0x8c, 0x8a, 0xcc, 0x43, 0x20, 0xa7, 0x45, 0xff, 0x2b, 0x55, 0xb0, 0x8b, 0x2d, 0xff, 0x55, 0x15, 0x4b, 0x84, 0xd0, 0xc3, 0xd3, 0x90, 0x9c, 0x94, 0x4b, 0x55, 0xd5, 0x62, 0xea, 0x22, 0xab, 0x62, 0x68, 0xdd, 0x53, 0xc6, 0xdc, 0xa5, 0xdd, 0x9a, 0x2d, 0x8e, 0x79, 0x7c, 0x2e, 0x9c, 0xe4, 0x66, 0x80, 0x8c, 0x1d}|VOID*|0x00010014
397
398 ## This PCD defines minimum length(in bytes) of the system preboot TCG event log area(LAML).
399 # For PC Client Implementation spec up to and including 1.2 the minimum log size is 64KB.
400 # @Prompt Minimum length(in bytes) of the system preboot TCG event log area(LAML).
401 gEfiSecurityPkgTokenSpaceGuid.PcdTcgLogAreaMinLen|0x10000|UINT32|0x00010017
402
403 ## This PCD defines length(in bytes) of the TCG2 Final event log area.
404 # @Prompt Length(in bytes) of the TCG2 Final event log area.
405 gEfiSecurityPkgTokenSpaceGuid.PcdTcg2FinalLogAreaLen|0x8000|UINT32|0x00010018
406
407 ## Null-terminated string of the Version of Physical Presence interface supported by platform.<BR><BR>
408 # To support configuring from setup page, this PCD can be DynamicHii type and map to a setup option.<BR>
409 # For example, map to TCG2_VERSION.PpiVersion to be configured by Tcg2ConfigDxe driver.<BR>
410 # gEfiSecurityPkgTokenSpaceGuid.PcdTcgPhysicalPresenceInterfaceVer|L"TCG2_VERSION"|gTcg2ConfigFormSetGuid|0x0|"1.3"|NV,BS<BR>
411 # @Prompt Version of Physical Presence interface supported by platform.
412 gEfiSecurityPkgTokenSpaceGuid.PcdTcgPhysicalPresenceInterfaceVer|"1.3"|VOID*|0x00000008
413
414 ## Indicate whether a physical presence user exist.
415 # When it is configured to Dynamic or DynamicEx, it can be set through detection using
416 # a platform-specific method (e.g. Button pressed) in a actual platform in early boot phase.<BR><BR>
417 # @Prompt A physical presence user status
418 gEfiSecurityPkgTokenSpaceGuid.PcdUserPhysicalPresence|FALSE|BOOLEAN|0x00010019
419
420 ## Indicate the TPM2 ACPI table revision. Rev 4 is defined in TCG ACPI Specification Rev 00.37.<BR><BR>
421 # To support configuring from setup page, this PCD can be DynamicHii type and map to a setup option.<BR>
422 # For example, map to TCG2_VERSION.Tpm2AcpiTableRev to be configured by Tcg2ConfigDxe driver.<BR>
423 # gEfiSecurityPkgTokenSpaceGuid.PcdTpm2AcpiTableRev|L"TCG2_VERSION"|gTcg2ConfigFormSetGuid|0x8|3|NV,BS<BR>
424 # @Prompt Revision of TPM2 ACPI table.
425 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2AcpiTableRev|3|UINT8|0x0001001A
426
427 ## This PCD defines initial setting of TCG2 Persistent Firmware Management Flags
428 # PCD can be configured for different settings in different scenarios
429 # Default setting is TCG2_BIOS_TPM_MANAGEMENT_FLAG_DEFAULT | TCG2_BIOS_STORAGE_MANAGEMENT_FLAG_DEFAULT
430 # @Prompt Initial setting of TCG2 Persistent Firmware Management Flags
431 gEfiSecurityPkgTokenSpaceGuid.PcdTcg2PhysicalPresenceFlags|0x300E2|UINT32|0x0001001B
432
433 ## Indicate current TPM2 Interrupt Number reported by _CRS control method.<BR><BR>
434 # TPM2 Interrupt feature is disabled If the pcd is set to 0.<BR>
435 # @Prompt Current TPM2 Interrupt Number
436 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2CurrentIrqNum|0x00|UINT32|0x0001001C
437
438 ## Indicate platform possible TPM2 Interrupt Number reported by _PRS control method.<BR><BR>
439 # Possible TPM2 Interrupt Number Buffer will not be reported if TPM2 Interrupt feature is disabled.<BR>
440 # @Prompt Possible TPM2 Interrupt Number buffer
441 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2PossibleIrqNumBuf|{0x00, 0x00, 0x00, 0x00}|VOID*|0x0001001D
442
443 [PcdsDynamic, PcdsDynamicEx]
444
445 ## This PCD indicates Hash mask for TPM 2.0. Bit definition strictly follows TCG Algorithm Registry.<BR><BR>
446 # If this bit is set, that means this algorithm is needed to extend to PCR.<BR>
447 # If this bit is clear, that means this algorithm is NOT needed to extend to PCR.<BR>
448 # If all the bits are clear, that means hash algorithm is determined by current Active PCR Banks.<BR>
449 # BIT0 - SHA1.<BR>
450 # BIT1 - SHA256.<BR>
451 # BIT2 - SHA384.<BR>
452 # BIT3 - SHA512.<BR>
453 # @Prompt Hash mask for TPM 2.0
454 # @ValidRange 0x80000001 | 0x00000000 - 0x0000000F
455 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2HashMask|0x0000000F|UINT32|0x00010010
456
457 ## This PCD indicated final BIOS supported Hash mask.
458 # Bios may choose to register a subset of PcdTpm2HashMask.
459 # So this PCD is final value of how many hash algo is extended to PCR.
460 # If software HashLib(HashLibBaseCryptoRouter) solution is chosen, this PCD
461 # has no need to be configured in platform dsc and will be set to correct
462 # value by the HashLib instance according to the HashInstanceLib instances
463 # linked, and the value of this PCD should be got in module entrypoint.
464 # @Prompt Hash Algorithm bitmap.
465 gEfiSecurityPkgTokenSpaceGuid.PcdTcg2HashAlgorithmBitmap|0xFFFFFFFF|UINT32|0x00010016
466
467 ## This PCD indicates current active TPM interface type.
468 # Accodingt to TCG PTP spec 1.3, there are 3 types defined in TPM2_PTP_INTERFACE_TYPE.<BR>
469 # 0x00 - FIFO interface as defined in TIS 1.3 is active.<BR>
470 # 0x01 - FIFO interface as defined in PTP for TPM 2.0 is active.<BR>
471 # 0x02 - CRB interface is active.<BR>
472 # 0xFF - Contains no current active TPM interface type.<BR>
473 #
474 # @Prompt current active TPM interface type.
475 gEfiSecurityPkgTokenSpaceGuid.PcdActiveTpmInterfaceType|0xFF|UINT8|0x0001001E
476
477 [UserExtensions.TianoCore."ExtraFiles"]
478 SecurityPkgExtra.uni