[mirror_edk2.git] / MdeModulePkg / Include / Library / SecurityManagementLib.h

/** @file\r
  This library class defines a set of interfaces to abstract the policy of\r
  security measurement by managing the different security measurement services.\r
  The library instances can be implemented according to the different security policy.\r
\r
Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __SECURITY_MANAGEMENT_LIB_H__\r
#define __SECURITY_MANAGEMENT_LIB_H__\r
\r
//\r
// Authentication Operation defintions for User Identity (UID), Measured and Secure boot.\r
//\r
#define EFI_AUTH_OPERATION_NONE                0x00\r
#define EFI_AUTH_OPERATION_VERIFY_IMAGE        0x01\r
#define EFI_AUTH_OPERATION_DEFER_IMAGE_LOAD    0x02\r
#define EFI_AUTH_OPERATION_MEASURE_IMAGE       0x04\r
#define EFI_AUTH_OPERATION_CONNECT_POLICY      0x08\r
//\r
// Authentication State Operation will check the authentication status of a file.\r
//\r
#define EFI_AUTH_OPERATION_AUTHENTICATION_STATE  0x10\r
\r
///\r
/// Image buffer is required by the security handler.\r
///\r
#define EFI_AUTH_OPERATION_IMAGE_REQUIRED      0x80000000\r
\r
/**\r
  The security handler is used to abstract platform-specific policy\r
  from the DXE core response to an attempt to use a file that returns a\r
  given status for the authentication check from the section extraction protocol.\r
\r
  The possible responses in a given SAP implementation may include locking\r
  flash upon failure to authenticate, attestation logging for all signed drivers,\r
  and other exception operations.  The File parameter allows for possible logging\r
  within the SAP of the driver.\r
\r
  If File is NULL, then EFI_INVALID_PARAMETER is returned.\r
\r
  If the file specified by File with an authentication status specified by\r
  AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned.\r
\r
  If the file specified by File with an authentication status specified by\r
  AuthenticationStatus is not safe for the DXE Core to use under any circumstances,\r
  then EFI_ACCESS_DENIED is returned.\r
\r
  If the file specified by File with an authentication status specified by\r
  AuthenticationStatus is not safe for the DXE Core to use at the time, but it\r
  might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is\r
  returned.\r
\r
  FileBuffer will be NULL and FileSize will be 0 if the handler being called\r
  did not set EFI_AUTH_OPERATION_IMAGE_REQUIRED when it was registered.\r
\r
  @param[in]    AuthenticationStatus\r
                           The authentication status returned from the security\r
                           measurement services for the input file.\r
  @param[in]    File       The pointer to the device path of the file that is\r
                           being dispatched. This will optionally be used for logging.\r
  @param[in]    FileBuffer The file buffer matches the input file device path.\r
  @param[in]    FileSize   The size of File buffer matches the input file device path.\r
\r
  @retval EFI_SUCCESS            The file specified by File did authenticate, and the\r
                                 platform policy dictates that the DXE Core may use File.\r
  @retval EFI_INVALID_PARAMETER  The file is NULL.\r
  @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and\r
                                 the platform policy dictates that File should be placed\r
                                 in the untrusted state. A file may be promoted from\r
                                 the untrusted to the trusted state at a future time\r
                                 with a call to the Trust() DXE Service.\r
  @retval EFI_ACCESS_DENIED      The file specified by File did not authenticate, and\r
                                 the platform policy dictates that File should not be\r
                                 used for any purpose.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *SECURITY_FILE_AUTHENTICATION_STATE_HANDLER)(\r
  IN  OUT   UINT32                     AuthenticationStatus,\r
  IN  CONST EFI_DEVICE_PATH_PROTOCOL   *File,\r
  IN  VOID                             *FileBuffer,\r
  IN  UINTN                            FileSize\r
  );\r
\r
/**\r
  Register security measurement handler with its operation type. Different\r
  handlers with the same operation can all be registered.\r
\r
  If SecurityHandler is NULL, then ASSERT().\r
  If no enough resources available to register new handler, then ASSERT().\r
  If AuthenticationOperation is not recongnized, then ASSERT().\r
  If the previous register handler can't be executed before the later register handler, then ASSERT().\r
\r
  @param[in]  SecurityHandler           The security measurement service handler to be registered.\r
  @param[in]  AuthenticationOperation   Theoperation type is specified for the registered handler.\r
\r
  @retval EFI_SUCCESS              The handlers were registered successfully.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RegisterSecurityHandler (\r
  IN  SECURITY_FILE_AUTHENTICATION_STATE_HANDLER  SecurityHandler,\r
  IN  UINT32                                      AuthenticationOperation\r
  );\r
\r
/**\r
  Execute registered handlers until one returns an error and that error is returned.\r
  If none of the handlers return an error, then EFI_SUCCESS is returned.\r
\r
  Before exectue handler, get the image buffer by file device path if a handler\r
  requires the image file. And return the image buffer to each handler when exectue handler.\r
\r
  The handlers are executed in same order to their registered order.\r
\r
  @param[in]  AuthenticationStatus\r
                           This is the authentication type returned from the Section\r
                           Extraction protocol. See the Section Extraction Protocol\r
                           Specification for details on this type.\r
  @param[in]  FilePath     This is a pointer to the device path of the file that is\r
                           being dispatched. This will optionally be used for logging.\r
\r
  @retval EFI_SUCCESS            The file specified by File authenticated when more\r
                                 than one security handler services were registered,\r
                                 or the file did not authenticate when no security\r
                                 handler service was registered. And the platform policy\r
                                 dictates that the DXE Core may use File.\r
  @retval EFI_INVALID_PARAMETER  File is NULL.\r
  @retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and\r
                                 the platform policy dictates that File should be placed\r
                                 in the untrusted state. A file may be promoted from\r
                                 the untrusted to the trusted state at a future time\r
                                 with a call to the Trust() DXE Service.\r
  @retval EFI_ACCESS_DENIED      The file specified by File did not authenticate, and\r
                                 the platform policy dictates that File should not be\r
                                 used for any purpose.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ExecuteSecurityHandlers (\r
  IN  UINT32                            AuthenticationStatus,\r
  IN  CONST EFI_DEVICE_PATH_PROTOCOL    *FilePath\r
  );\r
\r
/**\r
  The security handler is used to abstracts security-specific functions from the DXE\r
  Foundation of UEFI Image Verification, Trusted Computing Group (TCG) measured boot,\r
  User Identity policy for image loading and consoles, and for purposes of\r
  handling GUIDed section encapsulations.\r
\r
  @param[in]    AuthenticationStatus\r
                           The authentication status for the input file.\r
  @param[in]    File       The pointer to the device path of the file that is\r
                           being dispatched. This will optionally be used for logging.\r
  @param[in]    FileBuffer A pointer to the buffer with the UEFI file image\r
  @param[in]    FileSize   The size of File buffer.\r
  @param[in]    BootPolicy A boot policy that was used to call LoadImage() UEFI service.\r
\r
  @retval EFI_SUCCESS             The file specified by DevicePath and non-NULL\r
                                  FileBuffer did authenticate, and the platform policy dictates\r
                                  that the DXE Foundation may use the file.\r
  @retval EFI_SUCCESS             The device path specified by NULL device path DevicePath\r
                                  and non-NULL FileBuffer did authenticate, and the platform\r
                                  policy dictates that the DXE Foundation may execute the image in\r
                                  FileBuffer.\r
  @retval EFI_SUCCESS             FileBuffer is NULL and current user has permission to start\r
                                  UEFI device drivers on the device path specified by DevicePath.\r
  @retval EFI_SECURITY_VIOLATION  The file specified by DevicePath and FileBuffer did not\r
                                  authenticate, and the platform policy dictates that the file should be\r
                                  placed in the untrusted state. The image has been added to the file\r
                                  execution table.\r
  @retval EFI_ACCESS_DENIED       The file specified by File and FileBuffer did not\r
                                  authenticate, and the platform policy dictates that the DXE\r
                                  Foundation may not use File.\r
  @retval EFI_SECURITY_VIOLATION  FileBuffer is NULL and the user has no\r
                                  permission to start UEFI device drivers on the device path specified\r
                                  by DevicePath.\r
  @retval EFI_SECURITY_VIOLATION  FileBuffer is not NULL and the user has no permission to load\r
                                  drivers from the device path specified by DevicePath. The\r
                                  image has been added into the list of the deferred images.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *SECURITY2_FILE_AUTHENTICATION_HANDLER) (\r
  IN  UINT32                           AuthenticationStatus,\r
  IN  CONST EFI_DEVICE_PATH_PROTOCOL   *File,\r
  IN  VOID                             *FileBuffer,\r
  IN  UINTN                            FileSize,\r
  IN  BOOLEAN                          BootPolicy\r
  );\r
\r
/**\r
  Register security measurement handler with its operation type. Different\r
  handlers with the same operation can all be registered.\r
\r
  If SecurityHandler is NULL, then ASSERT().\r
  If no enough resources available to register new handler, then ASSERT().\r
  If AuthenticationOperation is not recongnized, then ASSERT().\r
  If AuthenticationOperation is EFI_AUTH_OPERATION_NONE, then ASSERT().\r
  If the previous register handler can't be executed before the later register handler, then ASSERT().\r
\r
  @param[in]  Security2Handler          The security measurement service handler to be registered.\r
  @param[in]  AuthenticationOperation   The operation type is specified for the registered handler.\r
\r
  @retval EFI_SUCCESS              The handlers were registered successfully.\r
**/\r
EFI_STATUS\r
EFIAPI\r
RegisterSecurity2Handler (\r
  IN  SECURITY2_FILE_AUTHENTICATION_HANDLER       Security2Handler,\r
  IN  UINT32                                      AuthenticationOperation\r
  );\r
