ipinfo.h

Go to the documentation of this file.

/*
 * 2025 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 within this implementation 
 * are proprietary to QRCS and its authorized licensors and are protected under 
 * applicable U.S. and international copyright, patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC STANDARDS:
 * - This software includes implementations of cryptographic algorithms such as 
 *   SHA3, AES, and others. These algorithms are public domain or standardized 
 *   by organizations such as NIST and are NOT the property of QRCS.
 * - However, all source code, optimizations, and implementations in this library 
 *   are original works of QRCS and are protected under this license.
 *
 * RESTRICTIONS:
 * - Redistribution, modification, or unauthorized distribution of this software, 
 *   in whole or in part, is strictly prohibited.
 * - This software is provided for non-commercial, educational, and research 
 *   purposes only. Commercial use in any form is expressly forbidden.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 * - Any use of this software implies acceptance of these restrictions.
 *
 * DISCLAIMER:
 * This software is provided "as is," without warranty of any kind, express or 
 * implied, including but not limited to warranties of merchantability or fitness 
 * for a particular purpose. QRCS disclaims all liability for any direct, indirect, 
 * incidental, or consequential damages resulting from the use or misuse of this software.
 *
 * FULL LICENSE:
 * This software is subject to the **Quantum Resistant Cryptographic Solutions 
 * Proprietary License (QRCS-PL)**. The complete license terms are included 
 * in the LICENSE.txt file distributed with this software.
 *
 * Written by: John G. Underhill
 * Contact: john.underhill@protonmail.com
 */
 
#ifndef QSC_IPINFO_H
#define QSC_IPINFO_H
 
#include <stdio.h>
#include <string.h>
#include "common.h"
#include "arrayutils.h"
#include "intutils.h"
#include "memutils.h"
#include "socketflags.h"
#include "stringutils.h"
 
QSC_CPLUSPLUS_ENABLED_START


#define QSC_IPINFO_IPV4_BYTELEN 0x04U

#define QSC_IPINFO_IPV4_MINLEN 0x08U

#define QSC_IPINFO_IPV4_STRNLEN 0x16U

#define QSC_IPINFO_IPV4_MASK_STRNLEN 0x10U

#define QSC_IPINFO_IPV6_BYTELEN 0x10U

#define QSC_IPINFO_IP_MAX_BYTELEN (QSC_IPINFO_IPV6_BYTELEN)

#define QSC_IPINFO_IPV6_STRNLEN 0x41U

#define QSC_IPINFO_IPV6_MASK_STRNLEN 0x41U

#define QSC_IPINFO_MAX_SIZE (QSC_IPINFO_IPV6_STRNLEN)

QSC_EXPORT_API typedef enum
{
    qsc_ipinfo_address_type_none = 0x00U,    
    qsc_ipinfo_address_type_ipv4 = 0x01U,    
    qsc_ipinfo_address_type_ipv6 = 0x02U,    
    qsc_ipinfo_address_type_unknown = 0xFFU  
} qsc_ipinfo_address_types;

QSC_EXPORT_API typedef struct
{
    uint8_t ipv4[QSC_IPINFO_IPV4_BYTELEN];  
} qsc_ipinfo_ipv4_address;

QSC_EXPORT_API typedef struct
{
    qsc_ipinfo_ipv4_address address;    
    uint16_t port;                      
    uint8_t mask;                       
} qsc_ipinfo_ipv4_info;

QSC_EXPORT_API qsc_ipinfo_address_types qsc_ipinfo_get_address_type(const char* address);

QSC_EXPORT_API qsc_ipinfo_ipv4_address qsc_ipinfo_ipv4_address_any(void);

QSC_EXPORT_API void qsc_ipinfo_ipv4_address_clear(qsc_ipinfo_ipv4_address* address);

QSC_EXPORT_API qsc_ipinfo_ipv4_address qsc_ipinfo_ipv4_address_from_array(const uint8_t* address);

QSC_EXPORT_API qsc_ipinfo_ipv4_address qsc_ipinfo_ipv4_address_from_bytes(uint8_t a1, uint8_t a2, uint8_t a3, uint8_t a4);

QSC_EXPORT_API qsc_ipinfo_ipv4_address qsc_ipinfo_ipv4_address_from_string(const char input[QSC_IPINFO_IPV4_STRNLEN]);

QSC_EXPORT_API bool qsc_ipinfo_ipv4_address_is_equal(const qsc_ipinfo_ipv4_address* a, const qsc_ipinfo_ipv4_address* b);

QSC_EXPORT_API bool qsc_ipinfo_ipv4_address_is_routable(const qsc_ipinfo_ipv4_address* address);

