[mirror_edk2.git] / SecurityPkg / Library / AuthVariableLib / AuthServiceInternal.h

/** @file\r
  The internal header file includes the common header files, defines\r
  internal structure and functions used by AuthService module.\r
\r
  Caution: This module requires additional review when modified.\r
  This driver will have external input - variable data. It may be input in SMM mode.\r
  This external input must be validated carefully to avoid security issue like\r
  buffer overflow, integer overflow.\r
  Variable attribute should also be checked to avoid authentication bypass.\r
     The whole SMM authentication variable design relies on the integrity of flash part and SMM.\r
  which is assumed to be protected by platform.  All variable code and metadata in flash/SMM Memory\r
  may not be modified without authorization. If platform fails to protect these resources,\r
  the authentication service provided in this driver will be broken, and the behavior is undefined.\r
\r
Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _AUTHSERVICE_INTERNAL_H_\r
#define _AUTHSERVICE_INTERNAL_H_\r
\r
#include <Library/AuthVariableLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/BaseCryptLib.h>\r
#include <Library/PlatformSecureLib.h>\r
\r
#include <Guid/AuthenticatedVariableFormat.h>\r
#include <Guid/ImageAuthentication.h>\r
\r
///\r
/// Struct to record signature requirement defined by UEFI spec.\r
/// For SigHeaderSize and SigDataSize, ((UINT32) ~0) means NO exact length requirement for this field.\r
///\r
typedef struct {\r
  EFI_GUID    SigType;\r
  // Expected SignatureHeader size in Bytes.\r
  UINT32      SigHeaderSize;\r
  // Expected SignatureData size in Bytes.\r
  UINT32      SigDataSize;\r
} EFI_SIGNATURE_ITEM;\r
\r
typedef enum {\r
  AuthVarTypePk,\r
  AuthVarTypeKek,\r
  AuthVarTypePriv,\r
  AuthVarTypePayload\r
} AUTHVAR_TYPE;\r
\r
///\r
/// "AuthVarKeyDatabase" variable for the Public Key store\r
/// of variables with EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS set.\r
///\r
/// GUID: gEfiAuthenticatedVariableGuid\r
///\r
/// We need maintain atomicity.\r
///\r
/// Format:\r
/// +----------------------------+\r
/// | AUTHVAR_KEY_DB_DATA        | <-- First AuthVarKey\r
/// +----------------------------+\r
/// | ......                     |\r
/// +----------------------------+\r
/// | AUTHVAR_KEY_DB_DATA        | <-- Last AuthKey\r
/// +----------------------------+\r
///\r
#define AUTHVAR_KEYDB_NAME      L"AuthVarKeyDatabase"\r
\r
#define EFI_CERT_TYPE_RSA2048_SHA256_SIZE 256\r
#define EFI_CERT_TYPE_RSA2048_SIZE        256\r
\r
#pragma pack(1)\r
typedef struct {\r
  UINT32    KeyIndex;\r
  UINT8     KeyData[EFI_CERT_TYPE_RSA2048_SIZE];\r
} AUTHVAR_KEY_DB_DATA;\r
#pragma pack()\r
\r
///\r
/// "certdb" variable stores the signer's certificates for non PK/KEK/DB/DBX\r
/// variables with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set.\r
///\r
/// GUID: gEfiCertDbGuid\r
///\r
/// We need maintain atomicity.\r
///\r
/// Format:\r
/// +----------------------------+\r
/// | UINT32                     | <-- CertDbListSize, including this UINT32\r
/// +----------------------------+\r
/// | AUTH_CERT_DB_DATA          | <-- First CERT\r
/// +----------------------------+\r
/// | ........                   |\r
/// +----------------------------+\r
/// | AUTH_CERT_DB_DATA          | <-- Last CERT\r
/// +----------------------------+\r
///\r
#define EFI_CERT_DB_NAME        L"certdb"\r
\r
#pragma pack(1)\r
typedef struct {\r
  EFI_GUID    VendorGuid;\r
  UINT32      CertNodeSize;\r
  UINT32      NameSize;\r
  UINT32      CertDataSize;\r
  /// CHAR16  VariableName[NameSize];\r
  /// UINT8   CertData[CertDataSize];\r
} AUTH_CERT_DB_DATA;\r
#pragma pack()\r
\r
extern UINT8    *mPubKeyStore;\r
extern UINT32   mPubKeyNumber;\r
extern UINT32   mMaxKeyNumber;\r
extern UINT32   mMaxKeyDbSize;\r
extern UINT8    *mCertDbStore;\r
extern UINT32   mMaxCertDbSize;\r
extern UINT32   mPlatformMode;\r
extern UINT8    mVendorKeyState;\r
\r
extern VOID     *mHashCtx;\r
\r
extern AUTH_VAR_LIB_CONTEXT_IN *mAuthVarLibContextIn;\r
\r
/**\r
  Process variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set\r
\r
  Caution: This function may receive untrusted input.\r
  This function may be invoked in SMM mode, and datasize and data are external input.\r
  This function will do basic validation, before parse the data.\r
  This function will parse the authentication carefully to avoid security issues, like\r
  buffer overflow, integer overflow.\r
\r
  @param[in]  VariableName                Name of Variable to be found.\r
  @param[in]  VendorGuid                  Variable vendor GUID.\r
  @param[in]  Data                        Data pointer.\r
  @param[in]  DataSize                    Size of Data found. If size is less than the\r
                                          data, this value contains the required size.\r
  @param[in]  Attributes                  Attribute value of the variable.\r
  @param[in]  AuthVarType                 Verify against PK, KEK database, private database or certificate in data payload.\r
  @param[out] VarDel                      Delete the variable or not.\r
\r
  @retval EFI_INVALID_PARAMETER           Invalid parameter.\r
  @retval EFI_SECURITY_VIOLATION          The variable does NOT pass the validation\r
                                          check carried out by the firmware.\r
  @retval EFI_OUT_OF_RESOURCES            Failed to process variable due to lack\r
                                          of resources.\r
  @retval EFI_SUCCESS                     Variable pass validation successfully.\r
\r
**/\r
EFI_STATUS\r
VerifyTimeBasedPayloadAndUpdate (\r
  IN     CHAR16                             *VariableName,\r
  IN     EFI_GUID                           *VendorGuid,\r
  IN     VOID                               *Data,\r
  IN     UINTN                              DataSize,\r
  IN     UINT32                             Attributes,\r
  IN     AUTHVAR_TYPE                       AuthVarType,\r
  OUT    BOOLEAN                            *VarDel\r
  );\r
