pqspolicy.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_POLICY_H
#define PQS_POLICY_H
 
#include "pqs.h"


#define PQS_POLICY_DATABASE_MAGIC "PQSPOLICYDB1"

#define PQS_POLICY_DEFAULT_GUEST "guest"

#define PQS_POLICY_DEFAULT_USER "user"

#define PQS_POLICY_DEFAULT_ADMIN "admin"

PQS_EXPORT_API typedef enum pqs_policy_modes
{
    pqs_policy_mode_none = 0x00U,                       
    pqs_policy_mode_restricted = 0x01U,                   
    pqs_policy_mode_forced = 0x02U,                       
    pqs_policy_mode_raw = 0x03U                          
} pqs_policy_modes;

PQS_EXPORT_API typedef struct pqs_policy_record
{
    char name[PQS_POLICY_NAME_MAX];                     
    char allowlist[PQS_POLICY_COMMAND_LIST_MAX];       
    char denylist[PQS_POLICY_COMMAND_LIST_MAX];         
    char forced[PQS_POLICY_COMMAND_MAX];              
    uint32_t privilege_mask;                          
    pqs_policy_modes mode;                              
    bool enabled;                                        
} pqs_policy_record;

PQS_EXPORT_API typedef struct pqs_policy_store
{
    pqs_policy_record records[PQS_POLICY_DATABASE_MAX]; 
    char path[QSC_SYSTEM_MAX_PATH];                     
    char guest_policy[PQS_POLICY_NAME_MAX];             
    char user_policy[PQS_POLICY_NAME_MAX];              
    char admin_policy[PQS_POLICY_NAME_MAX];             
    size_t count;                                       
    bool initialized;                                   
} pqs_policy_store;

PQS_EXPORT_API bool pqs_policy_store_add(pqs_policy_store* store, const char* name, pqs_policy_modes mode, uint32_t privilege_mask, bool enabled);

PQS_EXPORT_API bool pqs_policy_store_add_command(pqs_policy_store* store, const char* name, const char* command, bool allowed);

PQS_EXPORT_API bool pqs_policy_store_assign_privilege(pqs_policy_store* store, pqs_user_privileges privilege, const char* policy);


PQS_EXPORT_API bool pqs_policy_command_is_safe(const char* command);

PQS_EXPORT_API bool pqs_policy_store_authorize(const pqs_policy_store* store, pqs_user_privileges privilege, const char* command, const pqs_policy_record** matched);

PQS_EXPORT_API bool pqs_policy_store_enable(pqs_policy_store* store, const char* name, bool enabled);

PQS_EXPORT_API const pqs_policy_record* pqs_policy_store_find(const pqs_policy_store* store, const char* name);

PQS_EXPORT_API pqs_policy_record* pqs_policy_store_find_mutable(pqs_policy_store* store, const char* name);

PQS_EXPORT_API bool pqs_policy_store_initialize(pqs_policy_store* store, const char* path);

PQS_EXPORT_API bool pqs_policy_store_remove(pqs_policy_store* store, const char* name);

PQS_EXPORT_API bool pqs_policy_store_remove_command(pqs_policy_store* store, const char* name, const char* command, bool allowed);

PQS_EXPORT_API bool pqs_policy_store_save(const pqs_policy_store* store);

PQS_EXPORT_API bool pqs_policy_store_set_forced(pqs_policy_store* store, const char* name, const char* command);

PQS_EXPORT_API bool pqs_policy_store_set_mode(pqs_policy_store* store, const char* name, pqs_policy_modes mode);

PQS_EXPORT_API const char* pqs_policy_mode_to_string(pqs_policy_modes mode);

PQS_EXPORT_API pqs_policy_modes pqs_policy_mode_from_string(const char* value);

PQS_EXPORT_API uint32_t pqs_policy_privilege_to_mask(pqs_user_privileges privilege);
 
#endif