pkcs8_key_format.h
Go to the documentation of this file.
1 /**
2  * @file pkcs8_key_format.h
3  * @brief PKCS #8 key formatting
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 _PKCS8_KEY_FORMAT_H
32 #define _PKCS8_KEY_FORMAT_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 #include "pkc/rsa.h"
37 #include "pkc/dsa.h"
38 #include "ecc/ec.h"
39 #include "ecc/eddsa.h"
40 
41 //C++ guard
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 //Key formatting functions
47 error_t pkcs8FormatRsaPrivateKey(const RsaPrivateKey *privateKey,
48  uint8_t *output, size_t *written);
49 
50 error_t pkcs8FormatDsaPrivateKey(const DsaPrivateKey *privateKey,
51  uint8_t *output, size_t *written);
52 
53 error_t pkcs8FormatEcPrivateKey(const EcPrivateKey *privateKey,
54  uint8_t *output, size_t *written);
55 
56 error_t pkcs8FormatEcPublicKey(const EcPublicKey *publicKey,
57  uint8_t *output, size_t *written);
58 
59 error_t pkcs8FormatEddsaPrivateKey(const EddsaPrivateKey *privateKey,
60  uint8_t *output, size_t *written);
61 
62 error_t pkcs8FormatEddsaPublicKey(const EddsaPublicKey *publicKey,
63  uint8_t *output, size_t *written);
64 
65 //C++ guard
66 #ifdef __cplusplus
67 }
68 #endif
69 
70 #endif
pkcs8FormatEddsaPrivateKey
error_t pkcs8FormatEddsaPrivateKey(const EddsaPrivateKey *privateKey, uint8_t *output, size_t *written)
Format an EdDSA private key.
Definition: pkcs8_key_format.c:313
pkcs8FormatEddsaPublicKey
error_t pkcs8FormatEddsaPublicKey(const EddsaPublicKey *publicKey, uint8_t *output, size_t *written)
Format an EdDSA public key.
Definition: pkcs8_key_format.c:355
error_t
error_t
Error codes.
Definition: error.h:43
EddsaPublicKey
EdDSA public key.
Definition: eddsa.h:64
eddsa.h
EdDSA (Edwards-Curve Digital Signature Algorithm)
crypto.h
General definitions for cryptographic algorithms.
rsa.h
RSA public-key cryptography standard.
dsa.h
DSA (Digital Signature Algorithm)
EcPrivateKey
EC private key.
Definition: ec.h:432
DsaPrivateKey
DSA private key.
Definition: dsa.h:72
pkcs8FormatEcPrivateKey
error_t pkcs8FormatEcPrivateKey(const EcPrivateKey *privateKey, uint8_t *output, size_t *written)
Format an EC private key.
Definition: pkcs8_key_format.c:129
pkcs8FormatDsaPrivateKey
error_t pkcs8FormatDsaPrivateKey(const DsaPrivateKey *privateKey, uint8_t *output, size_t *written)
Format a DSA private key.
Definition: pkcs8_key_format.c:92
EddsaPrivateKey
EdDSA private key.
Definition: eddsa.h:75
EcPublicKey
EC public key.
Definition: ec.h:421
pkcs8FormatEcPublicKey
error_t pkcs8FormatEcPublicKey(const EcPublicKey *publicKey, uint8_t *output, size_t *written)
Format an EC public key.
Definition: pkcs8_key_format.c:252
RsaPrivateKey
RSA private key.
Definition: rsa.h:68
pkcs8FormatRsaPrivateKey
error_t pkcs8FormatRsaPrivateKey(const RsaPrivateKey *privateKey, uint8_t *output, size_t *written)
Format an RSA private key.
Definition: pkcs8_key_format.c:55
ec.h
ECC (Elliptic Curve Cryptography)