CryptoPkg/CryptoPkg.dec

   1 ## @file
   2 #  Package for cryptography modules.
   3 #
   4 #  This Package provides cryptographic-related libraries for UEFI security modules.
   5 #  It also provides a test application to test libraries.
   6 #
   7 #  Copyright (c) 2009 - 2020, Intel Corporation. All rights reserved.<BR>
   8 #  SPDX-License-Identifier: BSD-2-Clause-Patent
   9 #
  10 ##
  11
  12 [Defines]
  13   DEC_SPECIFICATION              = 0x00010005
  14   PACKAGE_NAME                   = CryptoPkg
  15   PACKAGE_UNI_FILE               = CryptoPkg.uni
  16   PACKAGE_GUID                   = 36470E80-36F2-4ba0-8CC8-937C7D9FF888
  17   PACKAGE_VERSION                = 0.98
  18
  19 [Includes]
  20   Include
  21
  22 [Includes.Common.Private]
  23   Private
  24   Library/Include
  25   Library/OpensslLib/openssl/include
  26
  27 [LibraryClasses]
  28   ##  @libraryclass  Provides basic library functions for cryptographic primitives.
  29   ##
  30   BaseCryptLib|Include/Library/BaseCryptLib.h
  31
  32   ##  @libraryclass  Provides TLS library functions for EFI TLS protocol.
  33   ##
  34   TlsLib|Include/Library/TlsLib.h
  35
  36   ##  @libraryclass  Provides Unified API for different hash implementations.
  37   #
  38   HashApiLib|Include/Library/HashApiLib.h
  39
  40 [LibraryClasses.common.Private]
  41   ##  @libraryclass  Provides library functions from the openssl project.
  42   #
  43   OpensslLib|Private/Library/OpensslLib.h
  44
  45   ##  @libraryclass  Provides compiler intrinsic functions required to link openssl project.
  46   #
  47   InstrinsicLib|Private/Library/IntrinsicLib.h
  48
  49 [Protocols]
  50   ## EDK II Crypto DXE protocol
  51   # 2C2275C9-3A7B-426F-BE54-2D22BD9D1092
  52   gEdkiiCryptoProtocolGuid =  { 0x2C2275C9, 0x3A7B, 0x426F, { 0xBE, 0x54, 0x2D, 0x22, 0xBD, 0x9D, 0x10, 0x92 }}
  53
  54   ## EDK II Crypto SMM protocol
  55   # F46B2EB2-E0D7-4C96-A3B1-CB7C572EB300
  56   gEdkiiSmmCryptoProtocolGuid =  { 0xF46B2EB2, 0xE0D7, 0x4C96, { 0xA3, 0xB1, 0xc, 0x61, 0xbb, 0x24, 0x5c, 0x42 }}
  57
  58 [Ppis]
  59   ## EDK II Crypto PPI
  60   # 7DCE671B-C223-446A-A705-ED637AAF6771
  61   gEdkiiCryptoPpiGuid =  { 0x7DCE671B, 0xC223, 0x446A, { 0xA7, 0x05, 0xED, 0x63, 0x7A, 0xAF, 0x67, 0x71 }}
  62
  63 [Guids]
  64   ## Crypto package token space guid.
  65   gEfiCryptoPkgTokenSpaceGuid      = { 0x6bd7de60, 0x9ef7, 0x4899, { 0x97, 0xd0, 0xab, 0xff, 0xfd, 0xe9, 0x70, 0xf2 } }
  66
  67 [PcdsFixedAtBuild]
  68   ## Enable/Disable the families and individual services produced by the
  69   #  EDK II Crypto Protocols/PPIs.  The default is all services disabled.
  70   #  This Structured PCD is associated with PCD_CRYPTO_SERVICE_FAMILY_ENABLE
  71   #  structure that is defined in Include/Pcd/PcdCryptoServiceFamilyEnable.h.
  72   # @Prompt Enable/Disable EDK II Crypto Protocol/PPI services
  73   gEfiCryptoPkgTokenSpaceGuid.PcdCryptoServiceFamilyEnable|{0x00}|PCD_CRYPTO_SERVICE_FAMILY_ENABLE|0x00000002 {
  74     <Packages>
  75       CryptoPkg/CryptoPkg.dec
  76     <HeaderFiles>
  77       Pcd/PcdCryptoServiceFamilyEnable.h
  78   }
  79
  80   ## This PCD indicates the HASH algorithm to calculate hash of data
  81   #  Based on the value set, the required algorithm is chosen to calculate
  82   #  the hash of data.<BR>
  83   #  The default hashing algorithm for BaseHashApiLib is set to SHA256.<BR>
  84   #     0x00000001    - HASH_ALG_SHA1.<BR>
  85   #     0x00000002    - HASH_ALG_SHA256.<BR>
  86   #     0x00000004    - HASH_ALG_SHA384.<BR>
  87   #     0x00000008    - HASH_ALG_SHA512.<BR>
  88   #     0x00000010    - HASH_ALG_SM3_256.<BR>
  89   # @Prompt Set policy for hashing unsigned image for Secure Boot.
  90   # @ValidList 0x80000001 | 0x00000001, 0x00000002, 0x00000004, 0x00000008, 0x00000010
  91   gEfiCryptoPkgTokenSpaceGuid.PcdHashApiLibPolicy|0x00000002|UINT32|0x00000001
  92
  93   ## Enable/Disable the ECC feature in openssl library. The default is disabled.
  94   #  If ECC feature is disabled, all related source files will not be compiled.
  95   # @Prompt Enable/Disable ECC feature in openssl library
  96   gEfiCryptoPkgTokenSpaceGuid.PcdOpensslEcEnabled|FALSE|BOOLEAN|0x0000003
  97   # Set it to TRUE if:
  98   # 1) Platform needs ECC in TLS, or asymmetric cryptography services such as
  99   #    X509 certificate or PEM format data processing.
 100   # 2) Platform needs to enable PcdCryptoServiceFamilyEnable.Ec service.
 101   # Please note:
 102   # ECC feature will cause a significant memory increase, approximate memory impact
 103   # in below table for reference by platform developers with FW size limitations.
 104   #                                   Uncompressed      LZMA Compressed
 105   # CPU   CRYPTO_SERVICES    Module  EC=FALSE  EC=TRUE  EC=FALSE  EC=TRUE  Increase
 106   # ====  ===============  ========  ========  =======  ========  =======  ========
 107   # IA32  NONE             CryptoPei    21536    21568                         0 KB
 108   # IA32  NONE             CryptoDxe    21632    21696                         0 KB
 109   # IA32  NONE             CryptoSmm    22976    23072                         0 KB
 110   # IA32  MIN_PEI          CryptoPei   248992   249120                         0 KB
 111   # IA32  MIN_DXE_MIN_SMM  CryptoDxe   636672   829568    288520   401034    113 KB
 112   # IA32  MIN_DXE_MIN_SMM  CryptoSmm   426048   601472    191517   296022    105 KB
 113   # IA32  ALL              CryptoPei   423840   598976    189047   293759    104 KB
 114   # IA32  ALL              CryptoDxe   645280   838144    292955   405277    113 KB
 115   # IA32  ALL              CryptoSmm   441888   617184    198779   303628    105 KB
 116   # X64   NONE             CryptoPei    29632    29664                         0 KB
 117   # X64   NONE             CryptoDxe    29792    29792                         0 KB
 118   # X64   NONE             CryptoSmm    31296    31296                         0 KB
 119   # X64   MIN_PEI          CryptoPei   310784   310848                         0 KB
 120   # X64   MIN_DXE_MIN_SMM  CryptoDxe   804288  1016256    311436   426596    115 KB
 121   # X64   MIN_DXE_MIN_SMM  CryptoSmm   543776   733920    204483   310775    106 KB
 122   # X64   ALL              CryptoPei   540384   730240    202494   308467    106 KB
 123   # X64   ALL              CryptoDxe   815392  1027296    316228   431321    115 KB
 124   # X64   ALL              CryptoSmm   563648   753696    213488   319644    106 KB
 125
 126 [UserExtensions.TianoCore."ExtraFiles"]
 127   CryptoPkgExtra.uni