[mirror_edk2.git] / SecurityPkg / SecurityPkg.dec

## @file  SecurityPkg.dec\r
#  This package includes the security drivers, defintions(including PPIs/PROTOCOLs/GUIDs  \r
#  and library classes) and libraries instances.\r
#\r
# Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials are licensed and made available under\r
# the terms and conditions of the BSD License which accompanies this distribution.\r
# The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
#\r
##\r
\r
[Defines]\r
  DEC_SPECIFICATION              = 0x00010005\r
  PACKAGE_NAME                   = SecurityPkg\r
  PACKAGE_GUID                   = 24369CAC-6AA6-4fb8-88DB-90BF061668AD\r
  PACKAGE_VERSION                = 0.92\r
\r
[Includes]\r
  Include\r
\r
[LibraryClasses]\r
  ##  @libraryclass  Definitions for common TPM commands as library API for TPM\r
  #                  module use.\r
  TpmCommLib|Include/Library/TpmCommLib.h\r
\r
[Guids]\r
  ## Security package token space guid\r
  # Include/Guid/SecurityPkgTokenSpace.h\r
  gEfiSecurityPkgTokenSpaceGuid      = { 0xd3fb176, 0x9569, 0x4d51, { 0xa3, 0xef, 0x7d, 0x61, 0xc6, 0x4f, 0xea, 0xba }}\r
  ## Guid acted as the authenticated variable store header's signature, and to specify the variable list entries put in the EFI system table.\r
  #  Include/Guid/AuthenticatedVariableFormat.h\r
  gEfiAuthenticatedVariableGuid      = { 0xaaf32c78, 0x947b, 0x439a, { 0xa1, 0x80, 0x2e, 0x14, 0x4e, 0xc3, 0x77, 0x92 } }\r
\r
  #  Include/Guid/AuthenticatedVariableFormat.h\r
  gEfiSecureBootEnableDisableGuid    = { 0xf0a30bc7, 0xaf08, 0x4556, { 0x99, 0xc4, 0x0, 0x10, 0x9, 0xc9, 0x3a, 0x44 } }\r
\r
  #  Include/Guid/AuthenticatedVariableFormat.h\r
  gEfiCustomModeEnableGuid           = { 0xc076ec0c, 0x7028, 0x4399, { 0xa0, 0x72, 0x71, 0xee, 0x5c, 0x44, 0x8b, 0x9f } }\r
\r
  #  Include/Guid/AuthenticatedVariableFormat.h\r
  gEfiCertDbGuid                     = { 0xd9bee56e, 0x75dc, 0x49d9, { 0xb4, 0xd7, 0xb5, 0x34, 0x21, 0xf, 0x63, 0x7a } }\r
  \r
  ## Include/Guid/TcgEventHob.h\r
  gTcgEventEntryHobGuid              = { 0x2e3044ac, 0x879f, 0x490f, {0x97, 0x60, 0xbb, 0xdf, 0xaf, 0x69, 0x5f, 0x50 }}\r
\r
  ## Include/Guid/PhysicalPresenceData.h\r
  gEfiPhysicalPresenceGuid           = { 0xf6499b1, 0xe9ad, 0x493d, { 0xb9, 0xc2, 0x2f, 0x90, 0x81, 0x5c, 0x6c, 0xbc }}\r
  \r
  ## Include/Guid/PwdCredentialProviderHii.h\r
  gPwdCredentialProviderGuid         = { 0x78b9ec8b, 0xc000, 0x46c5, { 0xac, 0x93, 0x24, 0xa0, 0xc1, 0xbb, 0x0, 0xce }}\r
\r
  ## Include/Guid/UsbCredentialProviderHii.h\r
  gUsbCredentialProviderGuid         = { 0xd0849ed1, 0xa88c, 0x4ba6, { 0xb1, 0xd6, 0xab, 0x50, 0xe2, 0x80, 0xb7, 0xa9 }}\r
\r
  ## Include/Guid/UserIdentifyManagerHii.h\r
  gUserIdentifyManagerGuid           = { 0x3ccd3dd8, 0x8d45, 0x4fed, { 0x96, 0x2d, 0x2b, 0x38, 0xcd, 0x82, 0xb3, 0xc4 }}\r
\r
  ## Include/Guid/UserProfileManagerHii.h\r
  gUserProfileManagerGuid            = { 0xc35f272c, 0x97c2, 0x465a, { 0xa2, 0x16, 0x69, 0x6b, 0x66, 0x8a, 0x8c, 0xfe }}\r
\r
  ## Include/Guid/TcgConfigHii.h\r
  gTcgConfigFormSetGuid              = { 0xb0f901e4, 0xc424, 0x45de, { 0x90, 0x81, 0x95, 0xe2, 0xb, 0xde, 0x6f, 0xb5 }}\r
  \r
  ## Include/Guid/SecureBootConfigHii.h\r
  gSecureBootConfigFormSetGuid       = { 0x5daf50a5, 0xea81, 0x4de2, {0x8f, 0x9b, 0xca, 0xbd, 0xa9, 0xcf, 0x5c, 0x14}}\r
                                      \r
[Ppis]\r
  ## Include/Ppi/LockPhysicalPresence.h\r
  gPeiLockPhysicalPresencePpiGuid    = { 0xef9aefe5, 0x2bd3, 0x4031, { 0xaf, 0x7d, 0x5e, 0xfe, 0x5a, 0xbb, 0x9a, 0xd } }\r
\r
  ## Include/Ppi/TpmInitialized.h\r
  gPeiTpmInitializedPpiGuid      = { 0xe9db0d58, 0xd48d, 0x47f6, { 0x9c, 0x6e, 0x6f, 0x40, 0xe8, 0x6c, 0x7b, 0x41 }}\r
\r
[PcdsFixedAtBuild]\r
  ## Pcd for OptionRom.\r
  #  Image verification policy settings:\r
  #  ALWAYS_EXECUTE                         0x00000000\r
  #  NEVER_EXECUTE                          0x00000001\r
  #  ALLOW_EXECUTE_ON_SECURITY_VIOLATION    0x00000002\r
  #  DEFER_EXECUTE_ON_SECURITY_VIOLATION    0x00000003\r
  #  DENY_EXECUTE_ON_SECURITY_VIOLATION     0x00000004\r
  #  QUERY_USER_ON_SECURITY_VIOLATION       0x00000005 \r
  gEfiSecurityPkgTokenSpaceGuid.PcdOptionRomImageVerificationPolicy|0x00|UINT32|0x00000001\r
  \r
  ## Pcd for removable media.\r
  #  Removable media include CD-ROM, Floppy, USB and network.\r
  #  Image verification policy settings:\r
  #  ALWAYS_EXECUTE                         0x00000000\r
  #  NEVER_EXECUTE                          0x00000001\r
  #  ALLOW_EXECUTE_ON_SECURITY_VIOLATION    0x00000002\r
  #  DEFER_EXECUTE_ON_SECURITY_VIOLATION    0x00000003\r
  #  DENY_EXECUTE_ON_SECURITY_VIOLATION     0x00000004\r
  #  QUERY_USER_ON_SECURITY_VIOLATION       0x00000005\r
  gEfiSecurityPkgTokenSpaceGuid.PcdRemovableMediaImageVerificationPolicy|0x05|UINT32|0x00000002\r
  \r
  ## Pcd for fixed media.\r
  #  Fixed media include hard disk.\r
  #  Image verification policy settings:\r
  #  ALWAYS_EXECUTE                         0x00000000\r
  #  NEVER_EXECUTE                          0x00000001\r
  #  ALLOW_EXECUTE_ON_SECURITY_VIOLATION    0x00000002\r
  #  DEFER_EXECUTE_ON_SECURITY_VIOLATION    0x00000003\r
  #  DENY_EXECUTE_ON_SECURITY_VIOLATION     0x00000004\r
  #  QUERY_USER_ON_SECURITY_VIOLATION       0x00000005  \r
  gEfiSecurityPkgTokenSpaceGuid.PcdFixedMediaImageVerificationPolicy|0x05|UINT32|0x00000003\r
  \r
  ## Defer Image Load policy settings.\r
  #  The policy is bitwise. \r
  #  If bit is set, the image from corresponding device will be trust when loading.\r
  #\r
  # IMAGE_UNKNOWN                         0x00000001\r
  # IMAGE_FROM_FV                         0x00000002\r
  # IMAGE_FROM_OPTION_ROM                 0x00000004\r
  # IMAGE_FROM_REMOVABLE_MEDIA            0x00000008\r
  # IMAGE_FROM_FIXED_MEDIA                0x00000010\r
  gEfiSecurityPkgTokenSpaceGuid.PcdDeferImageLoadPolicy|0x0000001F|UINT32|0x0000004\r
  \r
  ## The token file name used to save credential in USB credential provider driver.\r
  #  The specified file should be saved at the root directory of USB storage disk.\r
  gEfiSecurityPkgTokenSpaceGuid.PcdFixedUsbCredentialProviderTokenFileName|L"Token.bin"|VOID*|0x00000005\r
