[mirror_edk2.git] / MdeModulePkg / Universal / LockBox / SmmLockBox / SmmLockBox.c

/** @file\r
  LockBox SMM driver.\r
  \r
  Caution: This module requires additional review when modified.\r
  This driver will have external input - communicate buffer in SMM mode.\r
  This external input must be validated carefully to avoid security issue like\r
  buffer overflow, integer overflow.\r
  \r
  SmmLockBoxHandler(), SmmLockBoxRestore(), SmmLockBoxUpdate(), SmmLockBoxSave()\r
  will receive untrusted input and do basic validation.\r
\r
Copyright (c) 2010 - 2017, 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\r
of the BSD License which accompanies this distribution.  The\r
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 <PiSmm.h>\r
#include <Library/UefiDriverEntryPoint.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiRuntimeServicesTableLib.h>\r
#include <Library/SmmServicesTableLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/SmmMemLib.h>\r
#include <Library/LockBoxLib.h>\r
\r
#include <Protocol/SmmReadyToLock.h>\r
#include <Protocol/SmmCommunication.h>\r
#include <Protocol/LockBox.h>\r
#include <Guid/SmmLockBox.h>\r
\r
BOOLEAN              mLocked = FALSE;\r
\r
/**\r
  Dispatch function for SMM lock box save.\r
\r
  Caution: This function may receive untrusted input.\r
  Restore buffer and length are external input, so this function will validate\r
  it is in SMRAM.\r
\r
  @param LockBoxParameterSave  parameter of lock box save \r
**/\r
VOID\r
SmmLockBoxSave (\r
  IN EFI_SMM_LOCK_BOX_PARAMETER_SAVE *LockBoxParameterSave\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  EFI_SMM_LOCK_BOX_PARAMETER_SAVE TempLockBoxParameterSave;\r
\r
  //\r
  // Sanity check\r
  //\r
  if (mLocked) {\r
    DEBUG ((EFI_D_ERROR, "SmmLockBox Locked!\n"));\r
    LockBoxParameterSave->Header.ReturnStatus = (UINT64)EFI_ACCESS_DENIED;\r
    return ;\r
  }\r
\r
  CopyMem (&TempLockBoxParameterSave, LockBoxParameterSave, sizeof (EFI_SMM_LOCK_BOX_PARAMETER_SAVE));\r
\r
  //\r
  // Sanity check\r
  //\r
  if (!SmmIsBufferOutsideSmmValid ((UINTN)TempLockBoxParameterSave.Buffer, (UINTN)TempLockBoxParameterSave.Length)) {\r
    DEBUG ((EFI_D_ERROR, "SmmLockBox Save address in SMRAM or buffer overflow!\n"));\r
    LockBoxParameterSave->Header.ReturnStatus = (UINT64)EFI_ACCESS_DENIED;\r
    return ;\r
  }\r
\r
  //\r
  // Save data\r
  //\r
  Status = SaveLockBox (\r
             &TempLockBoxParameterSave.Guid,\r
             (VOID *)(UINTN)TempLockBoxParameterSave.Buffer,\r
             (UINTN)TempLockBoxParameterSave.Length\r
             );\r
  LockBoxParameterSave->Header.ReturnStatus = (UINT64)Status;\r
  return ;\r
}\r
\r
/**\r
  Dispatch function for SMM lock box set attributes.\r
\r
  @param LockBoxParameterSetAttributes  parameter of lock box set attributes\r
**/\r
VOID\r
SmmLockBoxSetAttributes (\r
  IN EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES *LockBoxParameterSetAttributes\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES TempLockBoxParameterSetAttributes;\r
\r
  //\r
  // Sanity check\r
  //\r
  if (mLocked) {\r
    DEBUG ((EFI_D_ERROR, "SmmLockBox Locked!\n"));\r
    LockBoxParameterSetAttributes->Header.ReturnStatus = (UINT64)EFI_ACCESS_DENIED;\r
    return ;\r
  }\r
\r
  CopyMem (&TempLockBoxParameterSetAttributes, LockBoxParameterSetAttributes, sizeof (EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES));\r
\r
  //\r
  // Update data\r
  //\r
  Status = SetLockBoxAttributes (\r
             &TempLockBoxParameterSetAttributes.Guid,\r
             TempLockBoxParameterSetAttributes.Attributes\r
             );\r
  LockBoxParameterSetAttributes->Header.ReturnStatus = (UINT64)Status;\r
  return ;\r
}\r
\r
/**\r
  Dispatch function for SMM lock box update.\r
\r
  Caution: This function may receive untrusted input.\r
  Restore buffer and length are external input, so this function will validate\r
  it is in SMRAM.\r
\r
  @param LockBoxParameterUpdate  parameter of lock box update \r
**/\r
VOID\r
SmmLockBoxUpdate (\r
  IN EFI_SMM_LOCK_BOX_PARAMETER_UPDATE *LockBoxParameterUpdate\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_SMM_LOCK_BOX_PARAMETER_UPDATE TempLockBoxParameterUpdate;\r
\r
  //\r
  // Sanity check\r
  //\r
  if (mLocked) {\r
    DEBUG ((EFI_D_ERROR, "SmmLockBox Locked!\n"));\r
    LockBoxParameterUpdate->Header.ReturnStatus = (UINT64)EFI_ACCESS_DENIED;\r
    return ;\r
  }\r
\r
  CopyMem (&TempLockBoxParameterUpdate, LockBoxParameterUpdate, sizeof (EFI_SMM_LOCK_BOX_PARAMETER_UPDATE));\r
\r
  //\r
  // Sanity check\r
  //\r
  if (!SmmIsBufferOutsideSmmValid ((UINTN)TempLockBoxParameterUpdate.Buffer, (UINTN)TempLockBoxParameterUpdate.Length)) {\r
    DEBUG ((EFI_D_ERROR, "SmmLockBox Update address in SMRAM or buffer overflow!\n"));\r
    LockBoxParameterUpdate->Header.ReturnStatus = (UINT64)EFI_ACCESS_DENIED;\r
    return ;\r
  }\r
\r
  //\r
  // Update data\r
  //\r
  Status = UpdateLockBox (\r
             &TempLockBoxParameterUpdate.Guid,\r
             (UINTN)TempLockBoxParameterUpdate.Offset,\r
             (VOID *)(UINTN)TempLockBoxParameterUpdate.Buffer,\r
             (UINTN)TempLockBoxParameterUpdate.Length\r
             );\r
  LockBoxParameterUpdate->Header.ReturnStatus = (UINT64)Status;\r
  return ;\r
}\r
\r
/**\r
  Dispatch function for SMM lock box restore.\r
\r
  Caution: This function may receive untrusted input.\r
  Restore buffer and length are external input, so this function will validate\r
  it is in SMRAM.\r
\r
  @param LockBoxParameterRestore  parameter of lock box restore \r
**/\r
VOID\r
SmmLockBoxRestore (\r
  IN EFI_SMM_LOCK_BOX_PARAMETER_RESTORE *LockBoxParameterRestore\r
  )\r
{\r
  EFI_STATUS                     Status;\r
  EFI_SMM_LOCK_BOX_PARAMETER_RESTORE TempLockBoxParameterRestore;\r
\r
  CopyMem (&TempLockBoxParameterRestore, LockBoxParameterRestore, sizeof (EFI_SMM_LOCK_BOX_PARAMETER_RESTORE));\r
\r
  //\r
  // Sanity check\r
  //\r
  if (!SmmIsBufferOutsideSmmValid ((UINTN)TempLockBoxParameterRestore.Buffer, (UINTN)TempLockBoxParameterRestore.Length)) {\r
    DEBUG ((EFI_D_ERROR, "SmmLockBox Restore address in SMRAM or buffer overflow!\n"));\r
    LockBoxParameterRestore->Header.ReturnStatus = (UINT64)EFI_ACCESS_DENIED;\r
    return ;\r
  }\r
\r
  //\r
  // Restore data\r
  //\r
  if ((TempLockBoxParameterRestore.Length == 0) && (TempLockBoxParameterRestore.Buffer == 0)) {\r
    Status = RestoreLockBox (\r
               &TempLockBoxParameterRestore.Guid,\r
               NULL,\r
               NULL\r
               );\r
  } else {\r
    Status = RestoreLockBox (\r
               &TempLockBoxParameterRestore.Guid,\r
               (VOID *)(UINTN)TempLockBoxParameterRestore.Buffer,\r
               (UINTN *)&TempLockBoxParameterRestore.Length\r
               );\r
  }\r
  LockBoxParameterRestore->Header.ReturnStatus = (UINT64)Status;\r
  return ;\r
}\r
\r
/**\r
  Dispatch function for SMM lock box restore all in place.\r
\r
  @param LockBoxParameterRestoreAllInPlace  parameter of lock box restore all in place\r
**/\r
VOID\r
SmmLockBoxRestoreAllInPlace (\r
  IN EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE *LockBoxParameterRestoreAllInPlace\r
  )\r
{\r
  EFI_STATUS                     Status;\r
\r
  Status = RestoreAllLockBoxInPlace ();\r
  LockBoxParameterRestoreAllInPlace->Header.ReturnStatus = (UINT64)Status;\r
  return ;\r
}\r
\r
/**\r
  Dispatch function for a Software SMI handler.\r
\r
  Caution: This function may receive untrusted input.\r
  Communicate buffer and buffer size are external input, so this function will do basic validation.\r
\r
  @param DispatchHandle  The unique handle assigned to this handler by SmiHandlerRegister().\r
  @param Context         Points to an optional handler context which was specified when the\r
                         handler was registered.\r
  @param CommBuffer      A pointer to a collection of data in memory that will\r
                         be conveyed from a non-SMM environment into an SMM environment.\r
  @param CommBufferSize  The size of the CommBuffer.\r
\r
  @retval EFI_SUCCESS Command is handled successfully.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmLockBoxHandler (\r
  IN EFI_HANDLE  DispatchHandle,\r
  IN CONST VOID  *Context         OPTIONAL,\r
  IN OUT VOID    *CommBuffer      OPTIONAL,\r
  IN OUT UINTN   *CommBufferSize  OPTIONAL\r
  )\r
{\r
  EFI_SMM_LOCK_BOX_PARAMETER_HEADER *LockBoxParameterHeader;\r
  UINTN                             TempCommBufferSize;\r
\r
  DEBUG ((DEBUG_INFO, "SmmLockBox SmmLockBoxHandler Enter\n"));\r
\r
  //\r
  // If input is invalid, stop processing this SMI\r
  //\r
  if (CommBuffer == NULL || CommBufferSize == NULL) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  TempCommBufferSize = *CommBufferSize;\r
\r
  //\r
  // Sanity check\r
  //\r
  if (TempCommBufferSize < sizeof(EFI_SMM_LOCK_BOX_PARAMETER_HEADER)) {\r
    DEBUG ((EFI_D_ERROR, "SmmLockBox Command Buffer Size invalid!\n"));\r
    return EFI_SUCCESS;\r
  }\r
  if (!SmmIsBufferOutsideSmmValid ((UINTN)CommBuffer, TempCommBufferSize)) {\r
    DEBUG ((EFI_D_ERROR, "SmmLockBox Command Buffer in SMRAM or overflow!\n"));\r
    return EFI_SUCCESS;\r
  }\r
\r
  LockBoxParameterHeader = (EFI_SMM_LOCK_BOX_PARAMETER_HEADER *)((UINTN)CommBuffer);\r
\r
  LockBoxParameterHeader->ReturnStatus = (UINT64)-1;\r
\r
  DEBUG ((DEBUG_INFO, "SmmLockBox LockBoxParameterHeader - %x\n", (UINTN)LockBoxParameterHeader));\r
\r
  DEBUG ((DEBUG_INFO, "SmmLockBox Command - %x\n", (UINTN)LockBoxParameterHeader->Command));\r
\r
  switch (LockBoxParameterHeader->Command) {\r
  case EFI_SMM_LOCK_BOX_COMMAND_SAVE:\r
    if (TempCommBufferSize < sizeof(EFI_SMM_LOCK_BOX_PARAMETER_SAVE)) {\r
      DEBUG ((EFI_D_ERROR, "SmmLockBox Command Buffer Size for SAVE invalid!\n"));\r
      break;\r
    }\r
    SmmLockBoxSave ((EFI_SMM_LOCK_BOX_PARAMETER_SAVE *)(UINTN)LockBoxParameterHeader);\r
    break;\r
  case EFI_SMM_LOCK_BOX_COMMAND_UPDATE:\r
    if (TempCommBufferSize < sizeof(EFI_SMM_LOCK_BOX_PARAMETER_UPDATE)) {\r
      DEBUG ((EFI_D_ERROR, "SmmLockBox Command Buffer Size for UPDATE invalid!\n"));\r
      break;\r
    }\r
    SmmLockBoxUpdate ((EFI_SMM_LOCK_BOX_PARAMETER_UPDATE *)(UINTN)LockBoxParameterHeader);\r
    break;\r
  case EFI_SMM_LOCK_BOX_COMMAND_RESTORE:\r
    if (TempCommBufferSize < sizeof(EFI_SMM_LOCK_BOX_PARAMETER_RESTORE)) {\r
      DEBUG ((EFI_D_ERROR, "SmmLockBox Command Buffer Size for RESTORE invalid!\n"));\r
      break;\r
    }\r
    SmmLockBoxRestore ((EFI_SMM_LOCK_BOX_PARAMETER_RESTORE *)(UINTN)LockBoxParameterHeader);\r
    break;\r
  case EFI_SMM_LOCK_BOX_COMMAND_SET_ATTRIBUTES:\r
    if (TempCommBufferSize < sizeof(EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES)) {\r
      DEBUG ((EFI_D_ERROR, "SmmLockBox Command Buffer Size for SET_ATTRIBUTES invalid!\n"));\r
      break;\r
    }\r
    SmmLockBoxSetAttributes ((EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES *)(UINTN)LockBoxParameterHeader);\r
    break;\r
  case EFI_SMM_LOCK_BOX_COMMAND_RESTORE_ALL_IN_PLACE:\r
    if (TempCommBufferSize < sizeof(EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE)) {\r
      DEBUG ((EFI_D_ERROR, "SmmLockBox Command Buffer Size for RESTORE_ALL_IN_PLACE invalid!\n"));\r
      break;\r
    }\r
    SmmLockBoxRestoreAllInPlace ((EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE *)(UINTN)LockBoxParameterHeader);\r
    break;\r
  default:\r
    DEBUG ((EFI_D_ERROR, "SmmLockBox Command invalid!\n"));\r
    break;\r
  }\r
\r
  LockBoxParameterHeader->Command = (UINT32)-1;\r
\r
  DEBUG ((DEBUG_INFO, "SmmLockBox SmmLockBoxHandler Exit\n"));\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Smm Ready To Lock event notification handler.\r
\r
  It sets a flag indicating that SMRAM has been locked.\r
  \r
  @param[in] Protocol   Points to the protocol's unique identifier.\r
  @param[in] Interface  Points to the interface instance.\r
  @param[in] Handle     The handle on which the interface was installed.\r
\r
  @retval EFI_SUCCESS   Notification handler runs successfully.\r
 **/\r
