[mirror_edk2.git] / MdeModulePkg / Universal / Variable / RuntimeDxe / TcgMorLockSmm.c

/** @file\r
  TCG MOR (Memory Overwrite Request) Lock Control support (SMM version).\r
\r
  This module initilizes MemoryOverwriteRequestControlLock variable.\r
  This module adds Variable Hook and check MemoryOverwriteRequestControlLock.\r
\r
Copyright (c) 2016, 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 <PiDxe.h>\r
#include <Guid/MemoryOverwriteControl.h>\r
#include <IndustryStandard/MemoryOverwriteRequestControlLock.h>\r
#include <Library/DebugLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include "Variable.h"\r
\r
typedef struct {\r
  CHAR16                                 *VariableName;\r
  EFI_GUID                               *VendorGuid;\r
} VARIABLE_TYPE;\r
\r
VARIABLE_TYPE  mMorVariableType[] = {\r
  {MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME,      &gEfiMemoryOverwriteControlDataGuid},\r
  {MEMORY_OVERWRITE_REQUEST_CONTROL_LOCK_NAME,  &gEfiMemoryOverwriteRequestControlLockGuid},\r
};\r
\r
#define MOR_LOCK_DATA_UNLOCKED           0x0\r
#define MOR_LOCK_DATA_LOCKED_WITHOUT_KEY 0x1\r
#define MOR_LOCK_DATA_LOCKED_WITH_KEY    0x2\r
\r
#define MOR_LOCK_V1_SIZE      1\r
#define MOR_LOCK_V2_KEY_SIZE  8\r
\r
typedef enum {\r
  MorLockStateUnlocked = 0,\r
  MorLockStateLocked = 1,\r
} MOR_LOCK_STATE;\r
\r
UINT8           mMorLockKey[MOR_LOCK_V2_KEY_SIZE];\r
BOOLEAN         mMorLockKeyEmpty = TRUE;\r
BOOLEAN         mMorLockPassThru = FALSE;\r
MOR_LOCK_STATE  mMorLockState = MorLockStateUnlocked;\r
\r
/**\r
  Returns if this is MOR related variable.\r
\r
  @param  VariableName the name of the vendor's variable, it's a Null-Terminated Unicode String\r
  @param  VendorGuid   Unify identifier for vendor.\r
\r
  @retval  TRUE            The variable is MOR related.\r
  @retval  FALSE           The variable is NOT MOR related.\r
**/\r
BOOLEAN\r
IsAnyMorVariable (\r
  IN CHAR16                                 *VariableName,\r
  IN EFI_GUID                               *VendorGuid\r
  )\r
{\r
  UINTN   Index;\r
\r
  for (Index = 0; Index < sizeof(mMorVariableType)/sizeof(mMorVariableType[0]); Index++) {\r
    if ((StrCmp (VariableName, mMorVariableType[Index].VariableName) == 0) &&\r
        (CompareGuid (VendorGuid, mMorVariableType[Index].VendorGuid))) {\r
      return TRUE;\r
    }\r
  }\r
  return FALSE;\r
}\r
\r
/**\r
  Returns if this is MOR lock variable.\r
\r
  @param  VariableName the name of the vendor's variable, it's a Null-Terminated Unicode String\r
  @param  VendorGuid   Unify identifier for vendor.\r
\r
  @retval  TRUE            The variable is MOR lock variable.\r
  @retval  FALSE           The variable is NOT MOR lock variable.\r
**/\r
BOOLEAN\r
IsMorLockVariable (\r
  IN CHAR16                                 *VariableName,\r
  IN EFI_GUID                               *VendorGuid\r
  )\r
{\r
  if ((StrCmp (VariableName, MEMORY_OVERWRITE_REQUEST_CONTROL_LOCK_NAME) == 0) &&\r
      (CompareGuid (VendorGuid, &gEfiMemoryOverwriteRequestControlLockGuid))) {\r
    return TRUE;\r
  }\r
  return FALSE;\r
}\r
\r
/**\r
  Set MOR lock variable.\r
\r
  @param  Data         MOR Lock variable data.\r
\r
  @retval  EFI_SUCCESS            The firmware has successfully stored the variable and its data as\r
                                  defined by the Attributes.\r
  @retval  EFI_INVALID_PARAMETER  An invalid combination of attribute bits was supplied, or the\r
                                  DataSize exceeds the maximum allowed.\r
  @retval  EFI_INVALID_PARAMETER  VariableName is an empty Unicode string.\r
  @retval  EFI_OUT_OF_RESOURCES   Not enough storage is available to hold the variable and its data.\r
  @retval  EFI_DEVICE_ERROR       The variable could not be saved due to a hardware failure.\r
  @retval  EFI_WRITE_PROTECTED    The variable in question is read-only.\r
  @retval  EFI_WRITE_PROTECTED    The variable in question cannot be deleted.\r
  @retval  EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\r
                                  set but the AuthInfo does NOT pass the validation check carried\r
                                  out by the firmware.\r
  @retval  EFI_NOT_FOUND          The variable trying to be updated or deleted was not found.\r
**/\r
EFI_STATUS\r
SetMorLockVariable (\r
  IN UINT8  Data\r
  )\r
{\r
  EFI_STATUS  Status;\r
\r
  mMorLockPassThru = TRUE;\r
  Status = VariableServiceSetVariable (\r
             MEMORY_OVERWRITE_REQUEST_CONTROL_LOCK_NAME,\r
             &gEfiMemoryOverwriteRequestControlLockGuid,\r
             EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS,\r
             sizeof(Data),\r
             &Data\r
             );\r
  mMorLockPassThru = FALSE;\r
  return Status;\r
}\r
\r
/**\r
  This service is an MorLock checker handler for the SetVariable().\r
\r
  @param  VariableName the name of the vendor's variable, as a\r
                       Null-Terminated Unicode String\r
  @param  VendorGuid   Unify identifier for vendor.\r
  @param  Attributes   Point to memory location to return the attributes of variable. If the point\r
                       is NULL, the parameter would be ignored.\r
  @param  DataSize     The size in bytes of Data-Buffer.\r
  @param  Data         Point to the content of the variable.\r
\r
  @retval  EFI_SUCCESS            The MorLock check pass, and Variable driver can store the variable data.\r
  @retval  EFI_INVALID_PARAMETER  The MorLock data or data size or attributes is not allowed.\r
  @retval  EFI_ACCESS_DENIED      The MorLock is locked.\r
  @retval  EFI_WRITE_PROTECTED    The MorLock deletion is not allowed.\r
  @retval  EFI_ALREADY_STARTED    The MorLock variable is handled inside this function.\r
                                  Variable driver can just return EFI_SUCCESS.\r
**/\r
EFI_STATUS\r
SetVariableCheckHandlerMorLock (\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
\r
  //\r
  // Basic Check\r
  //\r
  if (Attributes == 0 || DataSize == 0 || Data == NULL) {\r
    return EFI_WRITE_PROTECTED;\r
  }\r
\r
  if ((Attributes != (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS)) ||\r
      ((DataSize != MOR_LOCK_V1_SIZE) && (DataSize != MOR_LOCK_V2_KEY_SIZE))) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Do not check if the request is passthru.\r
  //\r
  if (mMorLockPassThru) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  if (mMorLockState == MorLockStateUnlocked) {\r
    //\r
    // In Unlocked State\r
    //\r
    if (DataSize == MOR_LOCK_V1_SIZE) {\r
      //\r
      // V1 - lock permanently\r
      //\r
      if (*(UINT8 *)Data == MOR_LOCK_DATA_UNLOCKED) {\r
        //\r
        // Unlock\r
        //\r
        Status = SetMorLockVariable (MOR_LOCK_DATA_UNLOCKED);\r
        if (!EFI_ERROR (Status)) {\r
          //\r
          // return EFI_ALREADY_STARTED to skip variable set.\r
          //\r
          return EFI_ALREADY_STARTED;\r
        } else {\r
          //\r
          // SetVar fail\r
          //\r
          return Status;\r
        }\r
      } else if (*(UINT8 *)Data == MOR_LOCK_DATA_LOCKED_WITHOUT_KEY) {\r
        //\r
        // Lock without key\r
        //\r
        Status = SetMorLockVariable (MOR_LOCK_DATA_LOCKED_WITHOUT_KEY);\r
        if (!EFI_ERROR (Status)) {\r
          //\r
          // Lock success\r
          //\r
          mMorLockState = MorLockStateLocked;\r
          //\r
          // return EFI_ALREADY_STARTED to skip variable set.\r
          //\r
          return EFI_ALREADY_STARTED;\r
        } else {\r
          //\r
          // SetVar fail\r
          //\r
          return Status;\r
        }\r
      } else {\r
        return EFI_INVALID_PARAMETER;\r
      }\r
    } else if (DataSize == MOR_LOCK_V2_KEY_SIZE) {\r
      //\r
      // V2 lock and provision the key\r
      //\r
\r
      //\r
      // Need set here because the data value on flash is different\r
      //\r
      Status = SetMorLockVariable (MOR_LOCK_DATA_LOCKED_WITH_KEY);\r
      if (EFI_ERROR(Status)) {\r
        //\r
        // SetVar fail, do not provision the key\r
        //\r
        return Status;\r
      } else {\r
        //\r
        // Lock success, provision the key\r
        //\r
        mMorLockKeyEmpty = FALSE;\r
        CopyMem (mMorLockKey, Data, MOR_LOCK_V2_KEY_SIZE);\r
        mMorLockState = MorLockStateLocked;\r
        //\r
        // return EFI_ALREADY_STARTED to skip variable set.\r
        //\r
        return EFI_ALREADY_STARTED;\r
      }\r
    } else {\r
      ASSERT (FALSE);\r
      return EFI_OUT_OF_RESOURCES;\r
    }\r
  } else {\r
    //\r
    // In Locked State\r
    //\r
    if (mMorLockKeyEmpty || (DataSize != MOR_LOCK_V2_KEY_SIZE)) {\r
      return EFI_ACCESS_DENIED;\r
    }\r
    if ((CompareMem (Data, mMorLockKey, MOR_LOCK_V2_KEY_SIZE) == 0)) {\r
      //\r
      // Key match - unlock\r
      //\r
\r
      //\r
      // Need set here because the data value on flash is different\r
      //\r
      Status = SetMorLockVariable (MOR_LOCK_DATA_UNLOCKED);\r
      if (EFI_ERROR (Status)) {\r
        //\r
        // SetVar fail\r
        //\r
        return Status;\r
      } else {\r
        //\r
        // Unlock Success\r
        //\r
        mMorLockState = MorLockStateUnlocked;\r
        mMorLockKeyEmpty = TRUE;\r
        ZeroMem (mMorLockKey, sizeof(mMorLockKey));\r
        //\r
        // return EFI_ALREADY_STARTED to skip variable set.\r
        //\r
        return EFI_ALREADY_STARTED;\r
      }\r
    } else {\r
      //\r
      // Key mismatch - Prevent Dictionary Attack\r
      //\r
      mMorLockState = MorLockStateLocked;\r
      mMorLockKeyEmpty = TRUE;\r
      ZeroMem (mMorLockKey, sizeof(mMorLockKey));\r
      return EFI_ACCESS_DENIED;\r
    }\r
  }\r
}\r
\r
/**\r
  This service is an MOR/MorLock checker handler for the SetVariable().\r
\r
  @param[in]  VariableName the name of the vendor's variable, as a\r
                           Null-Terminated Unicode String\r
  @param[in]  VendorGuid   Unify identifier for vendor.\r
  @param[in]  Attributes   Attributes bitmask to set for the variable.\r
  @param[in]  DataSize     The size in bytes of Data-Buffer.\r
  @param[in]  Data         Point to the content of the variable.\r
\r
  @retval  EFI_SUCCESS            The MOR/MorLock check pass, and Variable\r
                                  driver can store the variable data.\r
  @retval  EFI_INVALID_PARAMETER  The MOR/MorLock data or data size or\r
                                  attributes is not allowed for MOR variable.\r
  @retval  EFI_ACCESS_DENIED      The MOR/MorLock is locked.\r
  @retval  EFI_ALREADY_STARTED    The MorLock variable is handled inside this\r
                                  function. Variable driver can just return\r
                                  EFI_SUCCESS.\r
**/\r
EFI_STATUS\r
SetVariableCheckHandlerMor (\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
  // do not handle non-MOR variable\r
  //\r
  if (!IsAnyMorVariable (VariableName, VendorGuid)) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  //\r
  // MorLock variable\r
  //\r
  if (IsMorLockVariable (VariableName, VendorGuid)) {\r
    return SetVariableCheckHandlerMorLock (\r
             VariableName,\r
             VendorGuid,\r
             Attributes,\r
             DataSize,\r
             Data\r
             );\r
  }\r
\r
  //\r
  // Mor Variable\r
  //\r
\r
  //\r
  // Basic Check\r
  //\r
  if ((Attributes != (EFI_VARIABLE_NON_VOLATILE | EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_RUNTIME_ACCESS)) ||\r
      (DataSize != sizeof(UINT8)) ||\r
      (Data == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  if (mMorLockState == MorLockStateLocked) {\r
    //\r
    // If lock, deny access\r
    //\r
    return EFI_ACCESS_DENIED;\r
  }\r
  //\r
  // grant access\r
  //\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Initialization for MOR Control Lock.\r
\r
  @retval EFI_SUCCESS     MorLock initialization success.\r
  @return Others          Some error occurs.\r
**/\r
EFI_STATUS\r
MorLockInit (\r
  VOID\r
  )\r
{\r
  //\r
  // Set variable to report capability to OS\r
  //\r
  return SetMorLockVariable (0);\r
}\r
Commit	Line	Data
abad83e6 JY	1	/** @file\r
	2	TCG MOR (Memory Overwrite Request) Lock Control support (SMM version).\r
	3	\r
	4	This module initilizes MemoryOverwriteRequestControlLock variable.\r
	5	This module adds Variable Hook and check MemoryOverwriteRequestControlLock.\r
	6	\r
	7	Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
	8	This program and the accompanying materials\r
	9	are licensed and made available under the terms and conditions of the BSD License\r
	10	which accompanies this distribution. The full text of the license may be found at\r
	11	http://opensource.org/licenses/bsd-license.php\r
	12	\r
	13	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	14	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	15	\r
	16	**/\r
	17	\r
	18	#include <PiDxe.h>\r
	19	#include <Guid/MemoryOverwriteControl.h>\r
	20	#include <IndustryStandard/MemoryOverwriteRequestControlLock.h>\r
	21	#include <Library/DebugLib.h>\r
	22	#include <Library/BaseLib.h>\r
	23	#include <Library/BaseMemoryLib.h>\r
	24	#include "Variable.h"\r
	25	\r
	26	typedef struct {\r
	27	CHAR16 *VariableName;\r
	28	EFI_GUID *VendorGuid;\r
	29	} VARIABLE_TYPE;\r
	30	\r
	31	VARIABLE_TYPE mMorVariableType[] = {\r
	32	{MEMORY_OVERWRITE_REQUEST_VARIABLE_NAME, &gEfiMemoryOverwriteControlDataGuid},\r
	33	{MEMORY_OVERWRITE_REQUEST_CONTROL_LOCK_NAME, &gEfiMemoryOverwriteRequestControlLockGuid},\r
	34	};\r
	35	\r
	36	#define MOR_LOCK_DATA_UNLOCKED 0x0\r
	37	#define MOR_LOCK_DATA_LOCKED_WITHOUT_KEY 0x1\r
	38	#define MOR_LOCK_DATA_LOCKED_WITH_KEY 0x2\r
	39	\r
	40	#define MOR_LOCK_V1_SIZE 1\r
	41	#define MOR_LOCK_V2_KEY_SIZE 8\r
	42	\r
	43	typedef enum {\r
	44	MorLockStateUnlocked = 0,\r
	45	MorLockStateLocked = 1,\r
	46	} MOR_LOCK_STATE;\r
	47	\r
	48	UINT8 mMorLockKey[MOR_LOCK_V2_KEY_SIZE];\r
	49	BOOLEAN mMorLockKeyEmpty = TRUE;\r
	50	BOOLEAN mMorLockPassThru = FALSE;\r
	51	MOR_LOCK_STATE mMorLockState = MorLockStateUnlocked;\r
	52	\r
	53	/**\r
	54	Returns if this is MOR related variable.\r
	55	\r
	56	@param VariableName the name of the vendor's variable, it's a Null-Terminated Unicode String\r
	57	@param VendorGuid Unify identifier for vendor.\r
	58	\r
	59	@retval TRUE The variable is MOR related.\r
	60	@retval FALSE The variable is NOT MOR related.\r
	61	**/\r
	62	BOOLEAN\r
	63	IsAnyMorVariable (\r
	64	IN CHAR16 *VariableName,\r
65	IN EFI_GUID *VendorGuid\r
66	)\r
67	{\r
68	UINTN Index;\r
69	\r
70	for (Index = 0; Index < sizeof(mMorVariableType)/sizeof(mMorVariableType[0]); Index++) {\r
71	if ((StrCmp (VariableName, mMorVariableType[Index].VariableName) == 0) &&\r
72	(CompareGuid (VendorGuid, mMorVariableType[Index].VendorGuid))) {\r
73	return TRUE;\r
74	}\r
75	}\r
76	return FALSE;\r
77	}\r
78	\r
79	/**\r
80	Returns if this is MOR lock variable.\r
81	\r
82	@param VariableName the name of the vendor's variable, it's a Null-Terminated Unicode String\r
83	@param VendorGuid Unify identifier for vendor.\r
84	\r
85	@retval TRUE The variable is MOR lock variable.\r
86	@retval FALSE The variable is NOT MOR lock variable.\r
87	**/\r
88	BOOLEAN\r
89	IsMorLockVariable (\r
90	IN CHAR16 *VariableName,\r
91	IN EFI_GUID *VendorGuid\r
92	)\r
93	{\r
94	if ((StrCmp (VariableName, MEMORY_OVERWRITE_REQUEST_CONTROL_LOCK_NAME) == 0) &&\r
95	(CompareGuid (VendorGuid, &gEfiMemoryOverwriteRequestControlLockGuid))) {\r
96	return TRUE;\r
97	}\r
98	return FALSE;\r
99	}\r
100	\r
101	/**\r
102	Set MOR lock variable.\r
103	\r
104	@param Data MOR Lock variable data.\r
105	\r
106	@retval EFI_SUCCESS The firmware has successfully stored the variable and its data as\r
107	defined by the Attributes.\r
108	@retval EFI_INVALID_PARAMETER An invalid combination of attribute bits was supplied, or the\r
109	DataSize exceeds the maximum allowed.\r
110	@retval EFI_INVALID_PARAMETER VariableName is an empty Unicode string.\r
111	@retval EFI_OUT_OF_RESOURCES Not enough storage is available to hold the variable and its data.\r
112	@retval EFI_DEVICE_ERROR The variable could not be saved due to a hardware failure.\r
113	@retval EFI_WRITE_PROTECTED The variable in question is read-only.\r
114	@retval EFI_WRITE_PROTECTED The variable in question cannot be deleted.\r
115	@retval EFI_SECURITY_VIOLATION The variable could not be written due to EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\r
116	set but the AuthInfo does NOT pass the validation check carried\r
117	out by the firmware.\r
118	@retval EFI_NOT_FOUND The variable trying to be updated or deleted was not found.\r
119	**/\r
120	EFI_STATUS\r
121	SetMorLockVariable (\r
122	IN UINT8 Data\r
123	)\r
124	{\r
125	EFI_STATUS Status;\r
126	\r
127	mMorLockPassThru = TRUE;\r
128	Status = VariableServiceSetVariable (\r
129	MEMORY_OVERWRITE_REQUEST_CONTROL_LOCK_NAME,\r
130	&gEfiMemoryOverwriteRequestControlLockGuid,\r
131	EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS,\r
132	sizeof(Data),\r
133	&Data\r
134	);\r
135	mMorLockPassThru = FALSE;\r
136	return Status;\r
137	}\r
138	\r
139	/**\r
140	This service is an MorLock checker handler for the SetVariable().\r
141	\r
142	@param VariableName the name of the vendor's variable, as a\r
143	Null-Terminated Unicode String\r
144	@param VendorGuid Unify identifier for vendor.\r
145	@param Attributes Point to memory location to return the attributes of variable. If the point\r
146	is NULL, the parameter would be ignored.\r
147	@param DataSize The size in bytes of Data-Buffer.\r
148	@param Data Point to the content of the variable.\r
149	\r
150	@retval EFI_SUCCESS The MorLock check pass, and Variable driver can store the variable data.\r
151	@retval EFI_INVALID_PARAMETER The MorLock data or data size or attributes is not allowed.\r
152	@retval EFI_ACCESS_DENIED The MorLock is locked.\r
153	@retval EFI_WRITE_PROTECTED The MorLock deletion is not allowed.\r
154	@retval EFI_ALREADY_STARTED The MorLock variable is handled inside this function.\r
155	Variable driver can just return EFI_SUCCESS.\r
156	**/\r
157	EFI_STATUS\r
158	SetVariableCheckHandlerMorLock (\r
159	IN CHAR16 *VariableName,\r
160	IN EFI_GUID *VendorGuid,\r
161	IN UINT32 Attributes,\r
162	IN UINTN DataSize,\r
163	IN VOID *Data\r
164	)\r
165	{\r
166	EFI_STATUS Status;\r
167	\r
168	//\r
169	// Basic Check\r
170	//\r
171	if (Attributes == 0 \|\| DataSize == 0 \|\| Data == NULL) {\r
172	return EFI_WRITE_PROTECTED;\r
173	}\r
174	\r
175	if ((Attributes != (EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS)) \|\|\r
176	((DataSize != MOR_LOCK_V1_SIZE) && (DataSize != MOR_LOCK_V2_KEY_SIZE))) {\r
177	return EFI_INVALID_PARAMETER;\r
178	}\r
179	\r
180	//\r
181	// Do not check if the request is passthru.\r
182	//\r
183	if (mMorLockPassThru) {\r
184	return EFI_SUCCESS;\r
185	}\r
186	\r
187	if (mMorLockState == MorLockStateUnlocked) {\r
188	//\r
189	// In Unlocked State\r
190	//\r
191	if (DataSize == MOR_LOCK_V1_SIZE) {\r
192	//\r
0a18956d	193	// V1 - lock permanently\r
abad83e6 JY	194	//\r
	195	if ((UINT8 )Data == MOR_LOCK_DATA_UNLOCKED) {\r
	196	//\r
	197	// Unlock\r
	198	//\r
	199	Status = SetMorLockVariable (MOR_LOCK_DATA_UNLOCKED);\r
	200	if (!EFI_ERROR (Status)) {\r
	201	//\r
	202	// return EFI_ALREADY_STARTED to skip variable set.\r
	203	//\r
	204	return EFI_ALREADY_STARTED;\r
	205	} else {\r
	206	//\r
	207	// SetVar fail\r
	208	//\r
	209	return Status;\r
	210	}\r
	211	} else if ((UINT8 )Data == MOR_LOCK_DATA_LOCKED_WITHOUT_KEY) {\r
	212	//\r
	213	// Lock without key\r
	214	//\r
	215	Status = SetMorLockVariable (MOR_LOCK_DATA_LOCKED_WITHOUT_KEY);\r
	216	if (!EFI_ERROR (Status)) {\r
	217	//\r
	218	// Lock success\r
	219	//\r
	220	mMorLockState = MorLockStateLocked;\r
	221	//\r
	222	// return EFI_ALREADY_STARTED to skip variable set.\r
	223	//\r
	224	return EFI_ALREADY_STARTED;\r
	225	} else {\r
	226	//\r
	227	// SetVar fail\r
	228	//\r
	229	return Status;\r
	230	}\r
	231	} else {\r
	232	return EFI_INVALID_PARAMETER;\r
	233	}\r
	234	} else if (DataSize == MOR_LOCK_V2_KEY_SIZE) {\r
	235	//\r
	236	// V2 lock and provision the key\r
	237	//\r
	238	\r
	239	//\r
	240	// Need set here because the data value on flash is different\r
	241	//\r
	242	Status = SetMorLockVariable (MOR_LOCK_DATA_LOCKED_WITH_KEY);\r
	243	if (EFI_ERROR(Status)) {\r
	244	//\r
	245	// SetVar fail, do not provision the key\r
	246	//\r
	247	return Status;\r
	248	} else {\r
	249	//\r
	250	// Lock success, provision the key\r
	251	//\r
	252	mMorLockKeyEmpty = FALSE;\r
	253	CopyMem (mMorLockKey, Data, MOR_LOCK_V2_KEY_SIZE);\r
	254	mMorLockState = MorLockStateLocked;\r
	255	//\r
	256	// return EFI_ALREADY_STARTED to skip variable set.\r
	257	//\r
258	return EFI_ALREADY_STARTED;\r
259	}\r
260	} else {\r
261	ASSERT (FALSE);\r
262	return EFI_OUT_OF_RESOURCES;\r
263	}\r
264	} else {\r
265	//\r
266	// In Locked State\r
267	//\r
268	if (mMorLockKeyEmpty \|\| (DataSize != MOR_LOCK_V2_KEY_SIZE)) {\r
269	return EFI_ACCESS_DENIED;\r
270	}\r
271	if ((CompareMem (Data, mMorLockKey, MOR_LOCK_V2_KEY_SIZE) == 0)) {\r
272	//\r
273	// Key match - unlock\r
274	//\r
275	\r
276	//\r
277	// Need set here because the data value on flash is different\r
278	//\r
279	Status = SetMorLockVariable (MOR_LOCK_DATA_UNLOCKED);\r
280	if (EFI_ERROR (Status)) {\r
281	//\r
282	// SetVar fail\r
283	//\r
284	return Status;\r
285	} else {\r
286	//\r
287	// Unlock Success\r
288	//\r
289	mMorLockState = MorLockStateUnlocked;\r
290	mMorLockKeyEmpty = TRUE;\r
291	ZeroMem (mMorLockKey, sizeof(mMorLockKey));\r
292	//\r
293	// return EFI_ALREADY_STARTED to skip variable set.\r
294	//\r
295	return EFI_ALREADY_STARTED;\r
296	}\r
297	} else {\r
298	//\r
299	// Key mismatch - Prevent Dictionary Attack\r
300	//\r
301	mMorLockState = MorLockStateLocked;\r
302	mMorLockKeyEmpty = TRUE;\r
303	ZeroMem (mMorLockKey, sizeof(mMorLockKey));\r
304	return EFI_ACCESS_DENIED;\r
305	}\r
306	}\r
307	}\r
308	\r
309	/**\r
310	This service is an MOR/MorLock checker handler for the SetVariable().\r
311	\r
03877377 LE	312	@param[in] VariableName the name of the vendor's variable, as a\r
	313	Null-Terminated Unicode String\r
	314	@param[in] VendorGuid Unify identifier for vendor.\r
	315	@param[in] Attributes Attributes bitmask to set for the variable.\r
	316	@param[in] DataSize The size in bytes of Data-Buffer.\r
	317	@param[in] Data Point to the content of the variable.\r
	318	\r
	319	@retval EFI_SUCCESS The MOR/MorLock check pass, and Variable\r
	320	driver can store the variable data.\r
	321	@retval EFI_INVALID_PARAMETER The MOR/MorLock data or data size or\r
	322	attributes is not allowed for MOR variable.\r
abad83e6	323	@retval EFI_ACCESS_DENIED The MOR/MorLock is locked.\r
03877377 LE	324	@retval EFI_ALREADY_STARTED The MorLock variable is handled inside this\r
	325	function. Variable driver can just return\r
	326	EFI_SUCCESS.\r
abad83e6 JY	327	**/\r
	328	EFI_STATUS\r
	329	SetVariableCheckHandlerMor (\r
	330	IN CHAR16 *VariableName,\r
	331	IN EFI_GUID *VendorGuid,\r
	332	IN UINT32 Attributes,\r
	333	IN UINTN DataSize,\r
	334	IN VOID *Data\r
	335	)\r
	336	{\r
	337	//\r
	338	// do not handle non-MOR variable\r
	339	//\r
	340	if (!IsAnyMorVariable (VariableName, VendorGuid)) {\r
	341	return EFI_SUCCESS;\r
	342	}\r
	343	\r
	344	//\r
	345	// MorLock variable\r
	346	//\r
	347	if (IsMorLockVariable (VariableName, VendorGuid)) {\r
	348	return SetVariableCheckHandlerMorLock (\r
	349	VariableName,\r
	350	VendorGuid,\r
	351	Attributes,\r
	352	DataSize,\r
	353	Data\r
	354	);\r
	355	}\r
	356	\r
	357	//\r
	358	// Mor Variable\r
	359	//\r
	360	\r
	361	//\r
	362	// Basic Check\r
	363	//\r
	364	if ((Attributes != (EFI_VARIABLE_NON_VOLATILE \| EFI_VARIABLE_BOOTSERVICE_ACCESS \| EFI_VARIABLE_RUNTIME_ACCESS)) \|\|\r
	365	(DataSize != sizeof(UINT8)) \|\|\r
	366	(Data == NULL)) {\r
	367	return EFI_INVALID_PARAMETER;\r
	368	}\r
	369	if (mMorLockState == MorLockStateLocked) {\r
	370	//\r
	371	// If lock, deny access\r
	372	//\r
	373	return EFI_ACCESS_DENIED;\r
	374	}\r
	375	//\r
	376	// grant access\r
	377	//\r
	378	return EFI_SUCCESS;\r
	379	}\r
	380	\r
	381	/**\r
03877377	382	Initialization for MOR Control Lock.\r
abad83e6	383	\r
03877377	384	@retval EFI_SUCCESS MorLock initialization success.\r
abad83e6 JY	385	@return Others Some error occurs.\r
	386	**/\r
	387	EFI_STATUS\r
	388	MorLockInit (\r
	389	VOID\r
	390	)\r
	391	{\r
	392	//\r
	393	// Set variable to report capability to OS\r
	394	//\r
	395	return SetMorLockVariable (0);\r
	396	}\r