\r
/**\r
  Execute registered handlers based on input AuthenticationOperation until\r
  one returns an error and that error is returned.\r
\r
  If none of the handlers return an error, then EFI_SUCCESS is returned.\r
  The handlers those satisfy AuthenticationOperation will only be executed.\r
  The handlers are executed in same order to their registered order.\r
\r
  @param[in]  AuthenticationOperation\r
                           The operation type specifies which handlers will be executed.\r
  @param[in]  AuthenticationStatus\r
                           The authentication status for the input file.\r
  @param[in]  File         This is a pointer to the device path of the file that is\r
                           being dispatched. This will optionally be used for logging.\r
  @param[in]  FileBuffer   A pointer to the buffer with the UEFI file image\r
  @param[in]  FileSize     The size of File buffer.\r
  @param[in]  BootPolicy   A boot policy that was used to call LoadImage() UEFI service.\r
\r
  @retval EFI_SUCCESS             The file specified by DevicePath and non-NULL\r
                                  FileBuffer did authenticate, and the platform policy dictates\r
                                  that the DXE Foundation may use the file.\r
  @retval EFI_SUCCESS             The device path specified by NULL device path DevicePath\r
                                  and non-NULL FileBuffer did authenticate, and the platform\r
                                  policy dictates that the DXE Foundation may execute the image in\r
                                  FileBuffer.\r
  @retval EFI_SUCCESS             FileBuffer is NULL and current user has permission to start\r
                                  UEFI device drivers on the device path specified by DevicePath.\r
  @retval EFI_SECURITY_VIOLATION  The file specified by DevicePath and FileBuffer did not\r
                                  authenticate, and the platform policy dictates that the file should be\r
                                  placed in the untrusted state. The image has been added to the file\r
                                  execution table.\r
  @retval EFI_ACCESS_DENIED       The file specified by File and FileBuffer did not\r
                                  authenticate, and the platform policy dictates that the DXE\r
                                  Foundation may not use File.\r
  @retval EFI_SECURITY_VIOLATION  FileBuffer is NULL and the user has no\r
                                  permission to start UEFI device drivers on the device path specified\r
                                  by DevicePath.\r
  @retval EFI_SECURITY_VIOLATION  FileBuffer is not NULL and the user has no permission to load\r
                                  drivers from the device path specified by DevicePath. The\r
                                  image has been added into the list of the deferred images.\r
  @retval EFI_INVALID_PARAMETER   File and FileBuffer are both NULL.\r
**/\r
EFI_STATUS\r
EFIAPI\r
ExecuteSecurity2Handlers (\r
  IN  UINT32                           AuthenticationOperation,\r
  IN  UINT32                           AuthenticationStatus,\r
  IN  CONST EFI_DEVICE_PATH_PROTOCOL   *File,\r
  IN  VOID                             *FileBuffer,\r
  IN  UINTN                            FileSize,\r
  IN  BOOLEAN                          BootPolicy\r
  );\r
