message.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_MESSAGE_H
#define UDIF_MESSAGE_H
 
#include "udif.h"
#include "qstp.h"


#define UDIF_MESSAGE_HEADER_SIZE 6U

#define UDIF_MESSAGE_PAYLOAD_MAX (QSTP_PACKET_MESSAGE_MAX - QSTP_MACTAG_SIZE - 26U - UDIF_MESSAGE_HEADER_SIZE)

#define UDIF_MESSAGE_VERSION 1U

typedef enum udif_message_type
{
    udif_msg_none = 0x00U,                     
    udif_msg_keepalive = 0x01U,                   
    /* Certificate enrollment and lifecycle */
    udif_msg_cert_enroll_req = 0x10U,           
    udif_msg_cert_enroll_resp = 0x11U,         
    udif_msg_cert_revoke = 0x12U,               
    udif_msg_cert_suspend = 0x13U,             
    udif_msg_cert_resume = 0x14U,               
    udif_msg_cap_grant = 0x15U,                   
    udif_msg_cap_revoke = 0x16U,             
    /* Predicate queries */
    udif_msg_query_req = 0x20U,                   
    udif_msg_query_resp = 0x21U,             
    /* Object and registry operations */
    udif_msg_object_create = 0x30U,               
    udif_msg_object_transfer_req = 0x31U,       
    udif_msg_object_transfer_confirm = 0x32U,   
    udif_msg_registry_commit = 0x33U,           
    /* Anchor propagation */
    udif_msg_anchor_push = 0x40U,               
    udif_msg_anchor_ack = 0x41U,             
    /* Peering treaties and cross-domain queries */
    udif_msg_treaty_propose = 0x50U,         
    udif_msg_treaty_cosign = 0x51U,               
    udif_msg_treaty_revoke = 0x52U,               
    udif_msg_treaty_query_fwd = 0x53U,         
    udif_msg_treaty_query_resp = 0x54U,           
    /* Non-fatal application errors */
    udif_msg_error_report = 0x60U              
} udif_message_type;

UDIF_EXPORT_API typedef struct udif_message
{
    udif_message_type msgtype;                  
    uint32_t payloadlen;                      
    uint8_t* payload;                            
} udif_message;

UDIF_EXPORT_API udif_errors udif_message_init(udif_message* msg, udif_message_type msgtype, const uint8_t* payload, uint32_t payloadlen);

UDIF_EXPORT_API void udif_message_dispose(udif_message* msg);

UDIF_EXPORT_API udif_errors udif_message_encode(uint8_t* output, size_t outlen, const udif_message* msg, size_t* written);

UDIF_EXPORT_API udif_errors udif_message_decode(udif_message* msg, const uint8_t* input, size_t inplen, size_t* consumed);

UDIF_EXPORT_API size_t udif_message_encoded_size(const udif_message* msg);

UDIF_EXPORT_API const char* udif_message_type_name(udif_message_type msgtype);
 
#endif