pem_import.h
Go to the documentation of this file.
1 /**
2  * @file pem_import.h
3  * @brief PEM file import functions
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2025 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneCRYPTO Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.5.0
29  **/
30 
31 #ifndef _PEM_IMPORT_H
32 #define _PEM_IMPORT_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 #include "pkix/pem_common.h"
37 #include "pkix/x509_common.h"
38 #include "pkc/dh.h"
39 #include "pkc/rsa.h"
40 #include "pkc/dsa.h"
41 #include "ecc/ec.h"
42 #include "ecc/eddsa.h"
43 
44 //C++ guard
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 //PEM related functions
50 error_t pemImportCertificate(const char_t *input, size_t inputLen,
51  uint8_t *output, size_t *outputLen, size_t *consumed);
52 
53 error_t pemImportCrl(const char_t *input, size_t inputLen,
54  uint8_t *output, size_t *outputLen, size_t *consumed);
55 
56 error_t pemImportCsr(const char_t *input, size_t inputLen,
57  uint8_t *output, size_t *outputLen);
58 
59 error_t pemImportDhParameters(DhParameters *params, const char_t *input,
60  size_t length);
61 
62 error_t pemImportRsaPublicKey(RsaPublicKey *publicKey, const char_t *input,
63  size_t length);
64 
65 error_t pemImportRsaPrivateKey(RsaPrivateKey *privateKey, const char_t *input,
66  size_t length, const char_t *password);
67 
68 error_t pemImportDsaPublicKey(DsaPublicKey *publicKey, const char_t *input,
69  size_t length);
70 
71 error_t pemImportDsaPrivateKey(DsaPrivateKey *privateKey, const char_t *input,
72  size_t length, const char_t *password);
73 
74 error_t pemImportEcPublicKey(EcPublicKey *publicKey, const char_t *input,
75  size_t length);
76 
77 error_t pemImportEcPrivateKey(EcPrivateKey *privateKey, const char_t *input,
78  size_t length, const char_t *password);
79 
80 error_t pemImportEddsaPublicKey(EddsaPublicKey *publicKey, const char_t *input,
81  size_t length);
82 
84  const char_t *input, size_t length, const char_t *password);
85 
86 X509KeyType pemGetPublicKeyType(const char_t *input, size_t length);
87 const EcCurve *pemGetPublicKeyCurve(const char_t *input, size_t length);
88 
89 //C++ guard
90 #ifdef __cplusplus
91 }
92 #endif
93 
94 #endif
X.509 common definitions.
error_t pemImportRsaPublicKey(RsaPublicKey *publicKey, const char_t *input, size_t length)
Decode a PEM file containing an RSA public key.
Definition: pem_import.c:252
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.
Definition: pem_import.c:117
X509KeyType pemGetPublicKeyType(const char_t *input, size_t length)
Extract the public key type from a PEM file.
Definition: pem_import.c:1373
error_t pemImportEddsaPublicKey(EddsaPublicKey *publicKey, const char_t *input, size_t length)
Decode a PEM file containing a EdDSA public key.
Definition: pem_import.c:1148
PEM common definitions.
Diffie-Hellman key exchange.
DSA public key.
Definition: dsa.h:61
error_t
Error codes.
Definition: error.h:43
EdDSA public key.
Definition: eddsa.h:64
RSA public key.
Definition: rsa.h:57
EdDSA (Edwards-Curve Digital Signature Algorithm)
General definitions for cryptographic algorithms.
RSA public-key cryptography standard.
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.
Definition: pem_import.c:90
DSA (Digital Signature Algorithm)
EC private key.
Definition: ec.h:432
DSA private key.
Definition: dsa.h:72
uint8_t length
Definition: tcp.h:375
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.
Definition: pem_import.c:379
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.
Definition: pem_import.c:61
EdDSA private key.
Definition: eddsa.h:75
EC public key.
Definition: ec.h:421
char char_t
Definition: compiler_port.h:55
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.
Definition: pem_import.c:1228
error_t pemImportDsaPublicKey(DsaPublicKey *publicKey, const char_t *input, size_t length)
Decode a PEM file containing a DSA public key.
Definition: pem_import.c:582
RSA private key.
Definition: rsa.h:68
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.
Definition: pem_import.c:662
#define EcCurve
Definition: ec.h:346
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.
Definition: pem_import.c:945
Diffie-Hellman parameters.
Definition: dh.h:49
error_t pemImportDhParameters(DhParameters *params, const char_t *input, size_t length)
Decode a PEM file containing Diffie-Hellman parameters.
Definition: pem_import.c:143
X509KeyType
Public Key types.
Definition: x509_common.h:633
ECC (Elliptic Curve Cryptography)
error_t pemImportEcPublicKey(EcPublicKey *publicKey, const char_t *input, size_t length)
Decode a PEM file containing an EC public key.
Definition: pem_import.c:865
const EcCurve * pemGetPublicKeyCurve(const char_t *input, size_t length)
Extract elliptic curve parameters from a PEM file.
Definition: pem_import.c:1455