]> git.proxmox.com Git - mirror_edk2.git/commitdiff
MdeModulePkg Variable: Implement VarCheck PROTOCOL
authorStar Zeng <star.zeng@intel.com>
Mon, 5 Jan 2015 03:38:36 +0000 (03:38 +0000)
committerlzeng14 <lzeng14@Edk2>
Mon, 5 Jan 2015 03:38:36 +0000 (03:38 +0000)
and follow UEFI spec to check UEFI defined variables.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Jiewen Yao <jiewen.yao@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@16579 6f19259b-4bc3-4df7-8a09-765794883524

13 files changed:
MdeModulePkg/Include/Guid/SmmVariableCommon.h
MdeModulePkg/Include/Protocol/SmmVarCheck.h [new file with mode: 0644]
MdeModulePkg/Include/Protocol/VarCheck.h [new file with mode: 0644]
MdeModulePkg/MdeModulePkg.dec
MdeModulePkg/Universal/Variable/RuntimeDxe/VarCheck.c [new file with mode: 0644]
MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.c
MdeModulePkg/Universal/Variable/RuntimeDxe/Variable.h
MdeModulePkg/Universal/Variable/RuntimeDxe/VariableDxe.c
MdeModulePkg/Universal/Variable/RuntimeDxe/VariableRuntimeDxe.inf
MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.c
MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmm.inf
MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.c
MdeModulePkg/Universal/Variable/RuntimeDxe/VariableSmmRuntimeDxe.inf

index a2daae8fe3e17ea4a78993fbfd3190baf808893b..e92ab7fe79a6f8c18c8678a4672a4d91798e081f 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   The file defined some common structures used for communicating between SMM variable module and SMM variable wrapper module.\r
 \r
-Copyright (c) 2011 - 2013, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -15,6 +15,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef _SMM_VARIABLE_COMMON_H_\r
 #define _SMM_VARIABLE_COMMON_H_\r
 \r
+#include <Protocol/VarCheck.h>\r
+\r
 #define EFI_SMM_VARIABLE_WRITE_GUID \\r
   { 0x93ba1826, 0xdffb, 0x45dd, { 0x82, 0xa7, 0xe7, 0xdc, 0xaa, 0x3b, 0xbd, 0xf3 } }\r
 \r