\r
/**\r
  Delete matching signer's certificates when deleting common authenticated\r
  variable by corresponding VariableName and VendorGuid from "certdb".\r
\r
  @param[in]  VariableName   Name of authenticated Variable.\r
  @param[in]  VendorGuid     Vendor GUID of authenticated Variable.\r
\r
  @retval  EFI_INVALID_PARAMETER Any input parameter is invalid.\r
  @retval  EFI_NOT_FOUND         Fail to find "certdb" or matching certs.\r
  @retval  EFI_OUT_OF_RESOURCES  The operation is failed due to lack of resources.\r
  @retval  EFI_SUCCESS           The operation is completed successfully.\r
\r
**/\r
EFI_STATUS\r
DeleteCertsFromDb (\r
  IN     CHAR16           *VariableName,\r
  IN     EFI_GUID         *VendorGuid\r
  );\r
\r
/**\r
  Filter out the duplicated EFI_SIGNATURE_DATA from the new data by comparing to the original data.\r
\r
  @param[in]        Data          Pointer to original EFI_SIGNATURE_LIST.\r
  @param[in]        DataSize      Size of Data buffer.\r
  @param[in, out]   NewData       Pointer to new EFI_SIGNATURE_LIST.\r
  @param[in, out]   NewDataSize   Size of NewData buffer.\r
\r
**/\r
EFI_STATUS\r
FilterSignatureList (\r
  IN     VOID       *Data,\r
  IN     UINTN      DataSize,\r
  IN OUT VOID       *NewData,\r
  IN OUT UINTN      *NewDataSize\r
  );\r
\r
/**\r
  Process variable with platform key for verification.\r
\r
  Caution: This function may receive untrusted input.\r
  This function may be invoked in SMM mode, and datasize and data are external input.\r
  This function will do basic validation, before parse the data.\r
  This function will parse the authentication carefully to avoid security issues, like\r
  buffer overflow, integer overflow.\r
  This function will check attribute carefully to avoid authentication bypass.\r
\r
  @param[in]  VariableName                Name of Variable to be found.\r
  @param[in]  VendorGuid                  Variable vendor GUID.\r
  @param[in]  Data                        Data pointer.\r
  @param[in]  DataSize                    Size of Data found. If size is less than the\r
                                          data, this value contains the required size.\r
  @param[in]  Attributes                  Attribute value of the variable\r
  @param[in]  IsPk                        Indicate whether it is to process pk.\r
\r
  @return EFI_INVALID_PARAMETER           Invalid parameter.\r
  @return EFI_SECURITY_VIOLATION          The variable does NOT pass the validation.\r
                                          check carried out by the firmware.\r
  @return EFI_SUCCESS                     Variable passed validation successfully.\r
\r
**/\r
EFI_STATUS\r
ProcessVarWithPk (\r
  IN  CHAR16                    *VariableName,\r
  IN  EFI_GUID                  *VendorGuid,\r
  IN  VOID                      *Data,\r
  IN  UINTN                     DataSize,\r
  IN  UINT32                    Attributes OPTIONAL,\r
  IN  BOOLEAN                   IsPk\r
  );\r
