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 - 2014, 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   Variable.h
  54   AuthService.h
  55
  56 [Packages]
  57   MdePkg/MdePkg.dec
  58   MdeModulePkg/MdeModulePkg.dec
  59   CryptoPkg/CryptoPkg.dec
  60   SecurityPkg/SecurityPkg.dec
  61
  62 [LibraryClasses]
  63   UefiDriverEntryPoint
  64   MemoryAllocationLib
  65   BaseLib
  66   SynchronizationLib
  67   UefiLib
  68   SmmServicesTableLib
  69   BaseMemoryLib
  70   DebugLib
  71   DxeServicesTableLib
  72   BaseCryptLib
  73   PlatformSecureLib
  74   HobLib
  75
  76 [Protocols]
  77   gEfiSmmFirmwareVolumeBlockProtocolGuid        ## CONSUMES
  78   gEfiSmmAccess2ProtocolGuid                    ## CONSUMES
  79
  80   ## PRODUCES
  81   ## UNDEFINED     # SmiHandlerRegister
  82   gEfiSmmVariableProtocolGuid
  83
  84   ## CONSUMES
  85   ## NOTIFY
  86   gEfiSmmFaultTolerantWriteProtocolGuid
  87   gEfiSmmEndOfDxeProtocolGuid              ## NOTIFY
  88
  89 [Guids]
  90   ## PRODUCES             ## GUID # Variable store header
  91   ## CONSUMES             ## GUID # Variable store header
  92   ## SOMETIMES_CONSUMES   ## HOB
  93   gEfiAuthenticatedVariableGuid
  94
  95   ## SOMETIMES_CONSUMES   ## Variable:L"PlatformLang"
  96   ## SOMETIMES_PRODUCES   ## Variable:L"PlatformLang"
  97   ## SOMETIMES_CONSUMES   ## Variable:L"Lang"
  98   ## SOMETIMES_PRODUCES   ## Variable:L"Lang"
  99   ## SOMETIMES_CONSUMES   ## Variable:L"HwErrRecSupport"
 100   ## CONSUMES             ## Variable:L"SetupMode"
 101   ## PRODUCES             ## Variable:L"SetupMode"
 102   ## SOMETIMES_CONSUMES   ## Variable:L"PK"
 103   ## SOMETIMES_CONSUMES   ## Variable:L"KEK"
 104   ## CONSUMES             ## Variable:L"SecureBoot"
 105   ## PRODUCES             ## Variable:L"SecureBoot"
 106   ## CONSUMES             ## Variable:L"SignatureSupport"
 107   ## PRODUCES             ## Variable:L"SignatureSupport"
 108   ## PRODUCES             ## Variable:L"VendorKeys"
 109   gEfiGlobalVariableGuid
 110
 111   ## SOMETIMES_CONSUMES   ## Variable:L"DB"
 112   ## SOMETIMES_CONSUMES   ## Variable:L"DBX"
 113   gEfiImageSecurityDatabaseGuid
 114
 115   ## CONSUMES             ## Variable:L"SecureBootEnable"
 116   ## PRODUCES             ## Variable:L"SecureBootEnable"
 117   gEfiSecureBootEnableDisableGuid
 118
 119   ## CONSUMES             ## Variable:L"CustomMode"
 120   ## PRODUCES             ## Variable:L"CustomMode"
 121   gEfiCustomModeEnableGuid
 122
 123   ## CONSUMES             ## Variable:L"certdb"
 124   ## PRODUCES             ## Variable:L"certdb"
 125   gEfiCertDbGuid
 126
 127   ## CONSUMES             ## Variable:L"VendorKeysNv"
 128   ## PRODUCES             ## Variable:L"VendorKeysNv"
 129   gEfiVendorKeysNvGuid
 130
 131   gSmmVariableWriteGuid                    ## PRODUCES               ## GUID        # Install protocol
 132   gEfiCertTypeRsa2048Sha256Guid            ## SOMETIMES_CONSUMES     ## GUID        # Unique ID for the format of the CertData.
 133   gEfiCertPkcs7Guid                        ## SOMETIMES_CONSUMES     ## GUID        # Unique ID for the format of the CertData.
 134   gEfiCertX509Guid                         ## SOMETIMES_CONSUMES     ## GUID        # Unique ID for the type of the signature.
 135   gEfiSystemNvDataFvGuid                   ## CONSUMES               ## GUID
 136   gEfiHardwareErrorVariableGuid            ## SOMETIMES_CONSUMES     ## Variable:L"HwErrRec####"
 137   gEdkiiFaultTolerantWriteGuid             ## SOMETIMES_CONSUMES     ## HOB
 138
 139 [Pcd]
 140   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize       ## CONSUMES
 141   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase       ## SOMETIMES_CONSUMES
 142   gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64     ## CONSUMES
 143   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize                  ## CONSUMES
 144   gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize     ## CONSUMES
 145   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize                ## CONSUMES
 146   gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize                 ## CONSUMES
 147
 148 [FeaturePcd]
 149   gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics        ## CONSUMES  # statistic the information of variable.
 150   gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultLangDeprecate       ## CONSUMES  # Auto update PlatformLang/Lang
 151
 152 [Depex]
 153   TRUE
 154
 155 [UserExtensions.TianoCore."ExtraFiles"]
 156   VariableSmmExtra.uni