https://bugzilla.tianocore.org/show_bug.cgi?id=1373 Replace BSD 2-Clause License with BSD+Patent License. This change is based on the following emails: https://lists.01.org/pipermail/edk2-devel/2019-February/036260.html https://lists.01.org/pipermail/edk2-devel/2018-October/030385.html RFCs with detailed process for the license change: V3: https://lists.01.org/pipermail/edk2-devel/2019-March/038116.html V2: https://lists.01.org/pipermail/edk2-devel/2019-March/037669.html V1: https://lists.01.org/pipermail/edk2-devel/2019-March/037500.html Contributed-under: TianoCore Contribution Agreement 1.1 Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com> Reviewed-by: Hao Wu <hao.a.wu@intel.com> Reviewed-by: Jian J Wang <jian.j.wang@intel.com>
		
			
				
	
	
		
			61 lines
		
	
	
		
			2.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			61 lines
		
	
	
		
			2.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/** @file
 | 
						|
  NULL FMP authentication library.
 | 
						|
 | 
						|
  Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>
 | 
						|
  SPDX-License-Identifier: BSD-2-Clause-Patent
 | 
						|
 | 
						|
**/
 | 
						|
 | 
						|
#include <Uefi.h>
 | 
						|
 | 
						|
#include <Library/DebugLib.h>
 | 
						|
#include <Library/FmpAuthenticationLib.h>
 | 
						|
 | 
						|
/**
 | 
						|
  The function is used to do the authentication for FMP capsule based upon
 | 
						|
  EFI_FIRMWARE_IMAGE_AUTHENTICATION.
 | 
						|
 | 
						|
  The FMP capsule image should start with EFI_FIRMWARE_IMAGE_AUTHENTICATION,
 | 
						|
  followed by the payload.
 | 
						|
 | 
						|
  If the return status is RETURN_SUCCESS, the caller may continue the rest
 | 
						|
  FMP update process.
 | 
						|
  If the return status is NOT RETURN_SUCCESS, the caller should stop the FMP
 | 
						|
  update process and convert the return status to LastAttemptStatus
 | 
						|
  to indicate that FMP update fails.
 | 
						|
  The LastAttemptStatus can be got from ESRT table or via
 | 
						|
  EFI_FIRMWARE_MANAGEMENT_PROTOCOL.GetImageInfo().
 | 
						|
 | 
						|
  Caution: This function may receive untrusted input.
 | 
						|
 | 
						|
  @param[in]  Image                   Points to an FMP authentication image, started from EFI_FIRMWARE_IMAGE_AUTHENTICATION.
 | 
						|
  @param[in]  ImageSize               Size of the authentication image in bytes.
 | 
						|
  @param[in]  PublicKeyData           The public key data used to validate the signature.
 | 
						|
  @param[in]  PublicKeyDataLength     The length of the public key data.
 | 
						|
 | 
						|
  @retval RETURN_SUCCESS            Authentication pass.
 | 
						|
                                    The LastAttemptStatus should be LAST_ATTEMPT_STATUS_SUCCESS.
 | 
						|
  @retval RETURN_SECURITY_VIOLATION Authentication fail.
 | 
						|
                                    The LastAttemptStatus should be LAST_ATTEMPT_STATUS_ERROR_AUTH_ERROR.
 | 
						|
  @retval RETURN_INVALID_PARAMETER  The image is in an invalid format.
 | 
						|
                                    The LastAttemptStatus should be LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT.
 | 
						|
  @retval RETURN_UNSUPPORTED        No Authentication handler associated with CertType.
 | 
						|
                                    The LastAttemptStatus should be LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT.
 | 
						|
  @retval RETURN_UNSUPPORTED        Image or ImageSize is invalid.
 | 
						|
                                    The LastAttemptStatus should be LAST_ATTEMPT_STATUS_ERROR_INVALID_FORMAT.
 | 
						|
  @retval RETURN_OUT_OF_RESOURCES   No Authentication handler associated with CertType.
 | 
						|
                                    The LastAttemptStatus should be LAST_ATTEMPT_STATUS_ERROR_INSUFFICIENT_RESOURCES.
 | 
						|
**/
 | 
						|
RETURN_STATUS
 | 
						|
EFIAPI
 | 
						|
AuthenticateFmpImage (
 | 
						|
  IN EFI_FIRMWARE_IMAGE_AUTHENTICATION  *Image,
 | 
						|
  IN UINTN                              ImageSize,
 | 
						|
  IN CONST UINT8                        *PublicKeyData,
 | 
						|
  IN UINTN                              PublicKeyDataLength
 | 
						|
  )
 | 
						|
{
 | 
						|
  ASSERT(FALSE);
 | 
						|
  return RETURN_UNSUPPORTED;
 | 
						|
}
 |