\r
/**\r
  Process variable with key exchange key for verification.\r
\r
  Caution: This function may receive untrusted input.\r
  This function may be invoked in SMM mode, and datasize and data are external input.\r
  This function will do basic validation, before parse the data.\r
  This function will parse the authentication carefully to avoid security issues, like\r
  buffer overflow, integer overflow.\r
  This function will check attribute carefully to avoid authentication bypass.\r
\r
  @param[in]  VariableName                Name of Variable to be found.\r
  @param[in]  VendorGuid                  Variable vendor GUID.\r
  @param[in]  Data                        Data pointer.\r
  @param[in]  DataSize                    Size of Data found. If size is less than the\r
                                          data, this value contains the required size.\r
  @param[in]  Attributes                  Attribute value of the variable.\r
\r
  @return EFI_INVALID_PARAMETER           Invalid parameter.\r
  @return EFI_SECURITY_VIOLATION          The variable does NOT pass the validation\r
                                          check carried out by the firmware.\r
  @return EFI_SUCCESS                     Variable pass validation successfully.\r
\r
**/\r
EFI_STATUS\r
ProcessVarWithKek (\r
  IN  CHAR16                               *VariableName,\r
  IN  EFI_GUID                             *VendorGuid,\r
  IN  VOID                                 *Data,\r
  IN  UINTN                                DataSize,\r
  IN  UINT32                               Attributes OPTIONAL\r
  );\r
\r
/**\r
  Process variable with EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS/EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set\r
\r
  Caution: This function may receive untrusted input.\r
  This function may be invoked in SMM mode, and datasize and data are external input.\r
  This function will do basic validation, before parse the data.\r
  This function will parse the authentication carefully to avoid security issues, like\r
  buffer overflow, integer overflow.\r
  This function will check attribute carefully to avoid authentication bypass.\r
\r
  @param[in]  VariableName                Name of the variable.\r
  @param[in]  VendorGuid                  Variable vendor GUID.\r
  @param[in]  Data                        Data pointer.\r
  @param[in]  DataSize                    Size of Data.\r
  @param[in]  Attributes                  Attribute value of the variable.\r
\r
  @return EFI_INVALID_PARAMETER           Invalid parameter.\r
  @return EFI_WRITE_PROTECTED             Variable is write-protected and needs authentication with\r
                                          EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS set.\r
  @return EFI_OUT_OF_RESOURCES            The Database to save the public key is full.\r
  @return EFI_SECURITY_VIOLATION          The variable is with EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\r
                                          set, but the AuthInfo does NOT pass the validation\r
                                          check carried out by the firmware.\r
  @return EFI_SUCCESS                     Variable is not write-protected or pass validation successfully.\r
\r
**/\r
EFI_STATUS\r
ProcessVariable (\r
  IN     CHAR16                             *VariableName,\r
  IN     EFI_GUID                           *VendorGuid,\r
  IN     VOID                               *Data,\r
  IN     UINTN                              DataSize,\r
  IN     UINT32                             Attributes OPTIONAL\r
  );\r
\r
/**\r
  Finds variable in storage blocks of volatile and non-volatile storage areas.\r
\r
  This code finds variable in storage blocks of volatile and non-volatile storage areas.\r
  If VariableName is an empty string, then we just return the first\r
  qualified variable without comparing VariableName and VendorGuid.\r
\r
  @param[in]  VariableName          Name of the variable to be found.\r
  @param[in]  VendorGuid            Variable vendor GUID to be found.\r
  @param[out] Data                  Pointer to data address.\r
  @param[out] DataSize              Pointer to data size.\r
\r
  @retval EFI_INVALID_PARAMETER     If VariableName is not an empty string,\r
                                    while VendorGuid is NULL.\r
  @retval EFI_SUCCESS               Variable successfully found.\r
  @retval EFI_NOT_FOUND             Variable not found\r
\r
**/\r
EFI_STATUS\r
AuthServiceInternalFindVariable (\r
  IN  CHAR16        *VariableName,\r
  IN  EFI_GUID      *VendorGuid,\r
  OUT VOID          **Data,\r
  OUT UINTN         *DataSize\r
  );\r
