CryptPem.c File Reference

#include "InternalCryptLib.h"
#include <openssl/pem.h>

Go to the source code of this file.

Functions
INTN	PasswordCallback (OUT CHAR8 *Buf, IN INTN Size, IN INTN Flag, IN VOID *Key)
BOOLEAN EFIAPI	RsaGetPrivateKeyFromPem (IN CONST UINT8 *PemData, IN UINTN PemSize, IN CONST CHAR8 *Password, OUT VOID **RsaContext)
BOOLEAN EFIAPI	EcGetPrivateKeyFromPem (IN CONST UINT8 *PemData, IN UINTN PemSize, IN CONST CHAR8 *Password, OUT VOID **EcContext)

Detailed Description

PEM (Privacy Enhanced Mail) Format Handler Wrapper Implementation over OpenSSL.

Copyright (c) 2010 - 2020, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file CryptPem.c.

Function Documentation

EcGetPrivateKeyFromPem()

BOOLEAN EFIAPI EcGetPrivateKeyFromPem	(	IN CONST UINT8 *	PemData,
		IN UINTN	PemSize,
		IN CONST CHAR8 *	Password,
		OUT VOID **	EcContext
	)

Retrieve the EC Private Key from the password-protected PEM key data.

Parameters

[in]	PemData	Pointer to the PEM-encoded key data to be retrieved.
[in]	PemSize	Size of the PEM key data in bytes.
[in]	Password	NULL-terminated passphrase used for encrypted PEM key data.
[out]	EcContext	Pointer to new-generated EC DSA context which contain the retrieved EC private key component. Use EcFree() function to free the resource.

If PemData is NULL, then return FALSE. If EcContext is NULL, then return FALSE.

Return values

TRUE	EC Private Key was retrieved successfully.
FALSE	Invalid PEM key data or incorrect password.

Definition at line 149 of file CryptPem.c.

PasswordCallback()

INTN PasswordCallback	(	OUT CHAR8 *	Buf,
		IN INTN	Size,
		IN INTN	Flag,
		IN VOID *	Key
	)

Callback function for password phrase conversion used for retrieving the encrypted PEM.

Parameters

[out]	Buf	Pointer to the buffer to write the passphrase to.
[in]	Size	Maximum length of the passphrase (i.e. the size of Buf).
[in]	Flag	A flag which is set to 0 when reading and 1 when writing.
[in]	Key	Key data to be passed to the callback routine.

Return values

The	number of characters in the passphrase or 0 if an error occurred.

Definition at line 24 of file CryptPem.c.

RsaGetPrivateKeyFromPem()

BOOLEAN EFIAPI RsaGetPrivateKeyFromPem	(	IN CONST UINT8 *	PemData,
		IN UINTN	PemSize,
		IN CONST CHAR8 *	Password,
		OUT VOID **	RsaContext
	)

Retrieve the RSA Private Key from the password-protected PEM key data.

Parameters

[in]	PemData	Pointer to the PEM-encoded key data to be retrieved.
[in]	PemSize	Size of the PEM key data in bytes.
[in]	Password	NULL-terminated passphrase used for encrypted PEM key data.
[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.

Return values

TRUE	RSA Private Key was retrieved successfully.
FALSE	Invalid PEM key data or incorrect password.

Definition at line 66 of file CryptPem.c.