QSC Post Quantum Cryptographic Library 1.3.0.0 (C1)
A post quantum secure library written in Ansi C
Loading...
Searching...
No Matches
x509keywrite.h
Go to the documentation of this file.
1/* 2020-2026 Quantum Resistant Cryptographic Solutions Corporation
2 * All Rights Reserved.
3 *
4 * NOTICE:
5 * This software and all accompanying materials are the exclusive property of
6 * Quantum Resistant Cryptographic Solutions Corporation (QRCS). The intellectual
7 * and technical concepts contained herein are proprietary to QRCS and are
8 * protected under applicable Canadian, U.S., and international copyright,
9 * patent, and trade secret laws.
10 *
11 * CRYPTOGRAPHIC ALGORITHMS AND IMPLEMENTATIONS:
12 * - This software includes implementations of cryptographic primitives and
13 * algorithms that are standardized or in the public domain, such as AES
14 * and SHA-3, which are not proprietary to QRCS.
15 * - This software also includes cryptographic primitives, constructions, and
16 * algorithms designed by QRCS, including but not limited to RCS, SCB, CSX, QMAC, and
17 * related components, which are proprietary to QRCS.
18 * - All source code, implementations, protocol compositions, optimizations,
19 * parameter selections, and engineering work contained in this software are
20 * original works of QRCS and are protected under this license.
21 *
22 * LICENSE AND USE RESTRICTIONS:
23 * - This software is licensed under the Quantum Resistant Cryptographic Solutions
24 * Public Research and Evaluation License (QRCS-PREL), 2025-2026.
25 * - Permission is granted solely for non-commercial evaluation, academic research,
26 * cryptographic analysis, interoperability testing, and feasibility assessment.
27 * - Commercial use, production deployment, commercial redistribution, or
28 * integration into products or services is strictly prohibited without a
29 * separate written license agreement executed with QRCS.
30 * - Licensing and authorized distribution are solely at the discretion of QRCS.
31 *
32 * EXPERIMENTAL CRYPTOGRAPHY NOTICE:
33 * Portions of this software may include experimental, novel, or evolving
34 * cryptographic designs. Use of this software is entirely at the user's risk.
35 *
36 * DISCLAIMER:
37 * THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
38 * IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS
39 * FOR A PARTICULAR PURPOSE, SECURITY, OR NON-INFRINGEMENT. QRCS DISCLAIMS ALL
40 * LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
41 * ARISING FROM THE USE OR MISUSE OF THIS SOFTWARE.
42 *
43 * FULL LICENSE:
44 * This software is subject to the Quantum Resistant Cryptographic Solutions
45 * Public Research and Evaluation License (QRCS-PREL), 2025-2026. The complete license terms
46 * are provided in the accompanying LICENSE file or at https://www.qrcscorp.ca.
47 *
48 * Written by: John G. Underhill
49 * Contact: contact@qrcscorp.ca
50 */
51
52#ifndef QSC_X509_KEYWRITE_H
53#define QSC_X509_KEYWRITE_H
54
55#include "qsccommon.h"
56#include "x509key.h"
57#include "x509types.h"
58
59QSC_CPLUSPLUS_ENABLED_START
60
80
85#define QSC_X509_KEY_WRITE_MAX 16384U
86
103QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_sec1_der(const qsc_x509_private_key* key, bool includeparameters, bool includepublickey, uint8_t* output, size_t* outputlen);
104
120QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_sec1_pem(const qsc_x509_private_key* key, bool includeparameters, bool includepublickey, char* output, size_t* outputlen);
121
136QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_der(const qsc_x509_private_key* key, bool includepublickey, uint8_t* output, size_t* outputlen);
137
152QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_pem(const qsc_x509_private_key* key, bool includepublickey, char* output, size_t* outputlen);
153
173QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_der_ex(const qsc_x509_algorithm_identifier* algorithm, const uint8_t* privatekey,
174 size_t privatekeylen, const uint8_t* publickey, size_t publickeylen, bool publickeypresent, uint8_t* output, size_t* outputlen);
175
195QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_pem_ex(const qsc_x509_algorithm_identifier* algorithm, const uint8_t* privatekey,
196 size_t privatekeylen, const uint8_t* publickey, size_t publickeylen, bool publickeypresent, char* output, size_t* outputlen);
197
216QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_ml_dsa_der(qsc_x509_pqc_parameter_set parameter, const uint8_t* privatekey,
217 size_t privatekeylen, const uint8_t* publickey, size_t publickeylen, bool publickeypresent, uint8_t* output, size_t* outputlen);
218
237QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_ml_dsa_pem(qsc_x509_pqc_parameter_set parameter, const uint8_t* privatekey,
238 size_t privatekeylen, const uint8_t* publickey, size_t publickeylen, bool publickeypresent, char* output, size_t* outputlen);
239
258QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_ml_kem_der(qsc_x509_pqc_parameter_set parameter, const uint8_t* privatekey,
259 size_t privatekeylen, const uint8_t* publickey, size_t publickeylen, bool publickeypresent, uint8_t* output, size_t* outputlen);
260
279QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_ml_kem_pem(qsc_x509_pqc_parameter_set parameter, const uint8_t* privatekey,
280 size_t privatekeylen, const uint8_t* publickey, size_t publickeylen, bool publickeypresent, char* output, size_t* outputlen);
281
282QSC_CPLUSPLUS_ENABLED_END
283
284#endif
enum qsc_asn1_status_t qsc_asn1_status
ASN.1 helper status codes.
Contains common definitions for the Quantum Secure Cryptographic (QSC) library.
#define QSC_EXPORT_API
API export macro for Microsoft compilers when importing from a DLL.
Definition qsccommon.h:645
A decoded private key object with optional embedded public key material.
X.509 private key decoding, size validation, and certificate-key matching interface.
QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_der_ex(const qsc_x509_algorithm_identifier *algorithm, const uint8_t *privatekey, size_t privatekeylen, const uint8_t *publickey, size_t publickeylen, bool publickeypresent, uint8_t *output, size_t *outputlen)
Encode raw private key material as PKCS #8 DER.
Definition x509keywrite.c:577
QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_der(const qsc_x509_private_key *key, bool includepublickey, uint8_t *output, size_t *outputlen)
Encode a normalized private key object as PKCS #8 DER.
Definition x509keywrite.c:525
QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_ml_dsa_der(qsc_x509_pqc_parameter_set parameter, const uint8_t *privatekey, size_t privatekeylen, const uint8_t *publickey, size_t publickeylen, bool publickeypresent, uint8_t *output, size_t *outputlen)
Encode an ML-DSA private key as PKCS #8 DER.
Definition x509keywrite.c:845
QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_ml_kem_der(qsc_x509_pqc_parameter_set parameter, const uint8_t *privatekey, size_t privatekeylen, const uint8_t *publickey, size_t publickeylen, bool publickeypresent, uint8_t *output, size_t *outputlen)
Encode an ML-KEM private key as PKCS #8 DER.
Definition x509keywrite.c:892
QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_pem_ex(const qsc_x509_algorithm_identifier *algorithm, const uint8_t *privatekey, size_t privatekeylen, const uint8_t *publickey, size_t publickeylen, bool publickeypresent, char *output, size_t *outputlen)
Encode raw private key material as PKCS #8 PEM.
Definition x509keywrite.c:799
QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_ml_kem_pem(qsc_x509_pqc_parameter_set parameter, const uint8_t *privatekey, size_t privatekeylen, const uint8_t *publickey, size_t publickeylen, bool publickeypresent, char *output, size_t *outputlen)
Encode an ML-KEM private key as PKCS #8 PEM.
Definition x509keywrite.c:916
QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_ml_dsa_pem(qsc_x509_pqc_parameter_set parameter, const uint8_t *privatekey, size_t privatekeylen, const uint8_t *publickey, size_t publickeylen, bool publickeypresent, char *output, size_t *outputlen)
Encode an ML-DSA private key as PKCS #8 PEM.
Definition x509keywrite.c:869
QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_pkcs8_pem(const qsc_x509_private_key *key, bool includepublickey, char *output, size_t *outputlen)
Encode a normalized private key object as PKCS #8 PEM.
Definition x509keywrite.c:548
QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_sec1_der(const qsc_x509_private_key *key, bool includeparameters, bool includepublickey, uint8_t *output, size_t *outputlen)
Encode a normalized private key object as SEC 1 DER.
Definition x509keywrite.c:472
QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_encode_sec1_pem(const qsc_x509_private_key *key, bool includeparameters, bool includepublickey, char *output, size_t *outputlen)
Encode a normalized private key object as SEC 1 PEM.
Definition x509keywrite.c:496