\r
/**\r
  Update the variable region with Variable information.\r
\r
  @param[in] VariableName           Name of variable.\r
  @param[in] VendorGuid             Guid of variable.\r
  @param[in] Data                   Data pointer.\r
  @param[in] DataSize               Size of Data.\r
  @param[in] Attributes             Attribute value of the variable.\r
\r
  @retval EFI_SUCCESS               The update operation is success.\r
  @retval EFI_INVALID_PARAMETER     Invalid parameter.\r
  @retval EFI_WRITE_PROTECTED       Variable is write-protected.\r
  @retval EFI_OUT_OF_RESOURCES      There is not enough resource.\r
\r
**/\r
EFI_STATUS\r
AuthServiceInternalUpdateVariable (\r
  IN CHAR16         *VariableName,\r
  IN EFI_GUID       *VendorGuid,\r
  IN VOID           *Data,\r
  IN UINTN          DataSize,\r
  IN UINT32         Attributes\r
  );\r
\r
/**\r
  Update the variable region with Variable information.\r
\r
  @param[in] VariableName           Name of variable.\r
  @param[in] VendorGuid             Guid of variable.\r
  @param[in] Data                   Data pointer.\r
  @param[in] DataSize               Size of Data.\r
  @param[in] Attributes             Attribute value of the variable.\r
  @param[in] KeyIndex               Index of associated public key.\r
  @param[in] MonotonicCount         Value of associated monotonic count.\r
\r
  @retval EFI_SUCCESS               The update operation is success.\r
  @retval EFI_INVALID_PARAMETER     Invalid parameter.\r
  @retval EFI_WRITE_PROTECTED       Variable is write-protected.\r
  @retval EFI_OUT_OF_RESOURCES      There is not enough resource.\r
\r
**/\r
EFI_STATUS\r
AuthServiceInternalUpdateVariableWithMonotonicCount (\r
  IN CHAR16         *VariableName,\r
  IN EFI_GUID       *VendorGuid,\r
  IN VOID           *Data,\r
  IN UINTN          DataSize,\r
  IN UINT32         Attributes,\r
  IN UINT32         KeyIndex,\r
  IN UINT64         MonotonicCount\r
  );\r
\r
/**\r
  Update the variable region with Variable information.\r
\r
  @param[in] VariableName           Name of variable.\r
  @param[in] VendorGuid             Guid of variable.\r
  @param[in] Data                   Data pointer.\r
  @param[in] DataSize               Size of Data.\r
  @param[in] Attributes             Attribute value of the variable.\r
  @param[in] TimeStamp              Value of associated TimeStamp.\r
\r
  @retval EFI_SUCCESS               The update operation is success.\r
  @retval EFI_INVALID_PARAMETER     Invalid parameter.\r
  @retval EFI_WRITE_PROTECTED       Variable is write-protected.\r
  @retval EFI_OUT_OF_RESOURCES      There is not enough resource.\r
\r
**/\r
EFI_STATUS\r
AuthServiceInternalUpdateVariableWithTimeStamp (\r
  IN CHAR16         *VariableName,\r
  IN EFI_GUID       *VendorGuid,\r
  IN VOID           *Data,\r
  IN UINTN          DataSize,\r
  IN UINT32         Attributes,\r
  IN EFI_TIME       *TimeStamp\r
  );\r
