libutils, a C++20 utility librarylibutils, une bibliothèque utilitaire C++20

1. Overview1. Vue d'ensemble

Everything is in the namespace utils::. A project includes only the root header <utils/utils.hpp> and chooses the sections it needs with defines placed before it; nothing defined means everything.Tout est dans le namespace utils::. Un projet inclut seulement l'en-tête racine <utils/utils.hpp> et choisit les sections voulues avec des defines placés avant ; sans define, tout est inclus.

2. Install & integrate2. Installer & intégrer

2.1 Install2.1 Installation

curl -fsSL https://raw.githubusercontent.com/TsukiNi22/libutils/main/setup.sh | bash -s
sudo dnf install libutils

curl -fsSL https://raw.githubusercontent.com/TsukiNi22/libutils/main/setup.sh | bash -s
sudo apt install libutils

git clone https://github.com/TsukiNi22/libutils.git && cd libutils
export BUILD_DIR=build
cmake -S . -B $BUILD_DIR
sudo cmake --build $BUILD_DIR --target install --parallel $(nproc)

sudo dnf install mingw64-libutils    # Fedora (requires mingw64-openssl)
sudo apt install mingw64-libutils    # Debian / Ubuntu (OpenSSL for MinGW built by hand)

export BUILD_DIR=build-windows
cmake -S . -B $BUILD_DIR -DCMAKE_TOOLCHAIN_FILE=cmake/toolchain/mingw-w64.cmake -DCMAKE_BUILD_TYPE=Optimized
cmake --build $BUILD_DIR --parallel $(nproc)
cmake --install $BUILD_DIR --prefix <windows_prefix>   # include/, lib/libutils.a, lib/cmake/utils/
cmake --build $BUILD_DIR --target package               # mingw64-libutils-* RPM/DEB

2.2 Integrate2.2 Intégrer

find_package(utils 4.1.0 REQUIRED)
target_link_libraries(${TARGET} PRIVATE utils::utils)   # includes, static lib & OpenSSL

#define _Network
#define _Cli
#include <utils/utils.hpp>

3. Sections3. Sections

The full dependency view of the headers, classes and calls is on the graph page.La vue complète des dépendances entre en-têtes, classes et appels est sur la page graphe.

4. Errors4. Erreurs

Every error is an exception carrying a type and a code, never a return code. The codes are generated at the build from cmake/config/exceptions/**/*.json; a project adds its own codes (ExternalCode) with the same JSON format.Chaque erreur est une exception portant un type et un code, jamais un code de retour. Les codes sont générés au build depuis cmake/config/exceptions/**/*.json ; un projet ajoute ses propres codes (ExternalCode) avec le même format JSON.

try {
    server.start();
} catch (const utils::exception::IException& e) {
    if (e.getCode() == utils::exception::InternalCode::AlreadyRunning) return;
    std::cerr << e.formated() << std::endl; // [Error] file:line (origin) -> message / function = info
}

5. Network & EETP5. Réseau & EETP

A Server and a Client exchange payloads (strings ended by a separator, '\n' by default) through a socket object. listen() reads what is available without blocking, join() waits for the next epoll event; stop() / kill() can be called from another thread. On Windows the sockets use Winsock 2 and the epoll is emulated over WSAPoll.Un Server et un Client échangent des payloads (chaînes terminées par un séparateur, '\n' par défaut) via un objet socket. listen() lit ce qui est disponible sans bloquer, join() attend le prochain événement epoll ; stop() / kill() peuvent être appelés depuis un autre thread. Sous Windows les sockets utilisent Winsock 2 et l'epoll est émulé avec WSAPoll.

5.1 EETP protocol5.1 Protocole EETP

EETPParser keeps the keys of each peer: the client sends SYN (its RSA public key, encrypted with the common RSA key of ~/.ssh/common), the server answers SO (a new AES-256 key, encrypted with the client key), then every message is AES-256-GCM encrypted with a new random iv.EETPParser garde les clés de chaque pair : le client envoie SYN (sa clé publique RSA, chiffrée avec la clé RSA commune de ~/.ssh/common), le serveur répond SO (une nouvelle clé AES-256, chiffrée avec la clé du client), puis chaque message est chiffré en AES-256-GCM avec un nouvel iv aléatoire.

6. Processes & IPC6. Processus & IPC

Process wraps fork / execvp / waitpid with pipes and fd duplications applied in the child; Poll wraps epoll; SharedObject loads a .so. SharedMemory passes messages between processes through a POSIX shared memory split in slots. On Windows: CreateProcess, WSAPoll, LoadLibrary (.dll) and a file mapping with a named event (section 7).Process encapsule fork / execvp / waitpid avec pipes et duplications de fd appliquées dans le fils ; Poll encapsule epoll ; SharedObject charge un .so. SharedMemory fait passer des messages entre processus via une mémoire partagée POSIX découpée en slots. Sous Windows : CreateProcess, WSAPoll, LoadLibrary (.dll) et un file mapping avec un événement nommé (section 7).

7. Platforms7. Plateformes

Every class has the same API on Unix and Windows: the library only calls the system through utils::platform::, whose functions have the names, arguments and contract of POSIX (-1 and errno). On Unix they are the system calls, on Windows a Win32 / Winsock / CRT implementation. The same calls are given to the programs by the section _Platform.Chaque classe a la même API sous Unix et Windows : la bibliothèque n'appelle le système que via utils::platform::, dont les fonctions ont les noms, arguments et contrat de POSIX (-1 et errno). Sous Unix ce sont les appels système, sous Windows une implémentation Win32 / Winsock / CRT. Les mêmes appels sont donnés aux programmes par la section _Platform.

7.1 Calls7.1 Appels

7.2 Differences7.2 Différences

8. Build, tests & CI8. Build, tests & CI

9. Licenses9. Licences