\r
#endif\r
Commit	Line	Data
cd98f305	1	/** @file\r
d1102dba	2	This library class defines a set of interfaces to abstract the policy of\r
cd98f305 LG	3	security measurement by managing the different security measurement services.\r
	4	The library instances can be implemented according to the different security policy.\r
	5	\r
d1102dba	6	Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
9d510e61	7	SPDX-License-Identifier: BSD-2-Clause-Patent\r
cd98f305 LG	8	\r
	9	**/\r
	10	\r
	11	#ifndef __SECURITY_MANAGEMENT_LIB_H__\r
	12	#define __SECURITY_MANAGEMENT_LIB_H__\r
	13	\r
bc2dfdbc LG	14	//\r
	15	// Authentication Operation defintions for User Identity (UID), Measured and Secure boot.\r
	16	//\r
cd98f305 LG	17	#define EFI_AUTH_OPERATION_NONE 0x00\r
	18	#define EFI_AUTH_OPERATION_VERIFY_IMAGE 0x01\r
	19	#define EFI_AUTH_OPERATION_DEFER_IMAGE_LOAD 0x02\r
	20	#define EFI_AUTH_OPERATION_MEASURE_IMAGE 0x04\r
bc2dfdbc LG	21	#define EFI_AUTH_OPERATION_CONNECT_POLICY 0x08\r
	22	//\r
	23	// Authentication State Operation will check the authentication status of a file.\r
	24	//\r
	25	#define EFI_AUTH_OPERATION_AUTHENTICATION_STATE 0x10\r
