Add comment for modules which have external input.

[mirror_edk2.git] / SecurityPkg / VariableAuthenticated / RuntimeDxe / VariableSmm.inf

## @file\r
#  Component description file for SMM Authenticated Variable module.\r
#\r
#  This module installs SMM variable protocol into SMM protocol database,\r
#  which can be used by SMM driver, and installs SMM variable protocol\r
#  into BS protocol database, which can be used to notify the SMM Runtime\r
#  Dxe driver that the SMM variable service is ready.\r
#  This module should be used with SMM Runtime DXE module together. The\r
#  SMM Runtime DXE module would install variable arch protocol and variable\r
#  write arch protocol based on SMM variable module.\r
#\r
#  Caution: This module requires additional review when modified.\r
#  This driver will have external input - variable data and communicate buffer in SMM mode.\r
#  This external input must be validated carefully to avoid security issue like\r
#  buffer overflow, integer overflow.\r
#\r
# Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution. The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\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
  INF_VERSION                    = 0x00010005\r
  BASE_NAME                      = VariableSmm\r
  FILE_GUID                      = D34BDC5E-968A-40f5-A48C-E594F45AE211\r
  MODULE_TYPE                    = DXE_SMM_DRIVER\r
  VERSION_STRING                 = 1.0\r
  PI_SPECIFICATION_VERSION       = 0x0001000A\r
  ENTRY_POINT                    = VariableServiceInitialize\r
\r
#\r
# The following information is for reference only and not required by the build tools.\r
#\r
#  VALID_ARCHITECTURES           = IA32 X64\r
#\r
\r
\r
[Sources]\r
  Reclaim.c\r
  Variable.c\r
  VariableSmm.c\r
  AuthService.c\r
  Variable.h\r
  AuthService.h\r
\r
[Packages]\r
  MdePkg/MdePkg.dec\r
  MdeModulePkg/MdeModulePkg.dec\r
  CryptoPkg/CryptoPkg.dec\r
  SecurityPkg/SecurityPkg.dec\r
\r
[LibraryClasses]\r
  UefiDriverEntryPoint\r
  MemoryAllocationLib\r
  BaseLib\r
  SynchronizationLib\r
  UefiLib\r
  SmmServicesTableLib\r
  BaseMemoryLib\r
  DebugLib\r
  DxeServicesTableLib\r
  BaseCryptLib\r
  PlatformSecureLib\r
  HobLib\r
\r
[Protocols]\r
  gEfiSmmFirmwareVolumeBlockProtocolGuid        ## SOMETIMES_CONSUMES\r
  gEfiSmmVariableProtocolGuid                   ## ALWAYS_PRODUCES\r
  gEfiSmmFaultTolerantWriteProtocolGuid         ## SOMETIMES_CONSUMES\r
\r
[Guids]\r
  gEfiAuthenticatedVariableGuid                 ## PRODUCES ## Configuration Table Guid\r
  gEfiGlobalVariableGuid                        ## PRODUCES ## Variable Guid\r
  gSmmVariableWriteGuid                         ## PRODUCES ## SMM Variable Write Guid\r
  gEfiCertTypeRsa2048Sha256Guid\r
  gEfiImageSecurityDatabaseGuid\r
  gEfiCertX509Guid\r
  gEfiCertPkcs7Guid\r
  gEfiCertRsa2048Guid\r
  gEfiSecureBootEnableDisableGuid\r
  gEfiCustomModeEnableGuid\r
  gEfiSystemNvDataFvGuid                        ## CONSUMES\r
  gEfiCertDbGuid\r
  gEfiHardwareErrorVariableGuid                 ## SOMETIMES_CONSUMES\r
\r
[Pcd]\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize\r
\r
[FeaturePcd]\r
  gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics  ## SOMETIME_CONSUMES (statistic the information of variable.)\r
\r
[Depex]\r
  TRUE\r
\r
\r