The variable driver doesn't distinguish "non-volatile non-authenticated" variables from "volatile non-authenticated" variables, when checking individual variable sizes against the permitted maximum. PcdMaxVariableSize covers both kinds. This prevents volatile non-authenticated variables from carrying large data between UEFI drivers, despite having no flash impact. One example is EFI_TLS_CA_CERTIFICATE_VARIABLE, which platforms might want to create as volatile on every boot: the certificate list can be several hundred KB in size. Introduce PcdMaxVolatileVariableSize to represent the limit on individual volatile non-authenticated variables. The default value is zero, which makes Variable/RuntimeDxe fall back to PcdMaxVariableSize (i.e. the current behavior). This is similar to the PcdMaxAuthVariableSize fallback. Whenever the size limit is enforced, consult MaxVolatileVariableSize as the last option, after checking - MaxAuthVariableSize for VARIABLE_ATTRIBUTE_AT_AW, - and MaxVariableSize for EFI_VARIABLE_NON_VOLATILE. EFI_VARIABLE_HARDWARE_ERROR_RECORD is always handled separately; it always takes priority over the three cases listed above. Introduce the GetMaxVariableSize() helper to consider PcdMaxVolatileVariableSize, in addition to GetNonVolatileMaxVariableSize(). GetNonVolatileMaxVariableSize() is currently called at three sites, and two of those need to start using GetMaxVariableSize() instead: - VariableServiceInitialize() [VariableSmm.c]: the SMM comms buffer must accommodate all kinds of variables, - VariableCommonInitialize() [Variable.c]: the preallocated scratch space must also accommodate all kinds of variables, - InitNonVolatileVariableStore() [Variable.c] can continue using GetNonVolatileMaxVariableSize(). Don't modify the ReclaimForOS() function as it is specific to non-volatile variables and should ignore PcdMaxVolatileVariableSize. Cc: Eric Dong <eric.dong@intel.com> Cc: Ruiyu Ni <ruiyu.ni@intel.com> Cc: Star Zeng <star.zeng@intel.com> Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Laszlo Ersek <lersek@redhat.com> Reviewed-by: Gary Lin <glin@suse.com> Tested-by: Gary Lin <glin@suse.com> [lersek@redhat.com: set MaxVolatileVariableSize where Star suggested] Reviewed-by: Star Zeng <star.zeng@intel.com>
145 lines
5.9 KiB
INI
145 lines
5.9 KiB
INI
## @file
|
|
# Provides SMM variable service.
|
|
#
|
|
# This module installs SMM variable protocol into SMM protocol database,
|
|
# which can be used by SMM driver, and installs SMM variable protocol
|
|
# into BS protocol database, which can be used to notify the SMM Runtime
|
|
# Dxe driver that the SMM variable service is ready.
|
|
# This module should be used with SMM Runtime DXE module together. The
|
|
# SMM Runtime DXE module would install variable arch protocol and variable
|
|
# write arch protocol based on SMM variable module.
|
|
#
|
|
# Caution: This module requires additional review when modified.
|
|
# This driver will have external input - variable data and communicate buffer in SMM mode.
|
|
# This external input must be validated carefully to avoid security issues such as
|
|
# buffer overflow or integer overflow.
|
|
# The whole SMM authentication variable design relies on the integrity of flash part and SMM.
|
|
# which is assumed to be protected by platform. All variable code and metadata in flash/SMM Memory
|
|
# may not be modified without authorization. If platform fails to protect these resources,
|
|
# the authentication service provided in this driver will be broken, and the behavior is undefined.
|
|
#
|
|
# Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR>
|
|
# This program and the accompanying materials
|
|
# are licensed and made available under the terms and conditions of the BSD License
|
|
# which accompanies this distribution. The full text of the license may be found at
|
|
# http://opensource.org/licenses/bsd-license.php
|
|
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
|
#
|
|
##
|
|
|
|
[Defines]
|
|
INF_VERSION = 0x00010005
|
|
BASE_NAME = VariableSmm
|
|
MODULE_UNI_FILE = VariableSmm.uni
|
|
FILE_GUID = 23A089B3-EED5-4ac5-B2AB-43E3298C2343
|
|
MODULE_TYPE = DXE_SMM_DRIVER
|
|
VERSION_STRING = 1.0
|
|
PI_SPECIFICATION_VERSION = 0x0001000A
|
|
ENTRY_POINT = VariableServiceInitialize
|
|
|
|
#
|
|
# The following information is for reference only and not required by the build tools.
|
|
#
|
|
# VALID_ARCHITECTURES = IA32 X64
|
|
#
|
|
|
|
|
|
[Sources]
|
|
Reclaim.c
|
|
Variable.c
|
|
VariableSmm.c
|
|
VarCheck.c
|
|
Variable.h
|
|
PrivilegePolymorphic.h
|
|
VariableExLib.c
|
|
TcgMorLockSmm.c
|
|
|
|
[Packages]
|
|
MdePkg/MdePkg.dec
|
|
MdeModulePkg/MdeModulePkg.dec
|
|
|
|
[LibraryClasses]
|
|
UefiDriverEntryPoint
|
|
MemoryAllocationLib
|
|
BaseLib
|
|
SynchronizationLib
|
|
UefiLib
|
|
SmmServicesTableLib
|
|
BaseMemoryLib
|
|
DebugLib
|
|
DxeServicesTableLib
|
|
HobLib
|
|
PcdLib
|
|
SmmMemLib
|
|
AuthVariableLib
|
|
VarCheckLib
|
|
UefiBootServicesTableLib
|
|
|
|
[Protocols]
|
|
gEfiSmmFirmwareVolumeBlockProtocolGuid ## CONSUMES
|
|
## CONSUMES
|
|
## NOTIFY
|
|
gEfiSmmFaultTolerantWriteProtocolGuid
|
|
## PRODUCES
|
|
## UNDEFINED # SmiHandlerRegister
|
|
gEfiSmmVariableProtocolGuid
|
|
gEfiSmmEndOfDxeProtocolGuid ## NOTIFY
|
|
gEdkiiSmmVarCheckProtocolGuid ## PRODUCES
|
|
gEfiTcgProtocolGuid ## SOMETIMES_CONSUMES
|
|
gEfiTcg2ProtocolGuid ## SOMETIMES_CONSUMES
|
|
|
|
[Guids]
|
|
## SOMETIMES_CONSUMES ## GUID # Signature of Variable store header
|
|
## SOMETIMES_PRODUCES ## GUID # Signature of Variable store header
|
|
## SOMETIMES_CONSUMES ## HOB
|
|
## SOMETIMES_PRODUCES ## SystemTable
|
|
gEfiAuthenticatedVariableGuid
|
|
|
|
## SOMETIMES_CONSUMES ## GUID # Signature of Variable store header
|
|
## SOMETIMES_PRODUCES ## GUID # Signature of Variable store header
|
|
## SOMETIMES_CONSUMES ## HOB
|
|
## SOMETIMES_PRODUCES ## SystemTable
|
|
gEfiVariableGuid
|
|
|
|
## SOMETIMES_CONSUMES ## Variable:L"PlatformLang"
|
|
## SOMETIMES_PRODUCES ## Variable:L"PlatformLang"
|
|
## SOMETIMES_CONSUMES ## Variable:L"Lang"
|
|
## SOMETIMES_PRODUCES ## Variable:L"Lang"
|
|
gEfiGlobalVariableGuid
|
|
|
|
gEfiMemoryOverwriteControlDataGuid ## SOMETIMES_CONSUMES ## Variable:L"MemoryOverwriteRequestControl"
|
|
gEfiMemoryOverwriteRequestControlLockGuid ## SOMETIMES_PRODUCES ## Variable:L"MemoryOverwriteRequestControlLock"
|
|
|
|
gSmmVariableWriteGuid ## PRODUCES ## GUID # Install protocol
|
|
gEfiSystemNvDataFvGuid ## CONSUMES ## GUID
|
|
gEdkiiFaultTolerantWriteGuid ## SOMETIMES_CONSUMES ## HOB
|
|
|
|
## SOMETIMES_CONSUMES ## Variable:L"VarErrorFlag"
|
|
## SOMETIMES_PRODUCES ## Variable:L"VarErrorFlag"
|
|
gEdkiiVarErrorFlagGuid
|
|
|
|
[Pcd]
|
|
gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize ## CONSUMES
|
|
gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase ## SOMETIMES_CONSUMES
|
|
gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableBase64 ## CONSUMES
|
|
gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVariableSize ## CONSUMES
|
|
gEfiMdeModulePkgTokenSpaceGuid.PcdMaxAuthVariableSize ## CONSUMES
|
|
gEfiMdeModulePkgTokenSpaceGuid.PcdMaxVolatileVariableSize ## CONSUMES
|
|
gEfiMdeModulePkgTokenSpaceGuid.PcdMaxHardwareErrorVariableSize ## CONSUMES
|
|
gEfiMdeModulePkgTokenSpaceGuid.PcdVariableStoreSize ## CONSUMES
|
|
gEfiMdeModulePkgTokenSpaceGuid.PcdHwErrStorageSize ## CONSUMES
|
|
gEfiMdeModulePkgTokenSpaceGuid.PcdMaxUserNvVariableSpaceSize ## CONSUMES
|
|
gEfiMdeModulePkgTokenSpaceGuid.PcdBoottimeReservedNvVariableSpaceSize ## CONSUMES
|
|
gEfiMdeModulePkgTokenSpaceGuid.PcdReclaimVariableSpaceAtEndOfDxe ## CONSUMES
|
|
|
|
[FeaturePcd]
|
|
gEfiMdeModulePkgTokenSpaceGuid.PcdVariableCollectStatistics ## CONSUMES # statistic the information of variable.
|
|
gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultLangDeprecate ## CONSUMES # Auto update PlatformLang/Lang
|
|
|
|
[Depex]
|
|
TRUE
|
|
|
|
[UserExtensions.TianoCore."ExtraFiles"]
|
|
VariableSmmExtra.uni
|