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


#define UDIF_OBJECT_FLAG_DESTROYED 0x01U

#define UDIF_OBJECT_FLAG_SIZE 4U

#define UDIF_OBJECT_TYPE_SIZE 4U

#define UDIF_OBJECT_ENCODED_SIZE (UDIF_SIGNED_HASH_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_CRYPTO_HASH_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_VALID_TIME_STRUCTURE_SIZE + \
    UDIF_OBJECT_FLAG_SIZE + \
    UDIF_OBJECT_TYPE_SIZE)

#define UDIF_OBJECT_SIGNING_SIZE (UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_CRYPTO_HASH_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_VALID_TIME_STRUCTURE_SIZE + \
    UDIF_OBJECT_FLAG_SIZE + \
    UDIF_OBJECT_TYPE_SIZE)

#define UDIF_OBJECT_TRANSFER_SIZE (UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_VALID_TIME_SIZE)

#define UDIF_TRANSFER_RECORD_ENCODED_SIZE (UDIF_SIGNED_HASH_SIZE + \
    UDIF_SIGNED_HASH_SIZE + \
    UDIF_CRYPTO_HASH_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_VALID_TIME_SIZE)
 

UDIF_EXPORT_API typedef struct udif_object
{
    uint8_t signature[UDIF_SIGNED_HASH_SIZE]; 
    uint8_t attrroot[UDIF_CRYPTO_HASH_SIZE];   
    uint8_t serial[UDIF_SERIAL_NUMBER_SIZE];   
    uint8_t creator[UDIF_SERIAL_NUMBER_SIZE]; 
    uint8_t owner[UDIF_SERIAL_NUMBER_SIZE];     
    uint64_t created;                            
    uint64_t updated;                            
    uint32_t flags;                                
    uint32_t type;                              
} udif_object;

UDIF_EXPORT_API typedef struct udif_transfer_record
{
    uint8_t sender[UDIF_SIGNED_HASH_SIZE];       
    uint8_t receiver[UDIF_SIGNED_HASH_SIZE];   
    uint8_t txid[UDIF_CRYPTO_HASH_SIZE];               
    uint8_t serial[UDIF_SERIAL_NUMBER_SIZE];   
    uint8_t originator[UDIF_SERIAL_NUMBER_SIZE];
    uint8_t owner[UDIF_SERIAL_NUMBER_SIZE];     
    uint64_t timestamp;                            
} udif_transfer_record;

UDIF_EXPORT_API void udif_object_clear(udif_object* obj);

UDIF_EXPORT_API bool udif_object_compare(const udif_object* a, const udif_object* b);

UDIF_EXPORT_API udif_errors udif_object_compute_digest(uint8_t* digest, const udif_object* obj);

UDIF_EXPORT_API udif_errors udif_object_compute_signature(udif_object* obj, const uint8_t* sigkey, bool (*rng_generate)(uint8_t*, size_t));

UDIF_EXPORT_API udif_errors udif_object_compute_transfer_digest(uint8_t* digest, const uint8_t* objserial, const uint8_t* txid, const uint8_t* toowner, uint64_t timestamp);

UDIF_EXPORT_API udif_errors udif_object_create(udif_object* obj, const uint8_t* serial, uint32_t type, const uint8_t* creator, const uint8_t* attrroot, 
    const uint8_t* owner, const uint8_t* sigkey, uint64_t ctime, bool (*rng_generate)(uint8_t*, size_t));

UDIF_EXPORT_API udif_errors udif_object_deserialize(udif_object* obj, const uint8_t* input, size_t inplen);

UDIF_EXPORT_API udif_errors udif_object_destroy(udif_object* obj, const uint8_t* ownersigkey, uint64_t ctime, bool (*rng_generate)(uint8_t*, size_t));

UDIF_EXPORT_API bool udif_object_is_destroyed(const udif_object* obj);

UDIF_EXPORT_API udif_errors udif_object_serialize(uint8_t* output, size_t outlen, const udif_object* obj);

UDIF_EXPORT_API udif_errors udif_object_transfer(udif_object* obj, udif_transfer_record* transfer, const uint8_t* newowner, const uint8_t* sendsigkey, 
    const uint8_t* recvsigkey, uint64_t ctime, bool (*rng_generate)(uint8_t*, size_t));

UDIF_EXPORT_API udif_errors udif_object_update_attributes(udif_object* obj, const uint8_t* newattrroot, const uint8_t* ownersigkey, uint64_t ctime, 
    bool (*rng_generate)(uint8_t*, size_t));

UDIF_EXPORT_API bool udif_object_verify(const udif_object* obj, const uint8_t* ownerverkey);

UDIF_EXPORT_API void udif_transfer_clear(udif_transfer_record* transfer);

UDIF_EXPORT_API udif_errors udif_transfer_deserialize(udif_transfer_record* transfer, const uint8_t* input, size_t inplen);

UDIF_EXPORT_API udif_errors udif_transfer_serialize(uint8_t* output, size_t outlen, const udif_transfer_record* transfer);

UDIF_EXPORT_API bool udif_transfer_verify(const udif_transfer_record* transfer, const uint8_t* senderverkey, const uint8_t* recvverkey);
 
#endif