cd98f305 LG	26	\r
cd98f305 LG	27	///\r
64a80549	28	/// Image buffer is required by the security handler.\r
cd98f305 LG	29	///\r
	30	#define EFI_AUTH_OPERATION_IMAGE_REQUIRED 0x80000000\r
	31	\r
	32	/**\r
d1102dba LG	33	The security handler is used to abstract platform-specific policy\r
	34	from the DXE core response to an attempt to use a file that returns a\r
	35	given status for the authentication check from the section extraction protocol.\r
cd98f305	36	\r
d1102dba LG	37	The possible responses in a given SAP implementation may include locking\r
	38	flash upon failure to authenticate, attestation logging for all signed drivers,\r
	39	and other exception operations. The File parameter allows for possible logging\r
cd98f305	40	within the SAP of the driver.\r
d1102dba	41	\r
cd98f305 LG	42	If File is NULL, then EFI_INVALID_PARAMETER is returned.\r
cd98f305 LG	43	\r
d1102dba	44	If the file specified by File with an authentication status specified by\r
cd98f305 LG	45	AuthenticationStatus is safe for the DXE Core to use, then EFI_SUCCESS is returned.\r
cd98f305 LG	46	\r
d1102dba LG	47	If the file specified by File with an authentication status specified by\r
d1102dba LG	48	AuthenticationStatus is not safe for the DXE Core to use under any circumstances,\r
cd98f305 LG	49	then EFI_ACCESS_DENIED is returned.\r
cd98f305 LG	50	\r
d1102dba LG	51	If the file specified by File with an authentication status specified by\r
	52	AuthenticationStatus is not safe for the DXE Core to use at the time, but it\r
	53	might be possible to use it at a future time, then EFI_SECURITY_VIOLATION is\r
cd98f305 LG	54	returned.\r
cd98f305 LG	55	\r
d1102dba	56	FileBuffer will be NULL and FileSize will be 0 if the handler being called\r
64a80549	57	did not set EFI_AUTH_OPERATION_IMAGE_REQUIRED when it was registered.\r
cd98f305	58	\r
d1102dba	59	@param[in] AuthenticationStatus\r
64a80549	60	The authentication status returned from the security\r
cd98f305	61	measurement services for the input file.\r
64a80549	62	@param[in] File The pointer to the device path of the file that is\r
cd98f305	63	being dispatched. This will optionally be used for logging.\r
64a80549	64	@param[in] FileBuffer The file buffer matches the input file device path.\r
64a80549	65	@param[in] FileSize The size of File buffer matches the input file device path.\r
cd98f305 LG	66	\r
	67	@retval EFI_SUCCESS The file specified by File did authenticate, and the\r
	68	platform policy dictates that the DXE Core may use File.\r
64a80549	69	@retval EFI_INVALID_PARAMETER The file is NULL.\r
cd98f305 LG	70	@retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and\r
	71	the platform policy dictates that File should be placed\r
	72	in the untrusted state. A file may be promoted from\r
	73	the untrusted to the trusted state at a future time\r
	74	with a call to the Trust() DXE Service.\r
	75	@retval EFI_ACCESS_DENIED The file specified by File did not authenticate, and\r
	76	the platform policy dictates that File should not be\r
	77	used for any purpose.\r
	78	\r
	79	**/\r
