netutils.h

Go to the documentation of this file.

/* 2020-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 QSC_NETUTILS_H
#define QSC_NETUTILS_H
 
#include "qsccommon.h"
#include "ipinfo.h"
#include "socket.h"
#include "socketbase.h"
 
QSC_CPLUSPLUS_ENABLED_START

 
/* bogus winbase.h error */
QSC_SYSTEM_CONDITION_IGNORE(5105)
 

#define QSC_NETUTILS_ADAPTOR_NAME_SIZE 0x104U

#define QSC_NETUTILS_ADAPTOR_DESCRIPTION_SIZE 0x84U

#define QSC_NETUTILS_ADAPTOR_INFO_ARRAY_SIZE 0x08U

#define QSC_NETUTILS_DOMAIN_NAME_SIZE 0x104U

#define QSC_NETUTILS_HOSTS_NAME_SIZE 0x104U

#define QSC_NETUTILS_IP_STRING_SIZE 0x80U

#define QSC_NETUTILS_MAC_ADDRESS_SIZE 0x12U

#define QSC_NETUTILS_NAME_BUFFER_SIZE 0x80U

#define QSC_NETUTILS_SERVICE_NAME_BUFFER_SIZE 0x80U

#define QSC_NETUTILS_SUBNET_STRING_SIZE 0x10U

typedef struct
{
    char desc[QSC_NETUTILS_ADAPTOR_DESCRIPTION_SIZE];  
    char dhcp[QSC_NETUTILS_IP_STRING_SIZE];              
    char gateway[QSC_NETUTILS_IP_STRING_SIZE];            
    char ip[QSC_NETUTILS_IP_STRING_SIZE];              
    char mac[QSC_NETUTILS_MAC_ADDRESS_SIZE];            
    char name[QSC_NETUTILS_ADAPTOR_NAME_SIZE];            
    char subnet[QSC_NETUTILS_IP_STRING_SIZE];          
 
} qsc_netutils_adaptor_info;
 
//~~~IP Address~~~//

QSC_EXPORT_API void qsc_netutils_get_adaptor_info(qsc_netutils_adaptor_info* info, const char* infname);

QSC_EXPORT_API void qsc_netutils_get_mac_address(uint8_t mac[QSC_NETUTILS_MAC_ADDRESS_SIZE]);

QSC_EXPORT_API uint32_t qsc_netutils_atoi(const char* source);

QSC_EXPORT_API size_t qsc_netutils_get_domain_name(char output[QSC_NETUTILS_DOMAIN_NAME_SIZE]);

QSC_EXPORT_API bool qsc_netutils_get_host_name(char host[QSC_NETUTILS_HOSTS_NAME_SIZE]);

QSC_EXPORT_API void qsc_netutils_get_name_from_ipv4_address(const qsc_ipinfo_ipv4_address* address, char host[QSC_NETUTILS_HOSTS_NAME_SIZE]);

QSC_EXPORT_API bool qsc_netutils_get_ipv4_address(qsc_ipinfo_ipv4_address* padd);

QSC_EXPORT_API bool qsc_netutils_get_ipv6_address(qsc_ipinfo_ipv6_address* padd);

QSC_EXPORT_API void qsc_netutils_get_ipv4_info(qsc_ipinfo_ipv4_info* pinfo, const char* host, const char* service);

QSC_EXPORT_API void qsc_netutils_get_ipv6_info(qsc_ipinfo_ipv6_info* pinfo, const char* host, const char* service);

QSC_EXPORT_API void qsc_netutils_get_peer_name(char output[QSC_NETUTILS_HOSTS_NAME_SIZE], const qsc_socket* sock);

QSC_EXPORT_API void qsc_netutils_get_socket_name(char output[QSC_NETUTILS_NAME_BUFFER_SIZE], const qsc_socket* sock);

QSC_EXPORT_API uint16_t qsc_netutils_port_name_to_number(const char* portname, const char* protocol);
 
#if defined(QSC_DEBUG_MODE)
QSC_EXPORT_API void qsc_netutils_values_print(void);
#endif
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif