treatystore.h

Go to the documentation of this file.

/* 2025-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 UDIF_TREATYSTORE_H
#define UDIF_TREATYSTORE_H
 
#include "treaty.h"
#include "query.h"


#define UDIF_TREATYSTORE_CAPACITY 64U

#define UDIF_TREATYSTORE_PENDING_CAPACITY 64U

UDIF_EXPORT_API typedef enum udif_treatystore_status
{
    udif_treatystore_status_unknown = 0x00U,    
    udif_treatystore_status_active = 0x01U,     
    udif_treatystore_status_revoked = 0x02U,    
    udif_treatystore_status_expired = 0x03U     
} udif_treatystore_status;

UDIF_EXPORT_API typedef struct udif_treatystore_entry
{
    udif_treaty treaty;                         
    udif_treatystore_status status;             
    uint64_t statustime;                        
    bool occupied;                              
} udif_treatystore_entry;
 

UDIF_EXPORT_API typedef struct udif_treatystore_pending_query
{
    uint8_t treatyid[UDIF_SERIAL_NUMBER_SIZE];      
    uint8_t peerser[UDIF_SERIAL_NUMBER_SIZE];       
    uint8_t queryid[UDIF_QUERY_ID_SIZE];            
    uint8_t querydigest[UDIF_CRYPTO_HASH_SIZE];     
    uint64_t expires;                               
    uint8_t querytype;                              
    bool occupied;                                  
} udif_treatystore_pending_query;

UDIF_EXPORT_API typedef struct udif_treatystore
{
    udif_treatystore_entry entries[UDIF_TREATYSTORE_CAPACITY]; 
    udif_treatystore_pending_query pending[UDIF_TREATYSTORE_PENDING_CAPACITY]; 
    size_t count;                                               
    size_t pendingcount;                                        
} udif_treatystore;

UDIF_EXPORT_API void udif_treatystore_initialize(udif_treatystore* store);

UDIF_EXPORT_API void udif_treatystore_clear(udif_treatystore* store);

UDIF_EXPORT_API udif_errors udif_treatystore_add(udif_treatystore* store, const udif_treaty* treaty, udif_treatystore_status status, uint64_t nowsecs);

UDIF_EXPORT_API const udif_treaty* udif_treatystore_find(const udif_treatystore* store, const uint8_t* treatyid);

UDIF_EXPORT_API udif_treatystore_status udif_treatystore_get_status(const udif_treatystore* store, const uint8_t* treatyid);

UDIF_EXPORT_API udif_errors udif_treatystore_set_status(udif_treatystore* store, const uint8_t* treatyid, udif_treatystore_status status, uint64_t nowsecs);

UDIF_EXPORT_API const udif_treaty* udif_treatystore_find_active_for_query(udif_treatystore* store, const uint8_t* localser, 
    const uint8_t* peerser, uint8_t querytype, uint64_t nowsecs);

UDIF_EXPORT_API udif_errors udif_treatystore_add_pending_query(udif_treatystore* store, const uint8_t* treatyid, const uint8_t* peerser, 
    const udif_query* query, uint64_t expires);

UDIF_EXPORT_API udif_errors udif_treatystore_consume_pending_response(udif_treatystore* store, const uint8_t* localser, const uint8_t* peerser,
    const udif_query_response* response, uint64_t nowsecs);
 
#endif