d1102dba	80	typedef\r
cd98f305 LG	81	EFI_STATUS\r
	82	(EFIAPI *SECURITY_FILE_AUTHENTICATION_STATE_HANDLER)(\r
	83	IN OUT UINT32 AuthenticationStatus,\r
	84	IN CONST EFI_DEVICE_PATH_PROTOCOL *File,\r
	85	IN VOID *FileBuffer,\r
	86	IN UINTN FileSize\r
	87	);\r
	88	\r
	89	/**\r
64a80549	90	Register security measurement handler with its operation type. Different\r
64a80549	91	handlers with the same operation can all be registered.\r
cd98f305 LG	92	\r
	93	If SecurityHandler is NULL, then ASSERT().\r
	94	If no enough resources available to register new handler, then ASSERT().\r
	95	If AuthenticationOperation is not recongnized, then ASSERT().\r
	96	If the previous register handler can't be executed before the later register handler, then ASSERT().\r
	97	\r
64a80549	98	@param[in] SecurityHandler The security measurement service handler to be registered.\r
64a80549	99	@param[in] AuthenticationOperation Theoperation type is specified for the registered handler.\r
cd98f305 LG	100	\r
	101	@retval EFI_SUCCESS The handlers were registered successfully.\r
	102	**/\r
	103	EFI_STATUS\r
	104	EFIAPI\r
	105	RegisterSecurityHandler (\r
	106	IN SECURITY_FILE_AUTHENTICATION_STATE_HANDLER SecurityHandler,\r
	107	IN UINT32 AuthenticationOperation\r
	108	);\r
	109	\r
	110	/**\r
	111	Execute registered handlers until one returns an error and that error is returned.\r
	112	If none of the handlers return an error, then EFI_SUCCESS is returned.\r
	113	\r
d1102dba	114	Before exectue handler, get the image buffer by file device path if a handler\r
cd98f305 LG	115	requires the image file. And return the image buffer to each handler when exectue handler.\r
	116	\r
	117	The handlers are executed in same order to their registered order.\r
	118	\r
d1102dba	119	@param[in] AuthenticationStatus\r
cd98f305 LG	120	This is the authentication type returned from the Section\r
	121	Extraction protocol. See the Section Extraction Protocol\r
	122	Specification for details on this type.\r
	123	@param[in] FilePath This is a pointer to the device path of the file that is\r
	124	being dispatched. This will optionally be used for logging.\r
	125	\r
64a80549	126	@retval EFI_SUCCESS The file specified by File authenticated when more\r
d1102dba LG	127	than one security handler services were registered,\r
	128	or the file did not authenticate when no security\r
	129	handler service was registered. And the platform policy\r
cd98f305 LG	130	dictates that the DXE Core may use File.\r
	131	@retval EFI_INVALID_PARAMETER File is NULL.\r
	132	@retval EFI_SECURITY_VIOLATION The file specified by File did not authenticate, and\r
	133	the platform policy dictates that File should be placed\r
	134	in the untrusted state. A file may be promoted from\r
	135	the untrusted to the trusted state at a future time\r
	136	with a call to the Trust() DXE Service.\r
	137	@retval EFI_ACCESS_DENIED The file specified by File did not authenticate, and\r
	138	the platform policy dictates that File should not be\r
	139	used for any purpose.\r
	140	**/\r
	141	EFI_STATUS\r
	142	EFIAPI\r
	143	ExecuteSecurityHandlers (\r
	144	IN UINT32 AuthenticationStatus,\r
	145	IN CONST EFI_DEVICE_PATH_PROTOCOL *FilePath\r
	146	);\r
	147	\r
