storage.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_STORAGE_H
#define UDIF_STORAGE_H
 
#include "udifcommon.h"
#include "udif.h"
#include "fileutils.h"


#define UDIF_STORAGE_MAX_PATH 512U

#define UDIF_STORAGE_MAX_HANDLES 16U

typedef enum udif_ledger_type
{
    UDIF_LEDGER_MEMBERSHIP = 0U,        
    UDIF_LEDGER_TRANSACTION = 1U,       
    UDIF_LEDGER_REGISTRY = 2U           
} udif_ledger_type;

typedef struct udif_file_handle
{
    FILE* fp;                           
    char path[UDIF_STORAGE_MAX_PATH];   
    uint64_t lastaccess;                
    bool isopen;                        
} udif_file_handle;

typedef struct udif_storage_context
{
    char basepath[UDIF_STORAGE_MAX_PATH];                   
    udif_file_handle handles[UDIF_STORAGE_MAX_HANDLES];     
    size_t handlecount;                                     
    udif_ledger_type currentledger;                         
    bool initialized;                                       
} udif_storage_context;

UDIF_EXPORT_API udif_errors udif_storage_initialize(udif_storage_context* ctx, const char* basepath);

UDIF_EXPORT_API void udif_storage_set_ledger(udif_storage_context* ctx, udif_ledger_type ledgertype);

UDIF_EXPORT_API void udif_storage_get_callbacks(udif_storage_context* ctx, void* callbacks);

UDIF_EXPORT_API void udif_storage_dispose(udif_storage_context* ctx);

UDIF_EXPORT_API bool udif_storage_write(void* context, const uint8_t* loc, size_t loclen, const uint8_t* data, size_t datalen);

UDIF_EXPORT_API bool udif_storage_read(void* context, const uint8_t* loc, size_t loclen, uint8_t* data, size_t datalen, size_t* outread);

UDIF_EXPORT_API bool udif_storage_append(void* context, const uint8_t* loc, size_t loclen, const uint8_t* data, size_t datalen, uint64_t* outpos);

UDIF_EXPORT_API bool udif_storage_size(void* context, const uint8_t* loc, size_t loclen, uint64_t* outlen);

UDIF_EXPORT_API bool udif_storage_flush(void* context, const uint8_t* loc, size_t loclen);
 
/* === Internal Helper Functions === */

bool udif_storage_resolve_path(const udif_storage_context* ctx, const uint8_t* loc, size_t loclen, char* outpath, size_t outpathlen);

bool udif_storage_mkdir_recursive(const char* path);

bool udif_storage_get_handle(udif_storage_context* ctx, const char* path, qsc_fileutils_mode mode, FILE** outfp);

void udif_storage_evict_handle(udif_storage_context* ctx, const char* path);

void udif_storage_close_all_handles(udif_storage_context* ctx);
 
#endif /* UDIF_STORAGE_H */