[mirror_edk2.git] / CryptoPkg / CryptoPkg.dec

## @file\r
#  Package for cryptography modules.\r
#\r
#  This Package provides cryptographic-related libraries for UEFI security modules.\r
#  It also provides a test application to test libraries.\r
#\r
#  Copyright (c) 2009 - 2020, Intel Corporation. All rights reserved.<BR>\r
#  SPDX-License-Identifier: BSD-2-Clause-Patent\r
#\r
##\r
\r
[Defines]\r
  DEC_SPECIFICATION              = 0x00010005\r
  PACKAGE_NAME                   = CryptoPkg\r
  PACKAGE_UNI_FILE               = CryptoPkg.uni\r
  PACKAGE_GUID                   = 36470E80-36F2-4ba0-8CC8-937C7D9FF888\r
  PACKAGE_VERSION                = 0.98\r
\r
[Includes]\r
  Include\r
\r
[Includes.Common.Private]\r
  Private\r
  Library/Include\r
  Library/OpensslLib/openssl/include\r
\r
[LibraryClasses]\r
  ##  @libraryclass  Provides basic library functions for cryptographic primitives.\r
  ##\r
  BaseCryptLib|Include/Library/BaseCryptLib.h\r
\r
  ##  @libraryclass  Provides TLS library functions for EFI TLS protocol.\r
  ##\r
  TlsLib|Include/Library/TlsLib.h\r
\r
  ##  @libraryclass  Provides Unified API for different hash implementations.\r
  #\r
  HashApiLib|Include/Library/HashApiLib.h\r
\r
[LibraryClasses.common.Private]\r
  ##  @libraryclass  Provides library functions from the openssl project.\r
  #\r
  OpensslLib|Private/Library/OpensslLib.h\r
\r
  ##  @libraryclass  Provides compiler intrinsic functions required to link openssl project.\r
  #\r
  InstrinsicLib|Private/Library/IntrinsicLib.h\r
\r
[Protocols]\r
  ## EDK II Crypto DXE protocol\r
  # 2C2275C9-3A7B-426F-BE54-2D22BD9D1092\r
  gEdkiiCryptoProtocolGuid =  { 0x2C2275C9, 0x3A7B, 0x426F, { 0xBE, 0x54, 0x2D, 0x22, 0xBD, 0x9D, 0x10, 0x92 }}\r
\r
  ## EDK II Crypto SMM protocol\r
  # F46B2EB2-E0D7-4C96-A3B1-CB7C572EB300\r
  gEdkiiSmmCryptoProtocolGuid =  { 0xF46B2EB2, 0xE0D7, 0x4C96, { 0xA3, 0xB1, 0xc, 0x61, 0xbb, 0x24, 0x5c, 0x42 }}\r
\r
[Ppis]\r
  ## EDK II Crypto PPI\r
  # 7DCE671B-C223-446A-A705-ED637AAF6771\r
  gEdkiiCryptoPpiGuid =  { 0x7DCE671B, 0xC223, 0x446A, { 0xA7, 0x05, 0xED, 0x63, 0x7A, 0xAF, 0x67, 0x71 }}\r
\r
[Guids]\r
  ## Crypto package token space guid.\r
  gEfiCryptoPkgTokenSpaceGuid      = { 0x6bd7de60, 0x9ef7, 0x4899, { 0x97, 0xd0, 0xab, 0xff, 0xfd, 0xe9, 0x70, 0xf2 } }\r
\r
[PcdsFixedAtBuild]\r
  ## Enable/Disable the families and individual services produced by the\r
  #  EDK II Crypto Protocols/PPIs.  The default is all services disabled.\r
  #  This Structured PCD is associated with PCD_CRYPTO_SERVICE_FAMILY_ENABLE\r
  #  structure that is defined in Include/Pcd/PcdCryptoServiceFamilyEnable.h.\r
  # @Prompt Enable/Disable EDK II Crypto Protocol/PPI services\r
  gEfiCryptoPkgTokenSpaceGuid.PcdCryptoServiceFamilyEnable|{0x00}|PCD_CRYPTO_SERVICE_FAMILY_ENABLE|0x00000002 {\r
    <Packages>\r
      CryptoPkg/CryptoPkg.dec\r
    <HeaderFiles>\r
      Pcd/PcdCryptoServiceFamilyEnable.h\r
  }\r
