asn1.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_ASN1_H
#define QSC_ASN1_H
 
#include "qsccommon.h"
#include "encoding.h"
 
QSC_CPLUSPLUS_ENABLED_START


#define QSC_ASN1_OID_MAX_SIZE 32U

#define QSC_ASN1_OID_MAX_ARCS 16U

#define QSC_ASN1_BIT_STRING_MAX_UNUSED_BITS 7U

typedef enum qsc_asn1_status_t
{
    QSC_ASN1_STATUS_SUCCESS = 0,            
    QSC_ASN1_STATUS_FAILURE = -1,           
    QSC_ASN1_STATUS_INVALID_INPUT = -2,     
    QSC_ASN1_STATUS_INVALID_TAG = -3,       
    QSC_ASN1_STATUS_INVALID_LENGTH = -4,    
    QSC_ASN1_STATUS_INVALID_ENCODING = -5,  
    QSC_ASN1_STATUS_BUFFER_TOO_SMALL = -6,  
    QSC_ASN1_STATUS_OUT_OF_RANGE = -7,      
    QSC_ASN1_STATUS_NOT_FOUND = -8,         
    QSC_ASN1_STATUS_UNSUPPORTED = -9        
} qsc_asn1_status;

QSC_EXPORT_API typedef struct qsc_asn1_oid_t
{
    uint8_t data[QSC_ASN1_OID_MAX_SIZE];    
    uint32_t arcs[QSC_ASN1_OID_MAX_ARCS];   
    size_t length;                          
    size_t arcscount;                       
} qsc_asn1_oid;

QSC_EXPORT_API typedef struct qsc_asn1_bit_string_t
{
    const uint8_t* data;                    
    size_t length;                          
    uint8_t unused;                         
} qsc_asn1_bit_string;

QSC_EXPORT_API typedef struct qsc_asn1_time_t
{
    uint16_t year;                          
    uint8_t month;                          
    uint8_t day;                            
    uint8_t hour;                           
    uint8_t minute;                         
    uint8_t second;                         
    bool generalized;                       
} qsc_asn1_time;

QSC_EXPORT_API qsc_asn1_status qsc_asn1_der_decode_exact(const uint8_t* der, size_t derlen, qsc_encoding_ber_element** element);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_der_get_child_region(const uint8_t* der, size_t derlen, size_t index, const uint8_t** child, size_t* childlen);

QSC_EXPORT_API bool qsc_asn1_oid_compare(const qsc_asn1_oid* a, const qsc_asn1_oid* b);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_require_sequence(const qsc_encoding_ber_element* element, size_t minchildren, size_t maxchildren);

QSC_EXPORT_API const qsc_encoding_ber_element* qsc_asn1_get_child(const qsc_encoding_ber_element* element, size_t index);

QSC_EXPORT_API bool qsc_asn1_is_boolean(const qsc_encoding_ber_element* element);

QSC_EXPORT_API bool qsc_asn1_is_integer(const qsc_encoding_ber_element* element);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_decode_integer_u64(const qsc_encoding_ber_element* element, uint64_t* value);

QSC_EXPORT_API bool qsc_asn1_is_null(const qsc_encoding_ber_element* element);

QSC_EXPORT_API bool qsc_asn1_is_oid(const qsc_encoding_ber_element* element);

QSC_EXPORT_API bool qsc_asn1_element_is_tag(const qsc_encoding_ber_element* element, uint8_t tagclass, bool constructed, uint32_t tagnumber);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_require_tag(const qsc_encoding_ber_element* element, uint8_t tagclass, bool constructed, uint32_t tagnumber);

QSC_EXPORT_API size_t qsc_asn1_child_count(const qsc_encoding_ber_element* element);

QSC_EXPORT_API const qsc_encoding_ber_element* qsc_asn1_child_at(const qsc_encoding_ber_element* element, size_t index);

QSC_EXPORT_API const qsc_encoding_ber_element* qsc_asn1_find_context_child(const qsc_encoding_ber_element* element, uint32_t tagnumber);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_get_explicit_child(const qsc_encoding_ber_element* element, const qsc_encoding_ber_element** child);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_decode_boolean(const qsc_encoding_ber_element* element, bool* value);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_decode_uint64(const qsc_encoding_ber_element* element, uint64_t* value);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_decode_octet_string(const qsc_encoding_ber_element* element, uint8_t* output, size_t otplen, size_t* outlen);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_decode_bit_string(const qsc_encoding_ber_element* element, qsc_asn1_bit_string* value);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_decode_null(const qsc_encoding_ber_element* element);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_decode_oid(const qsc_encoding_ber_element* element, qsc_asn1_oid* oid);

QSC_EXPORT_API bool qsc_asn1_oid_are_equal(const qsc_asn1_oid* a, const qsc_asn1_oid* b);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_oid_to_string(const qsc_asn1_oid* oid, char* output, size_t otplen);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_decode_string(const qsc_encoding_ber_element* element, char* output, size_t otplen, size_t* outlen);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_decode_time(const qsc_encoding_ber_element* element, qsc_asn1_time* value);

QSC_EXPORT_API int32_t qsc_asn1_time_compare(const qsc_asn1_time* a, const qsc_asn1_time* b);

QSC_EXPORT_API qsc_asn1_status qsc_asn1_der_size(const qsc_encoding_ber_element* element, size_t* size);
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif