event.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_EVENT_H
#define UDIF_EVENT_H
 
#include "udif.h"
#include "mcelmanager.h"

 
#define UDIF_EVENT_CONTEXT_SIZE 32U

#define UDIF_EVENT_RECORD_SIZE (1U + 2U + UDIF_SERIAL_NUMBER_SIZE + UDIF_SERIAL_NUMBER_SIZE + \
    UDIF_EVENT_CONTEXT_SIZE + 8U + UDIF_CRYPTO_HASH_SIZE + 8U)

typedef enum udif_event_classes
{
    udif_event_class_membership = 1U,   
    udif_event_class_transaction = 2U,  
    udif_event_class_registry = 3U,     
    udif_event_class_error = 4U         
} udif_event_classes;

typedef enum udif_event_codes
{
    udif_audit_event_none = 0x0000U,                    
    udif_audit_event_cert_enroll_request = 0x1000U,     
    udif_audit_event_cert_enroll_response = 0x1001U,    
    udif_audit_event_cert_revoke = 0x1002U,             
    udif_audit_event_cert_suspend = 0x1003U,            
    udif_audit_event_cert_resume = 0x1004U,             
    udif_audit_event_cap_grant = 0x1005U,               
    udif_audit_event_cap_revoke = 0x1006U,              
    udif_audit_event_query_request = 0x2000U,           
    udif_audit_event_query_response = 0x2001U,          
    udif_audit_event_object_create = 0x3000U,           
    udif_audit_event_object_transfer_request = 0x3001U, 
    udif_audit_event_object_transfer_confirm = 0x3002U, 
    udif_audit_event_registry_commit = 0x3003U,         
    udif_audit_event_anchor_push = 0x4000U,             
    udif_audit_event_anchor_ack = 0x4001U,              
    udif_audit_event_treaty_propose = 0x5000U,          
    udif_audit_event_treaty_cosign = 0x5001U,           
    udif_audit_event_treaty_revoke = 0x5002U,           
    udif_audit_event_treaty_query_forward = 0x5003U,    
    udif_audit_event_treaty_query_response = 0x5004U,   
    udif_audit_event_error_report = 0x6000U             
} udif_event_codes;

typedef struct udif_event_record
{
    uint8_t eventclass;                             
    uint16_t eventcode;                             
    uint8_t actorser[UDIF_SERIAL_NUMBER_SIZE];      
    uint8_t subjectser[UDIF_SERIAL_NUMBER_SIZE];    
    uint8_t contextid[UDIF_EVENT_CONTEXT_SIZE];     
    uint64_t timestamp;                             
    uint8_t payloaddigest[UDIF_CRYPTO_HASH_SIZE];   
    uint64_t payloadlen;                            
} udif_event_record;

UDIF_EXPORT_API void udif_event_clear(udif_event_record* eventrec);

UDIF_EXPORT_API udif_errors udif_event_create(udif_event_record* eventrec, udif_event_classes eventclass, udif_event_codes eventcode,
    const uint8_t* actorser, const uint8_t* subjectser, const uint8_t* contextid, uint64_t timestamp, const uint8_t* payload, size_t payloadlen);

UDIF_EXPORT_API udif_errors udif_event_serialize(uint8_t* output, size_t outlen, const udif_event_record* eventrec);

UDIF_EXPORT_API udif_errors udif_event_log(udif_mcel_manager* mgr, udif_ledger_type ledger, udif_event_codes eventcode, const uint8_t* actorser,
    const uint8_t* subjectser, const uint8_t* contextid, uint64_t timestamp, const uint8_t* payload, size_t payloadlen);
 
#endif