|
|
||
|---|---|---|
| .devcontainer | ||
| .docker | ||
| .github | ||
| agent_controller | ||
| base | ||
| boreas | ||
| cmake | ||
| container_image_scanner | ||
| cyberark | ||
| doc | ||
| gmp | ||
| http | ||
| http_scanner | ||
| openvasd | ||
| osp | ||
| tests | ||
| util | ||
| .clang-format | ||
| .codecov.yml | ||
| .dockerignore | ||
| .gcovr.cfg | ||
| .gersemirc | ||
| .gitignore | ||
| .mergify.yml | ||
| cliff.toml | ||
| CMakeLists.txt | ||
| COPYING | ||
| INSTALL.md | ||
| README.md | ||
| VERSION.in | ||
gvm-libs
This is the libraries module for the Greenbone Community Edition.
It is used for the Greenbone Enterprise appliances and provides various functionalities to support the integrated service daemons.
Releases
All release files are signed with
the Greenbone Community Feed integrity key.
This gpg key can be downloaded at https://www.greenbone.net/GBCommunitySigningKey.asc
and the fingerprint is 8AE4 BE42 9B60 A59B 311C 2E73 9823 FAA6 0ED1 E580.
Installation
This module can be configured, built and installed with following commands:
cmake .
make install
For detailed installation requirements and instructions, please see the file INSTALL.md.
If you are not familiar or comfortable building from source code, we recommend that you use the Greenbone Security Manager TRIAL (GSM TRIAL), a prepared virtual machine with a readily available setup. Information regarding the virtual machine is available at https://www.greenbone.net/en/testnow.
Usage
The gvm-libs module consists of the following libraries:
-
base: All basic modules which require only thegliblibrary as a dependency. -
util: All modules that require more than thegliblibrary as dependency. -
gmp: API support for the Greenbone Management Protocol (GMP). -
osp: API support for the Open Scanner Protocol (OSP).
For more information on using the functionality provided by the gvm-libs
module please refer to the source code documentation.
Support
For any question on the usage of gvm-libs please use the Greenbone Community
Portal. If you found a problem with the
software, please create an issue
on GitHub. If you are a Greenbone customer you may alternatively or additionally
forward your issue to the Greenbone Support Portal.
Maintainer
This project is maintained by Greenbone AG.
Contributing
Your contributions are highly appreciated. Please create a pull request on GitHub. Bigger changes need to be discussed with the development team via the issues section at github first.
Before creating a pull request, it is recommended to check the formatting for source code and cmake files.
Code style and formatting
All C source and header files are formatted using clang-format. To install clang-format on a Debian based system the following command can be used:
sudo apt install clang-format
To format all C source and header files run the command:
make format
This reformats the new code to ensure that it follows the code style and formatting guidelines.
CMake formatting
All CMake files are formatted using gersemi. To install gersemi on a Debian based system the following commands can be used:
sudo apt install pipx
pipx install gersemi
To format all CMake files run the command:
gersemi -i cmake .
Static code analysis with the Clang Static Analyzer
If you want to use the Clang Static Analyzer
to do a static code analysis, you can do so by prefixing the configuration and
build commands with scan-build:
scan-build cmake ..
scan-build make
The tool will provide a hint on how to launch a web browser with the results.
It is recommended to do this analysis in a separate, empty build directory and
to empty the build directory before scan-build call.
License
Copyright (C) 2009-2025 Greenbone AG
Licensed under the GNU General Public License v2.0 or later.