\r
  ## The size of Append variable buffer. This buffer is reserved for runtime use, OS can append data into one existing variable.\r
  gEfiSecurityPkgTokenSpaceGuid.PcdMaxAppendVariableSize|0x2000|UINT32|0x30000005  \r
\r
  ## This PCD specifies the type of TCG platform that contains TPM chip. \r
  #  This PCD is only avaiable when PcdTpmPhysicalPresence is TRUE.\r
  #  If 0, TCG platform type is PC client.\r
  #  If 1, TCG platform type is server.\r
  gEfiSecurityPkgTokenSpaceGuid.PcdTpmPlatformClass|0|UINT8|0x00000006\r
\r
  ## The PCD is used to control whether to support hiding the TPM.\r
  #  If TRUE, PcdHideTpm controls whether to hide the TPM.\r
  gEfiSecurityPkgTokenSpaceGuid.PcdHideTpmSupport|FALSE|BOOLEAN|0x00000007\r
  \r
[PcdsDynamic, PcdsDynamicEx]\r
  ## The PCD is used to control whether to hide the TPM.\r
  gEfiSecurityPkgTokenSpaceGuid.PcdHideTpm|FALSE|BOOLEAN|0x00010002\r
\r
  ## The PCD is used to specify whether or not MOR (MemoryOverwriteControl) feature is enabled.\r
  gEfiSecurityPkgTokenSpaceGuid.PcdMorEnable|FALSE|BOOLEAN|0x00010000\r
\r
[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]\r
  ## This PCD indicates the presence or absence of the platform operator.\r
  gEfiSecurityPkgTokenSpaceGuid.PcdTpmPhysicalPresence|TRUE|BOOLEAN|0x00010001\r
