--- /dev/null
+/** @file\r
+ Provides variable check services and database management.\r
+\r
+Copyright (c) 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
+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_LIB_H_\r
+#define _VARIABLE_CHECK_LIB_H_\r
+\r
+#include <Protocol/VarCheck.h>\r
+\r
+typedef enum {\r
+ VarCheckRequestReserved0 = 0,\r
+ VarCheckRequestReserved1 = 1,\r
+ VarCheckFromTrusted = 2,\r
+ VarCheckFromUntrusted = 3,\r
+} VAR_CHECK_REQUEST_SOURCE;\r
+\r
+typedef\r
+VOID\r
+(EFIAPI *VAR_CHECK_END_OF_DXE_CALLBACK) (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Register END_OF_DXE callback.\r
+ The callback will be invoked by VarCheckLibInitializeAtEndOfDxe().\r
+\r
+ @param[in] Callback END_OF_DXE callback.\r
+\r
+ @retval EFI_SUCCESS The callback was registered successfully.\r
+ @retval EFI_INVALID_PARAMETER Callback 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 callback register request.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckLibRegisterEndOfDxeCallback (\r
+ IN VAR_CHECK_END_OF_DXE_CALLBACK Callback\r
+ );\r
+\r
+/**\r
+ Var check initialize at END_OF_DXE.\r
+\r
+ This function needs to be called at END_OF_DXE.\r
+ Address pointers may be returned,\r
+ and caller needs to ConvertPointer() for the pointers.\r
+\r
+ @param[in, out] AddressPointerCount Output pointer to address pointer count.\r
+\r
+ @return Address pointer buffer, NULL if input AddressPointerCount is NULL.\r
+\r
+**/\r
+VOID ***\r
+EFIAPI\r
+VarCheckLibInitializeAtEndOfDxe (\r
+ IN OUT UINTN *AddressPointerCount OPTIONAL\r
+ );\r
+\r
+/**\r
+ Register address pointer.\r
+ The AddressPointer may be returned by VarCheckLibInitializeAtEndOfDxe().\r
+\r
+ @param[in] AddressPointer Address pointer.\r
+\r
+ @retval EFI_SUCCESS The address pointer was registered successfully.\r
+ @retval EFI_INVALID_PARAMETER AddressPointer 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 address pointer register request.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckLibRegisterAddressPointer (\r
+ IN VOID **AddressPointer\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
+VarCheckLibRegisterSetVariableCheckHandler (\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
+VarCheckLibVariablePropertySet (\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
+VarCheckLibVariablePropertyGet (\r
+ IN CHAR16 *Name,\r
+ IN EFI_GUID *Guid,\r
+ OUT VAR_CHECK_VARIABLE_PROPERTY *VariableProperty\r
+ );\r
+\r
+/**\r
+ 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
+ @param[in] RequestSource Request source.\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
+ @retval Others The other return status from check handler.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckLibSetVariableCheck (\r
+ IN CHAR16 *VariableName,\r
+ IN EFI_GUID *VendorGuid,\r
+ IN UINT32 Attributes,\r
+ IN UINTN DataSize,\r
+ IN VOID *Data,\r
+ IN VAR_CHECK_REQUEST_SOURCE RequestSource\r
+ );\r
+\r
+#endif\r
--- /dev/null
+/** @file\r
+ Implementation functions and structures for var check services.\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/MemoryAllocationLib.h>\r
+\r
+#include <Guid/GlobalVariable.h>\r
+#include <Guid/HardwareErrorVariable.h>\r
+\r
+BOOLEAN mVarCheckLibEndOfDxe = FALSE;\r
+\r
+#define VAR_CHECK_TABLE_SIZE 0x8\r
+\r
+UINTN mVarCheckLibEndOfDxeCallbackCount = 0;\r
+UINTN mVarCheckLibEndOfDxeCallbackMaxCount = 0;\r
+VAR_CHECK_END_OF_DXE_CALLBACK *mVarCheckLibEndOfDxeCallback = NULL;\r
+\r
+UINTN mVarCheckLibAddressPointerCount = 0;\r
+UINTN mVarCheckLibAddressPointerMaxCount = 0;\r
+VOID ***mVarCheckLibAddressPointer = NULL;\r
+\r
+UINTN mNumberOfVarCheckHandler = 0;\r
+UINTN mMaxNumberOfVarCheckHandler = 0;\r
+VAR_CHECK_SET_VARIABLE_CHECK_HANDLER *mVarCheckHandlerTable = NULL;\r
+\r
+typedef struct {\r
+ EFI_GUID Guid;\r
+ VAR_CHECK_VARIABLE_PROPERTY VariableProperty;\r
+ //CHAR16 *Name;\r
+} VAR_CHECK_VARIABLE_ENTRY;\r
+\r
+UINTN mNumberOfVarCheckVariable = 0;\r
+UINTN mMaxNumberOfVarCheckVariable = 0;\r
+VARIABLE_ENTRY_PROPERTY **mVarCheckVariableTable = NULL;\r
+\r
+//\r
+// Handle variables with wildcard name specially.\r
+//\r
+VARIABLE_ENTRY_PROPERTY mVarCheckVariableWithWildcardName[] = {\r
+ {\r
+ &gEfiGlobalVariableGuid,\r
+ L"Boot####",\r
+ {\r
+ 0\r
+ },\r
+ },\r
+ {\r
+ &gEfiGlobalVariableGuid,\r
+ L"Driver####",\r
+ {\r
+ 0\r
+ },\r
+ },\r
+ {\r
+ &gEfiGlobalVariableGuid,\r
+ L"SysPrep####",\r
+ {\r
+ 0\r
+ },\r
+ },\r
+ {\r
+ &gEfiGlobalVariableGuid,\r
+ L"Key####",\r
+ {\r
+ 0\r
+ },\r
+ },\r
+ {\r
+ &gEfiHardwareErrorVariableGuid,\r
+ L"HwErrRec####",\r
+ {\r
+ 0\r
+ },\r
+ },\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
+VarCheckInternalIsHexaDecimalDigitCharacter (\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
+ Variable property get with wildcard name.\r
+\r
+ @param[in] VariableName Pointer to variable name.\r
+ @param[in] VendorGuid Pointer to variable vendor GUID.\r
+ @param[in] WildcardMatch Try wildcard match or not.\r
+\r
+ @return Pointer to variable property.\r
+\r
+**/\r
+VAR_CHECK_VARIABLE_PROPERTY *\r
+VariablePropertyGetWithWildcardName (\r
+ IN CHAR16 *VariableName,\r
+ IN EFI_GUID *VendorGuid,\r
+ IN BOOLEAN WildcardMatch\r
+ )\r
+{\r
+ UINTN Index;\r
+ UINTN NameLength;\r
+\r
+ NameLength = StrLen (VariableName) - 4;\r
+ for (Index = 0; Index < sizeof (mVarCheckVariableWithWildcardName)/sizeof (mVarCheckVariableWithWildcardName[0]); Index++) {\r
+ if (CompareGuid (mVarCheckVariableWithWildcardName[Index].Guid, VendorGuid)){\r
+ if (WildcardMatch) {\r
+ if ((StrLen (VariableName) == StrLen (mVarCheckVariableWithWildcardName[Index].Name)) &&\r
+ (StrnCmp (VariableName, mVarCheckVariableWithWildcardName[Index].Name, NameLength) == 0) &&\r
+ VarCheckInternalIsHexaDecimalDigitCharacter (VariableName[NameLength]) &&\r
+ VarCheckInternalIsHexaDecimalDigitCharacter (VariableName[NameLength + 1]) &&\r
+ VarCheckInternalIsHexaDecimalDigitCharacter (VariableName[NameLength + 2]) &&\r
+ VarCheckInternalIsHexaDecimalDigitCharacter (VariableName[NameLength + 3])) {\r
+ return &mVarCheckVariableWithWildcardName[Index].VariableProperty;\r
+ }\r
+ }\r
+ if (StrCmp (mVarCheckVariableWithWildcardName[Index].Name, VariableName) == 0) {\r
+ return &mVarCheckVariableWithWildcardName[Index].VariableProperty;\r
+ }\r
+ }\r
+ }\r
+\r
+ return NULL;\r
+}\r
+\r
+/**\r
+ Variable property get function.\r
+\r
+ @param[in] Name Pointer to the variable name.\r
+ @param[in] Guid Pointer to the vendor GUID.\r
+ @param[in] WildcardMatch Try wildcard match or not.\r
+\r
+ @return Pointer to the property of variable specified by the Name and Guid.\r
+\r
+**/\r
+VAR_CHECK_VARIABLE_PROPERTY *\r
+VariablePropertyGetFunction (\r
+ IN CHAR16 *Name,\r
+ IN EFI_GUID *Guid,\r
+ IN BOOLEAN WildcardMatch\r
+ )\r
+{\r
+ UINTN Index;\r
+ VAR_CHECK_VARIABLE_ENTRY *Entry;\r
+ CHAR16 *VariableName;\r
+\r
+ for (Index = 0; Index < mNumberOfVarCheckVariable; Index++) {\r
+ Entry = (VAR_CHECK_VARIABLE_ENTRY *) mVarCheckVariableTable[Index];\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
+ return VariablePropertyGetWithWildcardName (Name, Guid, WildcardMatch);\r
+}\r
+\r
+/**\r
+ Var check add table entry.\r
+\r
+ @param[in, out] Table Pointer to table buffer.\r
+ @param[in, out] MaxNumber Pointer to maximum number of entry in the table.\r
+ @param[in, out] CurrentNumber Pointer to current number of entry in the table.\r
+ @param[in] Entry Entry will be added to the table.\r
+\r
+ @retval EFI_SUCCESS Reallocate memory successfully.\r
+ @retval EFI_OUT_OF_RESOURCES No enough memory to allocate.\r
+\r
+**/\r
+EFI_STATUS\r
+VarCheckAddTableEntry (\r
+ IN OUT UINTN **Table,\r
+ IN OUT UINTN *MaxNumber,\r
+ IN OUT UINTN *CurrentNumber,\r
+ IN UINTN Entry\r
+ )\r
+{\r
+ UINTN *TempTable;\r
+\r
+ //\r
+ // Check whether the table is enough to store new entry.\r
+ //\r
+ if (*CurrentNumber == *MaxNumber) {\r
+ //\r
+ // Reallocate memory for the table.\r
+ //\r
+ TempTable = ReallocateRuntimePool (\r
+ *MaxNumber * sizeof (UINTN),\r
+ (*MaxNumber + VAR_CHECK_TABLE_SIZE) * sizeof (UINTN),\r
+ *Table\r
+ );\r
+\r
+ //\r
+ // No enough resource to allocate.\r
+ //\r
+ if (TempTable == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+\r
+ *Table = TempTable;\r
+ //\r
+ // Increase max number.\r
+ //\r
+ *MaxNumber += VAR_CHECK_TABLE_SIZE;\r
+ }\r
+\r
+ //\r
+ // Add entry to the table.\r
+ //\r
+ (*Table)[*CurrentNumber] = Entry;\r
+ (*CurrentNumber)++;\r
+\r
+ return EFI_SUCCESS;\r
+}\r
+\r
+/**\r
+ Register END_OF_DXE callback.\r
+ The callback will be invoked by VarCheckLibInitializeAtEndOfDxe().\r
+\r
+ @param[in] Callback END_OF_DXE callback.\r
+\r
+ @retval EFI_SUCCESS The callback was registered successfully.\r
+ @retval EFI_INVALID_PARAMETER Callback 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 callback register request.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckLibRegisterEndOfDxeCallback (\r
+ IN VAR_CHECK_END_OF_DXE_CALLBACK Callback\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ if (Callback == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ if (mVarCheckLibEndOfDxe) {\r
+ return EFI_ACCESS_DENIED;\r
+ }\r
+\r
+ Status = VarCheckAddTableEntry (\r
+ (UINTN **) &mVarCheckLibEndOfDxeCallback,\r
+ &mVarCheckLibEndOfDxeCallbackMaxCount,\r
+ &mVarCheckLibEndOfDxeCallbackCount,\r
+ (UINTN) Callback\r
+ );\r
+\r
+ DEBUG ((EFI_D_INFO, "VarCheckLibRegisterEndOfDxeCallback - 0x%x %r\n", Callback, Status));\r
+\r
+ return Status;\r
+}\r
+\r
+/**\r
+ Var check initialize at END_OF_DXE.\r
+\r
+ This function needs to be called at END_OF_DXE.\r
+ Address pointers may be returned,\r
+ and caller needs to ConvertPointer() for the pointers.\r
+\r
+ @param[in, out] AddressPointerCount Output pointer to address pointer count.\r
+\r
+ @return Address pointer buffer, NULL if input AddressPointerCount is NULL.\r
+\r
+**/\r
+VOID ***\r
+EFIAPI\r
+VarCheckLibInitializeAtEndOfDxe (\r
+ IN OUT UINTN *AddressPointerCount OPTIONAL\r
+ )\r
+{\r
+ VOID *TempTable;\r
+ UINTN TotalCount;\r
+ UINTN Index;\r
+\r
+ for (Index = 0; Index < mVarCheckLibEndOfDxeCallbackCount; Index++) {\r
+ //\r
+ // Invoke the callback registered by VarCheckLibRegisterEndOfDxeCallback().\r
+ //\r
+ mVarCheckLibEndOfDxeCallback[Index] ();\r
+ }\r
+ if (mVarCheckLibEndOfDxeCallback != NULL) {\r
+ //\r
+ // Free the callback buffer.\r
+ //\r
+ mVarCheckLibEndOfDxeCallbackCount = 0;\r
+ mVarCheckLibEndOfDxeCallbackMaxCount = 0;\r
+ FreePool ((VOID *) mVarCheckLibEndOfDxeCallback);\r
+ mVarCheckLibEndOfDxeCallback = NULL;\r
+ }\r
+\r
+ mVarCheckLibEndOfDxe = TRUE;\r
+\r
+ if (AddressPointerCount == NULL) {\r
+ if (mVarCheckLibAddressPointer != NULL) {\r
+ //\r
+ // Free the address pointer buffer.\r
+ //\r
+ mVarCheckLibAddressPointerCount = 0;\r
+ mVarCheckLibAddressPointerMaxCount = 0;\r
+ FreePool ((VOID *) mVarCheckLibAddressPointer);\r
+ mVarCheckLibAddressPointer = NULL;\r
+ }\r
+ return NULL;\r
+ }\r
+\r
+ //\r
+ // Get the total count needed.\r
+ // Also cover VarCheckHandler and the entries, and VarCheckVariable and the entries.\r
+ //\r
+ TotalCount = mVarCheckLibAddressPointerCount + (mNumberOfVarCheckHandler + 1) + (mNumberOfVarCheckVariable + 1);\r
+ TempTable = ReallocateRuntimePool (\r
+ mVarCheckLibAddressPointerMaxCount * sizeof (VOID **),\r
+ TotalCount * sizeof (VOID **),\r
+ (VOID *) mVarCheckLibAddressPointer\r
+ );\r
+\r
+ if (TempTable != NULL) {\r
+ mVarCheckLibAddressPointer = (VOID ***) TempTable;\r
+\r
+ //\r
+ // Cover VarCheckHandler and the entries.\r
+ //\r
+ mVarCheckLibAddressPointer[mVarCheckLibAddressPointerCount++] = (VOID **) &mVarCheckHandlerTable;\r
+ for (Index = 0; Index < mNumberOfVarCheckHandler; Index++) {\r
+ mVarCheckLibAddressPointer[mVarCheckLibAddressPointerCount++] = (VOID **) &mVarCheckHandlerTable[Index];\r
+ }\r
+\r
+ //\r
+ // Cover VarCheckVariable and the entries.\r
+ //\r
+ mVarCheckLibAddressPointer[mVarCheckLibAddressPointerCount++] = (VOID **) &mVarCheckVariableTable;\r
+ for (Index = 0; Index < mNumberOfVarCheckVariable; Index++) {\r
+ mVarCheckLibAddressPointer[mVarCheckLibAddressPointerCount++] = (VOID **) &mVarCheckVariableTable[Index];\r
+ }\r
+\r
+ ASSERT (mVarCheckLibAddressPointerCount == TotalCount);\r
+ mVarCheckLibAddressPointerMaxCount = mVarCheckLibAddressPointerCount;\r
+ }\r
+\r
+ *AddressPointerCount = mVarCheckLibAddressPointerCount;\r
+ return mVarCheckLibAddressPointer;\r
+}\r
+\r
+/**\r
+ Register address pointer.\r
+ The AddressPointer may be returned by VarCheckLibInitializeAtEndOfDxe().\r
+\r
+ @param[in] AddressPointer Address pointer.\r
+\r
+ @retval EFI_SUCCESS The address pointer was registered successfully.\r
+ @retval EFI_INVALID_PARAMETER AddressPointer 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 address pointer register request.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckLibRegisterAddressPointer (\r
+ IN VOID **AddressPointer\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+\r
+ if (AddressPointer == NULL) {\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+\r
+ if (mVarCheckLibEndOfDxe) {\r
+ return EFI_ACCESS_DENIED;\r
+ }\r
+\r
+ Status = VarCheckAddTableEntry(\r
+ (UINTN **) &mVarCheckLibAddressPointer,\r
+ &mVarCheckLibAddressPointerMaxCount,\r
+ &mVarCheckLibAddressPointerCount,\r
+ (UINTN) AddressPointer\r
+ );\r
+\r
+ DEBUG ((EFI_D_INFO, "VarCheckLibRegisterAddressPointer - 0x%x %r\n", AddressPointer, Status));\r
+\r
+ 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
+VarCheckLibRegisterSetVariableCheckHandler (\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 (mVarCheckLibEndOfDxe) {\r
+ return EFI_ACCESS_DENIED;\r
+ }\r
+\r
+ Status = VarCheckAddTableEntry(\r
+ (UINTN **) &mVarCheckHandlerTable,\r
+ &mMaxNumberOfVarCheckHandler,\r
+ &mNumberOfVarCheckHandler,\r
+ (UINTN) Handler\r
+ );\r
+\r
+ DEBUG ((EFI_D_INFO, "VarCheckLibRegisterSetVariableCheckHandler - 0x%x %r\n", Handler, Status));\r
+\r
+ return Status;\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
+VarCheckLibVariablePropertySet (\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 (mVarCheckLibEndOfDxe) {\r
+ return EFI_ACCESS_DENIED;\r
+ }\r
+\r
+ Status = EFI_SUCCESS;\r
+\r
+ Property = VariablePropertyGetFunction (Name, Guid, FALSE);\r
+ if (Property != NULL) {\r
+ CopyMem (Property, VariableProperty, sizeof (*VariableProperty));\r
+ } else {\r
+ Entry = AllocateRuntimeZeroPool (sizeof (*Entry) + StrSize (Name));\r
+ if (Entry == NULL) {\r
+ return EFI_OUT_OF_RESOURCES;\r
+ }\r
+ VariableName = (CHAR16 *) ((UINTN) Entry + sizeof (*Entry));\r
+ StrCpyS (VariableName, StrSize (Name)/sizeof (CHAR16), Name);\r
+ CopyGuid (&Entry->Guid, Guid);\r
+ CopyMem (&Entry->VariableProperty, VariableProperty, sizeof (*VariableProperty));\r
+\r
+ Status = VarCheckAddTableEntry(\r
+ (UINTN **) &mVarCheckVariableTable,\r
+ &mMaxNumberOfVarCheckVariable,\r
+ &mNumberOfVarCheckVariable,\r
+ (UINTN) Entry\r
+ );\r
+\r
+ if (EFI_ERROR (Status)) {\r
+ FreePool (Entry);\r
+ }\r
+ }\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
+VarCheckLibVariablePropertyGet (\r
+ IN CHAR16 *Name,\r
+ IN EFI_GUID *Guid,\r
+ OUT VAR_CHECK_VARIABLE_PROPERTY *VariableProperty\r
+ )\r
+{\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
+ Property = VariablePropertyGetFunction (Name, Guid, TRUE);\r
+ if (Property != NULL) {\r
+ CopyMem (VariableProperty, Property, sizeof (*VariableProperty));\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ return EFI_NOT_FOUND;\r
+}\r
+\r
+/**\r
+ 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
+ @param[in] RequestSource Request source.\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
+ @retval Others The other return status from check handler.\r
+\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+VarCheckLibSetVariableCheck (\r
+ IN CHAR16 *VariableName,\r
+ IN EFI_GUID *VendorGuid,\r
+ IN UINT32 Attributes,\r
+ IN UINTN DataSize,\r
+ IN VOID *Data,\r
+ IN VAR_CHECK_REQUEST_SOURCE RequestSource\r
+ )\r
+{\r
+ EFI_STATUS Status;\r
+ UINTN Index;\r
+ VAR_CHECK_VARIABLE_PROPERTY *Property;\r
+\r
+ if (!mVarCheckLibEndOfDxe) {\r
+ //\r
+ // Only do check after End Of Dxe.\r
+ //\r
+ return EFI_SUCCESS;\r
+ }\r
+\r
+ Property = VariablePropertyGetFunction (VariableName, VendorGuid, TRUE);\r
+ if (Property != NULL) {\r
+ if ((RequestSource != VarCheckFromTrusted) && ((Property->Property & VAR_CHECK_VARIABLE_PROPERTY_READ_ONLY) != 0)) {\r
+ DEBUG ((EFI_D_INFO, "Variable Check ReadOnly variable fail %r - %g:%s\n", EFI_WRITE_PROTECTED, VendorGuid, VariableName));\r
+ return EFI_WRITE_PROTECTED;\r
+ }\r
+ if (!((((Attributes & EFI_VARIABLE_APPEND_WRITE) == 0) && (DataSize == 0)) || (Attributes == 0))) {\r
+ //\r
+ // Not to delete variable.\r
+ //\r
+ if ((Property->Attributes != 0) && ((Attributes & (~EFI_VARIABLE_APPEND_WRITE)) != Property->Attributes)) {\r
+ DEBUG ((EFI_D_INFO, "Variable Check Attributes(0x%08x to 0x%08x) fail %r - %g:%s\n", Property->Attributes, Attributes, EFI_INVALID_PARAMETER, VendorGuid, VariableName));\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ if (DataSize != 0) {\r
+ if ((DataSize < Property->MinSize) || (DataSize > Property->MaxSize)) {\r
+ DEBUG ((EFI_D_INFO, "Variable Check DataSize fail(0x%x not in 0x%x - 0x%x) %r - %g:%s\n", DataSize, Property->MinSize, Property->MaxSize, EFI_INVALID_PARAMETER, VendorGuid, VariableName));\r
+ return EFI_INVALID_PARAMETER;\r
+ }\r
+ }\r
+ }\r
+ }\r
+\r
+ for (Index = 0; Index < mNumberOfVarCheckHandler; Index++) {\r
+ Status = mVarCheckHandlerTable[Index] (\r
+ VariableName,\r
+ VendorGuid,\r
+ Attributes,\r
+ DataSize,\r
+ Data\r
+ );\r
+ if (EFI_ERROR (Status)) {\r
+ DEBUG ((EFI_D_INFO, "Variable Check handler fail %r - %g:%s\n", Status, VendorGuid, VariableName));\r
+ return Status;\r
+ }\r
+ }\r
+ return EFI_SUCCESS;\r
+}\r
projects / mirror_edk2.git / commitdiff