EFI_STATUS\r
EFIAPI\r
SmmReadyToLockEventNotify (\r
  IN CONST EFI_GUID  *Protocol,\r
  IN VOID            *Interface,\r
  IN EFI_HANDLE      Handle\r
  )\r
{\r
  mLocked = TRUE;\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Entry Point for LockBox SMM driver.\r
\r
  @param[in] ImageHandle  Image handle of this driver.\r
  @param[in] SystemTable  A Pointer to the EFI System Table.\r
\r
  @retval EFI_SUCEESS     \r
  @return Others          Some error occurs.\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmLockBoxEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS                    Status;\r
  EFI_HANDLE                    DispatchHandle;\r
  VOID                          *Registration;\r
\r
  //\r
  // Register LockBox communication handler\r
  //\r
  Status = gSmst->SmiHandlerRegister (\r
                    SmmLockBoxHandler,\r
                    &gEfiSmmLockBoxCommunicationGuid,\r
                    &DispatchHandle\r
                    );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Register SMM Ready To Lock Protocol notification\r
  //\r
  Status = gSmst->SmmRegisterProtocolNotify (\r
                    &gEfiSmmReadyToLockProtocolGuid,\r
                    SmmReadyToLockEventNotify,\r
                    &Registration\r
                    );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Install NULL to DXE data base as notify\r
  //\r
  ImageHandle = NULL;\r
  Status = gBS->InstallProtocolInterface (\r
                  &ImageHandle,\r
                  &gEfiLockBoxProtocolGuid,\r
                  EFI_NATIVE_INTERFACE,\r
                  NULL\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  return Status;\r
}\r
Commit	Line	Data
1c837cd5	1	/** @file\r
e8c758dc HT	2	LockBox SMM driver.\r
e8c758dc HT	3	\r
32177f69 JY	4	Caution: This module requires additional review when modified.\r
	5	This driver will have external input - communicate buffer in SMM mode.\r
	6	This external input must be validated carefully to avoid security issue like\r
	7	buffer overflow, integer overflow.\r
e8c758dc	8	\r
32177f69 JY	9	SmmLockBoxHandler(), SmmLockBoxRestore(), SmmLockBoxUpdate(), SmmLockBoxSave()\r
32177f69 JY	10	will receive untrusted input and do basic validation.\r
1c837cd5	11	\r
558f58e3	12	Copyright (c) 2010 - 2017, Intel Corporation. All rights reserved.<BR>\r
e8c758dc	13	\r
1c837cd5	14	This program and the accompanying materials\r
	15	are licensed and made available under the terms and conditions\r
	16	of the BSD License which accompanies this distribution. The\r
	17	full text of the license may be found at\r
	18	http://opensource.org/licenses/bsd-license.php\r
	19	\r
	20	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	21	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	22	\r
	23	**/\r
	24	\r
	25	#include <PiSmm.h>\r
	26	#include <Library/UefiDriverEntryPoint.h>\r
	27	#include <Library/UefiBootServicesTableLib.h>\r
	28	#include <Library/UefiRuntimeServicesTableLib.h>\r
	29	#include <Library/SmmServicesTableLib.h>\r
	30	#include <Library/BaseLib.h>\r
	31	#include <Library/BaseMemoryLib.h>\r
	32	#include <Library/DebugLib.h>\r
842b1242	33	#include <Library/SmmMemLib.h>\r
1c837cd5	34	#include <Library/LockBoxLib.h>\r
842b1242	35	\r
1c837cd5	36	#include <Protocol/SmmReadyToLock.h>\r
1c837cd5	37	#include <Protocol/SmmCommunication.h>\r
1c837cd5	38	#include <Protocol/LockBox.h>\r
	39	#include <Guid/SmmLockBox.h>\r
	40	\r
	41	BOOLEAN mLocked = FALSE;\r
	42	\r
1c837cd5	43	/**\r
	44	Dispatch function for SMM lock box save.\r
	45	\r
32177f69 JY	46	Caution: This function may receive untrusted input.\r
	47	Restore buffer and length are external input, so this function will validate\r
	48	it is in SMRAM.\r
	49	\r
1c837cd5	50	@param LockBoxParameterSave parameter of lock box save \r
	51	**/\r
	52	VOID\r
	53	SmmLockBoxSave (\r
	54	IN EFI_SMM_LOCK_BOX_PARAMETER_SAVE *LockBoxParameterSave\r
	55	)\r
	56	{\r
	57	EFI_STATUS Status;\r
5e5bb2a9	58	EFI_SMM_LOCK_BOX_PARAMETER_SAVE TempLockBoxParameterSave;\r
1c837cd5	59	\r
	60	//\r
	61	// Sanity check\r
	62	//\r
	63	if (mLocked) {\r
	64	DEBUG ((EFI_D_ERROR, "SmmLockBox Locked!\n"));\r
	65	LockBoxParameterSave->Header.ReturnStatus = (UINT64)EFI_ACCESS_DENIED;\r
	66	return ;\r
	67	}\r
	68	\r
5e5bb2a9 SZ	69	CopyMem (&TempLockBoxParameterSave, LockBoxParameterSave, sizeof (EFI_SMM_LOCK_BOX_PARAMETER_SAVE));\r
5e5bb2a9 SZ	70	\r
32177f69 JY	71	//\r
	72	// Sanity check\r
	73	//\r
842b1242	74	if (!SmmIsBufferOutsideSmmValid ((UINTN)TempLockBoxParameterSave.Buffer, (UINTN)TempLockBoxParameterSave.Length)) {\r
9d00d20e	75	DEBUG ((EFI_D_ERROR, "SmmLockBox Save address in SMRAM or buffer overflow!\n"));\r
32177f69 JY	76	LockBoxParameterSave->Header.ReturnStatus = (UINT64)EFI_ACCESS_DENIED;\r
	77	return ;\r
	78	}\r
	79	\r
1c837cd5	80	//\r
	81	// Save data\r
	82	//\r
	83	Status = SaveLockBox (\r
5e5bb2a9 SZ	84	&TempLockBoxParameterSave.Guid,\r
	85	(VOID *)(UINTN)TempLockBoxParameterSave.Buffer,\r
	86	(UINTN)TempLockBoxParameterSave.Length\r
1c837cd5	87	);\r
	88	LockBoxParameterSave->Header.ReturnStatus = (UINT64)Status;\r
	89	return ;\r
	90	}\r
	91	\r
	92	/**\r
	93	Dispatch function for SMM lock box set attributes.\r
	94	\r
	95	@param LockBoxParameterSetAttributes parameter of lock box set attributes\r
	96	**/\r
	97	VOID\r
	98	SmmLockBoxSetAttributes (\r
	99	IN EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES *LockBoxParameterSetAttributes\r
	100	)\r
	101	{\r
	102	EFI_STATUS Status;\r
5e5bb2a9	103	EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES TempLockBoxParameterSetAttributes;\r
1c837cd5	104	\r
	105	//\r
	106	// Sanity check\r
	107	//\r
	108	if (mLocked) {\r
	109	DEBUG ((EFI_D_ERROR, "SmmLockBox Locked!\n"));\r
	110	LockBoxParameterSetAttributes->Header.ReturnStatus = (UINT64)EFI_ACCESS_DENIED;\r
	111	return ;\r
	112	}\r
	113	\r
5e5bb2a9 SZ	114	CopyMem (&TempLockBoxParameterSetAttributes, LockBoxParameterSetAttributes, sizeof (EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES));\r
5e5bb2a9 SZ	115	\r
1c837cd5	116	//\r
	117	// Update data\r
	118	//\r
	119	Status = SetLockBoxAttributes (\r
5e5bb2a9 SZ	120	&TempLockBoxParameterSetAttributes.Guid,\r
5e5bb2a9 SZ	121	TempLockBoxParameterSetAttributes.Attributes\r
1c837cd5	122	);\r
	123	LockBoxParameterSetAttributes->Header.ReturnStatus = (UINT64)Status;\r
	124	return ;\r
	125	}\r
	126	\r
	127	/**\r
	128	Dispatch function for SMM lock box update.\r
	129	\r
32177f69 JY	130	Caution: This function may receive untrusted input.\r
	131	Restore buffer and length are external input, so this function will validate\r
	132	it is in SMRAM.\r
	133	\r
1c837cd5	134	@param LockBoxParameterUpdate parameter of lock box update \r
	135	**/\r
	136	VOID\r
	137	SmmLockBoxUpdate (\r
	138	IN EFI_SMM_LOCK_BOX_PARAMETER_UPDATE *LockBoxParameterUpdate\r
	139	)\r
	140	{\r
	141	EFI_STATUS Status;\r
5e5bb2a9	142	EFI_SMM_LOCK_BOX_PARAMETER_UPDATE TempLockBoxParameterUpdate;\r
1c837cd5	143	\r
	144	//\r
	145	// Sanity check\r
	146	//\r
	147	if (mLocked) {\r
	148	DEBUG ((EFI_D_ERROR, "SmmLockBox Locked!\n"));\r
	149	LockBoxParameterUpdate->Header.ReturnStatus = (UINT64)EFI_ACCESS_DENIED;\r
	150	return ;\r
	151	}\r
	152	\r
5e5bb2a9 SZ	153	CopyMem (&TempLockBoxParameterUpdate, LockBoxParameterUpdate, sizeof (EFI_SMM_LOCK_BOX_PARAMETER_UPDATE));\r
5e5bb2a9 SZ	154	\r
32177f69 JY	155	//\r
	156	// Sanity check\r
	157	//\r
842b1242	158	if (!SmmIsBufferOutsideSmmValid ((UINTN)TempLockBoxParameterUpdate.Buffer, (UINTN)TempLockBoxParameterUpdate.Length)) {\r
9d00d20e	159	DEBUG ((EFI_D_ERROR, "SmmLockBox Update address in SMRAM or buffer overflow!\n"));\r
32177f69 JY	160	LockBoxParameterUpdate->Header.ReturnStatus = (UINT64)EFI_ACCESS_DENIED;\r
	161	return ;\r
	162	}\r
	163	\r
1c837cd5	164	//\r
	165	// Update data\r
	166	//\r
	167	Status = UpdateLockBox (\r
5e5bb2a9 SZ	168	&TempLockBoxParameterUpdate.Guid,\r
	169	(UINTN)TempLockBoxParameterUpdate.Offset,\r
	170	(VOID *)(UINTN)TempLockBoxParameterUpdate.Buffer,\r
	171	(UINTN)TempLockBoxParameterUpdate.Length\r
1c837cd5	172	);\r
	173	LockBoxParameterUpdate->Header.ReturnStatus = (UINT64)Status;\r
	174	return ;\r
	175	}\r
	176	\r
	177	/**\r
	178	Dispatch function for SMM lock box restore.\r
	179	\r
32177f69 JY	180	Caution: This function may receive untrusted input.\r
	181	Restore buffer and length are external input, so this function will validate\r
	182	it is in SMRAM.\r
	183	\r
1c837cd5	184	@param LockBoxParameterRestore parameter of lock box restore \r
	185	**/\r
	186	VOID\r
	187	SmmLockBoxRestore (\r
	188	IN EFI_SMM_LOCK_BOX_PARAMETER_RESTORE *LockBoxParameterRestore\r
	189	)\r
	190	{\r
	191	EFI_STATUS Status;\r
5e5bb2a9 SZ	192	EFI_SMM_LOCK_BOX_PARAMETER_RESTORE TempLockBoxParameterRestore;\r
	193	\r
	194	CopyMem (&TempLockBoxParameterRestore, LockBoxParameterRestore, sizeof (EFI_SMM_LOCK_BOX_PARAMETER_RESTORE));\r
1c837cd5	195	\r
	196	//\r
	197	// Sanity check\r
	198	//\r
842b1242	199	if (!SmmIsBufferOutsideSmmValid ((UINTN)TempLockBoxParameterRestore.Buffer, (UINTN)TempLockBoxParameterRestore.Length)) {\r
9d00d20e	200	DEBUG ((EFI_D_ERROR, "SmmLockBox Restore address in SMRAM or buffer overflow!\n"));\r
1c837cd5	201	LockBoxParameterRestore->Header.ReturnStatus = (UINT64)EFI_ACCESS_DENIED;\r
	202	return ;\r
	203	}\r
	204	\r
	205	//\r
	206	// Restore data\r
	207	//\r
5e5bb2a9	208	if ((TempLockBoxParameterRestore.Length == 0) && (TempLockBoxParameterRestore.Buffer == 0)) {\r
1476a257	209	Status = RestoreLockBox (\r
5e5bb2a9	210	&TempLockBoxParameterRestore.Guid,\r
1476a257	211	NULL,\r
	212	NULL\r
	213	);\r
	214	} else {\r
	215	Status = RestoreLockBox (\r
5e5bb2a9 SZ	216	&TempLockBoxParameterRestore.Guid,\r
	217	(VOID *)(UINTN)TempLockBoxParameterRestore.Buffer,\r
	218	(UINTN *)&TempLockBoxParameterRestore.Length\r
1476a257	219	);\r
1476a257	220	}\r
1c837cd5	221	LockBoxParameterRestore->Header.ReturnStatus = (UINT64)Status;\r
	222	return ;\r
	223	}\r
	224	\r
	225	/**\r
	226	Dispatch function for SMM lock box restore all in place.\r
	227	\r
	228	@param LockBoxParameterRestoreAllInPlace parameter of lock box restore all in place\r
	229	**/\r
	230	VOID\r
	231	SmmLockBoxRestoreAllInPlace (\r
	232	IN EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE *LockBoxParameterRestoreAllInPlace\r
	233	)\r
	234	{\r
	235	EFI_STATUS Status;\r
	236	\r
	237	Status = RestoreAllLockBoxInPlace ();\r
	238	LockBoxParameterRestoreAllInPlace->Header.ReturnStatus = (UINT64)Status;\r
	239	return ;\r
	240	}\r
	241	\r
	242	/**\r
	243	Dispatch function for a Software SMI handler.\r
	244	\r
32177f69 JY	245	Caution: This function may receive untrusted input.\r
	246	Communicate buffer and buffer size are external input, so this function will do basic validation.\r
	247	\r
1c837cd5	248	@param DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().\r
	249	@param Context Points to an optional handler context which was specified when the\r
	250	handler was registered.\r
	251	@param CommBuffer A pointer to a collection of data in memory that will\r
	252	be conveyed from a non-SMM environment into an SMM environment.\r
	253	@param CommBufferSize The size of the CommBuffer.\r
	254	\r
	255	@retval EFI_SUCCESS Command is handled successfully.\r
	256	\r
	257	**/\r
	258	EFI_STATUS\r
	259	EFIAPI\r
	260	SmmLockBoxHandler (\r
	261	IN EFI_HANDLE DispatchHandle,\r
	262	IN CONST VOID *Context OPTIONAL,\r
	263	IN OUT VOID *CommBuffer OPTIONAL,\r
	264	IN OUT UINTN *CommBufferSize OPTIONAL\r
	265	)\r
	266	{\r
	267	EFI_SMM_LOCK_BOX_PARAMETER_HEADER *LockBoxParameterHeader;\r
164a9b67	268	UINTN TempCommBufferSize;\r
1c837cd5	269	\r
558f58e3	270	DEBUG ((DEBUG_INFO, "SmmLockBox SmmLockBoxHandler Enter\n"));\r
1c837cd5	271	\r
164a9b67 SZ	272	//\r
	273	// If input is invalid, stop processing this SMI\r
	274	//\r
	275	if (CommBuffer == NULL \|\| CommBufferSize == NULL) {\r
	276	return EFI_SUCCESS;\r
	277	}\r
	278	\r
	279	TempCommBufferSize = *CommBufferSize;\r
	280	\r
32177f69 JY	281	//\r
	282	// Sanity check\r
	283	//\r
164a9b67	284	if (TempCommBufferSize < sizeof(EFI_SMM_LOCK_BOX_PARAMETER_HEADER)) {\r
32177f69 JY	285	DEBUG ((EFI_D_ERROR, "SmmLockBox Command Buffer Size invalid!\n"));\r
	286	return EFI_SUCCESS;\r
	287	}\r
842b1242	288	if (!SmmIsBufferOutsideSmmValid ((UINTN)CommBuffer, TempCommBufferSize)) {\r
9d00d20e	289	DEBUG ((EFI_D_ERROR, "SmmLockBox Command Buffer in SMRAM or overflow!\n"));\r
32177f69 JY	290	return EFI_SUCCESS;\r
	291	}\r
	292	\r
1c837cd5	293	LockBoxParameterHeader = (EFI_SMM_LOCK_BOX_PARAMETER_HEADER *)((UINTN)CommBuffer);\r
	294	\r
	295	LockBoxParameterHeader->ReturnStatus = (UINT64)-1;\r
	296	\r
558f58e3	297	DEBUG ((DEBUG_INFO, "SmmLockBox LockBoxParameterHeader - %x\n", (UINTN)LockBoxParameterHeader));\r
1c837cd5	298	\r
558f58e3	299	DEBUG ((DEBUG_INFO, "SmmLockBox Command - %x\n", (UINTN)LockBoxParameterHeader->Command));\r
1c837cd5	300	\r
	301	switch (LockBoxParameterHeader->Command) {\r
	302	case EFI_SMM_LOCK_BOX_COMMAND_SAVE:\r
164a9b67	303	if (TempCommBufferSize < sizeof(EFI_SMM_LOCK_BOX_PARAMETER_SAVE)) {\r
32177f69 JY	304	DEBUG ((EFI_D_ERROR, "SmmLockBox Command Buffer Size for SAVE invalid!\n"));\r
	305	break;\r
	306	}\r
1c837cd5	307	SmmLockBoxSave ((EFI_SMM_LOCK_BOX_PARAMETER_SAVE *)(UINTN)LockBoxParameterHeader);\r
	308	break;\r
	309	case EFI_SMM_LOCK_BOX_COMMAND_UPDATE:\r
164a9b67	310	if (TempCommBufferSize < sizeof(EFI_SMM_LOCK_BOX_PARAMETER_UPDATE)) {\r
32177f69 JY	311	DEBUG ((EFI_D_ERROR, "SmmLockBox Command Buffer Size for UPDATE invalid!\n"));\r
	312	break;\r
	313	}\r
1c837cd5	314	SmmLockBoxUpdate ((EFI_SMM_LOCK_BOX_PARAMETER_UPDATE *)(UINTN)LockBoxParameterHeader);\r
	315	break;\r
	316	case EFI_SMM_LOCK_BOX_COMMAND_RESTORE:\r
164a9b67	317	if (TempCommBufferSize < sizeof(EFI_SMM_LOCK_BOX_PARAMETER_RESTORE)) {\r
32177f69 JY	318	DEBUG ((EFI_D_ERROR, "SmmLockBox Command Buffer Size for RESTORE invalid!\n"));\r
	319	break;\r
	320	}\r
1c837cd5	321	SmmLockBoxRestore ((EFI_SMM_LOCK_BOX_PARAMETER_RESTORE *)(UINTN)LockBoxParameterHeader);\r
	322	break;\r
	323	case EFI_SMM_LOCK_BOX_COMMAND_SET_ATTRIBUTES:\r
164a9b67	324	if (TempCommBufferSize < sizeof(EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES)) {\r
32177f69 JY	325	DEBUG ((EFI_D_ERROR, "SmmLockBox Command Buffer Size for SET_ATTRIBUTES invalid!\n"));\r
	326	break;\r
	327	}\r
1c837cd5	328	SmmLockBoxSetAttributes ((EFI_SMM_LOCK_BOX_PARAMETER_SET_ATTRIBUTES *)(UINTN)LockBoxParameterHeader);\r
	329	break;\r
	330	case EFI_SMM_LOCK_BOX_COMMAND_RESTORE_ALL_IN_PLACE:\r
164a9b67	331	if (TempCommBufferSize < sizeof(EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE)) {\r
32177f69 JY	332	DEBUG ((EFI_D_ERROR, "SmmLockBox Command Buffer Size for RESTORE_ALL_IN_PLACE invalid!\n"));\r
	333	break;\r
	334	}\r
1c837cd5	335	SmmLockBoxRestoreAllInPlace ((EFI_SMM_LOCK_BOX_PARAMETER_RESTORE_ALL_IN_PLACE *)(UINTN)LockBoxParameterHeader);\r
	336	break;\r
	337	default:\r
32177f69	338	DEBUG ((EFI_D_ERROR, "SmmLockBox Command invalid!\n"));\r
1c837cd5	339	break;\r
	340	}\r
	341	\r
	342	LockBoxParameterHeader->Command = (UINT32)-1;\r
	343	\r
558f58e3	344	DEBUG ((DEBUG_INFO, "SmmLockBox SmmLockBoxHandler Exit\n"));\r
1c837cd5	345	\r
	346	return EFI_SUCCESS;\r
	347	}\r
	348	\r
	349	/**\r
	350	Smm Ready To Lock event notification handler.\r
	351	\r
	352	It sets a flag indicating that SMRAM has been locked.\r
	353	\r
	354	@param[in] Protocol Points to the protocol's unique identifier.\r
	355	@param[in] Interface Points to the interface instance.\r
	356	@param[in] Handle The handle on which the interface was installed.\r
	357	\r
	358	@retval EFI_SUCCESS Notification handler runs successfully.\r
	359	**/\r
	360	EFI_STATUS\r
	361	EFIAPI\r
	362	SmmReadyToLockEventNotify (\r
	363	IN CONST EFI_GUID *Protocol,\r
	364	IN VOID *Interface,\r
	365	IN EFI_HANDLE Handle\r
	366	)\r
	367	{\r
	368	mLocked = TRUE;\r
	369	return EFI_SUCCESS;\r
	370	}\r
	371	\r
	372	/**\r
	373	Entry Point for LockBox SMM driver.\r
	374	\r
	375	@param[in] ImageHandle Image handle of this driver.\r
	376	@param[in] SystemTable A Pointer to the EFI System Table.\r
	377	\r
	378	@retval EFI_SUCEESS \r
	379	@return Others Some error occurs.\r
	380	**/\r
	381	EFI_STATUS\r
	382	EFIAPI\r
	383	SmmLockBoxEntryPoint (\r
	384	IN EFI_HANDLE ImageHandle,\r
	385	IN EFI_SYSTEM_TABLE *SystemTable\r
	386	)\r
	387	{\r
	388	EFI_STATUS Status;\r
	389	EFI_HANDLE DispatchHandle;\r
	390	VOID *Registration;\r
1c837cd5	391	\r
	392	//\r
	393	// Register LockBox communication handler\r
	394	//\r
	395	Status = gSmst->SmiHandlerRegister (\r
	396	SmmLockBoxHandler,\r
	397	&gEfiSmmLockBoxCommunicationGuid,\r
	398	&DispatchHandle\r
	399	);\r
	400	ASSERT_EFI_ERROR (Status);\r
	401	\r
	402	//\r
	403	// Register SMM Ready To Lock Protocol notification\r
	404	//\r
	405	Status = gSmst->SmmRegisterProtocolNotify (\r
	406	&gEfiSmmReadyToLockProtocolGuid,\r
	407	SmmReadyToLockEventNotify,\r
	408	&Registration\r
	409	);\r
	410	ASSERT_EFI_ERROR (Status);\r
	411	\r
	412	//\r
	413	// Install NULL to DXE data base as notify\r
	414	//\r
	415	ImageHandle = NULL;\r
	416	Status = gBS->InstallProtocolInterface (\r
	417	&ImageHandle,\r
	418	&gEfiLockBoxProtocolGuid,\r
	419	EFI_NATIVE_INTERFACE,\r
	420	NULL\r
	421	);\r
	422	ASSERT_EFI_ERROR (Status);\r
	423	\r
	424	return Status;\r
	425	}\r