x509crl.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_CRL_H
#define QSC_X509_CRL_H
 
#include "qsccommon.h"
#include "x509types.h"
 
QSC_CPLUSPLUS_ENABLED_START


#define QSC_X509_CRL_ENTRY_MAX 512U

#define QSC_X509_CRL_REVOKED_MAX 1024U

typedef struct qsc_x509_crl_entry_t
{
    uint8_t serialnumber[QSC_X509_SERIAL_NUMBER_MAX];       
    size_t serialnumberlen;                                 
    qsc_asn1_time revocationdate;                           
    uint8_t rawextensions[QSC_X509_CRL_ENTRY_MAX];          
    size_t rawextensionslen;                                
} qsc_x509_crl_entry;

typedef struct qsc_x509_crl_t
{
    uint32_t version;                                       
    qsc_x509_algorithm_identifier tbsignature;              
    qsc_x509_name issuer;                                   
    qsc_asn1_time thisupdate;                               
    bool nextupdate_present;                                
    qsc_asn1_time nextupdate;                               
    qsc_x509_crl_entry revoked[QSC_X509_CRL_REVOKED_MAX];   
    size_t revokedcount;                                    
    qsc_x509_extensions extensions;                         
    qsc_x509_algorithm_identifier signaturealgorithm;       
    uint8_t signature[QSC_X509_SIGNATURE_MAX];              
    size_t signaturelen;                                    
    uint8_t signatureunusedbits;                            
    const uint8_t* tbsdata;                                 
    size_t tbsdatalen;                                      
    const uint8_t* der;                                     
    size_t derlen;                                          
} qsc_x509_crl;

typedef enum qsc_x509_crl_verify_status_t
{
 
    QSC_X509_CRL_VERIFY_STATUS_SUCCESS = 0,                 
    QSC_X509_CRL_VERIFY_STATUS_INVALID_INPUT = 1,           
    QSC_X509_CRL_VERIFY_STATUS_INVALID_CRL = 2,             
    QSC_X509_CRL_VERIFY_STATUS_ALGORITHM_MISMATCH = 3,      
    QSC_X509_CRL_VERIFY_STATUS_ISSUER_MISMATCH = 4,         
    QSC_X509_CRL_VERIFY_STATUS_EXPIRED = 5,                 
    QSC_X509_CRL_VERIFY_STATUS_NOT_YET_VALID = 6,           
    QSC_X509_CRL_VERIFY_STATUS_KEY_USAGE_REJECTED = 7,      
    QSC_X509_CRL_VERIFY_STATUS_SIGNATURE_REJECTED = 8,      
    QSC_X509_CRL_VERIFY_STATUS_CALLBACK_FAILURE = 9,        
    QSC_X509_CRL_VERIFY_STATUS_UNSUPPORTED = 10             
} qsc_x509_crl_verify_status;

typedef bool (*qsc_x509_crl_signature_verify_callback)(const qsc_x509_crl* crl, const qsc_x509_certificate* issuer, void* state);

QSC_EXPORT_API void qsc_x509_crl_clear(qsc_x509_crl* crl);

QSC_EXPORT_API qsc_asn1_status qsc_x509_crl_decode_der(const uint8_t* der, size_t derlen, qsc_x509_crl* crl);

QSC_EXPORT_API qsc_asn1_status qsc_x509_crl_encode_der(const qsc_x509_crl* crl, uint8_t* output, size_t* outputlen);

QSC_EXPORT_API bool qsc_x509_crl_is_current(const qsc_x509_crl* crl, const qsc_asn1_time* now);

QSC_EXPORT_API qsc_x509_crl_verify_status qsc_x509_crl_check_algorithms(const qsc_x509_crl* crl);

QSC_EXPORT_API const qsc_x509_crl_entry* qsc_x509_crl_find_serial(const qsc_x509_crl* crl, const uint8_t* serial, size_t seriallen);

QSC_EXPORT_API bool qsc_x509_certificate_is_revoked_by_crl(const qsc_x509_certificate* certificate, const qsc_x509_crl* crl);

QSC_EXPORT_API bool qsc_x509_crl_is_revoked(const qsc_x509_crl* crl, const qsc_x509_certificate* certificate);

QSC_EXPORT_API qsc_x509_crl_verify_status qsc_x509_crl_verify(const qsc_x509_crl* crl, const qsc_x509_certificate* issuer, const qsc_asn1_time* now, qsc_x509_crl_signature_verify_callback callback, void* state);
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif