SecurityPkg/VariableAuthenticated/RuntimeDxe/VariableSmm.inf

   1 ## @file
   2 #  Provides SMM authenticated variable service
   3 #
   4 #  This module installs SMM variable protocol into SMM protocol database,
   5 #  which can be used by SMM driver, and installs SMM variable protocol
   6 #  into BS protocol database, which can be used to notify the SMM Runtime
   7 #  Dxe driver that the SMM variable service is ready.
   8 #  This module should be used with SMM Runtime DXE module together. The
   9 #  SMM Runtime DXE module installs variable arch protocol and variable
  10 #  write arch protocol based on SMM variable module.
  11 #
  12 #  Caution: This module requires additional review when modified.
  13 #  This driver will have external input - variable data and communicate buffer in SMM mode.
  14 #  This external input must be validated carefully to avoid security issues such as
  15 #  buffer overflow or integer overflow.
  16 #    The whole SMM authentication variable design relies on the integrity of flash part and SMM.
  17 #  which is assumed to be protected by platform.  All variable code and metadata in flash/SMM Memory
  18 #  may not be modified without authorization. If platform fails to protect these resources,
  19 #  the authentication service provided in this driver will be broken, and the behavior is undefined.
  20 #
  21 # Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>
  22 # This program and the accompanying materials
  23 # are licensed and made available under the terms and conditions of the BSD License
  24 # which accompanies this distribution. The full text of the license may be found at
  25 # http://opensource.org/licenses/bsd-license.php
  26 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  27 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  28 #
  29 ##
  30
  31 [Defines]
  32   INF_VERSION                    = 0x00010005
  33   BASE_NAME                      = VariableAuthSmm
  34   MODULE_UNI_FILE                = VariableAuthSmm.uni
  35   FILE_GUID                      = D34BDC5E-968A-40f5-A48C-E594F45AE211
  36   MODULE_TYPE                    = DXE_SMM_DRIVER
  37   VERSION_STRING                 = 1.0
  38   PI_SPECIFICATION_VERSION       = 0x0001000A
  39   ENTRY_POINT                    = VariableServiceInitialize
  40
  41 #
  42 # The following information is for reference only and not required by the build tools.
  43 #
  44 #  VALID_ARCHITECTURES           = IA32 X64
  45 #
  46
  47
  48 [Sources]
  49   Reclaim.c
  50   Variable.c
  51   VariableSmm.c
  52   AuthService.c
  53   VarCheck.c
  54   Variable.h
  55   AuthService.h
  56
  57 [Packages]
  58   MdePkg/MdePkg.dec
  59   MdeModulePkg/MdeModulePkg.dec
  60   CryptoPkg/CryptoPkg.dec
  61   SecurityPkg/SecurityPkg.dec
  62
  63 [LibraryClasses]
  64   UefiDriverEntryPoint
  65   MemoryAllocationLib
  66   BaseLib
  67   SynchronizationLib
  68   UefiLib
  69   SmmServicesTableLib
  70   BaseMemoryLib
  71   DebugLib
  72   DxeServicesTableLib
  73   BaseCryptLib
  74   PlatformSecureLib
  75   HobLib
  76   PcdLib
  77   DevicePathLib
  78   SmmMemLib
  79
  80 [Protocols]
  81   gEfiSmmFirmwareVolumeBlockProtocolGuid        ## CONSUMES
  82
  83   ## PRODUCES
  84   ## UNDEFINED     # SmiHandlerRegister
  85   gEfiSmmVariableProtocolGuid
  86
  87   ## CONSUMES
  88   ## NOTIFY
  89   gEfiSmmFaultTolerantWriteProtocolGuid
  90   gEfiSmmEndOfDxeProtocolGuid                   ## NOTIFY
  91   gEdkiiSmmVarCheckProtocolGuid                 ## PRODUCES
  92
  93 [Guids]
  94   ## PRODUCES             ## GUID # Variable store header
  95   ## CONSUMES             ## GUID # Variable store header
  96   ## SOMETIMES_CONSUMES   ## HOB
  97   gEfiAuthenticatedVariableGuid
  98
  99   ## SOMETIMES_CONSUMES   ## Variable:L"PlatformLang"
 100   ## SOMETIMES_PRODUCES   ## Variable:L"PlatformLang"
 101   ## SOMETIMES_CONSUMES   ## Variable:L"Lang"
 102   ## SOMETIMES_PRODUCES   ## Variable:L"Lang"
 103   ## SOMETIMES_CONSUMES   ## Variable:L"HwErrRecSupport"
 104   ## CONSUMES             ## Variable:L"SetupMode"
 105   ## PRODUCES             ## Variable:L"SetupMode"
 106   ## SOMETIMES_CONSUMES   ## Variable:L"PK"
 107   ## SOMETIMES_CONSUMES   ## Variable:L"KEK"
 108   ## CONSUMES             ## Variable:L"SecureBoot"
 109   ## PRODUCES             ## Variable:L"SecureBoot"
 110   ## CONSUMES             ## Variable:L"SignatureSupport"
 111   ## PRODUCES             ## Variable:L"SignatureSupport"
 112   ## PRODUCES             ## Variable:L"VendorKeys"
 113   gEfiGlobalVariableGuid
 114
 115   ## SOMETIMES_CONSUMES   ## Variable:L"DB"
 116   ## SOMETIMES_CONSUMES   ## Variable:L"DBX"
 117   gEfiImageSecurityDatabaseGuid
 118
 119   ## CONSUMES             ## Variable:L"SecureBootEnable"
 120   ## PRODUCES             ## Variable:L"SecureBootEnable"
 121   gEfiSecureBootEnableDisableGuid
 122
 123   ## CONSUMES             ## Variable:L"CustomMode"
 124   ## PRODUCES             ## Variable:L"CustomMode"
 125   gEfiCustomModeEnableGuid
 126
 127   ## CONSUMES             ## Variable:L"certdb"
 128   ## PRODUCES             ## Variable:L"certdb"
 129   gEfiCertDbGuid
 130
 131   ## CONSUMES             ## Variable:L"VendorKeysNv"
 132   ## PRODUCES             ## Variable:L"VendorKeysNv"
 133   gEfiVendorKeysNvGuid
 134
 135   gSmmVariableWriteGuid                    ## PRODUCES               ## GUID        # Install protocol
 136   gEfiCertTypeRsa2048Sha256Guid            ## SOMETIMES_CONSUMES     ## GUID        # Unique ID for the format of the CertData.
 137   gEfiCertPkcs7Guid                        ## SOMETIMES_CONSUMES     ## GUID        # Unique ID for the format of the CertData.
 138   gEfiCertX509Guid                         ## SOMETIMES_CONSUMES     ## GUID        # Unique ID for the type of the signature.
 139   gEfiSystemNvDataFvGuid                   ## CONSUMES               ## GUID
 140   gEfiHardwareErrorVariableGuid            ## SOMETIMES_CONSUMES     ## Variable:L"HwErrRec####"
 141   gEdkiiFaultTolerantWriteGuid             ## SOMETIMES_CONSUMES     ## HOB
 142   gEdkiiVarErrorFlagGuid                   ## CONSUMES               ## GUID
 143
 144 [Pcd]
 145   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize       ## CONSUMES
 146   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase       ## SOMETIMES_CONSUMES
 147   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64     ## CONSUMES
 148   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize                  ## CONSUMES
 149   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxAuthVariableSize              ## CONSUMES
 150   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize     ## CONSUMES
 151   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize                ## CONSUMES
 152   gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize                 ## CONSUMES
 153   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxUserNvVariableSpaceSize           ## CONSUMES
 154   gEfiMdeModulePkgTokenSpaceGuid.PcdBoottimeReservedNvVariableSpaceSize  ## CONSUMES
 155   gEfiMdeModulePkgTokenSpaceGuid.PcdReclaimVariableSpaceAtEndOfDxe   ## CONSUMES
 156
 157 [FeaturePcd]
 158   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics        ## CONSUMES  # statistic the information of variable.
 159   gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultLangDeprecate       ## CONSUMES  # Auto update PlatformLang/Lang
 160
 161 [Depex]
 162   TRUE
 163
 164 [UserExtensions.TianoCore."ExtraFiles"]
 165   VariableSmmExtra.uni