pqsxfer.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 PQS_XFER_H
#define PQS_XFER_H
 
#include "pqscommon.h"
#include <stdio.h>


typedef enum pqs_xfer_walk_events
{
    pqs_xfer_walk_event_directory_begin = 0x01U, 
    pqs_xfer_walk_event_file = 0x02U,               
    pqs_xfer_walk_event_directory_end = 0x03U      
} pqs_xfer_walk_events;

typedef bool (*pqs_xfer_walk_callback)(pqs_xfer_walk_events event, const char* localpath, const char* relative, void* context);

PQS_EXPORT_API size_t pqs_xfer_payload_size(const uint8_t* message, size_t msglen);

PQS_EXPORT_API void pqs_xfer_join_path(char* output, size_t outlen, const char* first, const char* second);

PQS_EXPORT_API void pqs_xfer_join_remote(char* output, size_t outlen, const char* first, const char* second);

PQS_EXPORT_API bool pqs_xfer_local_path_is_directory(const char* path);

PQS_EXPORT_API bool pqs_xfer_create_parent_directories(const char* fpath);

PQS_EXPORT_API bool pqs_xfer_make_local_recursive_path(char* output, size_t outlen, const char* root, const char* relative);

PQS_EXPORT_API bool pqs_xfer_walk_directory(const char* localroot, const char* remoteroot, size_t maxdepth, pqs_xfer_walk_callback callback, void* context);

PQS_EXPORT_API bool pqs_xfer_make_path(char* output, size_t outlen, const char* root, const char* relative);

PQS_EXPORT_API bool pqs_xfer_extract_relative(char* output, size_t outlen, const uint8_t* message, size_t msglen);

PQS_EXPORT_API bool pqs_xfer_path_is_confined(const char* root, const char* path, bool existing);

PQS_EXPORT_API bool pqs_xfer_path_is_safe(const char* relative);

PQS_EXPORT_API bool pqs_xfer_make_user_root(char* output, size_t outlen, const char* root, const char* username);

PQS_EXPORT_API FILE* pqs_xfer_open_read_confined(const char* root, const char* relative);

PQS_EXPORT_API FILE* pqs_xfer_open_write_confined(const char* root, const char* relative);

PQS_EXPORT_API bool pqs_xfer_make_temporary_path(char* output, size_t outlen, const char* relative);

PQS_EXPORT_API bool pqs_xfer_remove_confined(const char* root, const char* relative);

PQS_EXPORT_API bool pqs_xfer_make_directory_confined(const char* root, const char* relative);

PQS_EXPORT_API bool pqs_xfer_publish_temporary_file(const char* root, const char* temporary, const char* relative);

PQS_EXPORT_API bool pqs_xfer_hash_file(const char* fpath, char* hexhash, size_t hexlen, size_t* filesize);

PQS_EXPORT_API bool pqs_xfer_format_metadata(char* output, size_t outlen, size_t filesize, const char* hexhash);

PQS_EXPORT_API bool pqs_xfer_parse_metadata(const char* metadata, size_t* filesize, char* hexhash, size_t hexlen);
 

PQS_EXPORT_API bool pqs_xfer_format_file_metadata(char* output, size_t outlen, const char* relative, size_t filesize, const char* hexhash);

PQS_EXPORT_API bool pqs_xfer_parse_file_metadata(const char* metadata, char* relative, size_t relen, size_t* filesize, char* hexhash, size_t hexlen);

PQS_EXPORT_API bool pqs_xfer_path_is_symlink(const char* path);
 
#endif