\r
#endif\r
Commit	Line	Data
a6811666 SZ	1	/** @file\r
	2	The internal header file includes the common header files, defines\r
	3	internal structure and functions used by AuthService module.\r
	4	\r
	5	Caution: This module requires additional review when modified.\r
	6	This driver will have external input - variable data. It may be input in SMM mode.\r
	7	This external input must be validated carefully to avoid security issue like\r
	8	buffer overflow, integer overflow.\r
	9	Variable attribute should also be checked to avoid authentication bypass.\r
	10	The whole SMM authentication variable design relies on the integrity of flash part and SMM.\r
	11	which is assumed to be protected by platform. All variable code and metadata in flash/SMM Memory\r
	12	may not be modified without authorization. If platform fails to protect these resources,\r
	13	the authentication service provided in this driver will be broken, and the behavior is undefined.\r
	14	\r
	15	Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>\r
	16	This program and the accompanying materials\r
	17	are licensed and made available under the terms and conditions of the BSD License\r
	18	which accompanies this distribution. The full text of the license may be found at\r
	19	http://opensource.org/licenses/bsd-license.php\r
	20	\r
	21	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	22	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	23	\r
	24	**/\r
	25	\r
	26	#ifndef _AUTHSERVICE_INTERNAL_H_\r
	27	#define _AUTHSERVICE_INTERNAL_H_\r
	28	\r
	29	#include <Library/AuthVariableLib.h>\r
	30	#include <Library/BaseLib.h>\r
	31	#include <Library/BaseMemoryLib.h>\r
	32	#include <Library/DebugLib.h>\r
	33	#include <Library/MemoryAllocationLib.h>\r
	34	#include <Library/BaseCryptLib.h>\r
	35	#include <Library/PlatformSecureLib.h>\r
	36	\r
	37	#include <Guid/AuthenticatedVariableFormat.h>\r
	38	#include <Guid/ImageAuthentication.h>\r
	39	\r
	40	///\r
	41	/// Struct to record signature requirement defined by UEFI spec.\r
	42	/// For SigHeaderSize and SigDataSize, ((UINT32) ~0) means NO exact length requirement for this field.\r
	43	///\r
	44	typedef struct {\r
	45	EFI_GUID SigType;\r
	46	// Expected SignatureHeader size in Bytes.\r
	47	UINT32 SigHeaderSize;\r
	48	// Expected SignatureData size in Bytes.\r
	49	UINT32 SigDataSize;\r
	50	} EFI_SIGNATURE_ITEM;\r
	51	\r
	52	typedef enum {\r
	53	AuthVarTypePk,\r
	54	AuthVarTypeKek,\r
	55	AuthVarTypePriv,\r
	56	AuthVarTypePayload\r
	57	} AUTHVAR_TYPE;\r
	58	\r
	59	///\r
	60	/// "AuthVarKeyDatabase" variable for the Public Key store\r
	61	/// of variables with EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS set.\r
	62	///\r
	63	/// GUID: gEfiAuthenticatedVariableGuid\r
	64	///\r
