pqsadmin.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.
 *
 * This software is subject to the Quantum Resistant Cryptographic Solutions
 * Public Research and Evaluation License (QRCS-PREL), 2025-2026.
 *
 * Written by: John G. Underhill
 * Contact: contact@qrcscorp.ca
 */
 
#ifndef PQS_ADMIN_H
#define PQS_ADMIN_H
 
#include "pqsconfig.h"
#include "pqskey.h"
#include "pqslogger.h"
#include "pqspolicy.h"
#include "pqssandbox.h"
#include "pqsshell.h"
#include "pqsuser.h"


#define PQS_ADMIN_ARGUMENT_MAX 128U

#define PQS_ADMIN_OUTPUT_MAX 2048U

#define PQS_ADMIN_POLICY_PREFIX "admin."

PQS_EXPORT_API typedef enum pqs_admin_command_ids
{
    pqs_admin_command_none = 0x0000U,                
    pqs_admin_command_server_status = 0x0001U,       
    pqs_admin_command_server_version = 0x0002U,      
    pqs_admin_command_server_fingerprint = 0x0003U,  
    pqs_admin_command_sandbox_status = 0x0004U,      
    pqs_admin_command_audit_verify = 0x0005U,        
    pqs_admin_command_config_summary = 0x0006U,      
    pqs_admin_command_user_list = 0x0007U,           
    pqs_admin_command_policy_list = 0x0008U,         
    pqs_admin_command_shell_list = 0x0009U           
} pqs_admin_command_ids;

PQS_EXPORT_API typedef struct pqs_admin_request
{
    pqs_admin_command_ids command;                   
    char arguments[PQS_ADMIN_ARGUMENT_MAX];          
} pqs_admin_request;

PQS_EXPORT_API typedef struct pqs_admin_context
{
    const char* user;                                
    const char* peer;                                
    pqs_user_privileges privilege;                   
    bool authenticated;                              
    const pqs_server_config* config;                 
    const pqs_user_store* users;                     
    const pqs_shell_store* shells;                   
    const pqs_policy_store* policies;                
    const pqs_sandbox_profile* sandbox;              
    const qsms_client_verification_key* public_key;  
    bool logger_failed;                               
} pqs_admin_context;

PQS_EXPORT_API bool pqs_admin_authorize(const pqs_admin_context* context, const pqs_admin_request* request);

PQS_EXPORT_API bool pqs_admin_execute(const pqs_admin_context* context, const pqs_admin_request* request, char* output, size_t outlen);

PQS_EXPORT_API bool pqs_admin_request_parse(pqs_admin_request* request, const char* command);

PQS_EXPORT_API const char* pqs_admin_command_to_string(pqs_admin_command_ids command);

PQS_EXPORT_API const char* pqs_admin_policy_verb(pqs_admin_command_ids command);
 
#endif