bc2dfdbc	148	/**\r
d1102dba LG	149	The security handler is used to abstracts security-specific functions from the DXE\r
	150	Foundation of UEFI Image Verification, Trusted Computing Group (TCG) measured boot,\r
	151	User Identity policy for image loading and consoles, and for purposes of\r
	152	handling GUIDed section encapsulations.\r
	153	\r
	154	@param[in] AuthenticationStatus\r
	155	The authentication status for the input file.\r
bc2dfdbc LG	156	@param[in] File The pointer to the device path of the file that is\r
	157	being dispatched. This will optionally be used for logging.\r
	158	@param[in] FileBuffer A pointer to the buffer with the UEFI file image\r
	159	@param[in] FileSize The size of File buffer.\r
	160	@param[in] BootPolicy A boot policy that was used to call LoadImage() UEFI service.\r
	161	\r
	162	@retval EFI_SUCCESS The file specified by DevicePath and non-NULL\r
	163	FileBuffer did authenticate, and the platform policy dictates\r
	164	that the DXE Foundation may use the file.\r
	165	@retval EFI_SUCCESS The device path specified by NULL device path DevicePath\r
	166	and non-NULL FileBuffer did authenticate, and the platform\r
	167	policy dictates that the DXE Foundation may execute the image in\r
	168	FileBuffer.\r
	169	@retval EFI_SUCCESS FileBuffer is NULL and current user has permission to start\r
	170	UEFI device drivers on the device path specified by DevicePath.\r
	171	@retval EFI_SECURITY_VIOLATION The file specified by DevicePath and FileBuffer did not\r
	172	authenticate, and the platform policy dictates that the file should be\r
	173	placed in the untrusted state. The image has been added to the file\r
	174	execution table.\r
	175	@retval EFI_ACCESS_DENIED The file specified by File and FileBuffer did not\r
	176	authenticate, and the platform policy dictates that the DXE\r
	177	Foundation may not use File.\r
	178	@retval EFI_SECURITY_VIOLATION FileBuffer is NULL and the user has no\r
	179	permission to start UEFI device drivers on the device path specified\r
	180	by DevicePath.\r
	181	@retval EFI_SECURITY_VIOLATION FileBuffer is not NULL and the user has no permission to load\r
	182	drivers from the device path specified by DevicePath. The\r
	183	image has been added into the list of the deferred images.\r
	184	**/\r
