capstore.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_CAPSTORE_H
#define UDIF_CAPSTORE_H
 
#include "udif.h"
#include "capability.h"


#define UDIF_CAPSTORE_CAPACITY 128U

UDIF_EXPORT_API typedef enum udif_capstore_status
{
    udif_capstore_status_unknown = 0x00U,          
    udif_capstore_status_active = 0x01U,           
    udif_capstore_status_revoked = 0x02U,          
    udif_capstore_status_expired = 0x03U           
} udif_capstore_status;

UDIF_EXPORT_API typedef struct udif_capstore_entry
{
    udif_capability capability;                   
    udif_capstore_status status;                  
    bool used;                                    
} udif_capstore_entry;

UDIF_EXPORT_API typedef struct udif_capstore
{
    udif_capstore_entry entries[UDIF_CAPSTORE_CAPACITY];    
    size_t count;                                          
} udif_capstore;

UDIF_EXPORT_API void udif_capstore_initialize(udif_capstore* store);

UDIF_EXPORT_API void udif_capstore_clear(udif_capstore* store);

UDIF_EXPORT_API udif_errors udif_capstore_add(udif_capstore* store, const udif_capability* capability);

UDIF_EXPORT_API udif_errors udif_capstore_add_verified(udif_capstore* store, const udif_capability* capability, const uint8_t* issuerkey, uint64_t nowsecs);

UDIF_EXPORT_API const udif_capability* udif_capstore_find(const udif_capstore* store, const uint8_t* digest);

UDIF_EXPORT_API const udif_capability* udif_capstore_find_any(const udif_capstore* store, const uint8_t* digest);

UDIF_EXPORT_API udif_capstore_status udif_capstore_get_status(const udif_capstore* store, const uint8_t* digest, uint64_t nowsecs);

UDIF_EXPORT_API bool udif_capstore_set_status(udif_capstore* store, const uint8_t* digest, udif_capstore_status status);

UDIF_EXPORT_API bool udif_capstore_remove(udif_capstore* store, const uint8_t* digest);
 
#endif