treaty.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_TREATY_H
#define UDIF_TREATY_H
 
#include "udif.h"


#define UDIF_TREATY_SCOPE_ANALYTICS 1U

#define UDIF_TREATY_SCOPE_INTRA_DOMAIN 2U

#define UDIF_TREATY_SCOPE_LOCAL 4U

#define UDIF_TREATY_SCOPE_QUERY 8U

#define UDIF_TREATY_SCOPE_TRANSFER 16U

#define UDIF_TREATY_SCOPE_TREATY 32U

#define UDIF_TREATY_SCOPE_RESERVED1 64U

#define UDIF_TREATY_SCOPE_RESERVED2 128U

#define UDIF_TREATY_SCOPE_RESERVED3 256U

#define UDIF_TREATY_SCOPE_MAX 256U

#define UDIF_TREATY_SCOPE_QUERY_EXIST UDIF_TREATY_SCOPE_QUERY

#define UDIF_TREATY_SCOPE_QUERY_OWNER UDIF_TREATY_SCOPE_INTRA_DOMAIN

#define UDIF_TREATY_SCOPE_QUERY_ATTR UDIF_TREATY_SCOPE_LOCAL

#define UDIF_TREATY_SCOPE_QUERY_PROOF UDIF_TREATY_SCOPE_TREATY

#define UDIF_TREATY_POLICY_VERSION_SIZE 4U

#define UDIF_TREATY_SCOPE_QUERY_SIZE 4U

#define UDIF_TREATY_DEFAULT_DURATION (365U * 24U * 3600U)

#define UDIF_TREATY_MAX_DURATION (5U * 365U * 24U * 3600U)

#define UDIF_TREATY_STRUCTURE_SIZE (UDIF_SIGNED_HASH_SIZE + \
    UDIF_SIGNED_HASH_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_VALID_TIME_SIZE + \
    UDIF_VALID_TIME_SIZE + \
    UDIF_TREATY_POLICY_VERSION_SIZE + \
    UDIF_TREATY_SCOPE_QUERY_SIZE)

UDIF_EXPORT_API typedef struct udif_treaty
{
    uint8_t domsiga[UDIF_SIGNED_HASH_SIZE];     
    uint8_t domsigb[UDIF_SIGNED_HASH_SIZE];     
    uint8_t domsera[UDIF_SERIAL_NUMBER_SIZE];   
    uint8_t domserb[UDIF_SERIAL_NUMBER_SIZE]; 
    uint8_t treatyid[UDIF_SERIAL_NUMBER_SIZE];   
    uint64_t validfrom;                            
    uint64_t validto;                            
    uint32_t policy;                          
    uint32_t scopebitmap;                        
} udif_treaty;

UDIF_EXPORT_API udif_errors udif_treaty_accept(udif_treaty* treaty, const uint8_t* domsigkeyb, bool (*rng_generate)(uint8_t*, size_t));

UDIF_EXPORT_API bool udif_treaty_allows_scope(const udif_treaty* treaty, uint32_t scope);

UDIF_EXPORT_API bool udif_treaty_allows_query(const udif_treaty* treaty, uint8_t querytype);

UDIF_EXPORT_API void udif_treaty_clear(udif_treaty* treaty);

UDIF_EXPORT_API bool udif_treaty_compare(const udif_treaty* a, const udif_treaty* b);

UDIF_EXPORT_API udif_errors udif_treaty_compute_digest(uint8_t* digest, const udif_treaty* treaty);

UDIF_EXPORT_API udif_errors udif_treaty_create_proposal(udif_treaty* treaty, const uint8_t* treatyid, const uint8_t* domsera, const uint8_t* domserb, 
    uint32_t scopebitmap, uint64_t validfrom, uint64_t validto, uint32_t policy, const uint8_t* domsigkeya, bool (*rng_generate)(uint8_t*, size_t));

UDIF_EXPORT_API udif_errors udif_treaty_deserialize(udif_treaty* treaty, const uint8_t* input, size_t inplen);

UDIF_EXPORT_API size_t udif_treaty_encoded_size(const udif_treaty* treaty);

UDIF_EXPORT_API uint64_t udif_treaty_get_duration(const udif_treaty* treaty);

UDIF_EXPORT_API bool udif_treaty_is_active(const udif_treaty* treaty, uint64_t ctime);

UDIF_EXPORT_API bool udif_treaty_is_expired(const udif_treaty* treaty, uint64_t ctime);

UDIF_EXPORT_API bool udif_treaty_is_participant(const udif_treaty* treaty, const uint8_t* entityser);

UDIF_EXPORT_API bool udif_treaty_is_pending(const udif_treaty* treaty);

UDIF_EXPORT_API udif_errors udif_treaty_serialize(uint8_t* output, size_t outlen, const udif_treaty* treaty);

UDIF_EXPORT_API udif_errors udif_treaty_validate(const udif_treaty* treaty);


UDIF_EXPORT_API bool udif_treaty_verify_proposal(const udif_treaty* treaty, const uint8_t* domverkeya);

UDIF_EXPORT_API bool udif_treaty_verify(const udif_treaty* treaty, const uint8_t* domverkeya, const uint8_t* domverkeyb);
 
#endif