entity.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_ENTITY_H
#define UDIF_ENTITY_H
 
#include "udif.h"
#include "certificate.h"
#include "certstore.h"
#include "capstore.h"
#include "treatystore.h"
#include "mcelmanager.h"
#include "registry.h"
#include "tunnel.h"
#include "qstp.h"


#define UDIF_ENTITY_MAX_TUNNELS 64U

#define UDIF_ENTITY_MAX_ANCHOR_STATES 64U

#define UDIF_ENTITY_MAX_REGISTRIES 64U
 
/* Tunnel table */

UDIF_EXPORT_API typedef struct udif_tunnel_table
{
    udif_tunnel entries[UDIF_ENTITY_MAX_TUNNELS];  
    size_t count;                                  
} udif_tunnel_table;
 

UDIF_EXPORT_API typedef struct udif_anchor_sequence_state
{
    uint8_t childser[UDIF_SERIAL_NUMBER_SIZE];   
    uint64_t nextseq;                            
    bool used;                                  
} udif_anchor_sequence_state;
 

UDIF_EXPORT_API typedef struct udif_entity_registry_entry
{
    uint8_t ownerser[UDIF_SERIAL_NUMBER_SIZE];   
    udif_registry_state registry;                
    bool used;                                  
} udif_entity_registry_entry;
 
/* Entity context */

UDIF_EXPORT_API typedef struct udif_entity_context
{
    udif_certificate selfcert;                  
    udif_certificate parentcert;              
    udif_certificate rootcert;                  
    udif_certstore certstore;                    
    udif_capstore capstore;                        
    udif_treatystore treatystore;                
    udif_signature_keypair selfkeypair;            
    uint8_t capabilitykey[UDIF_CRYPTO_KEY_SIZE]; 
    bool hascapabilitykey;                      
    qstp_root_certificate qstprootcert;         
    qstp_server_signature_key qstpserverkey;   
    udif_mcel_manager* mcelmgr;                 
    udif_tunnel_table tunnels;                  
    udif_anchor_sequence_state anchorseq[UDIF_ENTITY_MAX_ANCHOR_STATES]; 
    udif_entity_registry_entry registries[UDIF_ENTITY_MAX_REGISTRIES];    
    uint64_t nextanchorsecs;                  
    udif_roles role;                          
    bool haslistener;                            
    bool initialized;                            
} udif_entity_context;

UDIF_EXPORT_API typedef struct udif_entity_config
{
    const udif_certificate* selfcert;           
    const udif_certificate* parentcert;           
    const udif_certificate* rootcert;           
    const udif_signature_keypair* selfkeypair; 
    const uint8_t* capabilitykey;              
    const qstp_root_certificate* qstprootcert;  
    const qstp_server_signature_key* qstpserverkey;    
    const char* mcelbasepath;                   
    const udif_checkpoint_config* checkconfig; 
    udif_roles role;                          
    bool haslistener;                            
} udif_entity_config;
 
/* Anchor sequence state */

UDIF_EXPORT_API udif_errors udif_entity_anchor_expected_sequence(const udif_entity_context* ctx, const uint8_t* childser, uint64_t* expseq);

UDIF_EXPORT_API udif_errors udif_entity_anchor_commit_sequence(udif_entity_context* ctx, const uint8_t* childser, uint64_t acceptedseq);
 
/* Lifecycle */

UDIF_EXPORT_API udif_errors udif_entity_init(udif_entity_context* ctx, const udif_entity_config* cfg);

UDIF_EXPORT_API void udif_entity_dispose(udif_entity_context* ctx);
 
/* Runtime registry state */

UDIF_EXPORT_API udif_registry_state* udif_entity_registry_find(udif_entity_context* ctx, const uint8_t* ownerser);

UDIF_EXPORT_API const udif_registry_state* udif_entity_registry_find_const(const udif_entity_context* ctx, const uint8_t* ownerser);

UDIF_EXPORT_API udif_registry_state* udif_entity_registry_get_or_create(udif_entity_context* ctx, const uint8_t* ownerser, size_t capacity);

UDIF_EXPORT_API void udif_entity_registry_clear_all(udif_entity_context* ctx);
 
/* Tunnel table operations */

UDIF_EXPORT_API udif_tunnel* udif_entity_add_tunnel(udif_entity_context* ctx, const udif_tunnel* tun);

UDIF_EXPORT_API udif_tunnel* udif_entity_find_tunnel(udif_entity_context* ctx, const uint8_t* peerserial, const uint8_t* treatyid);

UDIF_EXPORT_API udif_tunnel* udif_entity_find_tunnel_by_qstp(udif_entity_context* ctx, const qstp_connection_state* qstpcns);

UDIF_EXPORT_API void udif_entity_remove_tunnel(udif_entity_context* ctx, udif_tunnel* tun, bool notify);

UDIF_EXPORT_API void udif_entity_tick_tunnels(udif_entity_context* ctx, uint64_t nowsecs);
 
/* Tunnel-table convenience wrappers
 * The following functions accept a bare udif_tunnel_table* instead of
 * udif_entity_context*.  They are used by the role modules (bc.c, gc.c,
 * root.c, ua.c) which maintain tunnel state directly inside
 * udif_server_application_state::tunnels.  Each wrapper builds a
 * minimal temporary entity_context containing only the tunnel table,
 * then delegates to the corresponding full-context function.
 */

UDIF_EXPORT_API udif_tunnel* udif_tunneltable_add(udif_tunnel_table* table, const udif_tunnel* tun);

UDIF_EXPORT_API udif_tunnel* udif_tunneltable_find(udif_tunnel_table* table, const uint8_t* peerserial, const uint8_t* treatyid);

UDIF_EXPORT_API udif_tunnel* udif_tunneltable_find_by_qstp(udif_tunnel_table* table, const qstp_connection_state* qstpcns);

UDIF_EXPORT_API void udif_tunneltable_remove(udif_tunnel_table* table, udif_tunnel* tun, bool notify);

UDIF_EXPORT_API void udif_tunneltable_tick(udif_tunnel_table* table, uint64_t nowsecs);
 
#endif