Description

The objective of this project is to maintain a library that has the responsibility of providing efficient file downloading and information retrieval to multiple remote information providers.

The main requirement is that its use be simple and abstract to what is strictly necessary to obtain said information.

It allows the download and invocation and calls to REST apis through the methods of GET, POST, PUT and DELETE.

Building

This project use CMake and VCPKG

cd ..
git clone https://github.com/microsoft/vcpkg.git
cd vcpkg && ./bootstrap-vcpkg.sh
export VCPKG_ROOT=$(pwd)
export PATH=$VCPKG_ROOT:$PATH
cd ../wazuh-http-request
cmake --preset=debug
cmake --build build -j$(nproc)

Please see the CMake documentation and CMakeLists.txt for more advanced usage.

Contribution Requirements

CPP Migration tools

1. Coding Style This project follow the Wazuh C++ Coding Style Wazuh C++ style guide

2. Tests All changes must be accompanied by a new (or changed) tests. Unit, component and benchmarking.

3. Fuzzing It is quite interesting and important to fuzz the interfaces of the designed components.

4. Diagrams All changes must be accompanied by a new (or changed) architectural diagrams.

Documentation

Apart from the markdown that we can find in the readme of the project subfolders, the code has doxygen headers, which generate technical documentation that gives some context of what the call tree is like, and what parameters and returns they have.

root@wazuh-dev:~/repos/wazuh-http-request# doxygen doxygen.cfg

After executing this command, open the index.html file that is generated in the doc/html folder, to view this technical and implementation documentation.