/** @file\r
Implement defer image load services for user identification in UEFI2.2.\r
\r
-Copyright (c) 2009 - 2013, 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
+Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
Get the image type.\r
\r
@param[in] File This is a pointer to the device path of the file\r
- that is being dispatched. \r
+ that is being dispatched.\r
\r
- @return UINT32 Image Type \r
+ @return UINT32 Image Type\r
\r
**/\r
UINT32\r
)\r
{\r
EFI_STATUS Status;\r
- EFI_HANDLE DeviceHandle; \r
+ EFI_HANDLE DeviceHandle;\r
EFI_DEVICE_PATH_PROTOCOL *TempDevicePath;\r
EFI_BLOCK_IO_PROTOCOL *BlockIo;\r
\r
}\r
\r
//\r
- // File is not in a Firmware Volume or on a Block I/O device, so check to see if \r
+ // File is not in a Firmware Volume or on a Block I/O device, so check to see if\r
// the device path supports the Simple File System Protocol.\r
//\r
DeviceHandle = NULL;\r
\r
//\r
// File is not from an FV, Block I/O or Simple File System, so the only options\r
- // left are a PCI Option ROM and a Load File Protocol such as a PXE Boot from a NIC. \r
+ // left are a PCI Option ROM and a Load File Protocol such as a PXE Boot from a NIC.\r
//\r
TempDevicePath = (EFI_DEVICE_PATH_PROTOCOL *)File;\r
while (!IsDevicePathEndType (TempDevicePath)) {\r
switch (DevicePathType (TempDevicePath)) {\r
- \r
+\r
case MEDIA_DEVICE_PATH:\r
if (DevicePathSubType (TempDevicePath) == MEDIA_RELATIVE_OFFSET_RANGE_DP) {\r
return IMAGE_FROM_OPTION_ROM;\r
case MESSAGING_DEVICE_PATH:\r
if (DevicePathSubType(TempDevicePath) == MSG_MAC_ADDR_DP) {\r
return IMAGE_FROM_REMOVABLE_MEDIA;\r
- } \r
+ }\r
break;\r
\r
default:\r
}\r
TempDevicePath = NextDevicePathNode (TempDevicePath);\r
}\r
- return IMAGE_UNKNOWN; \r
+ return IMAGE_UNKNOWN;\r
}\r
\r
\r
if (EFI_ERROR (Status)) {\r
return EFI_NOT_FOUND;\r
}\r
- \r
+\r
//\r
// Get current user access information.\r
//\r
if (EFI_ERROR (Status)) {\r
break;\r
}\r
- \r
+\r
ASSERT (Info != NULL);\r
if (Info->InfoType != EFI_USER_INFO_ACCESS_POLICY_RECORD) {\r
continue;\r
}\r
- \r
+\r
//\r
// Get specified access information.\r
//\r
CheckLen = 0;\r
while (CheckLen < Info->InfoSize - sizeof (EFI_USER_INFO)) {\r
Access = (EFI_USER_INFO_ACCESS_CONTROL *) ((UINT8 *) (Info + 1) + CheckLen);\r
- if ((Access->Type == AccessType)) {\r
+ if (Access->Type == AccessType) {\r
*AccessControl = AllocateZeroPool (Access->Size);\r
ASSERT (*AccessControl != NULL);\r
CopyMem (*AccessControl, Access, Access->Size);\r
CheckLen += Access->Size;\r
}\r
}\r
- \r
+\r
if (Info != NULL) {\r
FreePool (Info);\r
}\r
/**\r
Get file name from device path.\r
\r
- The file name may contain one or more device path node. Save the file name in a \r
- buffer if file name is found. The caller is responsible to free the buffer. \r
- \r
+ The file name may contain one or more device path node. Save the file name in a\r
+ buffer if file name is found. The caller is responsible to free the buffer.\r
+\r
@param[in] DevicePath A pointer to a device path.\r
@param[out] FileName The callee allocated buffer to save the file name if file name is found.\r
@param[out] FileNameOffset The offset of file name in device path if file name is found.\r
- \r
+\r
@retval UINTN The file name length. 0 means file name is not found.\r
\r
**/\r
-UINTN \r
+UINTN\r
GetFileName (\r
IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
OUT UINT8 **FileName,\r
FirstNodeChar = (CHAR16) ReadUnaligned16 ((UINT16 *)((UINT8 *)TmpDevicePath + sizeof (EFI_DEVICE_PATH_PROTOCOL)));\r
NodeStr = (CHAR8 *)TmpDevicePath + sizeof (EFI_DEVICE_PATH_PROTOCOL);\r
NodeStrLength = DevicePathNodeLength (TmpDevicePath) - sizeof (EFI_DEVICE_PATH_PROTOCOL) - sizeof(CHAR16);\r
- \r
+\r
if ((FirstNodeChar == '\\') && (LastNodeChar == '\\')) {\r
//\r
// Skip separator "\" when there are two separators.\r
//\r
NodeStr += sizeof (CHAR16);\r
- NodeStrLength -= sizeof (CHAR16); \r
+ NodeStrLength -= sizeof (CHAR16);\r
} else if ((FirstNodeChar != '\\') && (LastNodeChar != '\\')) {\r
//\r
// Add separator "\" when there is no separator.\r
//\r
WriteUnaligned16 ((UINT16 *)(*FileName + Length), '\\');\r
Length += sizeof (CHAR16);\r
- } \r
+ }\r
CopyMem (*FileName + Length, NodeStr, NodeStrLength);\r
Length += NodeStrLength;\r
- \r
+\r
LastNodeChar = (CHAR16) ReadUnaligned16 ((UINT16 *) (NodeStr + NodeStrLength - sizeof(CHAR16)));\r
TmpDevicePath = NextDevicePathNode (TmpDevicePath);\r
- } \r
+ }\r
\r
return Length;\r
}\r
\r
If DevicePath2 is identical with DevicePath1, or with DevicePath1's child device\r
path, then TRUE returned. Otherwise, FALSE is returned.\r
- \r
+\r
If DevicePath1 is NULL, then ASSERT().\r
If DevicePath2 is NULL, then ASSERT().\r
\r
@param[in] DevicePath1 A pointer to a device path.\r
@param[in] DevicePath2 A pointer to a device path.\r
\r
- @retval TRUE Two device paths are identical , or DevicePath2 is \r
+ @retval TRUE Two device paths are identical , or DevicePath2 is\r
DevicePath1's child device path.\r
- @retval FALSE Two device paths are not identical, and DevicePath2 \r
+ @retval FALSE Two device paths are not identical, and DevicePath2\r
is not DevicePath1's child device path.\r
\r
**/\r
if (IsDevicePathEnd (DevicePath1)) {\r
return FALSE;\r
}\r
- \r
+\r
//\r
- // The file name may contain one or more device path node. \r
+ // The file name may contain one or more device path node.\r
// To compare the file name, copy file name to a buffer and compare the buffer.\r
//\r
FileNameSize1 = GetFileName (DevicePath1, &FileName1, &FileNameOffset1);\r
DevicePathEqual = FALSE;\r
goto Done;\r
}\r
- if (CompareMem (DevicePath1, DevicePath2, FileNameOffset1) != 0) { \r
+ if (CompareMem (DevicePath1, DevicePath2, FileNameOffset1) != 0) {\r
DevicePathEqual = FALSE;\r
goto Done;\r
}\r
DevicePathEqual = FALSE;\r
goto Done;\r
}\r
- if (CompareMem (FileName1, FileName2, FileNameSize1) != 0) { \r
+ if (CompareMem (FileName1, FileName2, FileNameSize1) != 0) {\r
DevicePathEqual = FALSE;\r
goto Done;\r
}\r
DevicePathSize -= sizeof (EFI_DEVICE_PATH_PROTOCOL);\r
if (CompareMem (DevicePath1, DevicePath2, DevicePathSize) != 0) {\r
DevicePathEqual = FALSE;\r
- } \r
- \r
-Done: \r
+ }\r
+\r
+Done:\r
if (FileName1 != NULL) {\r
FreePool (FileName1);\r
}\r
\r
\r
/**\r
- Check whether the image pointed to by DevicePath is in the device path list \r
- specified by AccessType. \r
+ Check whether the image pointed to by DevicePath is in the device path list\r
+ specified by AccessType.\r
\r
@param[in] DevicePath Points to device path.\r
@param[in] AccessType The type of user access control.\r
- \r
- @retval TURE The DevicePath is in the specified List.\r
+\r
+ @retval TRUE The DevicePath is in the specified List.\r
@retval FALSE The DevicePath is not in the specified List.\r
\r
**/\r
EFI_STATUS Status;\r
EFI_USER_INFO_ACCESS_CONTROL *Access;\r
EFI_DEVICE_PATH_PROTOCOL *Path;\r
- UINTN OffSet; \r
+ UINTN OffSet;\r
\r
Status = GetAccessControl (&Access, AccessType);\r
if (EFI_ERROR (Status)) {\r
return FALSE;\r
- } \r
+ }\r
\r
OffSet = 0;\r
while (OffSet < Access->Size - sizeof (EFI_USER_INFO_ACCESS_CONTROL)) {\r
- Path = (EFI_DEVICE_PATH_PROTOCOL*)((UINT8*)(Access + 1) + OffSet); \r
+ Path = (EFI_DEVICE_PATH_PROTOCOL*)((UINT8*)(Access + 1) + OffSet);\r
if (CheckDevicePath (Path, DevicePath)) {\r
//\r
// The device path is found in list.\r
//\r
FreePool (Access);\r
return TRUE;\r
- } \r
+ }\r
OffSet += GetDevicePathSize (Path);\r
}\r
- \r
+\r
FreePool (Access);\r
- return FALSE; \r
+ return FALSE;\r
}\r
\r
\r
/**\r
- Check whether the image pointed to by DevicePath is permitted to load. \r
+ Check whether the image pointed to by DevicePath is permitted to load.\r
\r
@param[in] DevicePath Points to device path\r
- \r
- @retval TURE The image pointed by DevicePath is permitted to load.\r
+\r
+ @retval TRUE The image pointed by DevicePath is permitted to load.\r
@retval FALSE The image pointed by DevicePath is forbidden to load.\r
\r
**/\r
{\r
if (IsDevicePathInList (DevicePath, EFI_USER_INFO_ACCESS_PERMIT_LOAD)) {\r
//\r
- // This access control overrides any restrictions put in place by the \r
+ // This access control overrides any restrictions put in place by the\r
// EFI_USER_INFO_ACCESS_FORBID_LOAD record.\r
//\r
return TRUE;\r
}\r
- \r
+\r
if (IsDevicePathInList (DevicePath, EFI_USER_INFO_ACCESS_FORBID_LOAD)) {\r
//\r
// The device path is found in the forbidden list.\r
//\r
return FALSE;\r
}\r
- \r
- return TRUE; \r
+\r
+ return TRUE;\r
}\r
\r
\r
/**\r
- Check the image pointed by DevicePath is a boot option or not. \r
+ Check the image pointed by DevicePath is a boot option or not.\r
\r
@param[in] DevicePath Points to device path.\r
- \r
- @retval TURE The image pointed by DevicePath is a boot option.\r
+\r
+ @retval TRUE The image pointed by DevicePath is a boot option.\r
@retval FALSE The image pointed by DevicePath is not a boot option.\r
\r
**/\r
UINT8 *OptionBuffer;\r
UINT8 *OptionPtr;\r
EFI_DEVICE_PATH_PROTOCOL *OptionDevicePath;\r
- \r
+\r
//\r
// Get BootOrder\r
//\r
BootOrderListSize = 0;\r
- BootOrderList = NULL; \r
+ BootOrderList = NULL;\r
Status = gRT->GetVariable (\r
- L"BootOrder", \r
- &gEfiGlobalVariableGuid, \r
- NULL, \r
- &BootOrderListSize, \r
+ L"BootOrder",\r
+ &gEfiGlobalVariableGuid,\r
+ NULL,\r
+ &BootOrderListSize,\r
NULL\r
);\r
if (Status == EFI_BUFFER_TOO_SMALL) {\r
BootOrderList = AllocateZeroPool (BootOrderListSize);\r
ASSERT (BootOrderList != NULL);\r
Status = gRT->GetVariable (\r
- L"BootOrder", \r
- &gEfiGlobalVariableGuid, \r
- NULL, \r
- &BootOrderListSize, \r
+ L"BootOrder",\r
+ &gEfiGlobalVariableGuid,\r
+ NULL,\r
+ &BootOrderListSize,\r
BootOrderList\r
);\r
}\r
- \r
+\r
if (EFI_ERROR (Status)) {\r
//\r
// No Boot option\r
//\r
// Check whether the image is forbidden.\r
//\r
- \r
+\r
OptionPtr = OptionBuffer;\r
//\r
// Skip attribute.\r
// Skip descript string\r
//\r
OptionPtr += StrSize ((UINT16 *) OptionPtr);\r
- \r
+\r
//\r
// Now OptionPtr points to Device Path.\r
//\r
/**\r
Add the image info to a deferred image list.\r
\r
- @param[in] ImageDevicePath A pointer to the device path of a image. \r
- @param[in] Image Points to the first byte of the image, or NULL if the \r
+ @param[in] ImageDevicePath A pointer to the device path of a image.\r
+ @param[in] Image Points to the first byte of the image, or NULL if the\r
image is not available.\r
@param[in] ImageSize The size of the image, or 0 if the image is not available.\r
- \r
+\r
**/\r
VOID\r
PutDefferedImageInfo (\r
} else {\r
CurImageInfo = AllocatePool ((mDeferredImage.Count + 1) * sizeof (DEFERRED_IMAGE_INFO));\r
ASSERT (CurImageInfo != NULL);\r
- \r
+\r
CopyMem (\r
- CurImageInfo, \r
+ CurImageInfo,\r
mDeferredImage.ImageInfo,\r
mDeferredImage.Count * sizeof (DEFERRED_IMAGE_INFO)\r
);\r
mDeferredImage.ImageInfo = CurImageInfo;\r
}\r
mDeferredImage.Count++;\r
- \r
+\r
//\r
// Save the deferred image information.\r
//\r
/**\r
Returns information about a deferred image.\r
\r
- This function returns information about a single deferred image. The deferred images are \r
- numbered consecutively, starting with 0. If there is no image which corresponds to \r
- ImageIndex, then EFI_NOT_FOUND is returned. All deferred images may be returned by \r
+ This function returns information about a single deferred image. The deferred images are\r
+ numbered consecutively, starting with 0. If there is no image which corresponds to\r
+ ImageIndex, then EFI_NOT_FOUND is returned. All deferred images may be returned by\r
iteratively calling this function until EFI_NOT_FOUND is returned.\r
- Image may be NULL and ImageSize set to 0 if the decision to defer execution was made \r
- because of the location of the executable image, rather than its actual contents. \r
+ Image may be NULL and ImageSize set to 0 if the decision to defer execution was made\r
+ because of the location of the executable image, rather than its actual contents.\r
\r
@param[in] This Points to this instance of the EFI_DEFERRED_IMAGE_LOAD_PROTOCOL.\r
@param[in] ImageIndex Zero-based index of the deferred index.\r
- @param[out] ImageDevicePath On return, points to a pointer to the device path of the image. \r
- The device path should not be freed by the caller. \r
- @param[out] Image On return, points to the first byte of the image or NULL if the \r
+ @param[out] ImageDevicePath On return, points to a pointer to the device path of the image.\r
+ The device path should not be freed by the caller.\r
+ @param[out] Image On return, points to the first byte of the image or NULL if the\r
image is not available. The image should not be freed by the caller\r
- unless LoadImage() has been successfully called. \r
+ unless LoadImage() has been successfully called.\r
@param[out] ImageSize On return, the size of the image, or 0 if the image is not available.\r
- @param[out] BootOption On return, points to TRUE if the image was intended as a boot option \r
- or FALSE if it was not intended as a boot option. \r
- \r
+ @param[out] BootOption On return, points to TRUE if the image was intended as a boot option\r
+ or FALSE if it was not intended as a boot option.\r
+\r
@retval EFI_SUCCESS Image information returned successfully.\r
@retval EFI_NOT_FOUND ImageIndex does not refer to a valid image.\r
- @retval EFI_INVALID_PARAMETER ImageDevicePath is NULL or Image is NULL or ImageSize is NULL or \r
+ @retval EFI_INVALID_PARAMETER ImageDevicePath is NULL or Image is NULL or ImageSize is NULL or\r
BootOption is NULL.\r
- \r
+\r
**/\r
EFI_STATUS\r
EFIAPI\r
if ((This == NULL) || (ImageSize == NULL) || (Image == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
- \r
+\r
if ((ImageDevicePath == NULL) || (BootOption == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
if (ImageIndex >= mDeferredImage.Count) {\r
return EFI_NOT_FOUND;\r
}\r
- \r
+\r
//\r
// Get the request deferred image.\r
- // \r
+ //\r
ReqImageInfo = &mDeferredImage.ImageInfo[ImageIndex];\r
- \r
+\r
*ImageDevicePath = ReqImageInfo->ImageDevicePath;\r
*Image = ReqImageInfo->Image;\r
*ImageSize = ReqImageInfo->ImageSize;\r
*BootOption = ReqImageInfo->BootOption;\r
- \r
+\r
return EFI_SUCCESS;\r
}\r
\r
Provides the service of deferring image load based on platform policy control,\r
and installs Deferred Image Load Protocol.\r
\r
- @param[in] AuthenticationStatus This is the authentication status returned from the \r
+ @param[in] AuthenticationStatus This is the authentication status returned from the\r
security measurement services for the input file.\r
@param[in] File This is a pointer to the device path of the file that\r
is being dispatched. This will optionally be used for\r
\r
//\r
// Check whether user has a logon.\r
- // \r
+ //\r
CurrentUser = NULL;\r
if (mUserManager != NULL) {\r
mUserManager->Current (mUserManager, &CurrentUser);\r
return EFI_SUCCESS;\r
}\r
}\r
- \r
+\r
//\r
// Still no user logon.\r
// Check the file type and get policy setting.\r
//\r
return EFI_SUCCESS;\r
}\r
- \r
- DEBUG ((EFI_D_ERROR, "[Security] No user identified, the image is deferred to load!\n"));\r
+\r
+ DEBUG ((EFI_D_INFO, "[Security] No user identified, the image is deferred to load!\n"));\r
PutDefferedImageInfo (File, FileBuffer, FileSize);\r
\r
//\r
}\r
\r
/**\r
- Locate user manager protocol when user manager is installed. \r
+ Locate user manager protocol when user manager is installed.\r
\r
@param[in] Event The Event that is being processed, not used.\r
- @param[in] Context Event Context, not used. \r
+ @param[in] Context Event Context, not used.\r
\r
**/\r
VOID\r
NULL,\r
(VOID **) &mUserManager\r
);\r
- \r
+\r
}\r
\r
\r
)\r
{\r
VOID *Registration;\r
- \r
+\r
//\r
// Register user manager notification function.\r
//\r
EfiCreateProtocolNotifyEvent (\r
- &gEfiUserManagerProtocolGuid, \r
+ &gEfiUserManagerProtocolGuid,\r
TPL_CALLBACK,\r
FindUserManagerProtocol,\r
NULL,\r
&Registration\r
);\r
- \r
+\r
return RegisterSecurity2Handler (\r
DxeDeferImageLoadHandler,\r
- EFI_AUTH_OPERATION_DEFER_IMAGE_LOAD \r
- ); \r
+ EFI_AUTH_OPERATION_DEFER_IMAGE_LOAD\r
+ );\r
}\r
\r
\r