PEM file import functions. More...

#include "core/crypto.h"
#include "pkix/pem_import.h"
#include "pkix/pem_decrypt.h"
#include "pkix/pkcs5_decrypt.h"
#include "pkix/pkcs8_key_parse.h"
#include "pkix/x509_key_parse.h"
#include "encoding/asn1.h"
#include "encoding/oid.h"
#include "mpi/mpi.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL CRYPTO_TRACE_LEVEL

Functions
error_t	pemImportCertificate (const char_t input, size_t inputLen, uint8_t output, size_t outputLen, size_t consumed)
	Decode a PEM file containing a certificate. More...

error_t	pemImportCrl (const char_t input, size_t inputLen, uint8_t output, size_t outputLen, size_t consumed)
	Decode a PEM file containing a certificate revocation list. More...

error_t	pemImportCsr (const char_t input, size_t inputLen, uint8_t output, size_t *outputLen)
	Decode a PEM file containing a certification signing request. More...

error_t	pemImportDhParameters (DhParameters params, const char_t input, size_t length)
	Decode a PEM file containing Diffie-Hellman parameters. More...

error_t	pemImportRsaPublicKey (RsaPublicKey publicKey, const char_t input, size_t length)
	Decode a PEM file containing an RSA public key. More...

error_t	pemImportRsaPrivateKey (RsaPrivateKey privateKey, const char_t input, size_t length, const char_t *password)
	Decode a PEM file containing an RSA private key. More...

error_t	pemImportDsaPublicKey (DsaPublicKey publicKey, const char_t input, size_t length)
	Decode a PEM file containing a DSA public key. More...

error_t	pemImportDsaPrivateKey (DsaPrivateKey privateKey, const char_t input, size_t length, const char_t *password)
	Decode a PEM file containing a DSA private key. More...

error_t	pemImportEcPublicKey (EcPublicKey publicKey, const char_t input, size_t length)
	Decode a PEM file containing an EC public key. More...

error_t	pemImportEcPrivateKey (EcPrivateKey privateKey, const char_t input, size_t length, const char_t *password)
	Decode a PEM file containing an EC private key. More...

error_t	pemImportEddsaPublicKey (EddsaPublicKey publicKey, const char_t input, size_t length)
	Decode a PEM file containing a EdDSA public key. More...

error_t	pemImportEddsaPrivateKey (EddsaPrivateKey privateKey, const char_t input, size_t length, const char_t *password)
	Decode a PEM file containing a EdDSA private key. More...

X509KeyType	pemGetPublicKeyType (const char_t *input, size_t length)
	Extract the public key type from a PEM file. More...

const EcCurve *	pemGetPublicKeyCurve (const char_t *input, size_t length)
	Extract elliptic curve parameters from a PEM file. More...

Detailed Description

PEM file import functions.

License

SPDX-License-Identifier: GPL-2.0-or-later

This file is part of CycloneCRYPTO Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.5.0

Definition in file pem_import.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL CRYPTO_TRACE_LEVEL

Definition at line 32 of file pem_import.c.

Function Documentation

◆ pemGetPublicKeyCurve()

const EcCurve* pemGetPublicKeyCurve	(	const char_t *	input,
		size_t	length
	)

Extract elliptic curve parameters from a PEM file.

Parameters

[in]	input	Pointer to the PEM encoding
[in]	length	Length of the PEM encoding

Returns: Elliptic curve parameters

Definition at line 1455 of file pem_import.c.

◆ pemGetPublicKeyType()

X509KeyType pemGetPublicKeyType	(	const char_t *	input,
		size_t	length
	)

Extract the public key type from a PEM file.

Parameters

[in]	input	Pointer to the PEM encoding
[in]	length	Length of the PEM encoding

Returns: Public key type

Definition at line 1373 of file pem_import.c.

◆ pemImportCertificate()

error_t pemImportCertificate	(	const char_t *	input,
		size_t	inputLen,
		uint8_t *	output,
		size_t *	outputLen,
		size_t *	consumed
	)

Decode a PEM file containing a certificate.

Parameters

[in]	input	Pointer to the PEM encoding
[in]	inputLen	Length of the PEM structure
[out]	output	Pointer to the DER-encoded certificate
[out]	outputLen	Length of the DER-encoded certificate, in bytes
[out]	consumed	Total number of characters that have been consumed (optional parameter)

Returns: Error code

Definition at line 61 of file pem_import.c.

◆ pemImportCrl()

error_t pemImportCrl	(	const char_t *	input,
		size_t	inputLen,
		uint8_t *	output,
		size_t *	outputLen,
		size_t *	consumed
	)

Decode a PEM file containing a certificate revocation list.

Parameters

[in]	input	Pointer to the PEM encoding
[in]	inputLen	Length of the PEM structure
[out]	output	Pointer to the DER-encoded CRL
[out]	outputLen	Length of the DER-encoded CRL, in bytes
[out]	consumed	Total number of characters that have been consumed (optional parameter)

Returns: Error code

Definition at line 90 of file pem_import.c.

◆ pemImportCsr()

error_t pemImportCsr	(	const char_t *	input,
		size_t	inputLen,
		uint8_t *	output,
		size_t *	outputLen
	)

Decode a PEM file containing a certification signing request.

Parameters