\r
  ## This PCD indicates the HASH algorithm to calculate hash of data\r
  #  Based on the value set, the required algorithm is chosen to calculate\r
  #  the hash of data.<BR>\r
  #  The default hashing algorithm for BaseHashApiLib is set to SHA256.<BR>\r
  #     0x00000001    - HASH_ALG_SHA1.<BR>\r
  #     0x00000002    - HASH_ALG_SHA256.<BR>\r
  #     0x00000004    - HASH_ALG_SHA384.<BR>\r
  #     0x00000008    - HASH_ALG_SHA512.<BR>\r
  #     0x00000010    - HASH_ALG_SM3_256.<BR>\r
  # @Prompt Set policy for hashing unsigned image for Secure Boot.\r
  # @ValidList 0x80000001 | 0x00000001, 0x00000002, 0x00000004, 0x00000008, 0x00000010\r
  gEfiCryptoPkgTokenSpaceGuid.PcdHashApiLibPolicy|0x00000002|UINT32|0x00000001\r
\r
[UserExtensions.TianoCore."ExtraFiles"]\r
  CryptoPkgExtra.uni\r
Commit	Line	Data
97f98500 HT	1	## @file\r
	2	# Package for cryptography modules.\r
	3	#\r
7a2f2ec3 DG	4	# This Package provides cryptographic-related libraries for UEFI security modules.\r
7a2f2ec3 DG	5	# It also provides a test application to test libraries.\r
97f98500	6	#\r
2c061de0	7	# Copyright (c) 2009 - 2020, Intel Corporation. All rights reserved.<BR>\r
2009f6b4	8	# SPDX-License-Identifier: BSD-2-Clause-Patent\r
2c867744	9	#\r
97f98500 HT	10	##\r
97f98500 HT	11	\r
97f98500 HT	12	[Defines]\r
	13	DEC_SPECIFICATION = 0x00010005\r
	14	PACKAGE_NAME = CryptoPkg\r
7a2f2ec3	15	PACKAGE_UNI_FILE = CryptoPkg.uni\r
97f98500	16	PACKAGE_GUID = 36470E80-36F2-4ba0-8CC8-937C7D9FF888\r
cd9349ac	17	PACKAGE_VERSION = 0.98\r
97f98500 HT	18	\r
	19	[Includes]\r
	20	Include\r
abc4c817 LQ	21	\r
abc4c817 LQ	22	[Includes.Common.Private]\r
3b0e0430	23	Private\r
abc4c817	24	Library/Include\r
2c867744	25	Library/OpensslLib/openssl/include\r
97f98500 HT	26	\r
	27	[LibraryClasses]\r
	28	## @libraryclass Provides basic library functions for cryptographic primitives.\r
	29	##\r
	30	BaseCryptLib\|Include/Library/BaseCryptLib.h\r
	31	\r
9396cdfe JW	32	## @libraryclass Provides TLS library functions for EFI TLS protocol.\r
	33	##\r
	34	TlsLib\|Include/Library/TlsLib.h\r
	35	\r
3feea54e AS	36	## @libraryclass Provides Unified API for different hash implementations.\r
	37	#\r
	38	HashApiLib\|Include/Library/HashApiLib.h\r
	39	\r
e75951ca MK	40	[LibraryClasses.common.Private]\r
	41	## @libraryclass Provides library functions from the openssl project.\r
	42	#\r
	43	OpensslLib\|Private/Library/OpensslLib.h\r
	44	\r
	45	## @libraryclass Provides compiler intrinsic functions required to link openssl project.\r
	46	#\r
	47	InstrinsicLib\|Private/Library/IntrinsicLib.h\r
	48	\r
3b0e0430 MK	49	[Protocols]\r
	50	## EDK II Crypto DXE protocol\r
	51	# 2C2275C9-3A7B-426F-BE54-2D22BD9D1092\r
	52	gEdkiiCryptoProtocolGuid = { 0x2C2275C9, 0x3A7B, 0x426F, { 0xBE, 0x54, 0x2D, 0x22, 0xBD, 0x9D, 0x10, 0x92 }}\r
	53	\r
	54	## EDK II Crypto SMM protocol\r
	55	# F46B2EB2-E0D7-4C96-A3B1-CB7C572EB300\r
	56	gEdkiiSmmCryptoProtocolGuid = { 0xF46B2EB2, 0xE0D7, 0x4C96, { 0xA3, 0xB1, 0xc, 0x61, 0xbb, 0x24, 0x5c, 0x42 }}\r
	57	\r
	58	[Ppis]\r
	59	## EDK II Crypto PPI\r
	60	# 7DCE671B-C223-446A-A705-ED637AAF6771\r
	61	gEdkiiCryptoPpiGuid = { 0x7DCE671B, 0xC223, 0x446A, { 0xA7, 0x05, 0xED, 0x63, 0x7A, 0xAF, 0x67, 0x71 }}\r
	62	\r
2c061de0 AS	63	[Guids]\r
	64	## Crypto package token space guid.\r
	65	gEfiCryptoPkgTokenSpaceGuid = { 0x6bd7de60, 0x9ef7, 0x4899, { 0x97, 0xd0, 0xab, 0xff, 0xfd, 0xe9, 0x70, 0xf2 } }\r
	66	\r
3b0e0430 MK	67	[PcdsFixedAtBuild]\r
	68	## Enable/Disable the families and individual services produced by the\r
	69	# EDK II Crypto Protocols/PPIs. The default is all services disabled.\r
	70	# This Structured PCD is associated with PCD_CRYPTO_SERVICE_FAMILY_ENABLE\r
	71	# structure that is defined in Include/Pcd/PcdCryptoServiceFamilyEnable.h.\r
	72	# @Prompt Enable/Disable EDK II Crypto Protocol/PPI services\r
	73	gEfiCryptoPkgTokenSpaceGuid.PcdCryptoServiceFamilyEnable\|{0x00}\|PCD_CRYPTO_SERVICE_FAMILY_ENABLE\|0x00000002 {\r
	74	<Packages>\r
	75	CryptoPkg/CryptoPkg.dec\r
	76	<HeaderFiles>\r
	77	Pcd/PcdCryptoServiceFamilyEnable.h\r
	78	}\r
	79	\r
3feea54e AS	80	## This PCD indicates the HASH algorithm to calculate hash of data\r
	81	# Based on the value set, the required algorithm is chosen to calculate\r
	82	# the hash of data.<BR>\r
	83	# The default hashing algorithm for BaseHashApiLib is set to SHA256.<BR>\r
c70bdf9d AS	84	# 0x00000001 - HASH_ALG_SHA1.<BR>\r
	85	# 0x00000002 - HASH_ALG_SHA256.<BR>\r
	86	# 0x00000004 - HASH_ALG_SHA384.<BR>\r
	87	# 0x00000008 - HASH_ALG_SHA512.<BR>\r
	88	# 0x00000010 - HASH_ALG_SM3_256.<BR>\r
3feea54e	89	# @Prompt Set policy for hashing unsigned image for Secure Boot.\r
c70bdf9d AS	90	# @ValidList 0x80000001 \| 0x00000001, 0x00000002, 0x00000004, 0x00000008, 0x00000010\r
c70bdf9d AS	91	gEfiCryptoPkgTokenSpaceGuid.PcdHashApiLibPolicy\|0x00000002\|UINT32\|0x00000001\r
3feea54e	92	\r
7a2f2ec3 DG	93	[UserExtensions.TianoCore."ExtraFiles"]\r
7a2f2ec3 DG	94	CryptoPkgExtra.uni\r