65	/// We need maintain atomicity.\r
66	///\r
67	/// Format:\r
68	/// +----------------------------+\r
69	/// \| AUTHVAR_KEY_DB_DATA \| <-- First AuthVarKey\r
70	/// +----------------------------+\r
71	/// \| ...... \|\r
72	/// +----------------------------+\r
73	/// \| AUTHVAR_KEY_DB_DATA \| <-- Last AuthKey\r
74	/// +----------------------------+\r
75	///\r
76	#define AUTHVAR_KEYDB_NAME L"AuthVarKeyDatabase"\r
77	\r
78	#define EFI_CERT_TYPE_RSA2048_SHA256_SIZE 256\r
79	#define EFI_CERT_TYPE_RSA2048_SIZE 256\r
80	\r
81	#pragma pack(1)\r
82	typedef struct {\r
83	UINT32 KeyIndex;\r
84	UINT8 KeyData[EFI_CERT_TYPE_RSA2048_SIZE];\r
85	} AUTHVAR_KEY_DB_DATA;\r
86	#pragma pack()\r
87	\r
88	///\r
89	/// "certdb" variable stores the signer's certificates for non PK/KEK/DB/DBX\r
90	/// variables with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set.\r
91	///\r
92	/// GUID: gEfiCertDbGuid\r
93	///\r
94	/// We need maintain atomicity.\r
95	///\r
96	/// Format:\r
97	/// +----------------------------+\r
98	/// \| UINT32 \| <-- CertDbListSize, including this UINT32\r
99	/// +----------------------------+\r
100	/// \| AUTH_CERT_DB_DATA \| <-- First CERT\r
101	/// +----------------------------+\r
102	/// \| ........ \|\r
103	/// +----------------------------+\r
104	/// \| AUTH_CERT_DB_DATA \| <-- Last CERT\r
105	/// +----------------------------+\r
106	///\r
107	#define EFI_CERT_DB_NAME L"certdb"\r
108	\r
109	#pragma pack(1)\r
110	typedef struct {\r
111	EFI_GUID VendorGuid;\r
112	UINT32 CertNodeSize;\r
113	UINT32 NameSize;\r
114	UINT32 CertDataSize;\r
115	/// CHAR16 VariableName[NameSize];\r
116	/// UINT8 CertData[CertDataSize];\r
117	} AUTH_CERT_DB_DATA;\r
118	#pragma pack()\r
119	\r
120	extern UINT8 *mPubKeyStore;\r
121	extern UINT32 mPubKeyNumber;\r
122	extern UINT32 mMaxKeyNumber;\r
123	extern UINT32 mMaxKeyDbSize;\r
124	extern UINT8 *mCertDbStore;\r
125	extern UINT32 mMaxCertDbSize;\r
126	extern UINT32 mPlatformMode;\r
127	extern UINT8 mVendorKeyState;\r
128	\r
129	extern VOID *mHashCtx;\r
130	\r
131	extern AUTH_VAR_LIB_CONTEXT_IN *mAuthVarLibContextIn;\r
132	\r
133	/**\r
134	Process variable with EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set\r
135	\r
136	Caution: This function may receive untrusted input.\r
137	This function may be invoked in SMM mode, and datasize and data are external input.\r
138	This function will do basic validation, before parse the data.\r
139	This function will parse the authentication carefully to avoid security issues, like\r
140	buffer overflow, integer overflow.\r
141	\r
142	@param[in] VariableName Name of Variable to be found.\r
143	@param[in] VendorGuid Variable vendor GUID.\r
144	@param[in] Data Data pointer.\r
145	@param[in] DataSize Size of Data found. If size is less than the\r
146	data, this value contains the required size.\r
147	@param[in] Attributes Attribute value of the variable.\r
148	@param[in] AuthVarType Verify against PK, KEK database, private database or certificate in data payload.\r
149	@param[out] VarDel Delete the variable or not.\r
150	\r
151	@retval EFI_INVALID_PARAMETER Invalid parameter.\r
152	@retval EFI_SECURITY_VIOLATION The variable does NOT pass the validation\r
153	check carried out by the firmware.\r
154	@retval EFI_OUT_OF_RESOURCES Failed to process variable due to lack\r
155	of resources.\r
156	@retval EFI_SUCCESS Variable pass validation successfully.\r
157	\r
158	**/\r
159	EFI_STATUS\r
160	VerifyTimeBasedPayloadAndUpdate (\r
161	IN CHAR16 *VariableName,\r
162	IN EFI_GUID *VendorGuid,\r
163	IN VOID *Data,\r
164	IN UINTN DataSize,\r
165	IN UINT32 Attributes,\r
166	IN AUTHVAR_TYPE AuthVarType,\r
167	OUT BOOLEAN *VarDel\r
168	);\r
169	\r
170	/**\r
171	Delete matching signer's certificates when deleting common authenticated\r
172	variable by corresponding VariableName and VendorGuid from "certdb".\r
173	\r
174	@param[in] VariableName Name of authenticated Variable.\r
175	@param[in] VendorGuid Vendor GUID of authenticated Variable.\r
176	\r
177	@retval EFI_INVALID_PARAMETER Any input parameter is invalid.\r
178	@retval EFI_NOT_FOUND Fail to find "certdb" or matching certs.\r
179	@retval EFI_OUT_OF_RESOURCES The operation is failed due to lack of resources.\r
180	@retval EFI_SUCCESS The operation is completed successfully.\r
181	\r
182	**/\r
183	EFI_STATUS\r
184	DeleteCertsFromDb (\r
185	IN CHAR16 *VariableName,\r
186	IN EFI_GUID *VendorGuid\r
187	);\r
188	\r
189	/**\r
190	Filter out the duplicated EFI_SIGNATURE_DATA from the new data by comparing to the original data.\r
191	\r
192	@param[in] Data Pointer to original EFI_SIGNATURE_LIST.\r
193	@param[in] DataSize Size of Data buffer.\r
194	@param[in, out] NewData Pointer to new EFI_SIGNATURE_LIST.\r
195	@param[in, out] NewDataSize Size of NewData buffer.\r
196	\r
197	**/\r
198	EFI_STATUS\r
199	FilterSignatureList (\r
200	IN VOID *Data,\r
201	IN UINTN DataSize,\r
202	IN OUT VOID *NewData,\r
203	IN OUT UINTN *NewDataSize\r
204	);\r
205	\r
206	/**\r
207	Process variable with platform key for verification.\r
208	\r
209	Caution: This function may receive untrusted input.\r
210	This function may be invoked in SMM mode, and datasize and data are external input.\r
211	This function will do basic validation, before parse the data.\r
212	This function will parse the authentication carefully to avoid security issues, like\r
213	buffer overflow, integer overflow.\r
214	This function will check attribute carefully to avoid authentication bypass.\r
215	\r
216	@param[in] VariableName Name of Variable to be found.\r
217	@param[in] VendorGuid Variable vendor GUID.\r
218	@param[in] Data Data pointer.\r
219	@param[in] DataSize Size of Data found. If size is less than the\r
220	data, this value contains the required size.\r
221	@param[in] Attributes Attribute value of the variable\r
222	@param[in] IsPk Indicate whether it is to process pk.\r
223	\r
224	@return EFI_INVALID_PARAMETER Invalid parameter.\r
225	@return EFI_SECURITY_VIOLATION The variable does NOT pass the validation.\r
226	check carried out by the firmware.\r
227	@return EFI_SUCCESS Variable passed validation successfully.\r
228	\r
229	**/\r
230	EFI_STATUS\r
231	ProcessVarWithPk (\r
232	IN CHAR16 *VariableName,\r
233	IN EFI_GUID *VendorGuid,\r
234	IN VOID *Data,\r
235	IN UINTN DataSize,\r
236	IN UINT32 Attributes OPTIONAL,\r
237	IN BOOLEAN IsPk\r
238	);\r
239	\r
240	/**\r
241	Process variable with key exchange key for verification.\r
242	\r
243	Caution: This function may receive untrusted input.\r
244	This function may be invoked in SMM mode, and datasize and data are external input.\r
245	This function will do basic validation, before parse the data.\r
246	This function will parse the authentication carefully to avoid security issues, like\r
247	buffer overflow, integer overflow.\r
248	This function will check attribute carefully to avoid authentication bypass.\r
249	\r
250	@param[in] VariableName Name of Variable to be found.\r
251	@param[in] VendorGuid Variable vendor GUID.\r
252	@param[in] Data Data pointer.\r
253	@param[in] DataSize Size of Data found. If size is less than the\r
254	data, this value contains the required size.\r
255	@param[in] Attributes Attribute value of the variable.\r
256	\r
257	@return EFI_INVALID_PARAMETER Invalid parameter.\r
258	@return EFI_SECURITY_VIOLATION The variable does NOT pass the validation\r
259	check carried out by the firmware.\r
260	@return EFI_SUCCESS Variable pass validation successfully.\r
261	\r
262	**/\r
263	EFI_STATUS\r
264	ProcessVarWithKek (\r
265	IN CHAR16 *VariableName,\r
266	IN EFI_GUID *VendorGuid,\r
267	IN VOID *Data,\r
268	IN UINTN DataSize,\r
269	IN UINT32 Attributes OPTIONAL\r
270	);\r
271	\r
272	/**\r
273	Process variable with EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS/EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS set\r
274	\r
275	Caution: This function may receive untrusted input.\r
276	This function may be invoked in SMM mode, and datasize and data are external input.\r
277	This function will do basic validation, before parse the data.\r
278	This function will parse the authentication carefully to avoid security issues, like\r
279	buffer overflow, integer overflow.\r
280	This function will check attribute carefully to avoid authentication bypass.\r
281	\r
282	@param[in] VariableName Name of the variable.\r
283	@param[in] VendorGuid Variable vendor GUID.\r
284	@param[in] Data Data pointer.\r
285	@param[in] DataSize Size of Data.\r
286	@param[in] Attributes Attribute value of the variable.\r
287	\r
288	@return EFI_INVALID_PARAMETER Invalid parameter.\r
289	@return EFI_WRITE_PROTECTED Variable is write-protected and needs authentication with\r
290	EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS set.\r
291	@return EFI_OUT_OF_RESOURCES The Database to save the public key is full.\r
292	@return EFI_SECURITY_VIOLATION The variable is with EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS\r
293	set, but the AuthInfo does NOT pass the validation\r
294	check carried out by the firmware.\r
295	@return EFI_SUCCESS Variable is not write-protected or pass validation successfully.\r
296	\r
297	**/\r
298	EFI_STATUS\r
299	ProcessVariable (\r
300	IN CHAR16 *VariableName,\r
301	IN EFI_GUID *VendorGuid,\r
302	IN VOID *Data,\r
303	IN UINTN DataSize,\r
304	IN UINT32 Attributes OPTIONAL\r
305	);\r
306	\r
307	/**\r
308	Finds variable in storage blocks of volatile and non-volatile storage areas.\r
309	\r
310	This code finds variable in storage blocks of volatile and non-volatile storage areas.\r
311	If VariableName is an empty string, then we just return the first\r
312	qualified variable without comparing VariableName and VendorGuid.\r
313	\r
314	@param[in] VariableName Name of the variable to be found.\r
315	@param[in] VendorGuid Variable vendor GUID to be found.\r
316	@param[out] Data Pointer to data address.\r
317	@param[out] DataSize Pointer to data size.\r
318	\r
319	@retval EFI_INVALID_PARAMETER If VariableName is not an empty string,\r
320	while VendorGuid is NULL.\r
321	@retval EFI_SUCCESS Variable successfully found.\r
322	@retval EFI_NOT_FOUND Variable not found\r
323	\r
324	**/\r
325	EFI_STATUS\r
326	AuthServiceInternalFindVariable (\r
327	IN CHAR16 *VariableName,\r
328	IN EFI_GUID *VendorGuid,\r
329	OUT VOID **Data,\r
330	OUT UINTN *DataSize\r
331	);\r
332	\r
333	/**\r
334	Update the variable region with Variable information.\r
335	\r
336	@param[in] VariableName Name of variable.\r
337	@param[in] VendorGuid Guid of variable.\r
338	@param[in] Data Data pointer.\r
339	@param[in] DataSize Size of Data.\r
340	@param[in] Attributes Attribute value of the variable.\r
341	\r
342	@retval EFI_SUCCESS The update operation is success.\r
343	@retval EFI_INVALID_PARAMETER Invalid parameter.\r
344	@retval EFI_WRITE_PROTECTED Variable is write-protected.\r
345	@retval EFI_OUT_OF_RESOURCES There is not enough resource.\r
346	\r
347	**/\r
348	EFI_STATUS\r
349	AuthServiceInternalUpdateVariable (\r
350	IN CHAR16 *VariableName,\r
351	IN EFI_GUID *VendorGuid,\r
352	IN VOID *Data,\r
353	IN UINTN DataSize,\r
354	IN UINT32 Attributes\r
355	);\r
356	\r
357	/**\r
358	Update the variable region with Variable information.\r
359	\r
360	@param[in] VariableName Name of variable.\r
361	@param[in] VendorGuid Guid of variable.\r
362	@param[in] Data Data pointer.\r
363	@param[in] DataSize Size of Data.\r
364	@param[in] Attributes Attribute value of the variable.\r
365	@param[in] KeyIndex Index of associated public key.\r
366	@param[in] MonotonicCount Value of associated monotonic count.\r
367	\r
368	@retval EFI_SUCCESS The update operation is success.\r
369	@retval EFI_INVALID_PARAMETER Invalid parameter.\r
370	@retval EFI_WRITE_PROTECTED Variable is write-protected.\r
371	@retval EFI_OUT_OF_RESOURCES There is not enough resource.\r
372	\r
373	**/\r
374	EFI_STATUS\r
375	AuthServiceInternalUpdateVariableWithMonotonicCount (\r
376	IN CHAR16 *VariableName,\r
377	IN EFI_GUID *VendorGuid,\r
378	IN VOID *Data,\r
379	IN UINTN DataSize,\r
380	IN UINT32 Attributes,\r
381	IN UINT32 KeyIndex,\r
382	IN UINT64 MonotonicCount\r
383	);\r
384	\r
385	/**\r
386	Update the variable region with Variable information.\r
387	\r
388	@param[in] VariableName Name of variable.\r
389	@param[in] VendorGuid Guid of variable.\r
390	@param[in] Data Data pointer.\r
391	@param[in] DataSize Size of Data.\r
392	@param[in] Attributes Attribute value of the variable.\r
393	@param[in] TimeStamp Value of associated TimeStamp.\r
394	\r
395	@retval EFI_SUCCESS The update operation is success.\r
396	@retval EFI_INVALID_PARAMETER Invalid parameter.\r
397	@retval EFI_WRITE_PROTECTED Variable is write-protected.\r
398	@retval EFI_OUT_OF_RESOURCES There is not enough resource.\r
399	\r
400	**/\r
401	EFI_STATUS\r
402	AuthServiceInternalUpdateVariableWithTimeStamp (\r
403	IN CHAR16 *VariableName,\r
404	IN EFI_GUID *VendorGuid,\r
405	IN VOID *Data,\r
406	IN UINTN DataSize,\r
407	IN UINT32 Attributes,\r
408	IN EFI_TIME *TimeStamp\r
409	);\r
410	\r
411	#endif\r