blob: 959acf06b4c2e7826f61871b25fe84df202f361a [file] [log] [blame]
gdong10c187942011-09-02 07:49:32 +00001## @file SecurityPkg.dec
Dong, Guo606d38a2014-08-28 05:49:11 +00002# 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.
gdong10c187942011-09-02 07:49:32 +00007#
Yao, Jiewen4610b232015-01-12 03:16:49 +00008# Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>
Samer El-Haj-Mahmoudf88e9c52015-08-18 05:46:50 +00009# (C) Copyright 2015 Hewlett Packard Enterprise Development LP <BR>
gdong10c187942011-09-02 07:49:32 +000010# This program and the accompanying materials are licensed and made available under
11# the terms and conditions of the BSD License which accompanies this distribution.
12# The full text of the license may be found at
13# http://opensource.org/licenses/bsd-license.php
14#
15# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
16# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17#
18##
19
20[Defines]
21 DEC_SPECIFICATION = 0x00010005
22 PACKAGE_NAME = SecurityPkg
Dong, Guo606d38a2014-08-28 05:49:11 +000023 PACKAGE_UNI_FILE = SecurityPkg.uni
Star Zeng7ae77ce2015-07-01 03:13:02 +000024 PACKAGE_GUID = 4EFC4F66-6219-4427-B780-FB99F470767F
Chao Zhang0cebfe82015-08-20 02:57:05 +000025 PACKAGE_VERSION = 0.96
gdong10c187942011-09-02 07:49:32 +000026
27[Includes]
28 Include
29
30[LibraryClasses]
Dong Guoc2fcbc82014-01-28 07:00:06 +000031 ## @libraryclass Provides hash interfaces from different implementations.
32 #
jyao122f89642013-10-09 02:52:51 +000033 HashLib|Include/Library/HashLib.h
Dong Guoc2fcbc82014-01-28 07:00:06 +000034
35 ## @libraryclass Provides a platform specific interface to detect physically present user.
36 #
jyao122f89642013-10-09 02:52:51 +000037 PlatformSecureLib|Include/Library/PlatformSecureLib.h
Dong Guoc2fcbc82014-01-28 07:00:06 +000038
39 ## @libraryclass Provides interfaces to handle TPM 1.2 request.
40 #
jyao122f89642013-10-09 02:52:51 +000041 TcgPhysicalPresenceLib|Include/Library/TcgPhysicalPresenceLib.h
Dong Guoc2fcbc82014-01-28 07:00:06 +000042
Yao, Jiewen4610b232015-01-12 03:16:49 +000043 ## @libraryclass Provides support for TCG PP >= 128 Vendor Specific PPI Operation.
44 #
45 TcgPpVendorLib|Include/Library/TcgPpVendorLib.h
46
Dong Guoc2fcbc82014-01-28 07:00:06 +000047 ## @libraryclass Provides interfaces for other modules to send TPM 2.0 command.
48 #
jyao1c1d93242013-09-18 05:31:18 +000049 Tpm2CommandLib|Include/Library/Tpm2CommandLib.h
Dong Guoc2fcbc82014-01-28 07:00:06 +000050
51 ## @libraryclass Provides interfaces on how to access TPM 2.0 hardware device.
52 #
jyao1c1d93242013-09-18 05:31:18 +000053 Tpm2DeviceLib|Include/Library/Tpm2DeviceLib.h
Dong Guoc2fcbc82014-01-28 07:00:06 +000054
55 ## @libraryclass Provides interfaces for other modules to send TPM 1.2 command.
56 #
jyao122f89642013-10-09 02:52:51 +000057 Tpm12CommandLib|Include/Library/Tpm12CommandLib.h
Dong Guoc2fcbc82014-01-28 07:00:06 +000058
59 ## @libraryclass Provides interfaces on how to access TPM 1.2 hardware device.
60 #
jyao122f89642013-10-09 02:52:51 +000061 Tpm12DeviceLib|Include/Library/Tpm12DeviceLib.h
Dong Guoc2fcbc82014-01-28 07:00:06 +000062
63 ## @libraryclass Provides TPM Interface Specification (TIS) interfaces for TPM command.
64 #
jyao122f89642013-10-09 02:52:51 +000065 TpmCommLib|Include/Library/TpmCommLib.h
Dong Guoc2fcbc82014-01-28 07:00:06 +000066
67 ## @libraryclass Provides interfaces to handle TPM 2.0 request.
68 #
jyao122f89642013-10-09 02:52:51 +000069 TrEEPhysicalPresenceLib|Include/Library/TrEEPhysicalPresenceLib.h
Yao, Jiewen4610b232015-01-12 03:16:49 +000070
71 ## @libraryclass Provides support for TrEE PP >= 128 Vendor Specific PPI Operation.
72 #
73 TrEEPpVendorLib|Include/Library/TrEEPpVendorLib.h
Qiu Shuminde155b12015-08-27 05:26:24 +000074
75 ## @libraryclass Provides support for TCG Physical Presence Interface (PPI) specification
76 # >= 128 Vendor Specific PPI Operation.
77 #
78 Tcg2PpVendorLib|Include/Library/TcgPpVendorLib.h
79
80 ## @libraryclass Handle TPM 2.0 physical presence request from OS.
81 #
82 Tcg2PhysicalPresenceLib|Include/Library/Tcg2PhysicalPresenceLib.h
gdong10c187942011-09-02 07:49:32 +000083
84[Guids]
Dong, Guo606d38a2014-08-28 05:49:11 +000085 ## Security package token space guid.
gdong10c187942011-09-02 07:49:32 +000086 # Include/Guid/SecurityPkgTokenSpace.h
tye1ed47ae02012-03-31 04:42:20 +000087 gEfiSecurityPkgTokenSpaceGuid = { 0xd3fb176, 0x9569, 0x4d51, { 0xa3, 0xef, 0x7d, 0x61, 0xc6, 0x4f, 0xea, 0xba }}
Dong, Guo606d38a2014-08-28 05:49:11 +000088
Dong Guoc2fcbc82014-01-28 07:00:06 +000089 ## GUID used to "SecureBootEnable" variable for the Secure Boot feature enable/disable.
90 # This variable is used for allowing a physically present user to disable Secure Boot via firmware setup without the possession of PKpriv.
qianouyangbeda2352011-10-28 03:46:20 +000091 # Include/Guid/AuthenticatedVariableFormat.h
tye1ed47ae02012-03-31 04:42:20 +000092 gEfiSecureBootEnableDisableGuid = { 0xf0a30bc7, 0xaf08, 0x4556, { 0x99, 0xc4, 0x0, 0x10, 0x9, 0xc9, 0x3a, 0x44 } }
sfu5ecc722a2012-03-27 08:17:23 +000093
Dong Guoc2fcbc82014-01-28 07:00:06 +000094 ## GUID used to "CustomMode" variable for two Secure Boot modes feature: "Custom" and "Standard".
95 # Standard Secure Boot mode is the default mode as UEFI Spec's description.
96 # Custom Secure Boot mode allows for more flexibility as specified in the following:
97 # Can enroll or delete PK without existing PK's private key.
98 # Can enroll or delete KEK without existing PK's private key.
99 # Can enroll or delete signature from DB/DBX without KEK's private key.
sfu5ecc722a2012-03-27 08:17:23 +0000100 # Include/Guid/AuthenticatedVariableFormat.h
101 gEfiCustomModeEnableGuid = { 0xc076ec0c, 0x7028, 0x4399, { 0xa0, 0x72, 0x71, 0xee, 0x5c, 0x44, 0x8b, 0x9f } }
tye1ed47ae02012-03-31 04:42:20 +0000102
Dong Guoc2fcbc82014-01-28 07:00:06 +0000103 ## GUID used to "VendorKeysNv" variable to record the out of band secure boot keys modification.
Dong, Guo606d38a2014-08-28 05:49:11 +0000104 # This variable is a read-only NV variable that indicates whether someone other than the platform vendor has used a
Dong Guoc2fcbc82014-01-28 07:00:06 +0000105 # mechanism not defined by the UEFI Specification to transition the system to setup mode or to update secure boot keys.
tye1ed47ae02012-03-31 04:42:20 +0000106 # Include/Guid/AuthenticatedVariableFormat.h
Fu Siyuana5559402013-09-12 05:23:28 +0000107 gEfiVendorKeysNvGuid = { 0x9073e4e0, 0x60ec, 0x4b6e, { 0x99, 0x3, 0x4c, 0x22, 0x3c, 0x26, 0xf, 0x3c } }
108
Dong Guoc2fcbc82014-01-28 07:00:06 +0000109 ## GUID used to "certdb" variable to store the signer's certificates for common variables with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS attribute.
Fu Siyuana5559402013-09-12 05:23:28 +0000110 # Include/Guid/AuthenticatedVariableFormat.h
tye1ed47ae02012-03-31 04:42:20 +0000111 gEfiCertDbGuid = { 0xd9bee56e, 0x75dc, 0x49d9, { 0xb4, 0xd7, 0xb5, 0x34, 0x21, 0xf, 0x63, 0x7a } }
qianouyangbeda2352011-10-28 03:46:20 +0000112
Dong Guoc2fcbc82014-01-28 07:00:06 +0000113 ## Hob GUID used to pass a TCG_PCR_EVENT from a TPM PEIM to a TPM DXE Driver.
114 # Include/Guid/TcgEventHob.h
Shumin Qiu301c8672013-08-09 05:23:22 +0000115 gTcgEventEntryHobGuid = { 0x2b9ffb52, 0x1b13, 0x416f, { 0xa8, 0x7b, 0xbc, 0x93, 0xd, 0xef, 0x92, 0xa8 }}
gdong10c187942011-09-02 07:49:32 +0000116
Yao, Jiewen1abfa4c2015-08-13 08:24:17 +0000117 ## Hob GUID used to pass a TCG_PCR_EVENT_2 from a TPM2 PEIM to a TPM2 DXE Driver.
118 ## Include/Guid/TcgEventHob.h
119 gTcgEvent2EntryHobGuid = { 0xd26c221e, 0x2430, 0x4c8a, { 0x91, 0x70, 0x3f, 0xcb, 0x45, 0x0, 0x41, 0x3f }}
120
Yao, Jiewen6f785cf2015-01-12 03:21:00 +0000121 ## HOB GUID used to record TPM device error.
122 # Include/Guid/TcgEventHob.h
123 gTpmErrorHobGuid = { 0xef598499, 0xb25e, 0x473a, { 0xbf, 0xaf, 0xe7, 0xe5, 0x7d, 0xce, 0x82, 0xc4 }}
124
Dong Guoc2fcbc82014-01-28 07:00:06 +0000125 ## HOB GUID used to pass all PEI measured FV info to DXE Driver.
126 # Include/Guid/MeasuredFvHob.h
czhang460758c832012-09-28 00:57:02 +0000127 gMeasuredFvHobGuid = { 0xb2360b42, 0x7173, 0x420a, { 0x86, 0x96, 0x46, 0xca, 0x6b, 0xab, 0x10, 0x60 }}
czhang462aadc922012-09-11 02:26:50 +0000128
Dong Guoc2fcbc82014-01-28 07:00:06 +0000129 ## GUID used to "PhysicalPresence" variable and "PhysicalPresenceFlags" variable for TPM request and response.
130 # Include/Guid/PhysicalPresenceData.h
gdong10c187942011-09-02 07:49:32 +0000131 gEfiPhysicalPresenceGuid = { 0xf6499b1, 0xe9ad, 0x493d, { 0xb9, 0xc2, 0x2f, 0x90, 0x81, 0x5c, 0x6c, 0xbc }}
lgao4a0c56a82011-09-18 12:25:27 +0000132
Yao, Jiewen1abfa4c2015-08-13 08:24:17 +0000133 ## GUID used to "Tcg2PhysicalPresence" variable and "Tcg2PhysicalPresenceFlags" variable for TPM2 request and response.
134 # Include/Guid/Tcg2PhysicalPresenceData.h
135 gEfiTcg2PhysicalPresenceGuid = { 0xaeb9c5c1, 0x94f1, 0x4d02, { 0xbf, 0xd9, 0x46, 0x2, 0xdb, 0x2d, 0x3c, 0x54 }}
136
Dong Guoc2fcbc82014-01-28 07:00:06 +0000137 ## GUID used for form browser, password credential and provider identifier.
138 # Include/Guid/PwdCredentialProviderHii.h
lgao4a0c56a82011-09-18 12:25:27 +0000139 gPwdCredentialProviderGuid = { 0x78b9ec8b, 0xc000, 0x46c5, { 0xac, 0x93, 0x24, 0xa0, 0xc1, 0xbb, 0x0, 0xce }}
140
Dong Guoc2fcbc82014-01-28 07:00:06 +0000141 ## GUID used for form browser, USB credential and provider identifier.
142 # Include/Guid/UsbCredentialProviderHii.h
lgao4a0c56a82011-09-18 12:25:27 +0000143 gUsbCredentialProviderGuid = { 0xd0849ed1, 0xa88c, 0x4ba6, { 0xb1, 0xd6, 0xab, 0x50, 0xe2, 0x80, 0xb7, 0xa9 }}
144
Dong Guoc2fcbc82014-01-28 07:00:06 +0000145 ## GUID used for FormSet guid and user profile variable.
146 # Include/Guid/UserIdentifyManagerHii.h
lgao4a0c56a82011-09-18 12:25:27 +0000147 gUserIdentifyManagerGuid = { 0x3ccd3dd8, 0x8d45, 0x4fed, { 0x96, 0x2d, 0x2b, 0x38, 0xcd, 0x82, 0xb3, 0xc4 }}
148
Dong Guoc2fcbc82014-01-28 07:00:06 +0000149 ## GUID used for FormSet.
150 # Include/Guid/UserProfileManagerHii.h
lgao4a0c56a82011-09-18 12:25:27 +0000151 gUserProfileManagerGuid = { 0xc35f272c, 0x97c2, 0x465a, { 0xa2, 0x16, 0x69, 0x6b, 0x66, 0x8a, 0x8c, 0xfe }}
152
Dong Guoc2fcbc82014-01-28 07:00:06 +0000153 ## GUID used for FormSet.
154 # Include/Guid/TcgConfigHii.h
lgao4a0c56a82011-09-18 12:25:27 +0000155 gTcgConfigFormSetGuid = { 0xb0f901e4, 0xc424, 0x45de, { 0x90, 0x81, 0x95, 0xe2, 0xb, 0xde, 0x6f, 0xb5 }}
qianouyangbeda2352011-10-28 03:46:20 +0000156
Yao, Jiewen1abfa4c2015-08-13 08:24:17 +0000157 ## GUID used for FormSet and config variable.
158 # Include/Guid/Tcg2ConfigHii.h
159 gTcg2ConfigFormSetGuid = {0x6339d487, 0x26ba, 0x424b, { 0x9a, 0x5d, 0x68, 0x7e, 0x25, 0xd7, 0x40, 0xbc }}
160
Dong Guoc2fcbc82014-01-28 07:00:06 +0000161 ## GUID used for FormSet.
162 # Include/Guid/SecureBootConfigHii.h
qianouyangbeda2352011-10-28 03:46:20 +0000163 gSecureBootConfigFormSetGuid = { 0x5daf50a5, 0xea81, 0x4de2, {0x8f, 0x9b, 0xca, 0xbd, 0xa9, 0xcf, 0x5c, 0x14}}
Dong Guoc2fcbc82014-01-28 07:00:06 +0000164
165 ## GUID used to "TrEEPhysicalPresence" variable and "TrEEPhysicalPresenceFlags" variable for TPM2 request and response.
166 # Include/Guid/TrEEPhysicalPresenceData.h
jyao1c1d93242013-09-18 05:31:18 +0000167 gEfiTrEEPhysicalPresenceGuid = { 0xf24643c2, 0xc622, 0x494e, { 0x8a, 0xd, 0x46, 0x32, 0x57, 0x9c, 0x2d, 0x5b }}
168
Dong Guoc2fcbc82014-01-28 07:00:06 +0000169 ## GUID value used for PcdTpmInstanceGuid to indicate TPM is disabled.
170 # Include/Guid/TpmInstance.h
jyao1c1d93242013-09-18 05:31:18 +0000171 gEfiTpmDeviceInstanceNoneGuid = { 0x00000000, 0x0000, 0x0000, { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 } }
Dong Guoc2fcbc82014-01-28 07:00:06 +0000172
173 ## GUID value used for PcdTpmInstanceGuid to indicate TPM 1.2 device is selected to support.
174 # Include/Guid/TpmInstance.h
jyao1c1d93242013-09-18 05:31:18 +0000175 gEfiTpmDeviceInstanceTpm12Guid = { 0x8b01e5b6, 0x4f19, 0x46e8, { 0xab, 0x93, 0x1c, 0x53, 0x67, 0x1b, 0x90, 0xcc } }
Dong Guoc2fcbc82014-01-28 07:00:06 +0000176
177 ## GUID value used for PcdTpmInstanceGuid to indicate discrete TPM 2.0 device is selected to support.
178 # Include/Guid/TpmInstance.h
jyao1c1d93242013-09-18 05:31:18 +0000179 gEfiTpmDeviceInstanceTpm20DtpmGuid = { 0x286bf25a, 0xc2c3, 0x408c, { 0xb3, 0xb4, 0x25, 0xe6, 0x75, 0x8b, 0x73, 0x17 } }
Dong Guoc2fcbc82014-01-28 07:00:06 +0000180
181 ## GUID used to select supported TPM instance from UI.
182 # Include/Guid/TpmInstance.h
jyao1c1d93242013-09-18 05:31:18 +0000183 gEfiTpmDeviceSelectedGuid = { 0x7f4158d3, 0x74d, 0x456d, { 0x8c, 0xb2, 0x1, 0xf9, 0xc8, 0xf7, 0x9d, 0xaa } }
184
Dong Guoc2fcbc82014-01-28 07:00:06 +0000185 ## GUID used for FormSet and config variable.
186 # Include/Guid/TrEEConfigHii.h
jyao1c1d93242013-09-18 05:31:18 +0000187 gTrEEConfigFormSetGuid = {0xc54b425f, 0xaa79, 0x48b4, { 0x98, 0x1f, 0x99, 0x8b, 0x3c, 0x4b, 0x64, 0x1c }}
188
gdong10c187942011-09-02 07:49:32 +0000189[Ppis]
Dong, Guo606d38a2014-08-28 05:49:11 +0000190 ## The PPI GUID for that TPM physical presence should be locked.
191 # Include/Ppi/LockPhysicalPresence.h
gdong10c187942011-09-02 07:49:32 +0000192 gPeiLockPhysicalPresencePpiGuid = { 0xef9aefe5, 0x2bd3, 0x4031, { 0xaf, 0x7d, 0x5e, 0xfe, 0x5a, 0xbb, 0x9a, 0xd } }
193
Dong, Guo606d38a2014-08-28 05:49:11 +0000194 ## The PPI GUID for that TPM is initialized.
195 # Include/Ppi/TpmInitialized.h
gdong10c187942011-09-02 07:49:32 +0000196 gPeiTpmInitializedPpiGuid = { 0xe9db0d58, 0xd48d, 0x47f6, { 0x9c, 0x6e, 0x6f, 0x40, 0xe8, 0x6c, 0x7b, 0x41 }}
197
Yao, Jiewen83a276f2015-01-22 05:14:23 +0000198 ## The PPI GUID for that TPM initialization is done. TPM initialization may be success or fail.
199 # Include/Ppi/TpmInitialized.h
200 gPeiTpmInitializationDonePpiGuid = { 0xa030d115, 0x54dd, 0x447b, { 0x90, 0x64, 0xf2, 0x6, 0x88, 0x3d, 0x7c, 0xcc }}
201
jyao1c1d93242013-09-18 05:31:18 +0000202 ## Include/Ppi/FirmwareVolumeInfoMeasurementExcluded.h
203 gEfiPeiFirmwareVolumeInfoMeasurementExcludedPpiGuid = { 0x6e056ff9, 0xc695, 0x4364, { 0x9e, 0x2c, 0x61, 0x26, 0xf5, 0xce, 0xea, 0xae } }
204
Dong, Guo606d38a2014-08-28 05:49:11 +0000205#
206# [Error.gEfiSecurityPkgTokenSpaceGuid]
207# 0x80000001 | Invalid value provided.
208# 0x80000002 | Reserved bits must be set to zero.
Yao, Jiewen3dd05ac2015-03-04 01:15:08 +0000209# 0x80000003 | Incorrect progress or error code provided.
Dong, Guo606d38a2014-08-28 05:49:11 +0000210#
gdong10c187942011-09-02 07:49:32 +0000211
Dong, Guo4ccef562014-08-15 08:10:55 +0000212[PcdsFixedAtBuild, PcdsPatchableInModule]
Dong, Guo606d38a2014-08-28 05:49:11 +0000213 ## Image verification policy for OptionRom. Only following values are valid:<BR><BR>
214 # NOTE: Do NOT use 0x5 and 0x2 since it violates the UEFI specification and has been removed.<BR>
215 # 0x00000000 Always trust the image.<BR>
216 # 0x00000001 Never trust the image.<BR>
217 # 0x00000002 Allow execution when there is security violation.<BR>
218 # 0x00000003 Defer execution when there is security violation.<BR>
219 # 0x00000004 Deny execution when there is security violation.<BR>
220 # 0x00000005 Query user when there is security violation.<BR>
221 # @Prompt Set policy for the image from OptionRom.
222 # @ValidRange 0x80000001 | 0x00000000 - 0x00000005
223 gEfiSecurityPkgTokenSpaceGuid.PcdOptionRomImageVerificationPolicy|0x04|UINT32|0x00000001
224
225 ## Image verification policy for removable media which includes CD-ROM, Floppy, USB and network.
226 # Only following values are valid:<BR><BR>
227 # NOTE: Do NOT use 0x5 and 0x2 since it violates the UEFI specification and has been removed.<BR>
228 # 0x00000000 Always trust the image.<BR>
229 # 0x00000001 Never trust the image.<BR>
230 # 0x00000002 Allow execution when there is security violation.<BR>
231 # 0x00000003 Defer execution when there is security violation.<BR>
232 # 0x00000004 Deny execution when there is security violation.<BR>
233 # 0x00000005 Query user when there is security violation.<BR>
234 # @Prompt Set policy for the image from removable media.
235 # @ValidRange 0x80000001 | 0x00000000 - 0x00000005
236 gEfiSecurityPkgTokenSpaceGuid.PcdRemovableMediaImageVerificationPolicy|0x04|UINT32|0x00000002
237
238 ## Image verification policy for fixed media which includes hard disk.
239 # Only following values are valid:<BR><BR>
240 # NOTE: Do NOT use 0x5 and 0x2 since it violates the UEFI specification and has been removed.<BR>
241 # 0x00000000 Always trust the image.<BR>
242 # 0x00000001 Never trust the image.<BR>
243 # 0x00000002 Allow execution when there is security violation.<BR>
244 # 0x00000003 Defer execution when there is security violation.<BR>
245 # 0x00000004 Deny execution when there is security violation.<BR>
246 # 0x00000005 Query user when there is security violation.<BR>
247 # @Prompt Set policy for the image from fixed media.
248 # @ValidRange 0x80000001 | 0x00000000 - 0x00000005
249 gEfiSecurityPkgTokenSpaceGuid.PcdFixedMediaImageVerificationPolicy|0x04|UINT32|0x00000003
250
251 ## Defer Image Load policy settings. The policy is bitwise.
252 # If a bit is set, the image from corresponding device will be trusted when loading. Or
253 # the image will be deferred. The deferred image will be checked after user is identified.<BR><BR>
254 # BIT0 - Image from unknown device. <BR>
255 # BIT1 - Image from firmware volume.<BR>
256 # BIT2 - Image from OptionRom.<BR>
257 # BIT3 - Image from removable media which includes CD-ROM, Floppy, USB and network.<BR>
258 # BIT4 - Image from fixed media device which includes hard disk.<BR>
259 # @Prompt Set policy whether trust image before user identification.
260 # @ValidRange 0x80000002 | 0x00000000 - 0x0000001F
261 gEfiSecurityPkgTokenSpaceGuid.PcdDeferImageLoadPolicy|0x0000001F|UINT32|0x0000004
262
Dong, Guo4ccef562014-08-15 08:10:55 +0000263 ## Null-terminated Unicode string of the file name that is the default name to save USB credential.
264 # The specified file should be saved at the root directory of USB storage disk.
265 # @Prompt File name to save credential.
266 gEfiSecurityPkgTokenSpaceGuid.PcdFixedUsbCredentialProviderTokenFileName|L"Token.bin"|VOID*|0x00000005
Dong, Guo606d38a2014-08-28 05:49:11 +0000267
268 ## The size of Append variable buffer. This buffer is reserved for runtime use, OS can append data into one existing variable.
269 # Note: This PCD is not been used.
270 # @Prompt Max variable size for append operation.
271 gEfiSecurityPkgTokenSpaceGuid.PcdMaxAppendVariableSize|0x2000|UINT32|0x30000005
272
273 ## Specifies the type of TCG platform that contains TPM chip.<BR><BR>
274 # If 0, TCG platform type is PC client.<BR>
275 # If 1, TCG platform type is PC server.<BR>
276 # @Prompt Select platform type.
277 # @ValidRange 0x80000001 | 0x00 - 0x1
278 gEfiSecurityPkgTokenSpaceGuid.PcdTpmPlatformClass|0|UINT8|0x00000006
Yao, Jiewen6f785cf2015-01-12 03:21:00 +0000279
280 ## Progress Code for TPM device subclass definitions.<BR><BR>
281 # EFI_PERIPHERAL_TPM = (EFI_PERIPHERAL | 0x000D0000) = 0x010D0000<BR>
282 # @Prompt Status Code for TPM device definitions
283 # @ValidList 0x80000003 | 0x010D0000
284 gEfiSecurityPkgTokenSpaceGuid.PcdStatusCodeSubClassTpmDevice|0x010D0000|UINT32|0x00000007
Dong, Guo606d38a2014-08-28 05:49:11 +0000285
gdong10c187942011-09-02 07:49:32 +0000286[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
Dong, Guo606d38a2014-08-28 05:49:11 +0000287 ## Indicates the presence or absence of the platform operator during firmware booting.
288 # If platform operator is not physical presence during boot. TPM will be locked and the TPM commands
289 # that required operator physical presence can not run.<BR><BR>
290 # TRUE - The platform operator is physically present.<BR>
291 # FALSE - The platform operator is not physically present.<BR>
292 # @Prompt Physical presence of the platform operator.
gdong10c187942011-09-02 07:49:32 +0000293 gEfiSecurityPkgTokenSpaceGuid.PcdTpmPhysicalPresence|TRUE|BOOLEAN|0x00010001
294
gdong15a500332012-07-26 05:11:47 +0000295[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
Dong, Guo606d38a2014-08-28 05:49:11 +0000296 ## Indicates whether TPM physical presence is locked during platform initialization.
297 # Once it is locked, it can not be unlocked for TPM life time.<BR><BR>
298 # TRUE - Lock TPM physical presence asserting method.<BR>
299 # FALSE - Not lock TPM physical presence asserting method.<BR>
300 # @Prompt Lock TPM physical presence asserting method.
gdong15a500332012-07-26 05:11:47 +0000301 gEfiSecurityPkgTokenSpaceGuid.PcdPhysicalPresenceLifetimeLock|FALSE|BOOLEAN|0x00010003
Dong, Guo606d38a2014-08-28 05:49:11 +0000302
gdong15a500332012-07-26 05:11:47 +0000303[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
Dong, Guo606d38a2014-08-28 05:49:11 +0000304 ## Indicates whether the platform supports the software method of asserting physical presence.<BR><BR>
305 # TRUE - Supports the software method of asserting physical presence.<BR>
306 # FALSE - Does not support the software method of asserting physical presence.<BR>
307 # @Prompt Enable software method of asserting physical presence.
gdong15a500332012-07-26 05:11:47 +0000308 gEfiSecurityPkgTokenSpaceGuid.PcdPhysicalPresenceCmdEnable|TRUE|BOOLEAN|0x00010004
Dong, Guo606d38a2014-08-28 05:49:11 +0000309
gdong15a500332012-07-26 05:11:47 +0000310[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
Dong, Guo606d38a2014-08-28 05:49:11 +0000311 ## Indicates whether the platform supports the hardware method of asserting physical presence.<BR><BR>
312 # TRUE - Supports the hardware method of asserting physical presence.<BR>
313 # FALSE - Does not support the hardware method of asserting physical presence.<BR>
314 # @Prompt Enable hardware method of asserting physical presence.
gdong15a500332012-07-26 05:11:47 +0000315 gEfiSecurityPkgTokenSpaceGuid.PcdPhysicalPresenceHwEnable|TRUE|BOOLEAN|0x00010005
jyao1c1d93242013-09-18 05:31:18 +0000316
317[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
Dong, Guo606d38a2014-08-28 05:49:11 +0000318 ## This PCD indicates if debugger exists. <BR><BR>
319 # TRUE - Firmware debugger exists.<BR>
320 # FALSE - Firmware debugger doesn't exist.<BR>
321 # @Prompt Firmware debugger status.
jyao1c1d93242013-09-18 05:31:18 +0000322 gEfiSecurityPkgTokenSpaceGuid.PcdFirmwareDebuggerInitialized|FALSE|BOOLEAN|0x00010009
323
Dong, Guo606d38a2014-08-28 05:49:11 +0000324 ## This PCD indicates the initialization policy for TPM 2.0.<BR><BR>
325 # If 0, no initialization needed - most likely used for chipset SRTM solution, in which TPM is already initialized.<BR>
326 # If 1, initialization needed.<BR>
327 # @Prompt TPM 2.0 device initialization policy.<BR>
328 # @ValidRange 0x80000001 | 0x00 - 0x1
jyao1c1d93242013-09-18 05:31:18 +0000329 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2InitializationPolicy|1|UINT8|0x0001000A
330
Dong, Guo606d38a2014-08-28 05:49:11 +0000331 ## This PCD indicates the initialization policy for TPM 1.2.<BR><BR>
332 # If 0, no initialization needed - most likely used for chipset SRTM solution, in which TPM is already initialized.<BR>
333 # If 1, initialization needed.<BR>
334 # @Prompt TPM 1.2 device initialization policy.
335 # @ValidRange 0x80000001 | 0x00 - 0x1
jyao1c1d93242013-09-18 05:31:18 +0000336 gEfiSecurityPkgTokenSpaceGuid.PcdTpmInitializationPolicy|1|UINT8|0x0001000B
337
Dong, Guo606d38a2014-08-28 05:49:11 +0000338 ## This PCD indicates the TPM 2.0 SelfTest policy.<BR><BR>
339 # if 0, no SelfTest needed - most likely used for fTPM, because it might already be tested.<BR>
340 # if 1, SelfTest needed.<BR>
341 # @Prompt TPM 2.0 device selftest.
342 # @ValidRange 0x80000001 | 0x00 - 0x1
jyao1c1d93242013-09-18 05:31:18 +0000343 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2SelfTestPolicy|1|UINT8|0x0001000C
344
Dong, Guo606d38a2014-08-28 05:49:11 +0000345 ## This PCD indicates Static Core Root of Trust for Measurement (SCRTM) policy using TPM 2.0.<BR><BR>
346 # if 0, no SCRTM measurement needed - In this case, it is already done.<BR>
347 # if 1, SCRTM measurement done by BIOS.<BR>
348 # @Prompt SCRTM policy setting for TPM 2.0 device.
349 # @ValidRange 0x80000001 | 0x00 - 0x1
jyao1c1d93242013-09-18 05:31:18 +0000350 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2ScrtmPolicy|1|UINT8|0x0001000D
351
Dong, Guo606d38a2014-08-28 05:49:11 +0000352 ## This PCD indicates Static Core Root of Trust for Measurement (SCRTM) policy using TPM 1.2.<BR><BR>
353 # if 0, no SCRTM measurement needed - In this case, it is already done.<BR>
354 # if 1, SCRTM measurement done by BIOS.<BR>
355 # @Prompt SCRTM policy setting for TPM 1.2 device
356 # @ValidRange 0x80000001 | 0x00 - 0x1
jyao1c1d93242013-09-18 05:31:18 +0000357 gEfiSecurityPkgTokenSpaceGuid.PcdTpmScrtmPolicy|1|UINT8|0x0001000E
358
Dong, Guo606d38a2014-08-28 05:49:11 +0000359 ## Guid name to identify TPM instance.<BR><BR>
360 # TPM_DEVICE_INTERFACE_NONE means disable.<BR>
361 # TPM_DEVICE_INTERFACE_TPM12 means TPM 1.2 DTPM.<BR>
362 # TPM_DEVICE_INTERFACE_DTPM2 means TPM 2.0 DTPM.<BR>
Liming Gao99d9ade2015-05-14 05:03:55 +0000363 # Other GUID value means other TPM 2.0 device.<BR>
Dong, Guo606d38a2014-08-28 05:49:11 +0000364 # @Prompt TPM device type identifier
jyao1c1d93242013-09-18 05:31:18 +0000365 gEfiSecurityPkgTokenSpaceGuid.PcdTpmInstanceGuid |{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }|VOID*|0x0001000F
366
Samer El-Haj-Mahmoudf88e9c52015-08-18 05:46:50 +0000367 ## This PCD indicates if BIOS auto detect TPM1.2 or dTPM2.0.<BR><BR>
368 # FALSE - No auto detection.<BR>
369 # TRUE - Auto detection.<BR>
370 # @Prompt TPM type detection.
371 gEfiSecurityPkgTokenSpaceGuid.PcdTpmAutoDetection|TRUE|BOOLEAN|0x00010011
372
373 ## This PCD indicates TPM base address.<BR><BR>
374 # @Prompt TPM device address.
375 gEfiSecurityPkgTokenSpaceGuid.PcdTpmBaseAddress|0xFED40000|UINT64|0x00010012
376
377 ## This PCR means the OEM configurated number of PCR banks.
378 # 0 means dynamic get from supported HASH algorithm
Qiu Shuminf194d872015-08-27 05:23:46 +0000379 # @Prompt OEM configurated number of PCR banks.
Samer El-Haj-Mahmoudf88e9c52015-08-18 05:46:50 +0000380 gEfiSecurityPkgTokenSpaceGuid.PcdTcg2NumberOfPCRBanks|0x0|UINT32|0x00010015
381
382 ## Provides one or more SHA 256 Hashes of the RSA 2048 public keys used to verify Recovery and Capsule Update images
383 #
384 # @Prompt One or more SHA 256 Hashes of RSA 2048 bit public keys used to verify Recovery and Capsule Update images
385 #
386 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
387
388[PcdsDynamic, PcdsDynamicEx]
389
Dong, Guo606d38a2014-08-28 05:49:11 +0000390 ## This PCD indicates Hash mask for TPM 2.0.<BR><BR>
391 # If this bit is set, that means this algorithm is needed to extend to PCR.<BR>
392 # If this bit is clear, that means this algorithm is NOT needed to extend to PCR.<BR>
393 # BIT0 - SHA1.<BR>
394 # BIT1 - SHA256.<BR>
395 # BIT2 - SHA384.<BR>
396 # BIT3 - SHA512.<BR>
397 # @Prompt Hash mask for TPM 2.0
398 # @ValidRange 0x80000001 | 0x00000000 - 0x0000000F
399 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2HashMask|0x0000000F|UINT32|0x00010010
jyao1c1d93242013-09-18 05:31:18 +0000400
Yao, Jiewen1abfa4c2015-08-13 08:24:17 +0000401 ## This PCD indicated final BIOS supported Hash mask.
402 # Bios may choose to register a subset of PcdTpm2HashMask.
403 # So this PCD is final value of how many hash algo is extended to PCR.
Qiu Shuminf194d872015-08-27 05:23:46 +0000404 # @Prompt Hash Algorithm bitmap.
Yao, Jiewen1abfa4c2015-08-13 08:24:17 +0000405 gEfiSecurityPkgTokenSpaceGuid.PcdTcg2HashAlgorithmBitmap|0xFFFFFFFF|UINT32|0x00010016
Dong, Guo606d38a2014-08-28 05:49:11 +0000406
407[UserExtensions.TianoCore."ExtraFiles"]
408 SecurityPkgExtra.uni