@@ -65,6 +67,10 @@ typedef struct {
 //\r
 #define SMM_VARIABLE_FUNCTION_LOCK_VARIABLE           8\r
 \r
+#define SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_SET  9\r
+\r
+#define SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_GET  10\r
+\r
 ///\r
 /// Size of SMM communicate header, without including the payload.\r
 ///\r
@@ -107,4 +113,11 @@ typedef struct {
 \r
 typedef SMM_VARIABLE_COMMUNICATE_GET_NEXT_VARIABLE_NAME SMM_VARIABLE_COMMUNICATE_LOCK_VARIABLE;\r
 \r
+typedef struct {\r
+  EFI_GUID                      Guid;\r
+  UINTN                         NameSize;\r
+  VAR_CHECK_VARIABLE_PROPERTY   VariableProperty;\r
+  CHAR16                        Name[1];\r
+} SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY;\r
+\r
 #endif // _SMM_VARIABLE_COMMON_H_
\ No newline at end of file
diff --git a/MdeModulePkg/Include/Protocol/SmmVarCheck.h b/MdeModulePkg/Include/Protocol/SmmVarCheck.h
new file mode 100644 (file)
index 0000000..7faf5a9
--- /dev/null
@@ -0,0 +1,36 @@
+/** @file\r
+  SMM variable check definitions, it reuses the interface definitions of variable check.\r
+\r
+  Copyright (c) 2015, 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
+\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
+#ifndef __SMM_VAR_CHECK_H__\r
+#define __SMM_VAR_CHECK_H__\r
+\r
+#include <Protocol/VarCheck.h>\r
+\r
+#define EDKII_SMM_VAR_CHECK_PROTOCOL_GUID \\r
+  { \\r
+    0xb0d8f3c1, 0xb7de, 0x4c11, { 0xbc, 0x89, 0x2f, 0xb5, 0x62, 0xc8, 0xc4, 0x11 } \\r
+  };\r
+\r
+typedef struct _EDKII_SMM_VAR_CHECK_PROTOCOL EDKII_SMM_VAR_CHECK_PROTOCOL;\r
+\r
+struct _EDKII_SMM_VAR_CHECK_PROTOCOL {\r
+  EDKII_VAR_CHECK_REGISTER_SET_VARIABLE_CHECK_HANDLER   SmmRegisterSetVariableCheckHandler;\r
+  EDKII_VAR_CHECK_VARIABLE_PROPERTY_SET                 SmmVariablePropertySet;\r
+  EDKII_VAR_CHECK_VARIABLE_PROPERTY_GET                 SmmVariablePropertyGet;\r
+};\r
+\r
+extern EFI_GUID gEdkiiSmmVarCheckProtocolGuid;\r
+\r
+#endif\r
+\r
diff --git a/MdeModulePkg/Include/Protocol/VarCheck.h b/MdeModulePkg/Include/Protocol/VarCheck.h
new file mode 100644 (file)
index 0000000..1a79216
--- /dev/null
@@ -0,0 +1,120 @@
+/** @file\r
+  Variable check definitions.\r
+\r
+  Copyright (c) 2015, 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
+\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
+#ifndef _VARIABLE_CHECK_H_\r
+#define _VARIABLE_CHECK_H_\r
+\r
+#include <Uefi/UefiSpec.h>\r
+\r
+typedef struct _EDKII_VAR_CHECK_PROTOCOL    EDKII_VAR_CHECK_PROTOCOL;\r
+\r
+#define EDKII_VAR_CHECK_PROTOCOL_GUID { \\r
+  0xaf23b340, 0x97b4, 0x4685, { 0x8d, 0x4f, 0xa3, 0xf2, 0x81, 0x69, 0xb2, 0x1d } \\r
+};\r
+\r
+typedef EFI_SET_VARIABLE VAR_CHECK_SET_VARIABLE_CHECK_HANDLER;\r
+\r
+/**\r
+  Register SetVariable check handler.\r
+  Variable driver will call the handler to do check before\r
+  really setting the variable into variable storage.\r
+\r
+  @param[in] Handler            Pointer to the check handler.\r
+\r
+  @retval EFI_SUCCESS           The SetVariable check handler was registered successfully.\r
+  @retval EFI_INVALID_PARAMETER Handler is NULL.\r
+  @retval EFI_ACCESS_DENIED     EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has already been signaled.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough resource for the SetVariable check handler register request.\r
+  @retval EFI_UNSUPPORTED       This interface is not implemented.\r
+                                For example, it is unsupported in VarCheck protocol if both VarCheck and SmmVarCheck protocols are present.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI * EDKII_VAR_CHECK_REGISTER_SET_VARIABLE_CHECK_HANDLER) (\r
+  IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER   Handler\r
+  );\r
+\r
+#define VAR_CHECK_VARIABLE_PROPERTY_REVISION      0x0001\r
+//\r
+// 1. Set by VariableLock PROTOCOL\r
+// 2. Set by VarCheck PROTOCOL\r
+//\r
+// If set, other fields for check will be ignored.\r
+//\r
+#define VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY     BIT0\r
+\r
+typedef struct {\r
+  UINT16                            Revision;\r
+  UINT16                            Property;\r
+  UINT32                            Attributes;\r
+  UINTN                             MinSize;\r
+  UINTN                             MaxSize;\r
+} VAR_CHECK_VARIABLE_PROPERTY;\r
+\r
+/**\r
+  Variable property set.\r
+  Variable driver will do check according to the VariableProperty before\r
+  really setting the variable into variable storage.\r
+\r
+  @param[in] Name               Pointer to the variable name.\r
+  @param[in] Guid               Pointer to the vendor GUID.\r
+  @param[in] VariableProperty   Pointer to the input variable property.\r
+\r
+  @retval EFI_SUCCESS           The property of variable specified by the Name and Guid was set successfully.\r
+  @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string,\r
+                                or the fields of VariableProperty are not valid.\r
+  @retval EFI_ACCESS_DENIED     EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r
+                                already been signaled.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough resource for the variable property set request.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI * EDKII_VAR_CHECK_VARIABLE_PROPERTY_SET) (\r
+  IN CHAR16                         *Name,\r
+  IN EFI_GUID                       *Guid,\r
+  IN VAR_CHECK_VARIABLE_PROPERTY    *VariableProperty\r
+  );\r
+\r
+/**\r
+  Variable property get.\r
+\r
+  @param[in]  Name              Pointer to the variable name.\r
+  @param[in]  Guid              Pointer to the vendor GUID.\r
+  @param[out] VariableProperty  Pointer to the output variable property.\r
+\r
+  @retval EFI_SUCCESS           The property of variable specified by the Name and Guid was got successfully.\r
+  @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string.\r
+  @retval EFI_NOT_FOUND         The property of variable specified by the Name and Guid was not found.\r
+\r
+**/\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI * EDKII_VAR_CHECK_VARIABLE_PROPERTY_GET) (\r
+  IN CHAR16                         *Name,\r
+  IN EFI_GUID                       *Guid,\r
+  OUT VAR_CHECK_VARIABLE_PROPERTY   *VariableProperty\r
+  );\r
+\r
+struct _EDKII_VAR_CHECK_PROTOCOL {\r
+  EDKII_VAR_CHECK_REGISTER_SET_VARIABLE_CHECK_HANDLER   RegisterSetVariableCheckHandler;\r
+  EDKII_VAR_CHECK_VARIABLE_PROPERTY_SET                 VariablePropertySet;\r
+  EDKII_VAR_CHECK_VARIABLE_PROPERTY_GET                 VariablePropertyGet;\r
+};\r
+\r
+extern EFI_GUID gEdkiiVarCheckProtocolGuid;\r
+\r
+#endif\r
+\r
index c58f424ff4b66f0ab033bf5b11b52d6402219e3f..83906d21da9c7e44d29815a172568d5dec921307 100644 (file)
@@ -3,7 +3,7 @@
 # It also provides the definitions(including PPIs/PROTOCOLs/GUIDs and library classes)\r
 # and libraries instances, which are used for those modules.\r
 #\r
-# Copyright (c) 2007 - 2014, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2007 - 2015, Intel Corporation. All rights reserved.<BR>\r
 # This program and the accompanying materials are licensed and made available under \r
 # the terms and conditions of the BSD License that accompanies this distribution.  \r
 # The full text of the license may be found at\r
   #  Include/Protocol/VariableLock.h\r
   gEdkiiVariableLockProtocolGuid = { 0xcd3d0a05, 0x9e24, 0x437c, { 0xa8, 0x91, 0x1e, 0xe0, 0x53, 0xdb, 0x76, 0x38 }}\r
 \r
+  ## Include/Protocol/VarCheck.h\r
+  gEdkiiVarCheckProtocolGuid     = { 0xaf23b340, 0x97b4, 0x4685, { 0x8d, 0x4f, 0xa3, 0xf2, 0x81, 0x69, 0xb2, 0x1d } }\r
+\r
+  ## Include/Protocol/SmmVarCheck.h\r
+  gEdkiiSmmVarCheckProtocolGuid  = { 0xb0d8f3c1, 0xb7de, 0x4c11, { 0xbc, 0x89, 0x2f, 0xb5, 0x62, 0xc8, 0xc4, 0x11 } }\r
+\r
   ## This protocol is similar with DXE FVB protocol and used in the UEFI SMM evvironment.\r
   #  Include/Protocol/SmmFirmwareVolumeBlock.h\r
   gEfiSmmFirmwareVolumeBlockProtocolGuid = { 0xd326d041, 0xbd31, 0x4c01, { 0xb5, 0xa8, 0x62, 0x8b, 0xe8, 0x7f, 0x6, 0x53 }}\r
diff --git a/MdeModulePkg/Universal/Variable/RuntimeDxe/VarCheck.c b/MdeModulePkg/Universal/Variable/RuntimeDxe/VarCheck.c
new file mode 100644 (file)
index 0000000..f817330
--- /dev/null
@@ -0,0 +1,1063 @@
+/** @file\r
+  Implementation functions and structures for var check protocol.\r
+\r
+Copyright (c) 2015, 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
+\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
+#include "Variable.h"\r
+#include <Library/DevicePathLib.h>\r
+\r
+extern LIST_ENTRY mLockedVariableList;\r
+extern BOOLEAN mEndOfDxe;\r
+extern BOOLEAN mEnableLocking;\r
+\r
+#define VAR_CHECK_HANDLER_TABLE_SIZE    0x8\r
+\r
+UINT32                                  mNumberOfHandler = 0;\r
+UINT32                                  mMaxNumberOfHandler = 0;\r
+VAR_CHECK_SET_VARIABLE_CHECK_HANDLER    *mHandlerTable = NULL;\r
+\r
+typedef struct {\r
+  LIST_ENTRY                    Link;\r
+  EFI_GUID                      Guid;\r
+  VAR_CHECK_VARIABLE_PROPERTY   VariableProperty;\r
+  //CHAR16                        *Name;\r
+} VAR_CHECK_VARIABLE_ENTRY;\r
+\r
+LIST_ENTRY mVarCheckVariableList = INITIALIZE_LIST_HEAD_VARIABLE (mVarCheckVariableList);\r
+\r
+typedef\r
+EFI_STATUS\r
+(EFIAPI *INTERNAL_VAR_CHECK_FUNCTION) (\r
+  IN VAR_CHECK_VARIABLE_PROPERTY    *Propery,\r
+  IN UINTN                          DataSize,\r
+  IN VOID                           *Data\r
+  );\r
+\r
+typedef struct {\r
+  CHAR16                        *Name;\r
+  VAR_CHECK_VARIABLE_PROPERTY   VariableProperty;\r
+  INTERNAL_VAR_CHECK_FUNCTION   CheckFunction;\r
+} UEFI_DEFINED_VARIABLE_ENTRY;\r
+\r
+typedef struct _EFI_LOAD_OPTION {\r
+  UINT32                   Attributes;\r
+  UINT16                   FilePathListLength;\r
+//CHAR16                   Description[];\r
+//EFI_DEVICE_PATH_PROTOCOL FilePathList[];\r
+//UINT8                    OptionalData[];\r
+} EFI_LOAD_OPTION;\r
+\r
+/**\r
+  Internal check for load option.\r
+\r
+  @param[in] VariablePropery    Pointer to variable property.\r
+  @param[in] DataSize           Data size.\r
+  @param[in] Data               Pointer to data buffer.\r
+\r
+  @retval EFI_SUCCESS           The SetVariable check result was success.\r
+  @retval EFI_INVALID_PARAMETER The data buffer is not a valid load option.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InternalVarCheckLoadOption (\r
+  IN VAR_CHECK_VARIABLE_PROPERTY    *VariablePropery,\r
+  IN UINTN                          DataSize,\r
+  IN VOID                           *Data\r
+  )\r
+{\r
+  EFI_LOAD_OPTION           *LoadOption;\r
+  CHAR16                    *Description;\r
+  EFI_DEVICE_PATH_PROTOCOL  *FilePathList;\r
+\r
+  LoadOption = (EFI_LOAD_OPTION *) Data;\r
+\r
+  //\r
+  // Check Description\r
+  //\r
+  Description = (CHAR16 *) ((UINTN) Data + sizeof (EFI_LOAD_OPTION));\r
+  while (Description < (CHAR16 *) ((UINTN) Data + DataSize)) {\r
+    if (*Description == L'\0') {\r
+      break;\r
+    }\r
+    Description++;\r
+  }\r
+  if ((UINTN) Description >= ((UINTN) Data + DataSize)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+  Description++;\r
+\r
+  //\r
+  // Check FilePathList\r
+  //\r
+  FilePathList = (EFI_DEVICE_PATH_PROTOCOL *) Description;\r
+  if ((UINTN) FilePathList > (MAX_ADDRESS - LoadOption->FilePathListLength)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+  if (((UINTN) FilePathList + LoadOption->FilePathListLength) > ((UINTN) Data + DataSize)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+  if (LoadOption->FilePathListLength < sizeof (EFI_DEVICE_PATH_PROTOCOL)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+  if (!IsDevicePathValid (FilePathList, LoadOption->FilePathListLength)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Internal check for key option.\r
+\r
+  @param[in] VariablePropery    Pointer to variable property.\r
+  @param[in] DataSize           Data size.\r
+  @param[in] Data               Pointer to data buffer.\r
+\r
+  @retval EFI_SUCCESS           The SetVariable check result was success.\r
+  @retval EFI_INVALID_PARAMETER The data buffer is not a valid key option.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InternalVarCheckKeyOption (\r
+  IN VAR_CHECK_VARIABLE_PROPERTY    *VariablePropery,\r
+  IN UINTN                          DataSize,\r
+  IN VOID                           *Data\r
+  )\r
+{\r
+  if (((DataSize - sizeof (EFI_KEY_OPTION)) % sizeof (EFI_INPUT_KEY)) != 0) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Internal check for device path.\r
+\r
+  @param[in] VariablePropery    Pointer to variable property.\r
+  @param[in] DataSize           Data size.\r
+  @param[in] Data               Pointer to data buffer.\r
+\r
+  @retval EFI_SUCCESS           The SetVariable check result was success.\r
+  @retval EFI_INVALID_PARAMETER The data buffer is not a valid device path.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InternalVarCheckDevicePath (\r
+  IN VAR_CHECK_VARIABLE_PROPERTY    *VariablePropery,\r
+  IN UINTN                          DataSize,\r
+  IN VOID                           *Data\r
+  )\r
+{\r
+  if (!IsDevicePathValid ((EFI_DEVICE_PATH_PROTOCOL *) Data, DataSize)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Internal check for ASCII string.\r
+\r
+  @param[in] VariablePropery    Pointer to variable property.\r
+  @param[in] DataSize           Data size.\r
+  @param[in] Data               Pointer to data buffer.\r
+\r
+  @retval EFI_SUCCESS           The SetVariable check result was success.\r
+  @retval EFI_INVALID_PARAMETER The data buffer is not a Null-terminated ASCII string.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InternalVarCheckAsciiString (\r
+  IN VAR_CHECK_VARIABLE_PROPERTY    *VariablePropery,\r
+  IN UINTN                          DataSize,\r
+  IN VOID                           *Data\r
+  )\r
+{\r
+  CHAR8     *String;\r
+  UINTN     Index;\r
+\r
+  String = (CHAR8 *) Data;\r
+  if (String[DataSize - 1] == '\0') {\r
+    return EFI_SUCCESS;\r
+  } else {\r
+    for (Index = 1; Index < DataSize && (String[DataSize - 1 - Index] != '\0'); Index++);\r
+    if (Index == DataSize) {\r
+      return EFI_INVALID_PARAMETER;\r
+    }\r
+  }\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Internal check for size array.\r
+\r
+  @param[in] VariablePropery    Pointer to variable property.\r
+  @param[in] DataSize           Data size.\r
+  @param[in] Data               Pointer to data buffer.\r
+\r
+  @retval EFI_SUCCESS           The SetVariable check result was success.\r
+  @retval EFI_INVALID_PARAMETER The DataSize is not size array.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InternalVarCheckSizeArray (\r
+  IN VAR_CHECK_VARIABLE_PROPERTY    *VariablePropery,\r
+  IN UINTN                          DataSize,\r
+  IN VOID                           *Data\r
+  )\r
+{\r
+  if ((DataSize % VariablePropery->MinSize) != 0) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+//\r
+// To prevent name collisions with possible future globally defined variables,\r
+// other internal firmware data variables that are not defined here must be\r
+// saved with a unique VendorGuid other than EFI_GLOBAL_VARIABLE or\r
+// any other GUID defined by the UEFI Specification. Implementations must\r
+// only permit the creation of variables with a UEFI Specification-defined\r
+// VendorGuid when these variables are documented in the UEFI Specification.\r
+//\r
+UEFI_DEFINED_VARIABLE_ENTRY mGlobalVariableList[] = {\r
+  {\r
+    EFI_LANG_CODES_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      1,\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckAsciiString\r
+  },\r
+  {\r
+    EFI_LANG_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+      1,\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckAsciiString\r
+  },\r
+  {\r
+    EFI_TIME_OUT_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+      sizeof (UINT16),\r
+      sizeof (UINT16)\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_PLATFORM_LANG_CODES_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      1,\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckAsciiString\r
+  },\r
+  {\r
+    EFI_PLATFORM_LANG_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+      1,\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckAsciiString\r
+  },\r
+  {\r
+    EFI_CON_IN_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+      sizeof (EFI_DEVICE_PATH_PROTOCOL),\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckDevicePath\r
+  },\r
+  {\r
+    EFI_CON_OUT_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+      sizeof (EFI_DEVICE_PATH_PROTOCOL),\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckDevicePath\r
+  },\r
+  {\r
+    EFI_ERR_OUT_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+      sizeof (EFI_DEVICE_PATH_PROTOCOL),\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckDevicePath\r
+  },\r
+  {\r
+    EFI_CON_IN_DEV_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      sizeof (EFI_DEVICE_PATH_PROTOCOL),\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckDevicePath\r
+  },\r
+  {\r
+    EFI_CON_OUT_DEV_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      sizeof (EFI_DEVICE_PATH_PROTOCOL),\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckDevicePath\r
+  },\r
+  {\r
+    EFI_ERR_OUT_DEV_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      sizeof (EFI_DEVICE_PATH_PROTOCOL),\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckDevicePath\r
+  },\r
+  {\r
+    EFI_BOOT_ORDER_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+      sizeof (UINT16),\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckSizeArray\r
+  },\r
+  {\r
+    EFI_BOOT_NEXT_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+      sizeof (UINT16),\r
+      sizeof (UINT16)\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_BOOT_CURRENT_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      sizeof (UINT16),\r
+      sizeof (UINT16)\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      sizeof (UINT32),\r
+      sizeof (UINT32)\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_DRIVER_ORDER_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+      sizeof (UINT16),\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckSizeArray\r
+  },\r
+  {\r
+    EFI_HW_ERR_REC_SUPPORT_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+      sizeof (UINT16),\r
+      sizeof (UINT16)\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_SETUP_MODE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      sizeof (UINT8),\r
+      sizeof (UINT8)\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_KEY_EXCHANGE_KEY_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT_AT,\r
+      1,\r
+      MAX_UINTN\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_PLATFORM_KEY_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT_AT,\r
+      1,\r
+      MAX_UINTN\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_SIGNATURE_SUPPORT_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      sizeof (EFI_GUID),\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckSizeArray\r
+  },\r
+  {\r
+    EFI_SECURE_BOOT_MODE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      sizeof (UINT8),\r
+      sizeof (UINT8)\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_KEK_DEFAULT_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      1,\r
+      MAX_UINTN\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_PK_DEFAULT_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      1,\r
+      MAX_UINTN\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_DB_DEFAULT_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      1,\r
+      MAX_UINTN\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_DBX_DEFAULT_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      1,\r
+      MAX_UINTN\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_DBT_DEFAULT_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      1,\r
+      MAX_UINTN\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      sizeof (UINT64),\r
+      sizeof (UINT64)\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_OS_INDICATIONS_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+      sizeof (UINT64),\r
+      sizeof (UINT64)\r
+    },\r
+    NULL\r
+  },\r
+  {\r
+    EFI_VENDOR_KEYS_VARIABLE_NAME,\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY,\r
+      VARIABLE_ATTRIBUTE_BS_RT,\r
+      sizeof (UINT8),\r
+      sizeof (UINT8)\r
+    },\r
+    NULL\r
+  },\r
+};\r
+UEFI_DEFINED_VARIABLE_ENTRY mGlobalVariableList2[] = {\r
+  {\r
+    L"Boot####",\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+      sizeof (EFI_LOAD_OPTION),\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckLoadOption\r
+  },\r
+  {\r
+    L"Driver####",\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+      sizeof (EFI_LOAD_OPTION),\r
+      MAX_UINTN\r
+    },\r
+    InternalVarCheckLoadOption\r
+  },\r
+  {\r
+    L"Key####",\r
+    {\r
+      VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+      0,\r
+      VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+      sizeof (EFI_KEY_OPTION),\r
+      sizeof (EFI_KEY_OPTION) + 3 * sizeof (EFI_INPUT_KEY)\r
+    },\r
+    InternalVarCheckKeyOption\r
+  },\r
+};\r
+\r
+/**\r
+  Get UEFI defined global variable property.\r
+  The code will check if variable guid is global variable guid first.\r
+  If yes, further check if variable name is in mGlobalVariableList or mGlobalVariableList2.\r
+\r
+  @param[in]  VariableName      Pointer to variable name.\r
+  @param[in]  VendorGuid        Variable Vendor Guid.\r
+  @param[in]  WildcardMatch     Try wildcard match or not.\r
+  @param[out] VariableProperty  Pointer to variable property.\r
+  @param[out] VarCheckFunction  Pointer to check function.\r
+\r
+  @retval EFI_SUCCESS           Variable is not global variable.\r
+  @retval EFI_INVALID_PARAMETER Variable is global variable, but variable name is not in the lists.\r
+\r
+**/\r
+EFI_STATUS\r
+GetUefiDefinedVariableProperty (\r
+  IN CHAR16                         *VariableName,\r
+  IN EFI_GUID                       *VendorGuid,\r
+  IN BOOLEAN                        WildcardMatch,\r
+  OUT VAR_CHECK_VARIABLE_PROPERTY   **VariableProperty,\r
+  OUT INTERNAL_VAR_CHECK_FUNCTION   *VarCheckFunction OPTIONAL\r
+  )\r
+{\r
+  UINTN     Index;\r
+  UINTN     NameLength;\r
+\r
+  if (CompareGuid (VendorGuid, &gEfiGlobalVariableGuid)) {\r
+    //\r
+    // Try list 1, exactly match.\r
+    //\r
+    for (Index = 0; Index < sizeof (mGlobalVariableList)/sizeof (mGlobalVariableList[0]); Index++) {\r
+      if (StrCmp (mGlobalVariableList[Index].Name, VariableName) == 0) {\r
+        if (VarCheckFunction != NULL) {\r
+          *VarCheckFunction = mGlobalVariableList[Index].CheckFunction;\r
+        }\r
+        *VariableProperty = &mGlobalVariableList[Index].VariableProperty;\r
+        return EFI_SUCCESS;\r
+      }\r
+    }\r
+\r
+    //\r
+    // Try list 2.\r
+    //\r
+    NameLength = StrLen (VariableName) - 4;\r
+    for (Index = 0; Index < sizeof (mGlobalVariableList2)/sizeof (mGlobalVariableList2[0]); Index++) {\r
+      if (WildcardMatch) {\r
+        if ((StrLen (VariableName) == StrLen (mGlobalVariableList2[Index].Name)) &&\r
+            (StrnCmp (mGlobalVariableList2[Index].Name, VariableName, NameLength) == 0) &&\r
+            IsHexaDecimalDigitCharacter (VariableName[NameLength]) &&\r
+            IsHexaDecimalDigitCharacter (VariableName[NameLength + 1]) &&\r
+            IsHexaDecimalDigitCharacter (VariableName[NameLength + 2]) &&\r
+            IsHexaDecimalDigitCharacter (VariableName[NameLength + 3])) {\r
+          if (VarCheckFunction != NULL) {\r
+            *VarCheckFunction = mGlobalVariableList2[Index].CheckFunction;\r
+          }\r
+          *VariableProperty = &mGlobalVariableList2[Index].VariableProperty;\r
+          return EFI_SUCCESS;\r
+        }\r
+      } else {\r
+        if (StrCmp (mGlobalVariableList2[Index].Name, VariableName) == 0) {\r
+          if (VarCheckFunction != NULL) {\r
+            *VarCheckFunction = mGlobalVariableList2[Index].CheckFunction;\r
+          }\r
+          *VariableProperty = &mGlobalVariableList2[Index].VariableProperty;\r
+          return EFI_SUCCESS;\r
+        }\r
+      }\r
+    }\r
+\r
+    //\r
+    // The variable name is not in the lists.\r
+    //\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  //\r
+  // It is not global variable.\r
+  //\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Internal SetVariable check.\r
+\r
+  @param[in] VariableName       Name of Variable to set.\r
+  @param[in] VendorGuid         Variable vendor GUID.\r
+  @param[in] Attributes         Attribute value of the variable.\r
+  @param[in] DataSize           Size of Data to set.\r
+  @param[in] Data               Data pointer.\r
+\r
+  @retval EFI_SUCCESS           The SetVariable check result was success.\r
+  @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID were supplied,\r
+                                or the DataSize exceeds the minimum or maximum allowed,\r
+                                or the Data value is not following UEFI spec for UEFI defined variables.\r
+  @retval EFI_WRITE_PROTECTED   The variable in question is read-only.\r
+  @retval Others                The return status from check handler.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InternalVarCheckSetVariableCheck (\r
+  IN CHAR16     *VariableName,\r
+  IN EFI_GUID   *VendorGuid,\r
+  IN UINT32     Attributes,\r
+  IN UINTN      DataSize,\r
+  IN VOID       *Data\r
+  )\r
+{\r
+  EFI_STATUS                    Status;\r
+  UINTN                         Index;\r
+  LIST_ENTRY                    *Link;\r
+  VAR_CHECK_VARIABLE_ENTRY      *Entry;\r
+  CHAR16                        *Name;\r
+  VAR_CHECK_VARIABLE_PROPERTY   *Property;\r
+  INTERNAL_VAR_CHECK_FUNCTION   VarCheckFunction;\r
+\r
+  if (!mEndOfDxe) {\r
+    //\r
+    // Only do check after End Of Dxe.\r
+    //\r
+    return EFI_SUCCESS;\r
+  }\r
+\r
+  Property = NULL;\r
+  Status = GetUefiDefinedVariableProperty (VariableName, VendorGuid, TRUE, &Property, &VarCheckFunction);\r
+  if (EFI_ERROR (Status)) {\r
+    DEBUG ((EFI_D_INFO, "[Variable]: Var Check UEFI defined variable fail %r - %g:%s\n", Status, VendorGuid, VariableName));\r
+    return Status;\r
+  }\r
+  if (Property == NULL) {\r
+    VarCheckFunction = NULL;\r
+    for ( Link = GetFirstNode (&mVarCheckVariableList)\r
+        ; !IsNull (&mVarCheckVariableList, Link)\r
+        ; Link = GetNextNode (&mVarCheckVariableList, Link)\r
+        ) {\r
+      Entry = BASE_CR (Link, VAR_CHECK_VARIABLE_ENTRY, Link);\r
+      Name = (CHAR16 *) ((UINTN) Entry + sizeof (*Entry));\r
+      if (CompareGuid (&Entry->Guid, VendorGuid) && (StrCmp (Name, VariableName) == 0)) {\r
+        Property = &Entry->VariableProperty;\r
+        break;\r
+      }\r
+    }\r
+  }\r
+  if (Property != NULL) {\r
+    if (mEnableLocking && ((Property->Property & VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY) != 0)) {\r
+      DEBUG ((EFI_D_INFO, "[Variable]: Var Check ReadOnly variable fail %r - %g:%s\n", EFI_WRITE_PROTECTED, VendorGuid, VariableName));\r
+      return EFI_WRITE_PROTECTED;\r
+    }\r
+    if ((DataSize == 0) || (Attributes == 0)) {\r
+      //\r
+      // Do not check delete variable.\r
+      //\r
+      return EFI_SUCCESS;\r
+    }\r
+    if (Attributes != Property->Attributes) {\r
+      DEBUG ((EFI_D_INFO, "[Variable]: Var Check Attributes fail %r - %g:%s\n", EFI_INVALID_PARAMETER, VendorGuid, VariableName));\r
+      return EFI_INVALID_PARAMETER;\r
+    }\r
+    if ((DataSize < Property->MinSize) || (DataSize > Property->MaxSize)) {\r
+      DEBUG ((EFI_D_INFO, "[Variable]: Var Check DataSize fail %r - %g:%s\n", EFI_INVALID_PARAMETER, VendorGuid, VariableName));\r
+      return EFI_INVALID_PARAMETER;\r
+    }\r
+    if (VarCheckFunction != NULL) {\r
+      Status = VarCheckFunction (\r
+                 Property,\r
+                 DataSize,\r
+                 Data\r
+                 );\r
+      if (EFI_ERROR (Status)) {\r
+        DEBUG ((EFI_D_INFO, "[Variable]: Internal Var Check function fail %r - %g:%s\n", Status, VendorGuid, VariableName));\r
+        return Status;\r
+      }\r
+    }\r
+  }\r
+\r
+  for (Index = 0; Index < mNumberOfHandler; Index++) {\r
+    Status = mHandlerTable[Index] (\r
+               VariableName,\r
+               VendorGuid,\r
+               Attributes,\r
+               DataSize,\r
+               Data\r
+               );\r
+    if (EFI_ERROR (Status)) {\r
+      DEBUG ((EFI_D_INFO, "[Variable]: Var Check handler fail %r - %g:%s\n", Status, VendorGuid, VariableName));\r
+      return Status;\r
+    }\r
+  }\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Reallocates more global memory to store the registered handler list.\r
+\r
+  @retval RETURN_SUCCESS            Reallocate memory successfully.\r
+  @retval RETURN_OUT_OF_RESOURCES   No enough memory to allocate.\r
+\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+ReallocateHandlerTable (\r
+  VOID\r
+  )\r
+{\r
+  VAR_CHECK_SET_VARIABLE_CHECK_HANDLER  *HandlerTable;\r
+\r
+  //\r
+  // Reallocate memory for check handler table.\r
+  //\r
+  HandlerTable = ReallocateRuntimePool (\r
+                     mMaxNumberOfHandler * sizeof (VAR_CHECK_SET_VARIABLE_CHECK_HANDLER), \r
+                     (mMaxNumberOfHandler + VAR_CHECK_HANDLER_TABLE_SIZE) * sizeof (VAR_CHECK_SET_VARIABLE_CHECK_HANDLER), \r
+                     mHandlerTable\r
+                     );\r
+\r
+  //\r
+  // No enough resource to allocate.\r
+  //\r
+  if (HandlerTable == NULL) {\r
+    return RETURN_OUT_OF_RESOURCES;\r
+  }\r
+\r
+  mHandlerTable = HandlerTable;\r
+  //\r
+  // Increase max handler number.\r
+  //\r
+  mMaxNumberOfHandler = mMaxNumberOfHandler + VAR_CHECK_HANDLER_TABLE_SIZE;\r
+  return RETURN_SUCCESS;\r
+}\r
+\r
+/**\r
+  Register SetVariable check handler.\r
+\r
+  @param[in] Handler            Pointer to check handler.\r
+\r
+  @retval EFI_SUCCESS           The SetVariable check handler was registered successfully.\r
+  @retval EFI_INVALID_PARAMETER Handler is NULL.\r
+  @retval EFI_ACCESS_DENIED     EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r
+                                already been signaled.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough resource for the SetVariable check handler register request.\r
+  @retval EFI_UNSUPPORTED       This interface is not implemented.\r
+                                For example, it is unsupported in VarCheck protocol if both VarCheck and SmmVarCheck protocols are present.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckRegisterSetVariableCheckHandler (\r
+  IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER   Handler\r
+  )\r
+{\r
+  EFI_STATUS    Status;\r
+\r
+  if (Handler == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if (mEndOfDxe) {\r
+    return EFI_ACCESS_DENIED;\r
+  }\r
+\r
+  DEBUG ((EFI_D_INFO, "RegisterSetVariableCheckHandler - 0x%x\n", Handler));\r
+\r
+  //\r
+  // Check whether the handler list is enough to store new handler.\r
+  //\r
+  if (mNumberOfHandler == mMaxNumberOfHandler) {\r
+    //\r
+    // Allocate more resources for new handler.\r
+    //\r
+    Status = ReallocateHandlerTable();\r
+    if (EFI_ERROR (Status)) {\r
+      return Status;\r
+    }\r
+  }\r
+\r
+  //\r
+  // Register new handler into the handler list.\r
+  //\r
+  mHandlerTable[mNumberOfHandler] = Handler;\r
+  mNumberOfHandler++;\r
+\r
+  return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+  Internal variable property get.\r
+\r
+  @param[in] Name   Pointer to the variable name.\r
+  @param[in] Guid   Pointer to the vendor GUID.\r
+\r
+  @return Pointer to the property of variable specified by the Name and Guid.\r
+\r
+**/\r
+VAR_CHECK_VARIABLE_PROPERTY *\r
+InternalVarCheckVariablePropertyGet (\r
+  IN CHAR16                         *Name,\r
+  IN EFI_GUID                       *Guid\r
+  )\r
+{\r
+  LIST_ENTRY                    *Link;\r
+  VAR_CHECK_VARIABLE_ENTRY      *Entry;\r
+  CHAR16                        *VariableName;\r
+  VAR_CHECK_VARIABLE_PROPERTY   *Property;\r
+\r
+  Property = NULL;\r
+  GetUefiDefinedVariableProperty (Name, Guid, FALSE, &Property, NULL);\r
+  if (Property != NULL) {\r
+    return Property;\r
+  } else {\r
+    for ( Link = GetFirstNode (&mVarCheckVariableList)\r
+        ; !IsNull (&mVarCheckVariableList, Link)\r
+        ; Link = GetNextNode (&mVarCheckVariableList, Link)\r
+        ) {\r
+      Entry = BASE_CR (Link, VAR_CHECK_VARIABLE_ENTRY, Link);\r
+      VariableName = (CHAR16 *) ((UINTN) Entry + sizeof (*Entry));\r
+      if (CompareGuid (&Entry->Guid, Guid) && (StrCmp (VariableName, Name) == 0)) {\r
+        return &Entry->VariableProperty;\r
+      }\r
+    }\r
+  }\r
+\r
+  return NULL;\r
+}\r
+\r
+/**\r
+  Variable property set.\r
+\r
+  @param[in] Name               Pointer to the variable name.\r
+  @param[in] Guid               Pointer to the vendor GUID.\r
+  @param[in] VariableProperty   Pointer to the input variable property.\r
+\r
+  @retval EFI_SUCCESS           The property of variable specified by the Name and Guid was set successfully.\r
+  @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string,\r
+                                or the fields of VariableProperty are not valid.\r
+  @retval EFI_ACCESS_DENIED     EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r
+                                already been signaled.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough resource for the variable property set request.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckVariablePropertySet (\r
+  IN CHAR16                         *Name,\r
+  IN EFI_GUID                       *Guid,\r
+  IN VAR_CHECK_VARIABLE_PROPERTY    *VariableProperty\r
+  )\r
+{\r
+  EFI_STATUS                    Status;\r
+  VAR_CHECK_VARIABLE_ENTRY      *Entry;\r
+  CHAR16                        *VariableName;\r
+  VAR_CHECK_VARIABLE_PROPERTY   *Property;\r
+\r
+  if (Name == NULL || Name[0] == 0 || Guid == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if (VariableProperty == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if (VariableProperty->Revision != VAR_CHECK_VARIABLE_PROPERTY_REVISION) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if (mEndOfDxe) {\r
+    return EFI_ACCESS_DENIED;\r
+  }\r
+\r
+  Status = EFI_SUCCESS;\r
+\r
+  AcquireLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
+\r
+  Property = InternalVarCheckVariablePropertyGet (Name, Guid);\r
+  if (Property != NULL) {\r
+    CopyMem (Property, VariableProperty, sizeof (*VariableProperty));\r
+  } else {\r
+    Entry = AllocateRuntimeZeroPool (sizeof (*Entry) + StrSize (Name));\r
+    if (Entry == NULL) {\r
+      Status = EFI_OUT_OF_RESOURCES;\r
+      goto Done;\r
+    }\r
+    VariableName = (CHAR16 *) ((UINTN) Entry + sizeof (*Entry));\r
+    StrnCpy (VariableName, Name, StrLen (Name));\r
+    CopyGuid (&Entry->Guid, Guid);\r
+    CopyMem (&Entry->VariableProperty, VariableProperty, sizeof (*VariableProperty));\r
+    InsertTailList (&mVarCheckVariableList, &Entry->Link);\r
+  }\r
+\r
+Done:\r
+  ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
+\r
+  return Status;\r
+}\r
+\r
+/**\r
+  Variable property get.\r
+\r
+  @param[in]  Name              Pointer to the variable name.\r
+  @param[in]  Guid              Pointer to the vendor GUID.\r
+  @param[out] VariableProperty  Pointer to the output variable property.\r
+\r
+  @retval EFI_SUCCESS           The property of variable specified by the Name and Guid was got successfully.\r
+  @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string.\r
+  @retval EFI_NOT_FOUND         The property of variable specified by the Name and Guid was not found.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckVariablePropertyGet (\r
+  IN CHAR16                         *Name,\r
+  IN EFI_GUID                       *Guid,\r
+  OUT VAR_CHECK_VARIABLE_PROPERTY   *VariableProperty\r
+  )\r
+{\r
+  LIST_ENTRY                    *Link;\r
+  VARIABLE_ENTRY                *Entry;\r
+  CHAR16                        *VariableName;\r
+  BOOLEAN                       Found;\r
+  VAR_CHECK_VARIABLE_PROPERTY   *Property;\r
+\r
+  if (Name == NULL || Name[0] == 0 || Guid == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if (VariableProperty == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  Found = FALSE;\r
+\r
+  AcquireLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
+\r
+  Property = InternalVarCheckVariablePropertyGet (Name, Guid);\r
+  if (Property != NULL) {\r
+    CopyMem (VariableProperty, Property, sizeof (*VariableProperty));\r
+    Found = TRUE;\r
+  }\r
+\r
+  for ( Link = GetFirstNode (&mLockedVariableList)\r
+      ; !IsNull (&mLockedVariableList, Link)\r
+      ; Link = GetNextNode (&mLockedVariableList, Link)\r
+      ) {\r
+    Entry = BASE_CR (Link, VARIABLE_ENTRY, Link);\r
+    VariableName = (CHAR16 *) ((UINTN) Entry + sizeof (*Entry));\r
+    if (CompareGuid (&Entry->Guid, Guid) && (StrCmp (VariableName, Name) == 0)) {\r
+      VariableProperty->Property |= VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY;\r
+      if (!Found) {\r
+        VariableProperty->Revision = VAR_CHECK_VARIABLE_PROPERTY_REVISION;\r
+        Found = TRUE;\r
+      }\r
+    }\r
+  }\r
+\r
+  ReleaseLockOnlyAtBootTime (&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
+\r
+  return (Found ? EFI_SUCCESS : EFI_NOT_FOUND);\r
+}\r
+\r
index 3dac84a6b9dbfb49a775941af4972faaf987060a..e3c06b39622bd5a8e47a9dae7fed2f1f9e678948 100644 (file)
@@ -14,7 +14,7 @@
   VariableServiceGetVariable() and VariableServiceSetVariable() are external API\r
   to receive datasize and data buffer. The size should be checked carefully.\r
 \r
-Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2015, 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
@@ -55,51 +55,6 @@ BOOLEAN                mEndOfDxe              = FALSE;
 ///\r
 BOOLEAN                mEnableLocking         = TRUE;\r
 \r
-//\r
-// To prevent name collisions with possible future globally defined variables,\r
-// other internal firmware data variables that are not defined here must be\r
-// saved with a unique VendorGuid other than EFI_GLOBAL_VARIABLE or\r
-// any other GUID defined by the UEFI Specification. Implementations must\r
-// only permit the creation of variables with a UEFI Specification-defined\r
-// VendorGuid when these variables are documented in the UEFI Specification.\r
-//\r
-GLOBAL_VARIABLE_ENTRY mGlobalVariableList[] = {\r
-  {EFI_LANG_CODES_VARIABLE_NAME,             VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_LANG_VARIABLE_NAME,                   VARIABLE_ATTRIBUTE_NV_BS_RT},\r
-  {EFI_TIME_OUT_VARIABLE_NAME,               VARIABLE_ATTRIBUTE_NV_BS_RT},\r
-  {EFI_PLATFORM_LANG_CODES_VARIABLE_NAME,    VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_PLATFORM_LANG_VARIABLE_NAME,          VARIABLE_ATTRIBUTE_NV_BS_RT},\r
-  {EFI_CON_IN_VARIABLE_NAME,                 VARIABLE_ATTRIBUTE_NV_BS_RT},\r
-  {EFI_CON_OUT_VARIABLE_NAME,                VARIABLE_ATTRIBUTE_NV_BS_RT},\r
-  {EFI_ERR_OUT_VARIABLE_NAME,                VARIABLE_ATTRIBUTE_NV_BS_RT},\r
-  {EFI_CON_IN_DEV_VARIABLE_NAME,             VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_CON_OUT_DEV_VARIABLE_NAME,            VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_ERR_OUT_DEV_VARIABLE_NAME,            VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_BOOT_ORDER_VARIABLE_NAME,             VARIABLE_ATTRIBUTE_NV_BS_RT},\r
-  {EFI_BOOT_NEXT_VARIABLE_NAME,              VARIABLE_ATTRIBUTE_NV_BS_RT},\r
-  {EFI_BOOT_CURRENT_VARIABLE_NAME,           VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_BOOT_OPTION_SUPPORT_VARIABLE_NAME,    VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_DRIVER_ORDER_VARIABLE_NAME,           VARIABLE_ATTRIBUTE_NV_BS_RT},\r
-  {EFI_HW_ERR_REC_SUPPORT_VARIABLE_NAME,     VARIABLE_ATTRIBUTE_NV_BS_RT},\r
-  {EFI_SETUP_MODE_NAME,                      VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_KEY_EXCHANGE_KEY_NAME,                VARIABLE_ATTRIBUTE_NV_BS_RT_AT},\r
-  {EFI_PLATFORM_KEY_NAME,                    VARIABLE_ATTRIBUTE_NV_BS_RT_AT},\r
-  {EFI_SIGNATURE_SUPPORT_NAME,               VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_SECURE_BOOT_MODE_NAME,                VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_KEK_DEFAULT_VARIABLE_NAME,            VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_PK_DEFAULT_VARIABLE_NAME,             VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_DB_DEFAULT_VARIABLE_NAME,             VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_DBX_DEFAULT_VARIABLE_NAME,            VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_DBT_DEFAULT_VARIABLE_NAME,            VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_OS_INDICATIONS_SUPPORT_VARIABLE_NAME, VARIABLE_ATTRIBUTE_BS_RT},\r
-  {EFI_OS_INDICATIONS_VARIABLE_NAME,         VARIABLE_ATTRIBUTE_NV_BS_RT},\r
-  {EFI_VENDOR_KEYS_VARIABLE_NAME,            VARIABLE_ATTRIBUTE_BS_RT},\r
-};\r
-GLOBAL_VARIABLE_ENTRY mGlobalVariableList2[] = {\r
-  {L"Boot####",                              VARIABLE_ATTRIBUTE_NV_BS_RT},\r
-  {L"Driver####",                            VARIABLE_ATTRIBUTE_NV_BS_RT},\r
-  {L"Key####",                               VARIABLE_ATTRIBUTE_NV_BS_RT},\r
-};\r
 \r
 /**\r
   Routine used to track statistical information about variable usage. \r
@@ -2174,63 +2129,6 @@ IsHwErrRecVariable (
   return TRUE;\r
 }\r
 \r
-/**\r
-  This code checks if variable guid is global variable guid first.\r
-  If yes, further check if variable name is in mGlobalVariableList or mGlobalVariableList2 and attributes matched.\r
-\r
-  @param[in] VariableName       Pointer to variable name.\r
-  @param[in] VendorGuid         Variable Vendor Guid.\r
-  @param[in] Attributes         Attributes of the variable.\r
-\r
-  @retval EFI_SUCCESS           Variable is not global variable, or Variable is global variable, variable name is in the lists and attributes matched.\r
-  @retval EFI_INVALID_PARAMETER Variable is global variable, but variable name is not in the lists or attributes unmatched.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-CheckEfiGlobalVariable (\r
-  IN CHAR16             *VariableName,\r
-  IN EFI_GUID           *VendorGuid,\r
-  IN UINT32             Attributes\r
-  )\r
-{\r
-  UINTN     Index;\r
-  UINTN     NameLength;\r
-\r
-  if (CompareGuid (VendorGuid, &gEfiGlobalVariableGuid)){\r
-    //\r
-    // Try list 1, exactly match.\r
-    //\r
-    for (Index = 0; Index < sizeof (mGlobalVariableList)/sizeof (mGlobalVariableList[0]); Index++) {\r
-      if ((StrCmp (mGlobalVariableList[Index].Name, VariableName) == 0) &&\r
-          (Attributes == 0 || Attributes == mGlobalVariableList[Index].Attributes)) {\r
-        return EFI_SUCCESS;\r
-      }\r
-    }\r
-\r
-    //\r
-    // Try list 2.\r
-    //\r
-    NameLength = StrLen (VariableName) - 4;\r
-    for (Index = 0; Index < sizeof (mGlobalVariableList2)/sizeof (mGlobalVariableList2[0]); Index++) {\r
-      if ((StrLen (VariableName) == StrLen (mGlobalVariableList2[Index].Name)) &&\r
-          (StrnCmp (mGlobalVariableList2[Index].Name, VariableName, NameLength) == 0) &&\r
-          IsHexaDecimalDigitCharacter (VariableName[NameLength]) &&\r
-          IsHexaDecimalDigitCharacter (VariableName[NameLength + 1]) &&\r
-          IsHexaDecimalDigitCharacter (VariableName[NameLength + 2]) &&\r
-          IsHexaDecimalDigitCharacter (VariableName[NameLength + 3]) &&\r
-          (Attributes == 0 || Attributes == mGlobalVariableList2[Index].Attributes)) {\r
-        return EFI_SUCCESS;\r
-      }\r
-    }\r
-\r
-    DEBUG ((EFI_D_INFO, "[Variable]: set global variable with invalid variable name or attributes - %g:%s:%x\n", VendorGuid, VariableName, Attributes));\r
-    return EFI_INVALID_PARAMETER;\r
-  }\r
-\r
-  return EFI_SUCCESS;\r
-}\r
-\r
 /**\r
   Mark a variable that will become read-only after leaving the DXE phase of execution.\r
 \r
@@ -2255,6 +2153,7 @@ VariableLockRequestToLock (
   )\r
 {\r
   VARIABLE_ENTRY                  *Entry;\r
+  CHAR16                          *Name;\r
 \r
   if (VariableName == NULL || VariableName[0] == 0 || VendorGuid == NULL) {\r
     return EFI_INVALID_PARAMETER;\r
@@ -2273,8 +2172,8 @@ VariableLockRequestToLock (
 \r
   AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
 \r
-  Entry->Name = (CHAR16 *) (Entry + 1);\r
-  StrnCpy   (Entry->Name, VariableName, StrLen (VariableName));\r
+  Name = (CHAR16 *) ((UINTN) Entry + sizeof (*Entry));\r
+  StrnCpy   (Name, VariableName, StrLen (VariableName));\r
   CopyGuid (&Entry->Guid, VendorGuid);\r
   InsertTailList (&mLockedVariableList, &Entry->Link);\r
 \r
@@ -2567,6 +2466,7 @@ VariableServiceSetVariable (
   EFI_PHYSICAL_ADDRESS                Point;\r
   LIST_ENTRY                          *Link;\r
   VARIABLE_ENTRY                      *Entry;\r
+  CHAR16                              *Name;\r
 \r
   //\r
   // Check input parameters.\r
@@ -2619,12 +2519,7 @@ VariableServiceSetVariable (
     //\r
     if (StrSize (VariableName) + DataSize > PcdGet32 (PcdMaxVariableSize) - sizeof (VARIABLE_HEADER)) {\r
       return EFI_INVALID_PARAMETER;\r
-    }  \r
-  }\r
-\r
-  Status = CheckEfiGlobalVariable (VariableName, VendorGuid, Attributes);\r
-  if (EFI_ERROR (Status)) {\r
-    return Status;\r
+    }\r
   }\r
 \r
   AcquireLockOnlyAtBootTime(&mVariableModuleGlobal->VariableGlobal.VariableServicesLock);\r
@@ -2653,7 +2548,8 @@ VariableServiceSetVariable (
         ; Link = GetNextNode (&mLockedVariableList, Link)\r
         ) {\r
       Entry = BASE_CR (Link, VARIABLE_ENTRY, Link);\r
-      if (CompareGuid (&Entry->Guid, VendorGuid) && (StrCmp (Entry->Name, VariableName) == 0)) {\r
+      Name = (CHAR16 *) ((UINTN) Entry + sizeof (*Entry));\r
+      if (CompareGuid (&Entry->Guid, VendorGuid) && (StrCmp (Name, VariableName) == 0)) {\r
         Status = EFI_WRITE_PROTECTED;\r
         DEBUG ((EFI_D_INFO, "[Variable]: Changing readonly variable after leaving DXE phase - %g:%s\n", VendorGuid, VariableName));\r
         goto Done;\r
@@ -2661,6 +2557,11 @@ VariableServiceSetVariable (
     }\r
   }\r
 \r
+  Status = InternalVarCheckSetVariableCheck (VariableName, VendorGuid, Attributes, DataSize, Data);\r
+  if (EFI_ERROR (Status)) {\r
+    goto Done;\r
+  }\r
+\r
   //\r
   // Check whether the input variable is already existed.\r
   //\r
@@ -2678,6 +2579,7 @@ VariableServiceSetVariable (
       // 2. The only attribute differing is EFI_VARIABLE_APPEND_WRITE\r
       //\r
       Status = EFI_INVALID_PARAMETER;\r
+      DEBUG ((EFI_D_INFO, "[Variable]: Rewritten a preexisting variable with different attributes - %g:%s\n", VendorGuid, VariableName));\r
       goto Done;\r
     }\r
   }\r
index ac71f0c957ad8e77687cd92ec4ef902fe1079c75..eb21cd854b7a8b53b246116bfd2ed5b607161442 100644 (file)
@@ -3,7 +3,7 @@
   The internal header file includes the common header files, defines\r
   internal structure and functions used by Variable modules.\r
 \r
-Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2015, 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
@@ -23,6 +23,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Protocol/FirmwareVolumeBlock.h>\r
 #include <Protocol/Variable.h>\r
 #include <Protocol/VariableLock.h>\r
+#include <Protocol/VarCheck.h>\r
 #include <Library/PcdLib.h>\r
 #include <Library/HobLib.h>\r
 #include <Library/UefiDriverEntryPoint.h>\r
@@ -46,11 +47,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define VARIABLE_ATTRIBUTE_NV_BS_RT     (VARIABLE_ATTRIBUTE_BS_RT | EFI_VARIABLE_NON_VOLATILE)\r
 #define VARIABLE_ATTRIBUTE_NV_BS_RT_AT  (VARIABLE_ATTRIBUTE_NV_BS_RT | EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS)\r
 \r
-typedef struct {\r
-  CHAR16      *Name;\r
-  UINT32      Attributes;\r
-} GLOBAL_VARIABLE_ENTRY;\r
-\r
 ///\r
 /// The size of a 3 character ISO639 language code.\r
 ///\r
@@ -105,9 +101,9 @@ typedef struct {
 } VARIABLE_ENTRY_CONSISTENCY;\r
 \r
 typedef struct {\r
-  EFI_GUID    Guid;\r
-  CHAR16      *Name;\r
   LIST_ENTRY  Link;\r
+  EFI_GUID    Guid;\r
+  //CHAR16      *Name;\r
 } VARIABLE_ENTRY;\r
 \r
 /**\r
@@ -395,6 +391,9 @@ VariableServiceGetVariable (
 \r
   This code Finds the Next available variable.\r
 \r
+  Caution: This function may receive untrusted input.\r
+  This function may be invoked in SMM mode. This function will do basic validation, before parse the data.\r
+\r
   @param VariableNameSize           Size of the variable name.\r
   @param VariableName               Pointer to variable name.\r
   @param VendorGuid                 Variable Vendor Guid.\r
@@ -417,6 +416,10 @@ VariableServiceGetNextVariableName (
 \r
   This code sets variable in storage blocks (Volatile or Non-Volatile).\r
 \r
+  Caution: This function may receive untrusted input.\r
+  This function may be invoked in SMM mode, and datasize and data are external input.\r
+  This function will do basic validation, before parse the data.\r
+\r
   @param VariableName                     Name of Variable to be found.\r
   @param VendorGuid                       Variable vendor GUID.\r
   @param Attributes                       Attribute value of the variable found\r
@@ -445,6 +448,9 @@ VariableServiceSetVariable (
 \r
   This code returns information about the EFI variables.\r
 \r
+  Caution: This function may receive untrusted input.\r
+  This function may be invoked in SMM mode. This function will do basic validation, before parse the data.\r
+\r
   @param Attributes                     Attributes bitmask to specify the type of variables\r
                                         on which to return information.\r
   @param MaximumVariableStorageSize     Pointer to the maximum size of the storage space available\r
@@ -470,6 +476,9 @@ VariableServiceQueryVariableInfoInternal (
 \r
   This code returns information about the EFI variables.\r
 \r
+  Caution: This function may receive untrusted input.\r
+  This function may be invoked in SMM mode. This function will do basic validation, before parse the data.\r
+\r
   @param Attributes                     Attributes bitmask to specify the type of variables\r
                                         on which to return information.\r
   @param MaximumVariableStorageSize     Pointer to the maximum size of the storage space available\r
@@ -516,6 +525,116 @@ VariableLockRequestToLock (
   IN       EFI_GUID                     *VendorGuid\r
   );\r
 \r
+/**\r
+  Check if a Unicode character is a hexadecimal character.\r
+\r
+  This function checks if a Unicode character is a\r
+  hexadecimal character.  The valid hexadecimal character is\r
+  L'0' to L'9', L'a' to L'f', or L'A' to L'F'.\r
+\r
+\r
+  @param Char           The character to check against.\r
+\r
+  @retval TRUE          If the Char is a hexadecmial character.\r
+  @retval FALSE         If the Char is not a hexadecmial character.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsHexaDecimalDigitCharacter (\r
+  IN CHAR16             Char\r
+  );\r
+\r
+/**\r
+  Internal SetVariable check.\r
+\r
+  @param[in] VariableName       Name of Variable to set.\r
+  @param[in] VendorGuid         Variable vendor GUID.\r
+  @param[in] Attributes         Attribute value of the variable.\r
+  @param[in] DataSize           Size of Data to set.\r
+  @param[in] Data               Data pointer.\r
+\r
+  @retval EFI_SUCCESS           The SetVariable check result was success.\r
+  @retval EFI_INVALID_PARAMETER An invalid combination of attribute bits, name, and GUID were supplied,\r
+                                or the DataSize exceeds the minimum or maximum allowed,\r
+                                or the Data value is not following UEFI spec for UEFI defined variables.\r
+  @retval EFI_WRITE_PROTECTED   The variable in question is read-only.\r
+  @retval Others                The return status from check handler.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+InternalVarCheckSetVariableCheck (\r
+  IN CHAR16     *VariableName,\r
+  IN EFI_GUID   *VendorGuid,\r
+  IN UINT32     Attributes,\r
+  IN UINTN      DataSize,\r
+  IN VOID       *Data\r
+  );\r
+\r
+/**\r
+  Register SetVariable check handler.\r
+\r
+  @param[in] Handler            Pointer to check handler.\r
+\r
+  @retval EFI_SUCCESS           The SetVariable check handler was registered successfully.\r
+  @retval EFI_INVALID_PARAMETER Handler is NULL.\r
+  @retval EFI_ACCESS_DENIED     EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r
+                                already been signaled.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough resource for the SetVariable check handler register request.\r
+  @retval EFI_UNSUPPORTED       This interface is not implemented.\r
+                                For example, it is unsupported in VarCheck protocol if both VarCheck and SmmVarCheck protocols are present.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckRegisterSetVariableCheckHandler (\r
+  IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER   Handler\r
+  );\r
+\r
+/**\r
+  Variable property set.\r
+\r
+  @param[in] Name               Pointer to the variable name.\r
+  @param[in] Guid               Pointer to the vendor GUID.\r
+  @param[in] VariableProperty   Pointer to the input variable property.\r
+\r
+  @retval EFI_SUCCESS           The property of variable specified by the Name and Guid was set successfully.\r
+  @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string,\r
+                                or the fields of VariableProperty are not valid.\r
+  @retval EFI_ACCESS_DENIED     EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r
+                                already been signaled.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough resource for the variable property set request.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckVariablePropertySet (\r
+  IN CHAR16                         *Name,\r
+  IN EFI_GUID                       *Guid,\r
+  IN VAR_CHECK_VARIABLE_PROPERTY    *VariableProperty\r
+  );\r
+\r
+/**\r
+  Variable property get.\r
+\r
+  @param[in]  Name              Pointer to the variable name.\r
+  @param[in]  Guid              Pointer to the vendor GUID.\r
+  @param[out] VariableProperty  Pointer to the output variable property.\r
+\r
+  @retval EFI_SUCCESS           The property of variable specified by the Name and Guid was got successfully.\r
+  @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string.\r
+  @retval EFI_NOT_FOUND         The property of variable specified by the Name and Guid was not found.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckVariablePropertyGet (\r
+  IN CHAR16                         *Name,\r
+  IN EFI_GUID                       *Guid,\r
+  OUT VAR_CHECK_VARIABLE_PROPERTY   *VariableProperty\r
+  );\r
+\r
 extern VARIABLE_MODULE_GLOBAL  *mVariableModuleGlobal;\r
 \r
 #endif\r
index 2b7b0ecfb7ea10c948af3753300c5dd654c58fdf..2aa04f1fef8aee935a0d9764de388f03bdd09f40 100644 (file)
@@ -4,7 +4,7 @@
   and volatile storage space and install variable architecture protocol.\r
   \r
 Copyright (C) 2013, Red Hat, Inc.\r
-Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2015, 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
@@ -23,8 +23,14 @@ EFI_HANDLE                     mHandle                    = NULL;
 EFI_EVENT                      mVirtualAddressChangeEvent = NULL;\r
 EFI_EVENT                      mFtwRegistration           = NULL;\r
 extern LIST_ENTRY              mLockedVariableList;\r
+extern LIST_ENTRY              mVarCheckVariableList;\r
+extern UINT32                  mNumberOfHandler;\r
+extern VAR_CHECK_SET_VARIABLE_CHECK_HANDLER *mHandlerTable;\r
 extern BOOLEAN                 mEndOfDxe;\r
 EDKII_VARIABLE_LOCK_PROTOCOL   mVariableLock              = { VariableLockRequestToLock };\r
+EDKII_VAR_CHECK_PROTOCOL       mVarCheck                  = { VarCheckRegisterSetVariableCheckHandler,\r
+                                                              VarCheckVariablePropertySet,\r
+                                                              VarCheckVariablePropertyGet };\r
 \r
 /**\r
   Return TRUE if ExitBootServices () has been called.\r
@@ -222,9 +228,8 @@ VariableClassAddressChangeEvent (
   IN VOID                                 *Context\r
   )\r
 {\r
-  LIST_ENTRY     *Link;\r
-  VARIABLE_ENTRY *Entry;\r
   EFI_STATUS     Status;\r
+  UINTN          Index;\r
 \r
   EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->GetBlockSize);\r
   EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->FvbInstance->GetPhysicalAddress);\r
@@ -242,23 +247,16 @@ VariableClassAddressChangeEvent (
   EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal->VariableGlobal.HobVariableBase);\r
   EfiConvertPointer (0x0, (VOID **) &mVariableModuleGlobal);\r
   EfiConvertPointer (0x0, (VOID **) &mNvVariableCache);  \r
-\r
-  //\r
-  // in the list of locked variables, convert the name pointers first\r
-  //\r
-  for ( Link = GetFirstNode (&mLockedVariableList)\r
-      ; !IsNull (&mLockedVariableList, Link)\r
-      ; Link = GetNextNode (&mLockedVariableList, Link)\r
-      ) {\r
-    Entry = BASE_CR (Link, VARIABLE_ENTRY, Link);\r
-    Status = EfiConvertPointer (0x0, (VOID **) &Entry->Name);\r
-    ASSERT_EFI_ERROR (Status);\r
+  EfiConvertPointer (0x0, (VOID **) &mHandlerTable);\r
+  for (Index = 0; Index < mNumberOfHandler; Index++) {\r
+    EfiConvertPointer (0x0, (VOID **) &mHandlerTable[Index]);\r
   }\r
-  //\r
-  // second, convert the list itself using UefiRuntimeLib\r
-  //\r
+\r
   Status = EfiConvertList (0x0, &mLockedVariableList);\r
   ASSERT_EFI_ERROR (Status);\r
+\r
+  Status = EfiConvertList (0x0, &mVarCheckVariableList);\r
+  ASSERT_EFI_ERROR (Status);\r
 }\r
 \r
 \r
@@ -442,6 +440,14 @@ VariableServiceInitialize (
                   );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
+  Status = gBS->InstallMultipleProtocolInterfaces (\r
+                  &mHandle,\r
+                  &gEdkiiVarCheckProtocolGuid,\r
+                  &mVarCheck,\r
+                  NULL\r
+                  );\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
   SystemTable->RuntimeServices->GetVariable         = VariableServiceGetVariable;\r
   SystemTable->RuntimeServices->GetNextVariableName = VariableServiceGetNextVariableName;\r
   SystemTable->RuntimeServices->SetVariable         = VariableServiceSetVariable;\r
index f8ee4684e2fde7b64ca8ad5bcb1235ac1e38ffe2..007a6dc591ebf778883c7af669925821c96b11a3 100644 (file)
@@ -8,7 +8,7 @@
 #  This external input must be validated carefully to avoid security issues such as\r
 #  buffer overflow or integer overflow.\r
 #\r
-# Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR>\r
 #\r
 #  This program and the accompanying materials\r
 #  are licensed and made available under the terms and conditions of the BSD License\r
@@ -42,6 +42,7 @@
   Variable.c\r
   VariableDxe.c\r
   Variable.h\r
+  VarCheck.c\r
 \r
 [Packages]\r
   MdePkg/MdePkg.dec\r
@@ -60,6 +61,7 @@
   UefiDriverEntryPoint\r
   PcdLib\r
   HobLib\r
+  DevicePathLib\r
 \r
 [Protocols]\r
   gEfiFirmwareVolumeBlockProtocolGuid           ## CONSUMES\r
@@ -69,6 +71,7 @@
   gEfiVariableWriteArchProtocolGuid             ## PRODUCES\r
   gEfiVariableArchProtocolGuid                  ## PRODUCES\r
   gEdkiiVariableLockProtocolGuid                ## PRODUCES\r
+  gEdkiiVarCheckProtocolGuid                    ## PRODUCES\r
 \r
 [Guids]\r
   ## PRODUCES             ## GUID # Signature of Variable store header\r
index a80948bce8279d25e526749aed855bd4a172d708..6df1660a04c3ed914110724a7a71ef57dc5fdd49 100644 (file)
@@ -15,7 +15,7 @@
   VariableServiceSetVariable(), VariableServiceQueryVariableInfo(), ReclaimForOS(), \r
   SmmVariableGetStatistics() should also do validation based on its own knowledge.\r
 \r
-Copyright (c) 2010 - 2013, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2010 - 2015, 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
@@ -30,6 +30,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Protocol/SmmFaultTolerantWrite.h>\r
 #include <Protocol/SmmAccess2.h>\r
 #include <Protocol/SmmEndOfDxe.h>\r
+#include <Protocol/SmmVarCheck.h>\r
 \r
 #include <Library/SmmServicesTableLib.h>\r
 \r
@@ -102,6 +103,10 @@ EFI_SMM_VARIABLE_PROTOCOL      gSmmVariable = {
   VariableServiceQueryVariableInfo\r
 };\r
 \r
+EDKII_SMM_VAR_CHECK_PROTOCOL mSmmVarCheck = { VarCheckRegisterSetVariableCheckHandler,\r
+                                              VarCheckVariablePropertySet,\r
+                                              VarCheckVariablePropertyGet };\r
+\r
 /**\r
   Return TRUE if ExitBootServices () has been called.\r
   \r
@@ -498,6 +503,7 @@ SmmVariableHandler (
   SMM_VARIABLE_COMMUNICATE_QUERY_VARIABLE_INFO     *QueryVariableInfo;\r
   VARIABLE_INFO_ENTRY                              *VariableInfo;\r
   SMM_VARIABLE_COMMUNICATE_LOCK_VARIABLE           *VariableToLock;\r
+  SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY *CommVariableProperty;\r
   UINTN                                            InfoSize;\r
   UINTN                                            NameBufferSize;\r
   UINTN                                            CommBufferPayloadSize;\r
@@ -731,6 +737,61 @@ SmmVariableHandler (
                    );\r
       }\r
       break;\r
+    case SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_SET:\r
+      if (mEndOfDxe) {\r
+        Status = EFI_ACCESS_DENIED;\r
+      } else {\r
+        CommVariableProperty = (SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY *) SmmVariableFunctionHeader->Data;\r
+        Status = VarCheckVariablePropertySet (\r
+                   CommVariableProperty->Name,\r
+                   &CommVariableProperty->Guid,\r
+                   &CommVariableProperty->VariableProperty\r
+                   );\r
+      }\r
+      break;\r
+    case SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_GET:\r
+      if (CommBufferPayloadSize < OFFSET_OF (SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY, Name)) {\r
+        DEBUG ((EFI_D_ERROR, "VarCheckVariablePropertyGet: SMM communication buffer size invalid!\n"));\r
+        return EFI_SUCCESS;\r
+      }\r
+      //\r
+      // Copy the input communicate buffer payload to pre-allocated SMM variable buffer payload.\r
+      //\r
+      CopyMem (mVariableBufferPayload, SmmVariableFunctionHeader->Data, CommBufferPayloadSize);\r
+      CommVariableProperty = (SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY *) mVariableBufferPayload;\r
+      if ((UINTN) (~0) - CommVariableProperty->NameSize < OFFSET_OF (SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY, Name)) {\r
+        //\r
+        // Prevent InfoSize overflow happen\r
+        //\r
+        Status = EFI_ACCESS_DENIED;\r
+        goto EXIT;\r
+      }\r
+      InfoSize = OFFSET_OF (SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY, Name) + CommVariableProperty->NameSize;\r
+\r
+      //\r
+      // SMRAM range check already covered before\r
+      //\r
+      if (InfoSize > CommBufferPayloadSize) {\r
+        DEBUG ((EFI_D_ERROR, "VarCheckVariablePropertyGet: Data size exceed communication buffer size limit!\n"));\r
+        Status = EFI_ACCESS_DENIED;\r
+        goto EXIT;\r
+      }\r
+\r
+      if (CommVariableProperty->NameSize < sizeof (CHAR16) || CommVariableProperty->Name[CommVariableProperty->NameSize/sizeof (CHAR16) - 1] != L'\0') {\r
+        //\r
+        // Make sure VariableName is A Null-terminated string.\r
+        //\r
+        Status = EFI_ACCESS_DENIED;\r
+        goto EXIT;\r
+      }\r
+\r
+      Status = VarCheckVariablePropertyGet (\r
+                 CommVariableProperty->Name,\r
+                 &CommVariableProperty->Guid,\r
+                 &CommVariableProperty->VariableProperty\r
+                 );\r
+      CopyMem (SmmVariableFunctionHeader->Data, mVariableBufferPayload, CommBufferPayloadSize);\r
+      break;\r
 \r
     default:\r
       Status = EFI_UNSUPPORTED;\r
@@ -887,6 +948,14 @@ VariableServiceInitialize (
                     );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
+  Status = gSmst->SmmInstallProtocolInterface (\r
+                    &VariableHandle,\r
+                    &gEdkiiSmmVarCheckProtocolGuid,\r
+                    EFI_NATIVE_INTERFACE,\r
+                    &mSmmVarCheck\r
+                    );\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
   //\r
   // Get SMRAM information\r
   //\r
@@ -910,7 +979,7 @@ VariableServiceInitialize (
   mSmramRangeCount = Size / sizeof (EFI_SMRAM_DESCRIPTOR);\r
 \r
   mVariableBufferPayloadSize = MAX (PcdGet32 (PcdMaxVariableSize), PcdGet32 (PcdMaxHardwareErrorVariableSize)) +\r
-                               OFFSET_OF (SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE, Name) - sizeof (VARIABLE_HEADER);\r
+                               OFFSET_OF (SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY, Name) - sizeof (VARIABLE_HEADER);\r
 \r
   Status = gSmst->SmmAllocatePool (\r
                     EfiRuntimeServicesData,\r
index 62361c299a3f16f9464632588354c520406e076e..5e882134498041f1329bc5047e467a633f2aae83 100644 (file)
@@ -12,7 +12,7 @@
 #  This external input must be validated carefully to avoid security issue like\r
 #  buffer overflow, integer overflow.\r
 #\r
-# Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2010 - 2015, 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
@@ -44,6 +44,7 @@
   Reclaim.c\r
   Variable.c\r
   VariableSmm.c\r
+  VarCheck.c\r
   Variable.h\r
 \r
 [Packages]\r
@@ -62,6 +63,7 @@
   DxeServicesTableLib\r
   HobLib\r
   PcdLib\r
+  DevicePathLib\r
 \r
 [Protocols]\r
   gEfiSmmFirmwareVolumeBlockProtocolGuid        ## CONSUMES\r
@@ -72,7 +74,8 @@
   ## UNDEFINED # SmiHandlerRegister\r
   gEfiSmmVariableProtocolGuid\r
   gEfiSmmAccess2ProtocolGuid                    ## CONSUMES\r
-  gEfiSmmEndOfDxeProtocolGuid                   ## CONSUMES\r
+  gEfiSmmEndOfDxeProtocolGuid                   ## NOTIFY\r
+  gEdkiiSmmVarCheckProtocolGuid                 ## PRODUCES\r
 \r
 [Guids]\r
   ## PRODUCES             ## GUID # Signature of Variable store header\r
index 14e421cb793f6e9b19dad8b70d829ce4db4a3f24..873930ce67aeda577b90b5ea9a60dc9a13d712d9 100644 (file)
@@ -14,7 +14,7 @@
 \r
   InitCommunicateBuffer() is really function to check the variable data size.\r
 \r
-Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2010 - 2015, 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
@@ -30,6 +30,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include <Protocol/SmmCommunication.h>\r
 #include <Protocol/SmmVariable.h>\r
 #include <Protocol/VariableLock.h>\r
+#include <Protocol/VarCheck.h>\r
 \r
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/UefiRuntimeServicesTableLib.h>\r
@@ -56,6 +57,7 @@ UINTN                            mVariableBufferSize;
 UINTN                            mVariableBufferPayloadSize;\r
 EFI_LOCK                         mVariableServicesLock;\r
 EDKII_VARIABLE_LOCK_PROTOCOL     mVariableLock;\r
+EDKII_VAR_CHECK_PROTOCOL         mVarCheck;\r
 \r
 /**\r
   Acquires lock only at boot time. Simply returns at runtime.\r
@@ -244,6 +246,180 @@ Done:
   return Status;\r
 }\r
 \r
+/**\r
+  Register SetVariable check handler.\r
+\r
+  @param[in] Handler            Pointer to check handler.\r
+\r
+  @retval EFI_SUCCESS           The SetVariable check handler was registered successfully.\r
+  @retval EFI_INVALID_PARAMETER Handler is NULL.\r
+  @retval EFI_ACCESS_DENIED     EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r
+                                already been signaled.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough resource for the SetVariable check handler register request.\r
+  @retval EFI_UNSUPPORTED       This interface is not implemented.\r
+                                For example, it is unsupported in VarCheck protocol if both VarCheck and SmmVarCheck protocols are present.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckRegisterSetVariableCheckHandler (\r
+  IN VAR_CHECK_SET_VARIABLE_CHECK_HANDLER   Handler\r
+  )\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
+\r
+/**\r
+  Variable property set.\r
+\r
+  @param[in] Name               Pointer to the variable name.\r
+  @param[in] Guid               Pointer to the vendor GUID.\r
+  @param[in] VariableProperty   Pointer to the input variable property.\r
+\r
+  @retval EFI_SUCCESS           The property of variable specified by the Name and Guid was set successfully.\r
+  @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string,\r
+                                or the fields of VariableProperty are not valid.\r
+  @retval EFI_ACCESS_DENIED     EFI_END_OF_DXE_EVENT_GROUP_GUID or EFI_EVENT_GROUP_READY_TO_BOOT has\r
+                                already been signaled.\r
+  @retval EFI_OUT_OF_RESOURCES  There is not enough resource for the variable property set request.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckVariablePropertySet (\r
+  IN CHAR16                         *Name,\r
+  IN EFI_GUID                       *Guid,\r
+  IN VAR_CHECK_VARIABLE_PROPERTY    *VariableProperty\r
+  )\r
+{\r
+  EFI_STATUS                                Status;\r
+  UINTN                                     VariableNameSize;\r
+  UINTN                                     PayloadSize;\r
+  SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY *CommVariableProperty;\r
+\r
+  if (Name == NULL || Name[0] == 0 || Guid == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if (VariableProperty == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if (VariableProperty->Revision != VAR_CHECK_VARIABLE_PROPERTY_REVISION) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  VariableNameSize = StrSize (Name);\r
+  CommVariableProperty = NULL;\r
+\r
+  //\r
+  // If VariableName exceeds SMM payload limit. Return failure\r
+  //\r
+  if (VariableNameSize > mVariableBufferPayloadSize - OFFSET_OF (SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY, Name)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  AcquireLockOnlyAtBootTime (&mVariableServicesLock);\r
+\r
+  //\r
+  // Init the communicate buffer. The buffer data size is:\r
+  // SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize.\r
+  //\r
+  PayloadSize = OFFSET_OF (SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY, Name) + VariableNameSize;\r
+  Status = InitCommunicateBuffer ((VOID **) &CommVariableProperty, PayloadSize, SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_SET);\r
+  if (EFI_ERROR (Status)) {\r
+    goto Done;\r
+  }\r
+  ASSERT (CommVariableProperty != NULL);\r
+\r
+  CopyGuid (&CommVariableProperty->Guid, Guid);\r
+  CopyMem (&CommVariableProperty->VariableProperty, VariableProperty, sizeof (*VariableProperty));\r
+  CommVariableProperty->NameSize = VariableNameSize;\r
+  CopyMem (CommVariableProperty->Name, Name, CommVariableProperty->NameSize);\r
+\r
+  //\r
+  // Send data to SMM.\r
+  //\r
+  Status = SendCommunicateBuffer (PayloadSize);\r
+\r
+Done:\r
+  ReleaseLockOnlyAtBootTime (&mVariableServicesLock);\r
+  return Status;\r
+}\r
+\r
+/**\r
+  Variable property get.\r
+\r
+  @param[in]  Name              Pointer to the variable name.\r
+  @param[in]  Guid              Pointer to the vendor GUID.\r
+  @param[out] VariableProperty  Pointer to the output variable property.\r
+\r
+  @retval EFI_SUCCESS           The property of variable specified by the Name and Guid was got successfully.\r
+  @retval EFI_INVALID_PARAMETER Name, Guid or VariableProperty is NULL, or Name is an empty string.\r
+  @retval EFI_NOT_FOUND         The property of variable specified by the Name and Guid was not found.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckVariablePropertyGet (\r
+  IN CHAR16                         *Name,\r
+  IN EFI_GUID                       *Guid,\r
+  OUT VAR_CHECK_VARIABLE_PROPERTY   *VariableProperty\r
+  )\r
+{\r
+  EFI_STATUS                                Status;\r
+  UINTN                                     VariableNameSize;\r
+  UINTN                                     PayloadSize;\r
+  SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY *CommVariableProperty;\r
+\r
+  if (Name == NULL || Name[0] == 0 || Guid == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  if (VariableProperty == NULL) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  VariableNameSize = StrSize (Name);\r
+  CommVariableProperty = NULL;\r
+\r
+  //\r
+  // If VariableName exceeds SMM payload limit. Return failure\r
+  //\r
+  if (VariableNameSize > mVariableBufferPayloadSize - OFFSET_OF (SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY, Name)) {\r
+    return EFI_INVALID_PARAMETER;\r
+  }\r
+\r
+  AcquireLockOnlyAtBootTime (&mVariableServicesLock);\r
+\r
+  //\r
+  // Init the communicate buffer. The buffer data size is:\r
+  // SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + PayloadSize.\r
+  //\r
+  PayloadSize = OFFSET_OF (SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY, Name) + VariableNameSize;\r
+  Status = InitCommunicateBuffer ((VOID **) &CommVariableProperty, PayloadSize, SMM_VARIABLE_FUNCTION_VAR_CHECK_VARIABLE_PROPERTY_GET);\r
+  if (EFI_ERROR (Status)) {\r
+    goto Done;\r
+  }\r
+  ASSERT (CommVariableProperty != NULL);\r
+\r
+  CopyGuid (&CommVariableProperty->Guid, Guid);\r
+  CommVariableProperty->NameSize = VariableNameSize;\r
+  CopyMem (CommVariableProperty->Name, Name, CommVariableProperty->NameSize);\r
+\r
+  //\r
+  // Send data to SMM.\r
+  //\r
+  Status = SendCommunicateBuffer (PayloadSize);\r
+  if (Status == EFI_SUCCESS) {\r
+    CopyMem (VariableProperty, &CommVariableProperty->VariableProperty, sizeof (*VariableProperty));\r
+  }\r
+\r
+Done:\r
+  ReleaseLockOnlyAtBootTime (&mVariableServicesLock);\r
+  return Status;\r
+}\r
+\r
 /**\r
   This code finds variable in storage blocks (Volatile or Non-Volatile).\r
 \r
@@ -734,7 +910,7 @@ SmmVariableReady (
   // Allocate memory for variable communicate buffer.\r
   //\r
   mVariableBufferPayloadSize = MAX (PcdGet32 (PcdMaxVariableSize), PcdGet32 (PcdMaxHardwareErrorVariableSize)) +\r
-                               OFFSET_OF (SMM_VARIABLE_COMMUNICATE_ACCESS_VARIABLE, Name) - sizeof (VARIABLE_HEADER);\r
+                               OFFSET_OF (SMM_VARIABLE_COMMUNICATE_VAR_CHECK_VARIABLE_PROPERTY, Name) - sizeof (VARIABLE_HEADER);\r
   mVariableBufferSize  = SMM_COMMUNICATE_HEADER_SIZE + SMM_VARIABLE_COMMUNICATE_HEADER_SIZE + mVariableBufferPayloadSize;\r
   mVariableBuffer      = AllocateRuntimePool (mVariableBufferSize);\r
   ASSERT (mVariableBuffer != NULL);\r
@@ -833,6 +1009,17 @@ VariableSmmRuntimeInitialize (
                   );\r
   ASSERT_EFI_ERROR (Status);\r
 \r
+  mVarCheck.RegisterSetVariableCheckHandler = VarCheckRegisterSetVariableCheckHandler;\r
+  mVarCheck.VariablePropertySet = VarCheckVariablePropertySet;\r
+  mVarCheck.VariablePropertyGet = VarCheckVariablePropertyGet;\r
+  Status = gBS->InstallMultipleProtocolInterfaces (\r
+                  &mHandle,\r
+                  &gEdkiiVarCheckProtocolGuid,\r
+                  &mVarCheck,\r
+                  NULL\r
+                  );\r
+  ASSERT_EFI_ERROR (Status);\r
+\r
   //\r
   // Smm variable service is ready\r
   //\r
index 4bd470662f09ca8c7075ca544dfce8bbca8cee0e..a72619e002ec57aa6ada6e5b7922d24664e841d3 100644 (file)
@@ -10,7 +10,7 @@
 #  This external input must be validated carefully to avoid security issues such as\r
 #  buffer overflow or integer overflow.\r
 #\r
-# Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>\r
+# Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>\r
 #\r
 #  This program and the accompanying materials\r
 #  are licensed and made available under the terms and conditions of the BSD License\r
@@ -65,6 +65,7 @@
   ## UNDEFINED # Used to do smm communication\r
   gEfiSmmVariableProtocolGuid\r
   gEdkiiVariableLockProtocolGuid                ## PRODUCES\r
+  gEdkiiVarCheckProtocolGuid                    ## PRODUCES\r
 \r
 [Guids]\r
   gEfiEventVirtualAddressChangeGuid             ## CONSUMES ## Event\r