anchor.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 UDIFANCHOR_H
#define UDIFANCHOR_H
 
#include "udif.h"


#define UDIF_ANCHOR_INTERVAL_SEC 3600U

#define UDIF_ANCHOR_MAX_AGE_MAX 7200U

#define UDIF_ANCHOR_MAX_SIZE (512U + UDIF_SIGNED_HASH_SIZE)

#define UDIF_ANCHOR_MEMBERSHIP_EVENT_COUNTER 4U

#define UDIF_ANCHOR_REGISTRY_OBJECT_COUNTER 4U

#define UDIF_ANCHOR_REGISTRY_TRANSACTION_COUNTER 4U

#define UDIF_ANCHOR_SEQUENCE_SIZE 8U

#define UDIF_ANCHOR_RECORD_SIZE (UDIF_SIGNED_HASH_SIZE + \
    UDIF_CRYPTO_HASH_SIZE +\
    UDIF_CRYPTO_HASH_SIZE + \
    UDIF_CRYPTO_HASH_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_ANCHOR_SEQUENCE_SIZE + \
    UDIF_VALID_TIME_SIZE + \
    UDIF_ANCHOR_MEMBERSHIP_EVENT_COUNTER + \
    UDIF_ANCHOR_REGISTRY_OBJECT_COUNTER + \
    UDIF_ANCHOR_REGISTRY_TRANSACTION_COUNTER)

#define UDIF_ANCHOR_SIGNING_SIZE (UDIF_CRYPTO_HASH_SIZE + \
    UDIF_CRYPTO_HASH_SIZE + \
    UDIF_CRYPTO_HASH_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_ANCHOR_SEQUENCE_SIZE + \
    UDIF_VALID_TIME_SIZE + \
    UDIF_ANCHOR_MEMBERSHIP_EVENT_COUNTER + \
    UDIF_ANCHOR_REGISTRY_OBJECT_COUNTER + \
    UDIF_ANCHOR_REGISTRY_TRANSACTION_COUNTER)

UDIF_EXPORT_API typedef struct udif_anchor_record
{
    uint8_t signature[UDIF_SIGNED_HASH_SIZE];     
    uint8_t mroot[UDIF_CRYPTO_HASH_SIZE];         
    uint8_t regroot[UDIF_CRYPTO_HASH_SIZE];         
    uint8_t txroot[UDIF_CRYPTO_HASH_SIZE];           
    uint8_t childser[UDIF_SERIAL_NUMBER_SIZE];       
    uint64_t sequence;                              
    uint64_t timestamp;                                
    uint32_t memcount;                              
    uint32_t regcount;                              
    uint32_t txcount;                                
} udif_anchor_record;

UDIF_EXPORT_API udif_errors udif_anchor_create(udif_anchor_record* anchor, const uint8_t* childser, uint64_t sequence, uint64_t timestamp,
    const uint8_t* regroot, const uint8_t* txroot, const uint8_t* mroot, uint32_t regcount, uint32_t txcount,
    uint32_t memcount, const uint8_t* childsigkey, bool (*rng_generate)(uint8_t*, size_t));

UDIF_EXPORT_API udif_errors udif_anchor_deserialize(udif_anchor_record* anchor, const uint8_t* input, size_t inplen);

UDIF_EXPORT_API udif_errors udif_anchor_compute_digest(uint8_t* digest, const udif_anchor_record* anchor);

UDIF_EXPORT_API udif_errors udif_anchor_compute_signature(udif_anchor_record* anchor, const uint8_t* sigkey, bool (*rng_generate)(uint8_t*, size_t));

UDIF_EXPORT_API void udif_anchor_clear(udif_anchor_record* anchor);

UDIF_EXPORT_API bool udif_anchor_compare(const udif_anchor_record* a, const udif_anchor_record* b);

UDIF_EXPORT_API size_t udif_anchor_encoded_size(const udif_anchor_record* anchor);

UDIF_EXPORT_API bool udif_anchor_is_fresh(const udif_anchor_record* anchor, uint64_t ctime, uint64_t maxage);

UDIF_EXPORT_API udif_errors udif_anchor_serialize(uint8_t* output, size_t outlen, const udif_anchor_record* anchor);

UDIF_EXPORT_API bool udif_anchor_validate_sequence(const udif_anchor_record* anchor, uint64_t expseq);

UDIF_EXPORT_API bool udif_anchor_verify(const udif_anchor_record* anchor, const uint8_t* childverkey, uint64_t expseq);

UDIF_EXPORT_API bool udif_anchor_verify_chain(const udif_anchor_record* prevanchor, const udif_anchor_record* nextanchor, const uint8_t* childverkey);
 
#endif