x509csr.h

Go to the documentation of this file.

/* 2020-2026 Quantum Resistant Cryptographic Solutions Corporation
 * All Rights Reserved.
 *
 * NOTICE:
 * This software and all accompanying materials are the exclusive property of
 * Quantum Resistant Cryptographic Solutions Corporation (QRCS). The intellectual
 * and technical concepts contained herein are proprietary to QRCS and are
 * protected under applicable Canadian, U.S., and international copyright,
 * patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC ALGORITHMS AND IMPLEMENTATIONS:
 * - This software includes implementations of cryptographic primitives and
 *   algorithms that are standardized or in the public domain, such as AES
 *   and SHA-3, which are not proprietary to QRCS.
 * - This software also includes cryptographic primitives, constructions, and
 *   algorithms designed by QRCS, including but not limited to RCS, SCB, CSX, QMAC, and
 *   related components, which are proprietary to QRCS.
 * - All source code, implementations, protocol compositions, optimizations,
 *   parameter selections, and engineering work contained in this software are
 *   original works of QRCS and are protected under this license.
 *
 * LICENSE AND USE RESTRICTIONS:
 * - This software is licensed under the Quantum Resistant Cryptographic Solutions
 *   Public Research and Evaluation License (QRCS-PREL), 2025-2026.
 * - Permission is granted solely for non-commercial evaluation, academic research,
 *   cryptographic analysis, interoperability testing, and feasibility assessment.
 * - Commercial use, production deployment, commercial redistribution, or
 *   integration into products or services is strictly prohibited without a
 *   separate written license agreement executed with QRCS.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 *
 * EXPERIMENTAL CRYPTOGRAPHY NOTICE:
 * Portions of this software may include experimental, novel, or evolving
 * cryptographic designs. Use of this software is entirely at the user's risk.
 *
 * DISCLAIMER:
 * THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE, SECURITY, OR NON-INFRINGEMENT. QRCS DISCLAIMS ALL
 * LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING FROM THE USE OR MISUSE OF THIS SOFTWARE.
 *
 * FULL LICENSE:
 * This software is subject to the Quantum Resistant Cryptographic Solutions
 * Public Research and Evaluation License (QRCS-PREL), 2025-2026. The complete license terms
 * are provided in the accompanying LICENSE file or at https://www.qrcscorp.ca.
 *
 * Written by: John G. Underhill
 * Contact: contact@qrcscorp.ca
 */
 
#ifndef QSC_X509_CSR_H
#define QSC_X509_CSR_H
 
#include "qsccommon.h"
#include "x509types.h"
 
QSC_CPLUSPLUS_ENABLED_START


#define QSC_X509_CSR_ATTRIBUTES_MAX 8U

#define QSC_X509_CSR_ATTRIBUTE_VALUE_MAX 1024U

#define QSC_X509_CSR_WRITE_MAX 16384U

QSC_EXPORT_API typedef struct qsc_x509_csr_attribute_t
{
    qsc_asn1_oid oid;                                               
    uint8_t value[QSC_X509_CSR_ATTRIBUTE_VALUE_MAX];                
    size_t valuelen;                                                
} qsc_x509_csr_attribute;

QSC_EXPORT_API typedef struct qsc_x509_csr_t
{
    uint32_t version;                                               
    qsc_x509_name subject;                                          
    qsc_x509_subject_public_key_info spki;                          
    qsc_x509_algorithm_identifier signaturealgorithm;               
    qsc_x509_extensions extensions;                                 
    qsc_x509_csr_attribute attributes[QSC_X509_CSR_ATTRIBUTES_MAX]; 
    size_t attributecount;                                          
    uint8_t signature[QSC_X509_SIGNATURE_MAX];                      
    size_t signaturelen;                                            
    uint8_t signatureunusedbits;                                    
    const uint8_t* infodata;                                        
    size_t infodatalen;                                             
    const uint8_t* der;                                             
    size_t derlen;                                                  
    bool derowned;                                                  
} qsc_x509_csr;

typedef bool (*qsc_x509_csr_signature_verify_callback)(const qsc_x509_csr* csr, void* state);

QSC_EXPORT_API bool qsc_x509_csr_verify_with_spki(const qsc_x509_csr* csr, const qsc_x509_subject_public_key_info* signerspki);

QSC_EXPORT_API void qsc_x509_csr_initialize(qsc_x509_csr* csr);

QSC_EXPORT_API void qsc_x509_csr_clear(qsc_x509_csr* csr);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_set_subject(qsc_x509_csr* csr, const qsc_x509_name* subject);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_set_spki(qsc_x509_csr* csr, const qsc_x509_subject_public_key_info* spki);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_set_signature_algorithm(qsc_x509_csr* csr, const qsc_x509_algorithm_identifier* signaturealgorithm);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_set_extension_request(qsc_x509_csr* csr, const qsc_x509_extensions* extensions);

QSC_EXPORT_API const qsc_x509_extensions* qsc_x509_csr_get_extension_request(const qsc_x509_csr* csr);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_copy_extension_request(const qsc_x509_csr* csr, qsc_x509_extensions* extensions);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_encode_info_der(const qsc_x509_csr* csr, uint8_t* output, size_t* outputlen);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_encode_der(const qsc_x509_csr* csr, qsc_x509_certificate_sign_callback signcallback, void* context, uint8_t* output, size_t* outputlen);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_sign(const qsc_x509_csr* csr, qsc_x509_certificate_sign_callback signcallback, void* context, uint8_t* output, size_t* outputlen);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_decode_der(qsc_x509_csr* csr, const uint8_t* input, size_t inputlen);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_decode_pem(qsc_x509_csr* csr, const char* input, size_t inputlen);

QSC_EXPORT_API const qsc_x509_extension* qsc_x509_csr_find_extension(const qsc_x509_csr* csr, qsc_x509_extension_type type);

QSC_EXPORT_API bool qsc_x509_csr_verify(const qsc_x509_csr* csr);

QSC_EXPORT_API bool qsc_x509_csr_verify_ex(const qsc_x509_csr* csr, qsc_x509_csr_signature_verify_callback verifycallback, void* state);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_encode_pem(const uint8_t* der, size_t derlen, char* output, size_t* outputlen);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_add_attribute(qsc_x509_csr* csr, const qsc_asn1_oid* oid, const uint8_t* value, size_t valuelen);

QSC_EXPORT_API const qsc_x509_csr_attribute* qsc_x509_csr_get_attribute(const qsc_x509_csr* csr, const qsc_asn1_oid* oid);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_set_subject_alt_name(qsc_x509_csr* csr, const qsc_x509_subject_alt_name* subjectaltname);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_add_san_dns(qsc_x509_csr* csr, const char* dnsname, size_t dnsnamelen);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_add_san_ip(qsc_x509_csr* csr, const uint8_t* address, size_t addresslen);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_set_extended_key_usage(qsc_x509_csr* csr, const qsc_x509_extended_key_usage* extendedkeyusage);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_set_subject_key_identifier(qsc_x509_csr* csr, const qsc_x509_subject_key_identifier* subjectkeyidentifier);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_set_ml_dsa_signature_algorithm(qsc_x509_csr* csr, uint32_t level);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_set_ml_dsa_spki(qsc_x509_csr* csr, uint32_t level, const uint8_t* publickey, size_t publickeylen);

QSC_EXPORT_API qsc_asn1_status qsc_x509_csr_set_ml_kem_spki(qsc_x509_csr* csr, uint32_t level, const uint8_t* publickey, size_t publickeylen);
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif