mirror of
				https://git.proxmox.com/git/mirror_edk2
				synced 2025-11-04 12:54:17 +00:00 
			
		
		
		
	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: Jian J Wang <jian.j.wang@intel.com>
		
			
				
	
	
		
			130 lines
		
	
	
		
			3.3 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			130 lines
		
	
	
		
			3.3 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
/** @file
 | 
						|
  PEM (Privacy Enhanced Mail) Format Handler Wrapper Implementation over OpenSSL.
 | 
						|
 | 
						|
Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
 | 
						|
SPDX-License-Identifier: BSD-2-Clause-Patent
 | 
						|
 | 
						|
**/
 | 
						|
 | 
						|
#include "InternalCryptLib.h"
 | 
						|
#include <openssl/pem.h>
 | 
						|
 | 
						|
/**
 | 
						|
  Callback function for password phrase conversion used for retrieving the encrypted PEM.
 | 
						|
 | 
						|
  @param[out]  Buf      Pointer to the buffer to write the passphrase to.
 | 
						|
  @param[in]   Size     Maximum length of the passphrase (i.e. the size of Buf).
 | 
						|
  @param[in]   Flag     A flag which is set to 0 when reading and 1 when writing.
 | 
						|
  @param[in]   Key      Key data to be passed to the callback routine.
 | 
						|
 | 
						|
  @retval  The number of characters in the passphrase or 0 if an error occurred.
 | 
						|
 | 
						|
**/
 | 
						|
INTN
 | 
						|
PasswordCallback (
 | 
						|
  OUT  CHAR8  *Buf,
 | 
						|
  IN   INTN   Size,
 | 
						|
  IN   INTN   Flag,
 | 
						|
  IN   VOID   *Key
 | 
						|
  )
 | 
						|
{
 | 
						|
  INTN  KeyLength;
 | 
						|
 | 
						|
  ZeroMem ((VOID *) Buf, (UINTN) Size);
 | 
						|
  if (Key != NULL) {
 | 
						|
    //
 | 
						|
    // Duplicate key phrase directly.
 | 
						|
    //
 | 
						|
    KeyLength = (INTN) AsciiStrLen ((CHAR8 *)Key);
 | 
						|
    KeyLength = (KeyLength > Size ) ? Size : KeyLength;
 | 
						|
    CopyMem (Buf, Key, (UINTN) KeyLength);
 | 
						|
    return KeyLength;
 | 
						|
  } else {
 | 
						|
    return 0;
 | 
						|
  }
 | 
						|
}
 | 
						|
 | 
						|
/**
 | 
						|
  Retrieve the RSA Private Key from the password-protected PEM key data.
 | 
						|
 | 
						|
  @param[in]  PemData      Pointer to the PEM-encoded key data to be retrieved.
 | 
						|
  @param[in]  PemSize      Size of the PEM key data in bytes.
 | 
						|
  @param[in]  Password     NULL-terminated passphrase used for encrypted PEM key data.
 | 
						|
  @param[out] RsaContext   Pointer to new-generated RSA context which contain the retrieved
 | 
						|
                           RSA private key component. Use RsaFree() function to free the
 | 
						|
                           resource.
 | 
						|
 | 
						|
  If PemData is NULL, then return FALSE.
 | 
						|
  If RsaContext is NULL, then return FALSE.
 | 
						|
 | 
						|
  @retval  TRUE   RSA Private Key was retrieved successfully.
 | 
						|
  @retval  FALSE  Invalid PEM key data or incorrect password.
 | 
						|
 | 
						|
**/
 | 
						|
BOOLEAN
 | 
						|
EFIAPI
 | 
						|
RsaGetPrivateKeyFromPem (
 | 
						|
  IN   CONST UINT8  *PemData,
 | 
						|
  IN   UINTN        PemSize,
 | 
						|
  IN   CONST CHAR8  *Password,
 | 
						|
  OUT  VOID         **RsaContext
 | 
						|
  )
 | 
						|
{
 | 
						|
  BOOLEAN  Status;
 | 
						|
  BIO      *PemBio;
 | 
						|
 | 
						|
  //
 | 
						|
  // Check input parameters.
 | 
						|
  //
 | 
						|
  if (PemData == NULL || RsaContext == NULL || PemSize > INT_MAX) {
 | 
						|
    return FALSE;
 | 
						|
  }
 | 
						|
 | 
						|
  //
 | 
						|
  // Add possible block-cipher descriptor for PEM data decryption.
 | 
						|
  // NOTE: Only support most popular ciphers (3DES, AES) for the encrypted PEM.
 | 
						|
  //
 | 
						|
  if (EVP_add_cipher (EVP_des_ede3_cbc ()) == 0) {
 | 
						|
    return FALSE;
 | 
						|
  }
 | 
						|
  if (EVP_add_cipher (EVP_aes_128_cbc ()) == 0) {
 | 
						|
    return FALSE;
 | 
						|
  }
 | 
						|
  if (EVP_add_cipher (EVP_aes_192_cbc ()) == 0) {
 | 
						|
    return FALSE;
 | 
						|
  }
 | 
						|
  if (EVP_add_cipher (EVP_aes_256_cbc ()) == 0) {
 | 
						|
    return FALSE;
 | 
						|
  }
 | 
						|
 | 
						|
  Status = FALSE;
 | 
						|
 | 
						|
  //
 | 
						|
  // Read encrypted PEM Data.
 | 
						|
  //
 | 
						|
  PemBio = BIO_new (BIO_s_mem ());
 | 
						|
  if (PemBio == NULL) {
 | 
						|
    goto _Exit;
 | 
						|
  }
 | 
						|
 | 
						|
  if (BIO_write (PemBio, PemData, (int) PemSize) <= 0) {
 | 
						|
    goto _Exit;
 | 
						|
  }
 | 
						|
 | 
						|
  //
 | 
						|
  // Retrieve RSA Private Key from encrypted PEM data.
 | 
						|
  //
 | 
						|
  *RsaContext = PEM_read_bio_RSAPrivateKey (PemBio, NULL, (pem_password_cb *) &PasswordCallback, (void *) Password);
 | 
						|
  if (*RsaContext != NULL) {
 | 
						|
    Status = TRUE;
 | 
						|
  }
 | 
						|
 | 
						|
_Exit:
 | 
						|
  //
 | 
						|
  // Release Resources.
 | 
						|
  //
 | 
						|
  BIO_free (PemBio);
 | 
						|
 | 
						|
  return Status;
 | 
						|
}
 |