Skip to content

Latest commit

 

History

History
331 lines (234 loc) · 8.4 KB

BUILD.md

File metadata and controls

331 lines (234 loc) · 8.4 KB

Build Instructions

The following dependencies are required for building this project:

  • Git
  • CMake at least 3.22
  • C++ compiler (GCC 10 or Clang 13, coroutines support needed)
  • Vcpkg
  • Pkg-config
  • Plus some additional packages listed below...

Compilation steps for Linux

  1. Installing Dependencies on Debian

    To install the necessary dependencies on a Debian-based system, run the following commands:

    sudo apt-get update
sudo apt-get install cmake make g++ gcc git zip unzip curl tar ninja-build pkg-config wget \
lsb-release libsystemd-dev autopoint autoconf libtool gettext

  2. Clone the Repository

    First, clone the repository using the following command:

    git clone https://github.com/wazuh/wazuh-agent.git

  3. Vcpkg

    The project uses Vcpkg for dependency management. If you already have Vcpkg's repository checked out, you can speed up the configuration process slightly by making sure that VCPKG_ROOT is set to its path. Otherwise, it will be checked out during CMake's configuration phase.

  4. Configure and Build the Project

    cd wazuh-agent
cmake src -B build
cmake --build build

    If you want to include tests, configure the project with the following command:

    cmake src -B build -DBUILD_TESTS=1
cmake --build build

  5. Run the Agent

    To run the agent in the foreground from the CLI

    You can start and get status with:

    ./wazuh-agent
./wazuh-agent --status

    To run the agent as a systemd service

    Copy the file src/agent/service/wazuh-agent.service to /usr/lib/systemd/system/. Replace the placeholder WAZUH_HOME to your wazuh-agent executable directory. Reload unit files.

    systemctl daemon-reload

    Enable service.

    systemctl enable wazuh-agent

    You can start and stop the agent, and get status from systemctl:

    systemctl start wazuh-agent
systemctl stop wazuh-agent
systemctl is-active wazuh-agent
systemctl status wazuh-agent

  6. Run tests

    If built with CMake and -DBUILD_TESTS=1, you can run tests with:

    ctest --test-dir build --output-log build

Compilation steps for macOS

  1. Install brew, a package manager for macOS

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

  2. Install dependencies

    brew install automake autoconf libtool cmake pkg-config openssl

  3. Clone the Repository

    Clone the repository:

    git clone https://github.com/wazuh/wazuh-agent.git

  4. Vcpkg

    The project uses Vcpkg for dependency management. If you already have Vcpkg's repository checked out, you can speed up the configuration process slightly by making sure that VCPKG_ROOT is set to its path. Otherwise, it will be checked out during CMake's configuration phase.

  5. Configure and Build the Project

    cd wazuh-agent
cmake src -B build
cmake --build build

    If you want to include tests, configure the project with the following command:

    cmake src -B build -DBUILD_TESTS=1
cmake --build build

  6. Run the Agent

    To run the agent in the foreground from the CLI

    You can start and get status with:

    ./wazuh-agent
./wazuh-agent --status

    To run the agent as a launchd service

    Copy the property list file src/agent/service/com.wazuh.agent.plist to /Library/LaunchDaemons/. Edit the file and replace the placeholder path with your wazuh-agent executable directory as well as the working directory.

    sudo chown root:wheel /Library/LaunchDaemons/com.wazuh.agent.plist
sudo chmod 644 /Library/LaunchDaemons/com.wazuh.agent.plist

    Load the service

    sudo launchctl bootstrap system /Library/LaunchDaemons/com.wazuh.agent.plist

    This command has superseeded load in the legacy syntax. The daemon will run after load as indicated in the property list file.

    Unload the service

    sudo launchctl bootout system /Library/LaunchDaemons/com.wazuh.agent.plist

    This command has superseeded unload in the legacy syntax.

    Verify the service is running

    sudo launchctl print system/com.wazuh.agent

  7. Run tests

    If built with CMake and -DBUILD_TESTS=1, you can run tests with:

    ctest --test-dir build --output-log build

  8. Package Installation

    If you wish to install a package use the following command.

    sudo installer -pkg /path/to/package/package_filename.pkg -target /

    Then load and manage the service as indicated in point 6 above. Skip the property list file copying and editing as well as the permissions part - the installer takes care of that.

Compilation steps for Windows

  1. Installing Dependencies
  • Visual Studio Community 2022 (with MSVC 14)
  • Chocolatey 
    Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
  • Make 
    choco install make
  • Cmake 3.30.x 
    choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'
  • OpenSSL 
    choco install openssl
  • Git

  1. Clone the Repository

    First, clone the repository using the following command:

    git clone https://github.com/wazuh/wazuh-agent.git

  2. Vcpkg

    The project uses Vcpkg for dependency management. If you already have Vcpkg's repository checked out, you can speed up the configuration process slightly by making sure that VCPKG_ROOT is set to its path. Otherwise, it will be checked out during CMake's configuration phase.

  3. Configure and Build the Project

    cd wazuh-agent
cmake src -B build -G "Visual Studio 17 2022" -A x64
cmake --build build

    If you want to include tests, configure the project with the following command:

    cmake src -B build -DBUILD_TESTS=1 -G "Visual Studio 17 2022" -A x64
cmake --build build --config RelWithDebInfo

  4. Run the Agent

    To run the agent in the foreground from the CLI

    You can start and get status with the following commands:

    .\wazuh-agent
.\wazuh-agent --status

    To install the agent as a windows service

    .\RelWithDebInfo\wazuh-agent --install-service

    You can start, stop or restart the service from Windows SCM.

    Or from the CLI

    net start "Wazuh Agent"
net stop "Wazuh Agent"

    To remove the service

    .\RelWithDebInfo\wazuh-agent --remove-service

  5. Run tests

    If built with CMake and -DBUILD_TESTS=1, you can run tests with:

    ctest -C RelWithDebInfo --test-dir build --output-log build

Options

Option Description Default
BUILD_TESTS Enable tests compilation OFF
COVERAGE Enable coverage report OFF
ENABLE_CLANG_TIDY Check code with clang-tidy (requires clang-tidy-18) ON
ENABLE_INVENTORY Enable Inventory module ON
ENABLE_LOGCOLLECTOR Enable Logcollector module ON

Notes for developers

In addition to the requirements listed above, our development process mandates the use of clang-format and clang-tidy, with checks integrated into our CI pipelines.

On Linux, these tools can be installed with the following commands:

wget https://apt.llvm.org/llvm.sh
chmod +x llvm.sh
sudo ./llvm.sh 18
sudo apt-get update
sudo apt-get install -y clang-tidy-18 clang-format-18

Additionally, you may choose to checkout Vcpkg to a separate path and use that instance for builds:

git clone https://github.com/microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
export VCPKG_ROOT=$(pwd)