--- /dev/null
+/** @file\r
+ Implementation functions and structures for var check uefi library.\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 <Library/VarCheckLib.h>\r
+#include <Library/BaseLib.h>\r
+#include <Library/BaseMemoryLib.h>\r
+#include <Library/DebugLib.h>\r
+#include <Library/DevicePathLib.h>\r
+\r
+#include <Guid/VariableFormat.h>\r
+#include <Guid/GlobalVariable.h>\r
+#include <Guid/HardwareErrorVariable.h>\r
+#include <Guid/ImageAuthentication.h>\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
+/**\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
+ UINT16 FilePathListLength;\r
+ CHAR16 *Description;\r
+ EFI_DEVICE_PATH_PROTOCOL *FilePathList;\r
+\r
+ FilePathListLength = *((UINT16 *) ((UINTN) Data + sizeof (UINT32)));\r
+\r
+ //\r
+ // Check Description\r
+ //\r
+ Description = (CHAR16 *) ((UINTN) Data + sizeof (UINT32) + sizeof (UINT16));\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 - FilePathListLength)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ if (((UINTN) FilePathList + FilePathListLength) > ((UINTN) Data + DataSize)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ if (FilePathListLength < sizeof (EFI_DEVICE_PATH_PROTOCOL)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ if (!IsDevicePathValid (FilePathList, 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_SYS_PREP_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
+\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 (UINT32) + sizeof (UINT16),\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 (UINT32) + sizeof (UINT16),\r
+ MAX_UINTN\r
+ },\r
+ InternalVarCheckLoadOption\r
+ },\r
+ {\r
+ L"SysPrep####",\r
+ {\r
+ VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+ 0,\r
+ VARIABLE_ATTRIBUTE_NV_BS_RT,\r
+ sizeof (UINT32) + sizeof (UINT16),\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
+// EFI_IMAGE_SECURITY_DATABASE_GUID\r
+//\r
+UEFI_DEFINED_VARIABLE_ENTRY mImageSecurityVariableList[] = {\r
+ {\r
+ EFI_IMAGE_SECURITY_DATABASE,\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_IMAGE_SECURITY_DATABASE1,\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_IMAGE_SECURITY_DATABASE2,\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
+\r
+//\r
+// EFI_HARDWARE_ERROR_VARIABLE\r
+//\r
+UEFI_DEFINED_VARIABLE_ENTRY mHwErrRecVariable = {\r
+ L"HwErrRec####",\r
+ {\r
+ VAR_CHECK_VARIABLE_PROPERTY_REVISION,\r
+ 0,\r
+ VARIABLE_ATTRIBUTE_NV_BS_RT_HR,\r
+ 1,\r
+ MAX_UINTN\r
+ },\r
+ NULL\r
+};\r
+\r
+EFI_GUID *mUefiDefinedGuid[] = {\r
+ &gEfiGlobalVariableGuid,\r
+ &gEfiImageSecurityDatabaseGuid,\r
+ &gEfiHardwareErrorVariableGuid\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[in] 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
+VarCheckUefiIsHexaDecimalDigitCharacter (\r
+ IN CHAR16 Char\r
+ )\r
+{\r
+ return (BOOLEAN) ((Char >= L'0' && Char <= L'9') || (Char >= L'A' && Char <= L'F') || (Char >= L'a' && Char <= L'f'));\r
+}\r
+\r
+/**\r
+\r
+ This code checks if variable is hardware error record variable or not.\r
+\r
+ According to UEFI spec, hardware error record variable should use the EFI_HARDWARE_ERROR_VARIABLE VendorGuid\r
+ and have the L"HwErrRec####" name convention, #### is a printed hex value and no 0x or h is included in the hex value.\r
+\r
+ @param[in] VariableName Pointer to variable name.\r
+ @param[in] VendorGuid Variable Vendor Guid.\r
+\r
+ @retval TRUE Variable is hardware error record variable.\r
+ @retval FALSE Variable is not hardware error record variable.\r
+\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsHwErrRecVariable (\r
+ IN CHAR16 *VariableName,\r
+ IN EFI_GUID *VendorGuid\r
+ )\r
+{\r
+ if (!CompareGuid (VendorGuid, &gEfiHardwareErrorVariableGuid) ||\r
+ (StrLen (VariableName) != StrLen (L"HwErrRec####")) ||\r
+ (StrnCmp(VariableName, L"HwErrRec", StrLen (L"HwErrRec")) != 0) ||\r
+ !VarCheckUefiIsHexaDecimalDigitCharacter (VariableName[0x8]) ||\r
+ !VarCheckUefiIsHexaDecimalDigitCharacter (VariableName[0x9]) ||\r
+ !VarCheckUefiIsHexaDecimalDigitCharacter (VariableName[0xA]) ||\r
+ !VarCheckUefiIsHexaDecimalDigitCharacter (VariableName[0xB])) {\r
+ return FALSE;\r
+ }\r
+\r
+ return TRUE;\r
+}\r
+\r
+/**\r
+ Get UEFI defined var check function.\r
+\r
+ @param[in] VariableName Pointer to variable name.\r
+ @param[in] VendorGuid Pointer to variable vendor GUID.\r
+ @param[out] VariableProperty Pointer to variable property.\r
+\r
+ @return Internal var check function, NULL if no specific check function.\r
+\r
+**/\r
+INTERNAL_VAR_CHECK_FUNCTION\r
+GetUefiDefinedVarCheckFunction (\r
+ IN CHAR16 *VariableName,\r
+ IN EFI_GUID *VendorGuid,\r
+ OUT VAR_CHECK_VARIABLE_PROPERTY **VariableProperty\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
+ *VariableProperty = &(mGlobalVariableList[Index].VariableProperty);\r
+ return mGlobalVariableList[Index].CheckFunction;\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 (VariableName, mGlobalVariableList2[Index].Name, NameLength) == 0) &&\r
+ VarCheckUefiIsHexaDecimalDigitCharacter (VariableName[NameLength]) &&\r
+ VarCheckUefiIsHexaDecimalDigitCharacter (VariableName[NameLength + 1]) &&\r
+ VarCheckUefiIsHexaDecimalDigitCharacter (VariableName[NameLength + 2]) &&\r
+ VarCheckUefiIsHexaDecimalDigitCharacter (VariableName[NameLength + 3])) {\r
+ *VariableProperty = &(mGlobalVariableList2[Index].VariableProperty);\r
+ return mGlobalVariableList2[Index].CheckFunction;\r
+ }\r
+ }\r
+ }\r
+\r
+ return NULL;\r
+}\r
+\r
+/**\r
+ SetVariable check handler UEFI defined.\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, GUID,\r
+ DataSize and Data value was supplied.\r
+ @retval EFI_WRITE_PROTECTED The variable in question is read-only.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+SetVariableCheckHandlerUefiDefined (\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
+ VAR_CHECK_VARIABLE_PROPERTY Property;\r
+ VAR_CHECK_VARIABLE_PROPERTY *VarCheckProperty;\r
+ INTERNAL_VAR_CHECK_FUNCTION VarCheckFunction;\r
+\r
+ if ((((Attributes & EFI_VARIABLE_APPEND_WRITE) == 0) && (DataSize == 0)) || (Attributes == 0)) {\r
+ //\r
+ // Do not check delete variable.\r
+ //\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ if ((Attributes & EFI_VARIABLE_HARDWARE_ERROR_RECORD) == EFI_VARIABLE_HARDWARE_ERROR_RECORD) {\r
+ if (!IsHwErrRecVariable (VariableName, VendorGuid)) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ }\r
+\r
+ for (Index = 0; Index < sizeof (mUefiDefinedGuid)/sizeof (mUefiDefinedGuid[0]); Index++) {\r
+ if (CompareGuid (VendorGuid, mUefiDefinedGuid[Index])) {\r
+ if (VarCheckLibVariablePropertyGet (VariableName, VendorGuid, &Property) == EFI_NOT_FOUND) {\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
+ DEBUG ((EFI_D_INFO, "UEFI Variable Check fail %r - %s not in %g namespace\n", EFI_INVALID_PARAMETER, VariableName, VendorGuid));\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ }\r
+ }\r
+\r
+ if (DataSize == 0) {\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ VarCheckProperty = NULL;\r
+ VarCheckFunction = GetUefiDefinedVarCheckFunction (VariableName, VendorGuid, &VarCheckProperty);\r
+ if (VarCheckFunction != NULL) {\r
+ Status = VarCheckFunction (\r
+ VarCheckProperty,\r
+ DataSize,\r
+ Data\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ DEBUG ((EFI_D_INFO, "UEFI Variable Check function fail %r - %g:%s\n", Status, VendorGuid, VariableName));\r
+ return Status;\r
+ }\r
+ }\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Variable property set for UEFI defined variables.\r
+\r
+**/\r
+VOID\r
+VariablePropertySetUefiDefined (\r
+ VOID\r
+ )\r
+{\r
+ UINTN Index;\r
+\r
+ //\r
+ // EFI_GLOBAL_VARIABLE\r
+ //\r
+ for (Index = 0; Index < sizeof (mGlobalVariableList)/sizeof (mGlobalVariableList[0]); Index++) {\r
+ VarCheckLibVariablePropertySet (\r
+ mGlobalVariableList[Index].Name,\r
+ &gEfiGlobalVariableGuid,\r
+ &mGlobalVariableList[Index].VariableProperty\r
+ );\r
+ }\r
+ for (Index = 0; Index < sizeof (mGlobalVariableList2)/sizeof (mGlobalVariableList2[0]); Index++) {\r
+ VarCheckLibVariablePropertySet (\r
+ mGlobalVariableList2[Index].Name,\r
+ &gEfiGlobalVariableGuid,\r
+ &mGlobalVariableList2[Index].VariableProperty\r
+ );\r
+ }\r
+\r
+ //\r
+ // EFI_IMAGE_SECURITY_DATABASE_GUID\r
+ //\r
+ for (Index = 0; Index < sizeof (mImageSecurityVariableList)/sizeof (mImageSecurityVariableList[0]); Index++) {\r
+ VarCheckLibVariablePropertySet (\r
+ mImageSecurityVariableList[Index].Name,\r
+ &gEfiImageSecurityDatabaseGuid,\r
+ &mImageSecurityVariableList[Index].VariableProperty\r
+ );\r
+ }\r
+\r
+ //\r
+ // EFI_HARDWARE_ERROR_VARIABLE\r
+ //\r
+ VarCheckLibVariablePropertySet (\r
+ mHwErrRecVariable.Name,\r
+ &gEfiHardwareErrorVariableGuid,\r
+ &mHwErrRecVariable.VariableProperty\r
+ );\r
+}\r
+\r
+/**\r
+ Constructor function of VarCheckUefiLib to set property and\r
+ register SetVariable check handler for UEFI defined variables.\r
+\r
+ @param[in] ImageHandle The firmware allocated handle for the EFI image.\r
+ @param[in] SystemTable A pointer to the EFI System Table.\r
+\r
+ @retval EFI_SUCCESS The constructor executed correctly.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckUefiLibNullClassConstructor (\r
+ IN EFI_HANDLE ImageHandle,\r
+ IN EFI_SYSTEM_TABLE *SystemTable\r
+ )\r
+{\r
+ VariablePropertySetUefiDefined ();\r
+ VarCheckLibRegisterSetVariableCheckHandler (SetVariableCheckHandlerUefiDefined);\r
+\r
+ return EFI_SUCCESS;\r
+}\r