registry.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 UDIFREGISTRY_H
#define UDIFREGISTRY_H
 
#include "udif.h"
#include "object.h"


#define UDIF_REGISTRY_DEFAULT_CAPACITY 1024U

#define UDIF_REGISTRY_MAX_CAPACITY 1048576U
 

#define UDIF_REGISTRY_COMMIT_STRUCTURE_SIZE (UDIF_SIGNED_HASH_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_CRYPTO_HASH_SIZE + \
    sizeof(uint64_t) + \
    sizeof(uint64_t))

UDIF_EXPORT_API typedef struct udif_registry_commit
{
    uint8_t signature[UDIF_SIGNED_HASH_SIZE];     
    uint8_t ownerser[UDIF_SERIAL_NUMBER_SIZE];       
    uint8_t regroot[UDIF_CRYPTO_HASH_SIZE];         
    uint64_t epoch;                                
    uint64_t timestamp;                            
} udif_registry_commit;

UDIF_EXPORT_API typedef struct udif_merkle_node
{
    uint8_t hash[UDIF_CRYPTO_HASH_SIZE];       
    bool isleft;                              
} udif_merkle_node;

#define UDIF_REGISTRY_FLAG_ACTIVE 0x00000001UL

#define UDIF_REGISTRY_FLAG_DESTROYED 0x00000002UL

#define UDIF_REGISTRY_FLAG_TRANSFERRED 0x00000004UL

UDIF_EXPORT_API typedef struct udif_registry_leaf
{
    uint8_t objdigest[UDIF_CRYPTO_HASH_SIZE]; 
    uint8_t ownerdigest[UDIF_CRYPTO_HASH_SIZE]; 
    uint8_t objserial[UDIF_OBJECT_SERIAL_SIZE]; 
    uint64_t timestamp;                        
    uint32_t flags;                            
} udif_registry_leaf;

UDIF_EXPORT_API typedef struct udif_registry_state
{
    uint8_t ownerser[UDIF_SERIAL_NUMBER_SIZE];   
    uint8_t ownerdigest[UDIF_CRYPTO_HASH_SIZE]; 
    qsc_keccak_state mstate;                  
    udif_registry_leaf* leaves;             
    size_t objcount;                            
    size_t capacity;                            
    bool initialized;                            
} udif_registry_state;

UDIF_EXPORT_API udif_errors udif_registry_leaf_encode(uint8_t* output, const udif_registry_leaf* leaf);

UDIF_EXPORT_API udif_errors udif_registry_leaf_digest(uint8_t* digest, const udif_registry_leaf* leaf);

UDIF_EXPORT_API udif_errors udif_registry_add_object(udif_registry_state* reg, const udif_object* obj);

UDIF_EXPORT_API udif_errors udif_registry_add_leaf(udif_registry_state* reg, const udif_registry_leaf* leaf);

UDIF_EXPORT_API udif_errors udif_registry_get_leaf(udif_registry_leaf* leaf, const udif_registry_state* reg, const uint8_t* serial);

UDIF_EXPORT_API bool udif_registry_object_is_active(const udif_registry_state* reg, const uint8_t* serial);

UDIF_EXPORT_API udif_errors udif_registry_transfer_object(udif_registry_state* origin, udif_registry_state* dest, const udif_transfer_record* transfer);

UDIF_EXPORT_API size_t udif_registry_get_capacity(const udif_registry_state* reg);

UDIF_EXPORT_API void udif_registry_clear(udif_registry_state* reg);

UDIF_EXPORT_API udif_errors udif_registry_compute_root(uint8_t* root, const udif_registry_state* reg);

UDIF_EXPORT_API void udif_registry_dispose(udif_registry_state* reg);

UDIF_EXPORT_API bool udif_registry_find_object(const udif_registry_state* reg, const uint8_t* serial, size_t* index);

UDIF_EXPORT_API udif_errors udif_registry_generate_proof(uint8_t* proof, size_t* prooflen, const udif_registry_state* reg, const uint8_t* serial);

UDIF_EXPORT_API size_t udif_registry_get_count(const udif_registry_state* reg);

UDIF_EXPORT_API udif_errors udif_registry_get_digest_at(uint8_t* digest, const udif_registry_state* reg, size_t index);

UDIF_EXPORT_API udif_errors udif_registry_initialize(udif_registry_state* reg, const uint8_t* ownerser, size_t capacity);

UDIF_EXPORT_API bool udif_registry_is_full(const udif_registry_state* reg);

UDIF_EXPORT_API udif_errors udif_registry_remove_object(udif_registry_state* reg, const uint8_t* serial);

UDIF_EXPORT_API udif_errors udif_registry_resize(udif_registry_state* reg, size_t newcapacity);

UDIF_EXPORT_API udif_errors udif_registry_update_object(udif_registry_state* reg, const udif_object* obj);

UDIF_EXPORT_API bool udif_registry_verify_proof(const uint8_t* proof, size_t prooflen, const uint8_t* root, const uint8_t* objdigest);

UDIF_EXPORT_API void udif_registry_commit_clear(udif_registry_commit* commit);

UDIF_EXPORT_API udif_errors udif_registry_commit_digest(uint8_t* digest, const udif_registry_commit* commit);

UDIF_EXPORT_API udif_errors udif_registry_commit_deserialize(udif_registry_commit* commit, const uint8_t* input, size_t inlen);

UDIF_EXPORT_API udif_errors udif_registry_commit_serialize(uint8_t* output, size_t outlen, const udif_registry_commit* commit);

UDIF_EXPORT_API udif_errors udif_registry_commit_sign(udif_registry_commit* commit, const uint8_t* sigkey, bool (*rng_generate)(uint8_t*, size_t));

UDIF_EXPORT_API bool udif_registry_commit_verify(const udif_registry_commit* commit, const uint8_t* verkey);
 
#endif