QSC_EXPORT_API bool qsc_ipinfo_ipv4_address_is_valid(const qsc_ipinfo_ipv4_address* address);

QSC_EXPORT_API bool qsc_ipinfo_ipv4_address_string_is_valid(const char* address);

QSC_EXPORT_API bool qsc_ipinfo_ipv4_address_is_zeroed(const qsc_ipinfo_ipv4_address* address);

QSC_EXPORT_API qsc_ipinfo_ipv4_address qsc_ipinfo_ipv4_address_loopback(void);

QSC_EXPORT_API void qsc_ipinfo_ipv4_address_get_mask(char mask[QSC_IPINFO_IPV4_MASK_STRNLEN], const qsc_ipinfo_ipv4_address* address);

QSC_EXPORT_API uint8_t qsc_ipinfo_ipv4_address_get_cidr_mask(const qsc_ipinfo_ipv4_address* address);

QSC_EXPORT_API void qsc_ipinfo_ipv4_address_to_array(uint8_t* output, const qsc_ipinfo_ipv4_address* address);

QSC_EXPORT_API void qsc_ipinfo_ipv4_address_to_string(char output[QSC_IPINFO_IPV4_STRNLEN], const qsc_ipinfo_ipv4_address* address);

QSC_EXPORT_API void qsc_ipinfo_ipv4_array_to_string(char output[QSC_IPINFO_IPV4_STRNLEN], const uint8_t* address);

QSC_EXPORT_API typedef struct
{
    uint8_t ipv6[QSC_IPINFO_IPV6_BYTELEN];  
} qsc_ipinfo_ipv6_address;

QSC_EXPORT_API typedef struct
{
    qsc_ipinfo_ipv6_address address;    
    uint16_t port;                      
    uint8_t mask;                       
} qsc_ipinfo_ipv6_info;

QSC_EXPORT_API qsc_ipv6_address_prefix_types qsc_ipinfo_ipv6_address_type(const qsc_ipinfo_ipv6_address* address);

QSC_EXPORT_API qsc_ipinfo_ipv6_address qsc_ipinfo_ipv6_address_any(void);

QSC_EXPORT_API void qsc_ipinfo_ipv6_address_clear(qsc_ipinfo_ipv6_address* address);

QSC_EXPORT_API qsc_ipinfo_ipv6_address qsc_ipinfo_ipv6_address_from_array(const uint8_t* address);

QSC_EXPORT_API qsc_ipinfo_ipv6_address qsc_ipinfo_ipv6_address_from_string(const char input[QSC_IPINFO_IPV6_STRNLEN]);

QSC_EXPORT_API bool qsc_ipinfo_ipv6_address_is_equal(const qsc_ipinfo_ipv6_address* a, const qsc_ipinfo_ipv6_address* b);

QSC_EXPORT_API bool qsc_ipinfo_ipv6_address_is_routable(const qsc_ipinfo_ipv6_address* address);

QSC_EXPORT_API bool qsc_ipinfo_ipv6_address_is_valid(const qsc_ipinfo_ipv6_address* address);

QSC_EXPORT_API bool qsc_ipinfo_ipv6_address_string_is_valid(const char* address);

QSC_EXPORT_API bool qsc_ipinfo_ipv6_address_is_zeroed(const qsc_ipinfo_ipv6_address* address);

QSC_EXPORT_API qsc_ipinfo_ipv6_address qsc_ipinfo_ipv6_address_loopback(void);

QSC_EXPORT_API void qsc_ipinfo_ipv6_address_get_mask(char mask[QSC_IPINFO_IPV6_MASK_STRNLEN], const qsc_ipinfo_ipv6_address* address);

QSC_EXPORT_API uint8_t qsc_ipinfo_ipv6_address_get_cidr_mask(const qsc_ipinfo_ipv6_address* address);

QSC_EXPORT_API void qsc_ipinfo_ipv6_address_to_array(uint8_t* output, const qsc_ipinfo_ipv6_address* address);

QSC_EXPORT_API void qsc_ipinfo_ipv6_address_to_string(char output[QSC_IPINFO_IPV6_STRNLEN], const qsc_ipinfo_ipv6_address* address);

QSC_EXPORT_API void qsc_ipinfo_ipv6_array_to_string(char output[QSC_IPINFO_IPV6_STRNLEN], const uint8_t* address);

QSC_EXPORT_API uint8_t qsc_ipinfo_ipv4_mask_to_cidr(const char mask[QSC_IPINFO_IPV4_MASK_STRNLEN]);

QSC_EXPORT_API void qsc_ipinfo_ipv4_cidr_to_mask(char mask[QSC_IPINFO_IPV4_MASK_STRNLEN], uint8_t cidr);
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif