pqsshell.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_SHELL_H
#define PQS_SHELL_H
 
#include "pqs.h"


#define PQS_SHELL_DATABASE_MAGIC "PQSSHELLDB1"

#define PQS_SHELL_PRIVILEGE_GUEST 0x01U

#define PQS_SHELL_PRIVILEGE_USER 0x02U

#define PQS_SHELL_PRIVILEGE_ADMIN 0x04U

#define PQS_SHELL_PRIVILEGE_ALL (PQS_SHELL_PRIVILEGE_GUEST | PQS_SHELL_PRIVILEGE_USER | PQS_SHELL_PRIVILEGE_ADMIN)

PQS_EXPORT_API typedef struct pqs_shell_profile
{
    char name[PQS_SHELL_PROFILE_NAME_MAX];                      
    char type[PQS_SHELL_PROFILE_TYPE_MAX];                      
    char path[PQS_SHELL_PROFILE_PATH_MAX];                      
    uint32_t privilege_mask;                                  
    bool enabled;                                                
    bool isdefault;                                                
} pqs_shell_profile;

PQS_EXPORT_API typedef struct pqs_shell_store
{
    pqs_shell_profile profiles[PQS_SHELL_PROFILE_DATABASE_MAX];    
    char path[QSC_SYSTEM_MAX_PATH];                             
    size_t count;                                               
    bool initialized;                                           
} pqs_shell_store;

PQS_EXPORT_API bool pqs_shell_store_add(pqs_shell_store* store, const char* name, const char* type, const char* path, uint32_t privilege_mask, bool enabled);

PQS_EXPORT_API bool pqs_shell_store_enable(pqs_shell_store* store, const char* name, bool enabled);

PQS_EXPORT_API const pqs_shell_profile* pqs_shell_store_find(const pqs_shell_store* store, const char* name);

PQS_EXPORT_API pqs_shell_profile* pqs_shell_store_find_mutable(pqs_shell_store* store, const char* name);

PQS_EXPORT_API const pqs_shell_profile* pqs_shell_store_default(const pqs_shell_store* store);

PQS_EXPORT_API bool pqs_shell_store_initialize(pqs_shell_store* store, const char* path);

PQS_EXPORT_API bool pqs_shell_store_remove(pqs_shell_store* store, const char* name);

PQS_EXPORT_API bool pqs_shell_store_save(const pqs_shell_store* store);

PQS_EXPORT_API bool pqs_shell_store_set_default(pqs_shell_store* store, const char* name);

PQS_EXPORT_API bool pqs_shell_store_set_privilege(pqs_shell_store* store, const char* name, pqs_user_privileges privilege, bool allowed);

PQS_EXPORT_API uint32_t pqs_shell_privilege_to_mask(pqs_user_privileges privilege);

PQS_EXPORT_API bool pqs_shell_profile_allows_privilege(const pqs_shell_profile* profile, pqs_user_privileges privilege);
 
#endif