\r
Commit	Line	Data
	1	## @file SecurityPkg.dec\r
	2	# This package includes the security drivers, defintions(including PPIs/PROTOCOLs/GUIDs \r
	3	# and library classes) and libraries instances.\r
	4	#\r
	5	# Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>\r
	6	# This program and the accompanying materials are licensed and made available under\r
	7	# the terms and conditions of the BSD License which accompanies this distribution.\r
	8	# The full text of the license may be found at\r
	9	# http://opensource.org/licenses/bsd-license.php\r
	10	#\r
	11	# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	#\r
	14	##\r
	15	\r
	16	[Defines]\r
	17	DEC_SPECIFICATION = 0x00010005\r
	18	PACKAGE_NAME = SecurityPkg\r
	19	PACKAGE_GUID = 24369CAC-6AA6-4fb8-88DB-90BF061668AD\r
	20	PACKAGE_VERSION = 0.92\r
	21	\r
	22	[Includes]\r
	23	Include\r
	24	\r
	25	[LibraryClasses]\r
	26	## @libraryclass Definitions for common TPM commands as library API for TPM\r
	27	# module use.\r
	28	TpmCommLib\|Include/Library/TpmCommLib.h\r
	29	\r
	30	[Guids]\r
	31	## Security package token space guid\r
	32	# Include/Guid/SecurityPkgTokenSpace.h\r
	33	gEfiSecurityPkgTokenSpaceGuid = { 0xd3fb176, 0x9569, 0x4d51, { 0xa3, 0xef, 0x7d, 0x61, 0xc6, 0x4f, 0xea, 0xba }}\r
	34	## Guid acted as the authenticated variable store header's signature, and to specify the variable list entries put in the EFI system table.\r
	35	# Include/Guid/AuthenticatedVariableFormat.h\r
	36	gEfiAuthenticatedVariableGuid = { 0xaaf32c78, 0x947b, 0x439a, { 0xa1, 0x80, 0x2e, 0x14, 0x4e, 0xc3, 0x77, 0x92 } }\r
	37	\r
	38	# Include/Guid/AuthenticatedVariableFormat.h\r
	39	gEfiSecureBootEnableDisableGuid = { 0xf0a30bc7, 0xaf08, 0x4556, { 0x99, 0xc4, 0x0, 0x10, 0x9, 0xc9, 0x3a, 0x44 } }\r
	40	\r
	41	# Include/Guid/AuthenticatedVariableFormat.h\r
	42	gEfiCustomModeEnableGuid = { 0xc076ec0c, 0x7028, 0x4399, { 0xa0, 0x72, 0x71, 0xee, 0x5c, 0x44, 0x8b, 0x9f } }\r
	43	\r
	44	# Include/Guid/AuthenticatedVariableFormat.h\r
	45	gEfiCertDbGuid = { 0xd9bee56e, 0x75dc, 0x49d9, { 0xb4, 0xd7, 0xb5, 0x34, 0x21, 0xf, 0x63, 0x7a } }\r
	46	\r
	47	## Include/Guid/TcgEventHob.h\r
	48	gTcgEventEntryHobGuid = { 0x2e3044ac, 0x879f, 0x490f, {0x97, 0x60, 0xbb, 0xdf, 0xaf, 0x69, 0x5f, 0x50 }}\r
	49	\r
	50	## Include/Guid/PhysicalPresenceData.h\r
	51	gEfiPhysicalPresenceGuid = { 0xf6499b1, 0xe9ad, 0x493d, { 0xb9, 0xc2, 0x2f, 0x90, 0x81, 0x5c, 0x6c, 0xbc }}\r
	52	\r
	53	## Include/Guid/PwdCredentialProviderHii.h\r
	54	gPwdCredentialProviderGuid = { 0x78b9ec8b, 0xc000, 0x46c5, { 0xac, 0x93, 0x24, 0xa0, 0xc1, 0xbb, 0x0, 0xce }}\r
	55	\r
	56	## Include/Guid/UsbCredentialProviderHii.h\r
	57	gUsbCredentialProviderGuid = { 0xd0849ed1, 0xa88c, 0x4ba6, { 0xb1, 0xd6, 0xab, 0x50, 0xe2, 0x80, 0xb7, 0xa9 }}\r
	58	\r
	59	## Include/Guid/UserIdentifyManagerHii.h\r
	60	gUserIdentifyManagerGuid = { 0x3ccd3dd8, 0x8d45, 0x4fed, { 0x96, 0x2d, 0x2b, 0x38, 0xcd, 0x82, 0xb3, 0xc4 }}\r
	61	\r
	62	## Include/Guid/UserProfileManagerHii.h\r
	63	gUserProfileManagerGuid = { 0xc35f272c, 0x97c2, 0x465a, { 0xa2, 0x16, 0x69, 0x6b, 0x66, 0x8a, 0x8c, 0xfe }}\r
	64	\r
	65	## Include/Guid/TcgConfigHii.h\r
	66	gTcgConfigFormSetGuid = { 0xb0f901e4, 0xc424, 0x45de, { 0x90, 0x81, 0x95, 0xe2, 0xb, 0xde, 0x6f, 0xb5 }}\r
	67	\r
	68	## Include/Guid/SecureBootConfigHii.h\r
	69	gSecureBootConfigFormSetGuid = { 0x5daf50a5, 0xea81, 0x4de2, {0x8f, 0x9b, 0xca, 0xbd, 0xa9, 0xcf, 0x5c, 0x14}}\r
	70	\r
	71	[Ppis]\r
	72	## Include/Ppi/LockPhysicalPresence.h\r
	73	gPeiLockPhysicalPresencePpiGuid = { 0xef9aefe5, 0x2bd3, 0x4031, { 0xaf, 0x7d, 0x5e, 0xfe, 0x5a, 0xbb, 0x9a, 0xd } }\r
	74	\r
	75	## Include/Ppi/TpmInitialized.h\r
	76	gPeiTpmInitializedPpiGuid = { 0xe9db0d58, 0xd48d, 0x47f6, { 0x9c, 0x6e, 0x6f, 0x40, 0xe8, 0x6c, 0x7b, 0x41 }}\r
	77	\r
	78	[PcdsFixedAtBuild]\r
	79	## Pcd for OptionRom.\r
	80	# Image verification policy settings:\r
	81	# ALWAYS_EXECUTE 0x00000000\r
	82	# NEVER_EXECUTE 0x00000001\r
	83	# ALLOW_EXECUTE_ON_SECURITY_VIOLATION 0x00000002\r
	84	# DEFER_EXECUTE_ON_SECURITY_VIOLATION 0x00000003\r
	85	# DENY_EXECUTE_ON_SECURITY_VIOLATION 0x00000004\r
	86	# QUERY_USER_ON_SECURITY_VIOLATION 0x00000005 \r
	87	gEfiSecurityPkgTokenSpaceGuid.PcdOptionRomImageVerificationPolicy\|0x00\|UINT32\|0x00000001\r
	88	\r
	89	## Pcd for removable media.\r
	90	# Removable media include CD-ROM, Floppy, USB and network.\r
	91	# Image verification policy settings:\r
	92	# ALWAYS_EXECUTE 0x00000000\r
	93	# NEVER_EXECUTE 0x00000001\r
	94	# ALLOW_EXECUTE_ON_SECURITY_VIOLATION 0x00000002\r
	95	# DEFER_EXECUTE_ON_SECURITY_VIOLATION 0x00000003\r
	96	# DENY_EXECUTE_ON_SECURITY_VIOLATION 0x00000004\r
	97	# QUERY_USER_ON_SECURITY_VIOLATION 0x00000005\r
	98	gEfiSecurityPkgTokenSpaceGuid.PcdRemovableMediaImageVerificationPolicy\|0x05\|UINT32\|0x00000002\r
	99	\r
	100	## Pcd for fixed media.\r
	101	# Fixed media include hard disk.\r
	102	# Image verification policy settings:\r
	103	# ALWAYS_EXECUTE 0x00000000\r
	104	# NEVER_EXECUTE 0x00000001\r
	105	# ALLOW_EXECUTE_ON_SECURITY_VIOLATION 0x00000002\r
	106	# DEFER_EXECUTE_ON_SECURITY_VIOLATION 0x00000003\r
	107	# DENY_EXECUTE_ON_SECURITY_VIOLATION 0x00000004\r
	108	# QUERY_USER_ON_SECURITY_VIOLATION 0x00000005 \r
	109	gEfiSecurityPkgTokenSpaceGuid.PcdFixedMediaImageVerificationPolicy\|0x05\|UINT32\|0x00000003\r
	110	\r
	111	## Defer Image Load policy settings.\r
	112	# The policy is bitwise. \r
	113	# If bit is set, the image from corresponding device will be trust when loading.\r
	114	#\r
	115	# IMAGE_UNKNOWN 0x00000001\r
	116	# IMAGE_FROM_FV 0x00000002\r
	117	# IMAGE_FROM_OPTION_ROM 0x00000004\r
	118	# IMAGE_FROM_REMOVABLE_MEDIA 0x00000008\r
	119	# IMAGE_FROM_FIXED_MEDIA 0x00000010\r
	120	gEfiSecurityPkgTokenSpaceGuid.PcdDeferImageLoadPolicy\|0x0000001F\|UINT32\|0x0000004\r
	121	\r
	122	## The token file name used to save credential in USB credential provider driver.\r
	123	# The specified file should be saved at the root directory of USB storage disk.\r
	124	gEfiSecurityPkgTokenSpaceGuid.PcdFixedUsbCredentialProviderTokenFileName\|L"Token.bin"\|VOID*\|0x00000005\r
	125	\r
	126	## The size of Append variable buffer. This buffer is reserved for runtime use, OS can append data into one existing variable.\r
	127	gEfiSecurityPkgTokenSpaceGuid.PcdMaxAppendVariableSize\|0x2000\|UINT32\|0x30000005 \r
	128	\r
	129	## This PCD specifies the type of TCG platform that contains TPM chip. \r
	130	# This PCD is only avaiable when PcdTpmPhysicalPresence is TRUE.\r
	131	# If 0, TCG platform type is PC client.\r
	132	# If 1, TCG platform type is server.\r
	133	gEfiSecurityPkgTokenSpaceGuid.PcdTpmPlatformClass\|0\|UINT8\|0x00000006\r
	134	\r
	135	## The PCD is used to control whether to support hiding the TPM.\r
	136	# If TRUE, PcdHideTpm controls whether to hide the TPM.\r
	137	gEfiSecurityPkgTokenSpaceGuid.PcdHideTpmSupport\|FALSE\|BOOLEAN\|0x00000007\r
	138	\r
	139	[PcdsDynamic, PcdsDynamicEx]\r
	140	## The PCD is used to control whether to hide the TPM.\r
	141	gEfiSecurityPkgTokenSpaceGuid.PcdHideTpm\|FALSE\|BOOLEAN\|0x00010002\r
	142	\r
	143	## The PCD is used to specify whether or not MOR (MemoryOverwriteControl) feature is enabled.\r
	144	gEfiSecurityPkgTokenSpaceGuid.PcdMorEnable\|FALSE\|BOOLEAN\|0x00010000\r
	145	\r
	146	[PcdsFixedAtBuild, PcdsPatchableInModule, PcdsDynamic, PcdsDynamicEx]\r
	147	## This PCD indicates the presence or absence of the platform operator.\r
	148	gEfiSecurityPkgTokenSpaceGuid.PcdTpmPhysicalPresence\|TRUE\|BOOLEAN\|0x00010001\r
	149	\r