[in]	input	Pointer to the PEM encoding
[in]	inputLen	Length of the PEM structure
[out]	output	Pointer to the DER-encoded CSR
[out]	outputLen	Length of the DER-encoded CSR, in bytes

Returns: Error code

Definition at line 117 of file pem_import.c.

◆ pemImportDhParameters()

error_t pemImportDhParameters	(	DhParameters *	params,
		const char_t *	input,
		size_t	length
	)

Decode a PEM file containing Diffie-Hellman parameters.

Parameters

[out]	params	Diffie-Hellman parameters resulting from the parsing process
[in]	input	Pointer to the PEM encoding
[in]	length	Length of the PEM encoding

Returns: Error code

Definition at line 143 of file pem_import.c.

◆ pemImportDsaPrivateKey()

error_t pemImportDsaPrivateKey	(	DsaPrivateKey *	privateKey,
		const char_t *	input,
		size_t	length,
		const char_t *	password
	)

Decode a PEM file containing a DSA private key.

Parameters

[out]	privateKey	DSA private key resulting from the parsing process
[in]	input	Pointer to the PEM encoding
[in]	length	Length of the PEM encoding
[in]	password	NULL-terminated string containing the password. This parameter is required if the private key is encrypted

Returns: Error code

Definition at line 662 of file pem_import.c.

◆ pemImportDsaPublicKey()

error_t pemImportDsaPublicKey	(	DsaPublicKey *	publicKey,
		const char_t *	input,
		size_t	length
	)

Decode a PEM file containing a DSA public key.

Parameters

[out]	publicKey	DSA public key resulting from the parsing process
[in]	input	Pointer to the PEM encoding
[in]	length	Length of the PEM encoding

Returns: Error code

Definition at line 582 of file pem_import.c.

◆ pemImportEcPrivateKey()

error_t pemImportEcPrivateKey	(	EcPrivateKey *	privateKey,
		const char_t *	input,
		size_t	length,
		const char_t *	password
	)

Decode a PEM file containing an EC private key.

Parameters

[out]	privateKey	EC private key resulting from the parsing process
[in]	input	Pointer to the PEM encoding
[in]	length	Length of the PEM encoding
[in]	password	NULL-terminated string containing the password. This parameter is required if the private key is encrypted

Returns: Error code

Definition at line 945 of file pem_import.c.

◆ pemImportEcPublicKey()

error_t pemImportEcPublicKey	(	EcPublicKey *	publicKey,
		const char_t *	input,
		size_t	length
	)

Decode a PEM file containing an EC public key.

Parameters

[out]	publicKey	EC public key resulting from the parsing process
[in]	input	Pointer to the PEM encoding
[in]	length	Length of the PEM encoding

Returns: Error code

Definition at line 865 of file pem_import.c.

◆ pemImportEddsaPrivateKey()

error_t pemImportEddsaPrivateKey	(	EddsaPrivateKey *	privateKey,
		const char_t *	input,
		size_t	length,
		const char_t *	password
	)

Decode a PEM file containing a EdDSA private key.

Parameters

[out]	privateKey	EdDSA private key resulting from the parsing process
[in]	input	Pointer to the PEM encoding
[in]	length	Length of the PEM encoding
[in]	password	NULL-terminated string containing the password. This parameter is required if the private key is encrypted

Returns: Error code

Definition at line 1228 of file pem_import.c.

◆ pemImportEddsaPublicKey()

error_t pemImportEddsaPublicKey	(	EddsaPublicKey *	publicKey,
		const char_t *	input,
		size_t	length
	)

Decode a PEM file containing a EdDSA public key.

Parameters

[out]	publicKey	EdDSA public key resulting from the parsing process
[in]	input	Pointer to the PEM encoding
[in]	length	Length of the PEM encoding

Returns: Error code

Definition at line 1148 of file pem_import.c.

◆ pemImportRsaPrivateKey()

error_t pemImportRsaPrivateKey	(	RsaPrivateKey *	privateKey,
		const char_t *	input,
		size_t	length,
		const char_t *	password
	)

Decode a PEM file containing an RSA private key.

Parameters

[out]	privateKey	RSA private key resulting from the parsing process
[in]	input	Pointer to the PEM encoding
[in]	length	Length of the PEM encoding
[in]	password	NULL-terminated string containing the password. This parameter is required if the private key is encrypted

Returns: Error code

Definition at line 379 of file pem_import.c.

◆ pemImportRsaPublicKey()

error_t pemImportRsaPublicKey	(	RsaPublicKey *	publicKey,
		const char_t *	input,
		size_t	length
	)

Decode a PEM file containing an RSA public key.

Parameters

[out]	publicKey	RSA public key resulting from the parsing process
[in]	input	Pointer to the PEM encoding
[in]	length	Length of the PEM encoding

Returns: Error code

Definition at line 252 of file pem_import.c.

Macros

Functions

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ pemGetPublicKeyCurve()

◆ pemGetPublicKeyType()

◆ pemImportCertificate()

◆ pemImportCrl()

◆ pemImportCsr()

◆ pemImportDhParameters()

◆ pemImportDsaPrivateKey()

◆ pemImportDsaPublicKey()

◆ pemImportEcPrivateKey()

◆ pemImportEcPublicKey()

◆ pemImportEddsaPrivateKey()

◆ pemImportEddsaPublicKey()

◆ pemImportRsaPrivateKey()

◆ pemImportRsaPublicKey()