Upgrade package version to 0.93
[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 Definitions for common TPM commands as library API for TPM
27 # module use.
28 HashLib|Include/Library/HashLib.h
29 PlatformSecureLib|Include/Library/PlatformSecureLib.h
30 TcgPhysicalPresenceLib|Include/Library/TcgPhysicalPresenceLib.h
31 Tpm2CommandLib|Include/Library/Tpm2CommandLib.h
32 Tpm2DeviceLib|Include/Library/Tpm2DeviceLib.h
33 Tpm12CommandLib|Include/Library/Tpm12CommandLib.h
34 Tpm12DeviceLib|Include/Library/Tpm12DeviceLib.h
35 TpmCommLib|Include/Library/TpmCommLib.h
36 TpmMeasurementLib|Include/Library/TpmMeasurementLib.h
37 TrEEPhysicalPresenceLib|Include/Library/TrEEPhysicalPresenceLib.h
38
39 [Guids]
40 ## Security package token space guid
41 # Include/Guid/SecurityPkgTokenSpace.h
42 gEfiSecurityPkgTokenSpaceGuid = { 0xd3fb176, 0x9569, 0x4d51, { 0xa3, 0xef, 0x7d, 0x61, 0xc6, 0x4f, 0xea, 0xba }}
43 ## Guid acted as the authenticated variable store header's signature, and to specify the variable list entries put in the EFI system table.
44 # Include/Guid/AuthenticatedVariableFormat.h
45 gEfiAuthenticatedVariableGuid = { 0xaaf32c78, 0x947b, 0x439a, { 0xa1, 0x80, 0x2e, 0x14, 0x4e, 0xc3, 0x77, 0x92 } }
46
47 # Include/Guid/AuthenticatedVariableFormat.h
48 gEfiSecureBootEnableDisableGuid = { 0xf0a30bc7, 0xaf08, 0x4556, { 0x99, 0xc4, 0x0, 0x10, 0x9, 0xc9, 0x3a, 0x44 } }
49
50 # Include/Guid/AuthenticatedVariableFormat.h
51 gEfiCustomModeEnableGuid = { 0xc076ec0c, 0x7028, 0x4399, { 0xa0, 0x72, 0x71, 0xee, 0x5c, 0x44, 0x8b, 0x9f } }
52
53 # Include/Guid/AuthenticatedVariableFormat.h
54 gEfiVendorKeysNvGuid = { 0x9073e4e0, 0x60ec, 0x4b6e, { 0x99, 0x3, 0x4c, 0x22, 0x3c, 0x26, 0xf, 0x3c } }
55
56 # Include/Guid/AuthenticatedVariableFormat.h
57 gEfiCertDbGuid = { 0xd9bee56e, 0x75dc, 0x49d9, { 0xb4, 0xd7, 0xb5, 0x34, 0x21, 0xf, 0x63, 0x7a } }
58
59 ## Include/Guid/TcgEventHob.h
60 gTcgEventEntryHobGuid = { 0x2b9ffb52, 0x1b13, 0x416f, { 0xa8, 0x7b, 0xbc, 0x93, 0xd, 0xef, 0x92, 0xa8 }}
61
62 ## Include/Guid/MeasuredFvHob.h
63 gMeasuredFvHobGuid = { 0xb2360b42, 0x7173, 0x420a, { 0x86, 0x96, 0x46, 0xca, 0x6b, 0xab, 0x10, 0x60 }}
64
65 ## Include/Guid/PhysicalPresenceData.h
66 gEfiPhysicalPresenceGuid = { 0xf6499b1, 0xe9ad, 0x493d, { 0xb9, 0xc2, 0x2f, 0x90, 0x81, 0x5c, 0x6c, 0xbc }}
67
68 ## Include/Guid/PwdCredentialProviderHii.h
69 gPwdCredentialProviderGuid = { 0x78b9ec8b, 0xc000, 0x46c5, { 0xac, 0x93, 0x24, 0xa0, 0xc1, 0xbb, 0x0, 0xce }}
70
71 ## Include/Guid/UsbCredentialProviderHii.h
72 gUsbCredentialProviderGuid = { 0xd0849ed1, 0xa88c, 0x4ba6, { 0xb1, 0xd6, 0xab, 0x50, 0xe2, 0x80, 0xb7, 0xa9 }}
73
74 ## Include/Guid/UserIdentifyManagerHii.h
75 gUserIdentifyManagerGuid = { 0x3ccd3dd8, 0x8d45, 0x4fed, { 0x96, 0x2d, 0x2b, 0x38, 0xcd, 0x82, 0xb3, 0xc4 }}
76
77 ## Include/Guid/UserProfileManagerHii.h
78 gUserProfileManagerGuid = { 0xc35f272c, 0x97c2, 0x465a, { 0xa2, 0x16, 0x69, 0x6b, 0x66, 0x8a, 0x8c, 0xfe }}
79
80 ## Include/Guid/TcgConfigHii.h
81 gTcgConfigFormSetGuid = { 0xb0f901e4, 0xc424, 0x45de, { 0x90, 0x81, 0x95, 0xe2, 0xb, 0xde, 0x6f, 0xb5 }}
82
83 ## Include/Guid/SecureBootConfigHii.h
84 gSecureBootConfigFormSetGuid = { 0x5daf50a5, 0xea81, 0x4de2, {0x8f, 0x9b, 0xca, 0xbd, 0xa9, 0xcf, 0x5c, 0x14}}
85
86 ## Include/Guid/TrEEPhysicalPresenceData.h
87 gEfiTrEEPhysicalPresenceGuid = { 0xf24643c2, 0xc622, 0x494e, { 0x8a, 0xd, 0x46, 0x32, 0x57, 0x9c, 0x2d, 0x5b }}
88
89 ## Include/Guid/TpmInstance.h
90 gEfiTpmDeviceInstanceNoneGuid = { 0x00000000, 0x0000, 0x0000, { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 } }
91 gEfiTpmDeviceInstanceTpm12Guid = { 0x8b01e5b6, 0x4f19, 0x46e8, { 0xab, 0x93, 0x1c, 0x53, 0x67, 0x1b, 0x90, 0xcc } }
92 gEfiTpmDeviceInstanceTpm20DtpmGuid = { 0x286bf25a, 0xc2c3, 0x408c, { 0xb3, 0xb4, 0x25, 0xe6, 0x75, 0x8b, 0x73, 0x17 } }
93 gEfiTpmDeviceSelectedGuid = { 0x7f4158d3, 0x74d, 0x456d, { 0x8c, 0xb2, 0x1, 0xf9, 0xc8, 0xf7, 0x9d, 0xaa } }
94
95 ## Include/Guid/TrEEConfigHii.h
96 gTrEEConfigFormSetGuid = {0xc54b425f, 0xaa79, 0x48b4, { 0x98, 0x1f, 0x99, 0x8b, 0x3c, 0x4b, 0x64, 0x1c }}
97
98 [Ppis]
99 ## Include/Ppi/LockPhysicalPresence.h
100 gPeiLockPhysicalPresencePpiGuid = { 0xef9aefe5, 0x2bd3, 0x4031, { 0xaf, 0x7d, 0x5e, 0xfe, 0x5a, 0xbb, 0x9a, 0xd } }
101
102 ## Include/Ppi/TpmInitialized.h
103 gPeiTpmInitializedPpiGuid = { 0xe9db0d58, 0xd48d, 0x47f6, { 0x9c, 0x6e, 0x6f, 0x40, 0xe8, 0x6c, 0x7b, 0x41 }}
104
105 ## Include/Ppi/FirmwareVolumeInfoMeasurementExcluded.h
106 gEfiPeiFirmwareVolumeInfoMeasurementExcludedPpiGuid = { 0x6e056ff9, 0xc695, 0x4364, { 0x9e, 0x2c, 0x61, 0x26, 0xf5, 0xce, 0xea, 0xae } }
107
108 [PcdsFixedAtBuild]
109 ## Pcd for OptionRom.
110 # Image verification policy settings:
111 # ALWAYS_EXECUTE 0x00000000
112 # NEVER_EXECUTE 0x00000001
113 # ALLOW_EXECUTE_ON_SECURITY_VIOLATION 0x00000002
114 # DEFER_EXECUTE_ON_SECURITY_VIOLATION 0x00000003
115 # DENY_EXECUTE_ON_SECURITY_VIOLATION 0x00000004
116 # QUERY_USER_ON_SECURITY_VIOLATION 0x00000005
117 # NOTE: Do NOT use QUERY_USER_ON_SECURITY_VIOLATION and ALLOW_EXECUTE_ON_SECURITY_VIOLATION since
118 # it violates the UEFI specification and has been removed.
119 gEfiSecurityPkgTokenSpaceGuid.PcdOptionRomImageVerificationPolicy|0x04|UINT32|0x00000001
120
121 ## Pcd for removable media.
122 # Removable media include CD-ROM, Floppy, USB and network.
123 # Image verification policy settings:
124 # ALWAYS_EXECUTE 0x00000000
125 # NEVER_EXECUTE 0x00000001
126 # ALLOW_EXECUTE_ON_SECURITY_VIOLATION 0x00000002
127 # DEFER_EXECUTE_ON_SECURITY_VIOLATION 0x00000003
128 # DENY_EXECUTE_ON_SECURITY_VIOLATION 0x00000004
129 # QUERY_USER_ON_SECURITY_VIOLATION 0x00000005
130 # NOTE: Do NOT use QUERY_USER_ON_SECURITY_VIOLATION and ALLOW_EXECUTE_ON_SECURITY_VIOLATION since
131 # it violates the UEFI specification and has been removed.
132 gEfiSecurityPkgTokenSpaceGuid.PcdRemovableMediaImageVerificationPolicy|0x04|UINT32|0x00000002
133
134 ## Pcd for fixed media.
135 # Fixed media include hard disk.
136 # Image verification policy settings:
137 # ALWAYS_EXECUTE 0x00000000
138 # NEVER_EXECUTE 0x00000001
139 # ALLOW_EXECUTE_ON_SECURITY_VIOLATION 0x00000002
140 # DEFER_EXECUTE_ON_SECURITY_VIOLATION 0x00000003
141 # DENY_EXECUTE_ON_SECURITY_VIOLATION 0x00000004
142 # QUERY_USER_ON_SECURITY_VIOLATION 0x00000005
143 # NOTE: Do NOT use QUERY_USER_ON_SECURITY_VIOLATION and ALLOW_EXECUTE_ON_SECURITY_VIOLATION since
144 # it violates the UEFI specification and has been removed.
145 gEfiSecurityPkgTokenSpaceGuid.PcdFixedMediaImageVerificationPolicy|0x04|UINT32|0x00000003
146
147 ## Defer Image Load policy settings.
148 # The policy is bitwise.
149 # If bit is set, the image from corresponding device will be trust when loading.
150 #
151 # IMAGE_UNKNOWN 0x00000001
152 # IMAGE_FROM_FV 0x00000002
153 # IMAGE_FROM_OPTION_ROM 0x00000004
154 # IMAGE_FROM_REMOVABLE_MEDIA 0x00000008
155 # IMAGE_FROM_FIXED_MEDIA 0x00000010
156 gEfiSecurityPkgTokenSpaceGuid.PcdDeferImageLoadPolicy|0x0000001F|UINT32|0x0000004
157
158 ## The token file name used to save credential in USB credential provider driver.
159 # The specified file should be saved at the root directory of USB storage disk.
160 gEfiSecurityPkgTokenSpaceGuid.PcdFixedUsbCredentialProviderTokenFileName|L"Token.bin"|VOID*|0x00000005
161
162 ## The size of Append variable buffer. This buffer is reserved for runtime use, OS can append data into one existing variable.
163 gEfiSecurityPkgTokenSpaceGuid.PcdMaxAppendVariableSize|0x2000|UINT32|0x30000005
164
165 ## This PCD specifies the type of TCG platform that contains TPM chip.
166 # This PCD is only avaiable when PcdTpmPhysicalPresence is TRUE.
167 # If 0, TCG platform type is PC client.
168 # If 1, TCG platform type is server.
169 gEfiSecurityPkgTokenSpaceGuid.PcdTpmPlatformClass|0|UINT8|0x00000006
170
171 ## The PCD is used to control whether to support hiding the TPM.
172 # If TRUE, PcdHideTpm controls whether to hide the TPM.
173 gEfiSecurityPkgTokenSpaceGuid.PcdHideTpmSupport|FALSE|BOOLEAN|0x00000007
174
175 [PcdsDynamic, PcdsDynamicEx]
176 ## The PCD is used to control whether to hide the TPM.
177 gEfiSecurityPkgTokenSpaceGuid.PcdHideTpm|FALSE|BOOLEAN|0x00010002
178
179 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
180 ## This PCD indicates the presence or absence of the platform operator.
181 gEfiSecurityPkgTokenSpaceGuid.PcdTpmPhysicalPresence|TRUE|BOOLEAN|0x00010001
182
183 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
184 ## This PCD indicates whether to set TPM physicalPresenceLifetimeLock bit.
185 ## Once this bit is set, it can not be cleared (It is locked for TPM life time).
186 gEfiSecurityPkgTokenSpaceGuid.PcdPhysicalPresenceLifetimeLock|FALSE|BOOLEAN|0x00010003
187
188 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
189 ## This PCD is used to specify the default value for physicalPresenceCMDEnable bit when setting physicalPresenceLifetimeLock bit.
190 ## If PcdPhysicalPresenceCmdEnable is set to TRUE, physicalPresenceCMDEnable bit will be set, else this bit will be cleared.
191 gEfiSecurityPkgTokenSpaceGuid.PcdPhysicalPresenceCmdEnable|TRUE|BOOLEAN|0x00010004
192
193 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
194 ## This PCD is used to specify the default value for physicalPresenceHWEnable bit when setting physicalPresenceLifetimeLock bit.
195 ## If PcdPhysicalPresenceHwEnable is set to TRUE, physicalPresenceHWEnable bit will be set, else this bit will be cleared.
196 gEfiSecurityPkgTokenSpaceGuid.PcdPhysicalPresenceHwEnable|TRUE|BOOLEAN|0x00010005
197
198 [PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]
199 ## This PCD indicates if debugger exists.
200 gEfiSecurityPkgTokenSpaceGuid.PcdFirmwareDebuggerInitialized|FALSE|BOOLEAN|0x00010009
201
202 ## This PCD indicates the TPM2 initializatin policy.
203 ## 0: No initialization needed - most likely used for chipset SRTM sloution, in which TPM is already initialized.
204 ## 1: Initialization needed.
205 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2InitializationPolicy|1|UINT8|0x0001000A
206
207 ## This PCD indicates the TPM initializatin policy.
208 ## 0: No initialization needed - most likely used for chipset SRTM sloution, in which TPM is already initialized.
209 ## 1: Initialization needed.
210 gEfiSecurityPkgTokenSpaceGuid.PcdTpmInitializationPolicy|1|UINT8|0x0001000B
211
212 ## This PCD indicates the TPM2 SelfTest policy.
213 ## 0: No SelfTest needed - most likely used for fTPM, because it might already be tested.
214 ## 1: SelfTest needed.
215 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2SelfTestPolicy|1|UINT8|0x0001000C
216
217 ## This PCD indicates the TPM2 SCRTM policy.
218 ## 0: No SCRTM needed - In this case, it is already done.
219 ## 1: SCRTM done by BIOS.
220 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2ScrtmPolicy|1|UINT8|0x0001000D
221
222 ## This PCD indicates the TPM SCRTM policy.
223 ## 0: No SCRTM needed - In this case, it is already done.
224 ## 1: SCRTM done by BIOS.
225 gEfiSecurityPkgTokenSpaceGuid.PcdTpmScrtmPolicy|1|UINT8|0x0001000E
226
227 ## Guid name to identify TPM instance
228 ## TPM_DEVICE_INTERFACE_NONE means disable
229 ## TPM_DEVICE_INTERFACE_TPM12 means TPM1.2 DTPM
230 ## TPM_DEVICE_INTERFACE_DTPM2 means TPM2 DTPM
231 gEfiSecurityPkgTokenSpaceGuid.PcdTpmInstanceGuid |{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }|VOID*|0x0001000F
232
233 ## This PCD indicates the TPM2 Hash mask.
234 ## BIT0: SHA1
235 ## BIT1: SHA256
236 ## BIT2: SHA384
237 ## BIT3: SHA512
238 ## If this bit is set, that means this algorithm is needed to extend to PCR.
239 ## If this bit is clear, that means this algorithm is NOT needed to extend to PCR.
240 ## 0xFFFFFFFF means extend all.
241 gEfiSecurityPkgTokenSpaceGuid.PcdTpm2HashMask|0xFFFFFFFF|UINT32|0x00010010
242
243 ## This PCD indicates if BIOS auto detect TPM1.2 or dTPM2.0.
244 ## 0: No auto detection.
245 ## 1: Auto detection.
246 gEfiSecurityPkgTokenSpaceGuid.PcdTpmAutoDetection|TRUE|BOOLEAN|0x00010011
247
248 ## This PCD indicates TPM base address.
249 gEfiSecurityPkgTokenSpaceGuid.PcdTpmBaseAddress|0xFED40000|UINT64|0x00010012