QSC Post Quantum Cryptographic Library 1.1.0.2 (B2)
A post quantum secure library written in Ansi C
Loading...
Searching...
No Matches
x509pem.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_PEM_H
53#define QSC_X509_PEM_H
54
55#include "qsccommon.h"
56#include "x509cert.h"
57#include "x509crl.h"
58#include "x509csr.h"
59#include "x509key.h"
60#include "x509types.h"
61
62QSC_CPLUSPLUS_ENABLED_START
63
86
91#define QSC_X509_PEM_DER_MAX 16384U
92
110#define QSC_X509_PEM_BINARY_MAX 8192U
111
138#define QSC_X509_PEM_TEXT_MAX ((((QSC_X509_PEM_BINARY_MAX + 2U) / 3U) * 4U) + 512U)
139
153QSC_EXPORT_API qsc_asn1_status qsc_x509_certificate_decode_pem(const char* pem, size_t pemlen, qsc_x509_certificate* certificate);
154
166QSC_EXPORT_API void qsc_x509_chain_free(qsc_x509_chain* chain);
167
179QSC_EXPORT_API void qsc_x509_store_free(qsc_x509_store* store);
180
197QSC_EXPORT_API qsc_asn1_status qsc_x509_chain_decode_pem_bundle(const char* pem, size_t pemlen, qsc_x509_certificate* certificates, size_t certcount, qsc_x509_chain* chain);
198
215QSC_EXPORT_API qsc_asn1_status qsc_x509_store_load_pem_bundle(const char* pem, size_t pemlen, qsc_x509_trust_anchor* anchors, size_t anchorcount, qsc_x509_store* store);
216
231
245QSC_EXPORT_API qsc_asn1_status qsc_x509_crl_decode_pem(const char* pem, size_t pemlen, qsc_x509_crl* crl);
246
261
276
291
313QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_decode_pkcs8_pem_ex_from_bundle(const char* pem, size_t pemlen, qsc_x509_algorithm_identifier* algorithm,
314 uint8_t* privatekey, size_t privatekeycapacity, size_t* privatekeylen, uint8_t* publickey, size_t publickeycapacity, size_t* publickeylen, bool* publickeypresent);
315
326QSC_EXPORT_API qsc_asn1_status qsc_x509_pem_encode_private_key_pkcs8(const uint8_t* der, size_t derlen, char* pem, size_t* pemlen);
327
338QSC_EXPORT_API qsc_asn1_status qsc_x509_pem_encode_private_key_sec1(const uint8_t* der, size_t derlen, char* pem, size_t* pemlen);
339
355 char* pem, size_t* pemlen);
356
372QSC_EXPORT_API qsc_asn1_status qsc_x509_pem_encode_private_key_sec1_from_key(const qsc_x509_private_key* key, bool includeparameters, bool includepublickey, char* pem, size_t* pemlen);
373
384QSC_EXPORT_API qsc_asn1_status qsc_x509_pem_encode_certificate(const uint8_t* der, size_t derlen, char* pem, size_t* pemlen);
385
396QSC_EXPORT_API qsc_asn1_status qsc_x509_pem_encode_crl(const uint8_t* der, size_t derlen, char* pem, size_t* pemlen);
397
408QSC_EXPORT_API qsc_asn1_status qsc_x509_pem_encode_csr(const uint8_t* der, size_t derlen, char* pem, size_t* pemlen);
409
410QSC_CPLUSPLUS_ENABLED_END
411
412#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:605
A decoded X.509 CertificateList object.
A decoded private key object with optional embedded public key material.
X.509 certificate revocation list parsing, encoding, lookup, and verification interface.
PKCS#10 certificate signing request encoding, decoding, mutation, and verification interface.
QSC_EXPORT_API struct qsc_x509_csr_t qsc_x509_csr
A decoded or mutable PKCS#10 certificate signing request.
X.509 private key decoding, size validation, and certificate-key matching interface.
QSC_EXPORT_API qsc_asn1_status qsc_x509_pem_encode_private_key_pkcs8_from_key(const qsc_x509_private_key *key, bool includepublickey, char *pem, size_t *pemlen)
Encode a normalized private key object as PKCS #8 PEM.
Definition x509pem.c:687
QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_decode_pem_from_bundle(const char *pem, size_t pemlen, qsc_x509_private_key *key)
Decode a private key from a PEM bundle.
Definition x509pem.c:622
QSC_EXPORT_API qsc_asn1_status qsc_x509_pem_encode_crl(const uint8_t *der, size_t derlen, char *pem, size_t *pemlen)
Convert a DER encoded CRL to PEM.
Definition x509pem.c:536
QSC_EXPORT_API void qsc_x509_chain_free(qsc_x509_chain *chain)
Free the resources associated with a decoded certificate chain.
Definition x509pem.c:496
QSC_EXPORT_API qsc_asn1_status qsc_x509_pem_encode_certificate(const uint8_t *der, size_t derlen, char *pem, size_t *pemlen)
Convert a DER encoded certificate to PEM.
Definition x509pem.c:531
QSC_EXPORT_API qsc_asn1_status qsc_x509_certificate_decode_pem(const char *pem, size_t pemlen, qsc_x509_certificate *certificate)
Decode a PEM encoded certificate.
Definition x509pem.c:292
QSC_EXPORT_API qsc_asn1_status qsc_x509_pem_encode_private_key_sec1(const uint8_t *der, size_t derlen, char *pem, size_t *pemlen)
Convert a DER encoded SEC 1 private key to PEM.
Definition x509pem.c:682
QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_decode_sec1_pem_from_bundle(const char *pem, size_t pemlen, qsc_x509_private_key *key)
Decode a SEC 1 private key from a PEM bundle.
Definition x509pem.c:551
QSC_EXPORT_API qsc_asn1_status qsc_x509_crl_decode_pem(const char *pem, size_t pemlen, qsc_x509_crl *crl)
Decode a CRL from a PEM bundle.
Definition x509pem.c:443
QSC_EXPORT_API qsc_asn1_status qsc_x509_pem_encode_csr(const uint8_t *der, size_t derlen, char *pem, size_t *pemlen)
Convert a DER encoded CSR to PEM.
Definition x509pem.c:546
QSC_EXPORT_API qsc_asn1_status qsc_x509_pem_encode_private_key_pkcs8(const uint8_t *der, size_t derlen, char *pem, size_t *pemlen)
Convert a DER encoded PKCS #8 private key to PEM.
Definition x509pem.c:677
QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_decode_pkcs8_pem_ex_from_bundle(const char *pem, size_t pemlen, qsc_x509_algorithm_identifier *algorithm, uint8_t *privatekey, size_t privatekeycapacity, size_t *privatekeylen, uint8_t *publickey, size_t publickeycapacity, size_t *publickeylen, bool *publickeypresent)
Decode a PKCS #8 private key from a PEM bundle into caller-supplied buffers.
Definition x509pem.c:639
QSC_EXPORT_API qsc_asn1_status qsc_x509_chain_decode_pem_bundle(const char *pem, size_t pemlen, qsc_x509_certificate *certificates, size_t certcount, qsc_x509_chain *chain)
Decode a PEM certificate bundle into a chain object.
Definition x509pem.c:324
QSC_EXPORT_API qsc_asn1_status qsc_x509_private_key_decode_pkcs8_pem_from_bundle(const char *pem, size_t pemlen, qsc_x509_private_key *key)
Decode a PKCS #8 private key from a PEM bundle.
Definition x509pem.c:586
QSC_EXPORT_API qsc_asn1_status qsc_x509_store_load_pem_bundle(const char *pem, size_t pemlen, qsc_x509_trust_anchor *anchors, size_t anchorcount, qsc_x509_store *store)
Load a PEM trust-anchor bundle into a certificate store.
Definition x509pem.c:406
QSC_EXPORT_API qsc_asn1_status qsc_x509_pem_encode_private_key_sec1_from_key(const qsc_x509_private_key *key, bool includeparameters, bool includepublickey, char *pem, size_t *pemlen)
Encode a normalized private key object as SEC 1 PEM.
Definition x509pem.c:692
QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_decode_pem_from_bundle(const char *pem, size_t pemlen, qsc_x509_csr *csr)
Decode a CSR from a PEM bundle.
Definition x509pem.c:541
QSC_EXPORT_API void qsc_x509_store_free(qsc_x509_store *store)
Free the resources associated with a certificate store.
Definition x509pem.c:513