logging.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_LOGGING_H
#define UDIF_LOGGING_H
 
#include "udif.h"

 

#define UDIF_LOG_DEFAULT_CAPACITY 1024U

#define UDIF_LOG_MAX_CAPACITY 10485760U

#define UDIF_LOG_MAX_DATA_SIZE 65535U

UDIF_EXPORT_API typedef enum udif_logging_type
{
    udif_logging_membership = 0,         
    udif_logging_transaction = 1            
} udif_logging_type;

UDIF_EXPORT_API typedef struct udif_logging_entry
{
    uint16_t event_code;                        
    uint8_t subject_serial[UDIF_SERIAL_NUMBER_SIZE];   
    uint64_t timestamp;                         
    uint8_t* data;                              
    size_t datalen;                             
    uint8_t digest[UDIF_CRYPTO_HASH_SIZE];           
    uint8_t signature[UDIF_SIGNED_HASH_SIZE];     
} udif_logging_entry;

UDIF_EXPORT_API typedef struct udif_logging_state
{
    udif_logging_type type;                    
    uint8_t owner_serial[UDIF_SERIAL_NUMBER_SIZE]; 
    udif_logging_entry* entries;            
    size_t entry_count;                     
    size_t capacity;                        
    bool initialized;                       
} udif_logging_state;

UDIF_EXPORT_API udif_errors udif_logging_initialize(udif_logging_state* log, udif_logging_type logtype, const uint8_t* ownerser, size_t capacity);

UDIF_EXPORT_API udif_errors udif_logging_append(udif_logging_state* log, uint16_t eventcode, const uint8_t* subjser, uint64_t timestamp,
    const uint8_t* data, size_t datalen, const uint8_t* sigkey, bool (*rng_generate)(uint8_t*, size_t));

UDIF_EXPORT_API udif_errors udif_logging_compute_root(uint8_t* root, const udif_logging_state* log, size_t fromseq, size_t toseq);

UDIF_EXPORT_API udif_errors udif_logging_generate_proof(uint8_t* proof, size_t* prooflen, const udif_logging_state* log, size_t entryseq);

UDIF_EXPORT_API bool udif_logging_verify_proof(const uint8_t* proof, size_t prooflen, const uint8_t* root, const uint8_t* entrydigest);

UDIF_EXPORT_API udif_errors udif_logging_get_entry(udif_logging_entry* entry, const udif_logging_state* log, size_t seq);

UDIF_EXPORT_API size_t udif_logging_get_count(const udif_logging_state* log);

UDIF_EXPORT_API bool udif_logging_verify_entry(const udif_logging_entry* entry, const uint8_t* verkey);

UDIF_EXPORT_API void udif_logging_compute_entry_digest(uint8_t* digest, const udif_logging_entry* entry);

UDIF_EXPORT_API udif_errors udif_logging_resize(udif_logging_state* log, size_t capacity);

UDIF_EXPORT_API void udif_logging_dispose(udif_logging_state* log);

UDIF_EXPORT_API void udif_logging_clear(udif_logging_state* log);

UDIF_EXPORT_API void udif_logging_entry_clear(udif_logging_entry* entry);

UDIF_EXPORT_API udif_errors udif_logging_entry_serialize(uint8_t* output, size_t* outlen, const udif_logging_entry* entry);

UDIF_EXPORT_API udif_errors udif_logging_entry_deserialize(udif_logging_entry* entry, const uint8_t* input, size_t inlen);

UDIF_EXPORT_API bool udif_logging_is_empty(const udif_logging_state* log);

UDIF_EXPORT_API bool udif_logging_is_full(const udif_logging_state* log);

UDIF_EXPORT_API udif_errors udif_logging_get_statistics(const udif_logging_state* log, size_t* count, size_t* capacity, uint8_t* root);
 
#endif