d1102dba	185	typedef\r
bc2dfdbc LG	186	EFI_STATUS\r
	187	(EFIAPI *SECURITY2_FILE_AUTHENTICATION_HANDLER) (\r
	188	IN UINT32 AuthenticationStatus,\r
	189	IN CONST EFI_DEVICE_PATH_PROTOCOL *File,\r
	190	IN VOID *FileBuffer,\r
	191	IN UINTN FileSize,\r
	192	IN BOOLEAN BootPolicy\r
	193	);\r
	194	\r
	195	/**\r
	196	Register security measurement handler with its operation type. Different\r
	197	handlers with the same operation can all be registered.\r
	198	\r
	199	If SecurityHandler is NULL, then ASSERT().\r
	200	If no enough resources available to register new handler, then ASSERT().\r
	201	If AuthenticationOperation is not recongnized, then ASSERT().\r
	202	If AuthenticationOperation is EFI_AUTH_OPERATION_NONE, then ASSERT().\r
	203	If the previous register handler can't be executed before the later register handler, then ASSERT().\r
	204	\r
	205	@param[in] Security2Handler The security measurement service handler to be registered.\r
	206	@param[in] AuthenticationOperation The operation type is specified for the registered handler.\r
	207	\r
	208	@retval EFI_SUCCESS The handlers were registered successfully.\r
	209	**/\r
	210	EFI_STATUS\r
	211	EFIAPI\r
	212	RegisterSecurity2Handler (\r
	213	IN SECURITY2_FILE_AUTHENTICATION_HANDLER Security2Handler,\r
	214	IN UINT32 AuthenticationOperation\r
	215	);\r
	216	\r
	217	/**\r
d1102dba LG	218	Execute registered handlers based on input AuthenticationOperation until\r
	219	one returns an error and that error is returned.\r
	220	\r
bc2dfdbc LG	221	If none of the handlers return an error, then EFI_SUCCESS is returned.\r
	222	The handlers those satisfy AuthenticationOperation will only be executed.\r
	223	The handlers are executed in same order to their registered order.\r
	224	\r
d1102dba	225	@param[in] AuthenticationOperation\r
bc2dfdbc	226	The operation type specifies which handlers will be executed.\r
d1102dba	227	@param[in] AuthenticationStatus\r
bc2dfdbc LG	228	The authentication status for the input file.\r
	229	@param[in] File This is a pointer to the device path of the file that is\r
	230	being dispatched. This will optionally be used for logging.\r
	231	@param[in] FileBuffer A pointer to the buffer with the UEFI file image\r
	232	@param[in] FileSize The size of File buffer.\r
	233	@param[in] BootPolicy A boot policy that was used to call LoadImage() UEFI service.\r
	234	\r
	235	@retval EFI_SUCCESS The file specified by DevicePath and non-NULL\r
	236	FileBuffer did authenticate, and the platform policy dictates\r
	237	that the DXE Foundation may use the file.\r
	238	@retval EFI_SUCCESS The device path specified by NULL device path DevicePath\r
	239	and non-NULL FileBuffer did authenticate, and the platform\r
	240	policy dictates that the DXE Foundation may execute the image in\r
	241	FileBuffer.\r
	242	@retval EFI_SUCCESS FileBuffer is NULL and current user has permission to start\r
	243	UEFI device drivers on the device path specified by DevicePath.\r
	244	@retval EFI_SECURITY_VIOLATION The file specified by DevicePath and FileBuffer did not\r
	245	authenticate, and the platform policy dictates that the file should be\r
	246	placed in the untrusted state. The image has been added to the file\r
	247	execution table.\r
	248	@retval EFI_ACCESS_DENIED The file specified by File and FileBuffer did not\r
	249	authenticate, and the platform policy dictates that the DXE\r
	250	Foundation may not use File.\r
	251	@retval EFI_SECURITY_VIOLATION FileBuffer is NULL and the user has no\r
	252	permission to start UEFI device drivers on the device path specified\r
	253	by DevicePath.\r
	254	@retval EFI_SECURITY_VIOLATION FileBuffer is not NULL and the user has no permission to load\r
	255	drivers from the device path specified by DevicePath. The\r
	256	image has been added into the list of the deferred images.\r
d1102dba	257	@retval EFI_INVALID_PARAMETER File and FileBuffer are both NULL.\r
bc2dfdbc LG	258	**/\r
	259	EFI_STATUS\r
	260	EFIAPI\r
	261	ExecuteSecurity2Handlers (\r
	262	IN UINT32 AuthenticationOperation,\r
	263	IN UINT32 AuthenticationStatus,\r
	264	IN CONST EFI_DEVICE_PATH_PROTOCOL *File,\r
	265	IN VOID *FileBuffer,\r
	266	IN UINTN FileSize,\r
	267	IN BOOLEAN BootPolicy\r
	268	);\r
	269	\r
cd98f305	270	#endif\r