{"id":18565013,"url":"https://github.com/greenbone/gsad","last_synced_at":"2026-04-09T10:17:40.155Z","repository":{"id":37976920,"uuid":"380210961","full_name":"greenbone/gsad","owner":"greenbone","description":"Greenbone Security Assistant HTTP Server - The server talking to the Greenbone Vulnerability Management daemon (gvmd).","archived":false,"fork":false,"pushed_at":"2026-02-19T11:48:31.000Z","size":54554,"stargazers_count":21,"open_issues_count":1,"forks_count":17,"subscribers_count":15,"default_branch":"main","last_synced_at":"2026-02-19T14:35:32.122Z","etag":null,"topics":["backend","base","c","gea","greenbone","greenbone-vulnerability-management","openvas","vulnerability-management","webserver"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/greenbone.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.toml","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-06-25T11:03:04.000Z","updated_at":"2026-02-19T11:48:35.000Z","dependencies_parsed_at":"2023-02-19T07:50:17.337Z","dependency_job_id":"4f432a83-d39c-424d-9bec-6290c24f5407","html_url":"https://github.com/greenbone/gsad","commit_stats":null,"previous_names":[],"tags_count":156,"template":false,"template_full_name":null,"purl":"pkg:github/greenbone/gsad","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fgsad","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fgsad/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fgsad/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fgsad/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/greenbone","download_url":"https://codeload.github.com/greenbone/gsad/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenbone%2Fgsad/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29741154,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-23T07:44:07.782Z","status":"ssl_error","status_checked_at":"2026-02-23T07:44:07.432Z","response_time":90,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backend","base","c","gea","greenbone","greenbone-vulnerability-management","openvas","vulnerability-management","webserver"],"created_at":"2024-11-06T22:17:25.233Z","updated_at":"2026-04-09T10:17:40.148Z","avatar_url":"https://github.com/greenbone.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Greenbone Logo](https://www.greenbone.net/wp-content/uploads/gb_new-logo_horizontal_rgb_small.png)\n\n# Greenbone Security Assistant HTTP server \u003c!-- omit in toc --\u003e\n\n[![GitHub releases](https://img.shields.io/github/release/greenbone/gsad.svg)](https://github.com/greenbone/gsad/releases)\n[![Build and test C](https://github.com/greenbone/gsad/actions/workflows/ci-c.yml/badge.svg?branch=main)](https://github.com/greenbone/gsad/actions/workflows/ci-c.yml?query=branch%3Amain++)\n\nThe Greenbone Security Assistant HTTP Server is the server developed for the\ncommunication with the [Greenbone Enterprise appliances](https://www.greenbone.net/en/product-comparison/).\n\nIt connects to the Greenbone Vulnerability Manager Daemon **gvmd** to provide a\nfull-featured HTTP interface for vulnerability management.\n\n- [Releases](#releases)\n- [Installation](#installation)\n  - [Prerequisites](#prerequisites)\n  - [Compiling](#compiling)\n  - [Unit tests](#unit-tests)\n- [Logging Configuration](#logging-configuration)\n- [Usage](#usage)\n- [Development](#development)\n- [Support](#support)\n- [Maintainer](#maintainer)\n- [Contributing](#contributing)\n  - [Code style and formatting](#code-style-and-formatting)\n  - [CMake formatting](#cmake-formatting)\n- [License](#license)\n\n## Releases\n\nAll [release files](https://github.com/greenbone/gsad/releases) are signed with\nthe [Greenbone Community Feed integrity key](https://community.greenbone.net/t/gcf-managing-the-digital-signatures/101).\nThis gpg key can be downloaded at https://www.greenbone.net/GBCommunitySigningKey.asc\nand the fingerprint is `8AE4 BE42 9B60 A59B 311C  2E73 9823 FAA6 0ED1 E580`.\n\n## Installation\n\nIf you are not familiar or comfortable building from source code, we recommend\nthat you use the Greenbone Security Manager TRIAL (GSM TRIAL), a prepared virtual\nmachine with a readily available setup. Information regarding the virtual machine\nis available at \u003chttps://www.greenbone.net/en/testnow\u003e.\n\nThis module can be configured, built and installed with following commands:\n\n```bash\ncd path/to/gsad\nmkdir build \u0026\u0026 cd build\ncmake ..\nmake install\n```\n\nPlease note: The reference system used by most of the developers is Debian\nGNU/Linux 'Buster' 10. The build might fail on any other system. Also, it is\nnecessary to install dependent development packages.\n\n### Prerequisites\n\nSee at the end of this section how to easily install these prerequisites on\nsome supported platforms.\n\nPrerequisites:\n\n- libgvm_base, libgvm_util \u003e= 22.8.0\n- libgvm_gmp \u003e= 22.38.0\n- gnutls \u003e= 3.2.15\n- libgcrypt\n- cmake \u003e= 3.18\n- glib-2.0 \u003e= 2.42\n- libxml\n- libmicrohttpd \u003e= 0.9.0\n- pkg-config\n- gcc\n- zlib \u003e= 1.2\n- libbrotli (optional, for Brotli compression)\n\nOptional prerequisites\n\n- Doxygen (for building documentation)\n- xmltoman (for building man page)\n- cgreen (for building tests)\n- libasan (for building tests)\n\nInstall prerequisites on Debian GNU/Linux:\n\n```bash\napt-get install libmicrohttpd-dev libxml2-dev zlib1g-dev\n```\n\n### Compiling\n\nIf you have installed required libraries to a non-standard location, remember to\nset the `PKG_CONFIG_PATH` environment variable to the location of you pkg-config\nfiles before configuring:\n\n```bash\nexport PKG_CONFIG_PATH=/your/location/lib/pkgconfig:$PKG_CONFIG_PATH\n```\n\nCreate a build directory and change into it with:\n\n```bash\nmkdir build \u0026\u0026 cd build\n```\n\nThen configure the build with:\n\n```bash\ncmake -DCMAKE_INSTALL_PREFIX=/path/to/your/installation ..\n```\n\nOr (if you want to use the default installation path /usr/local):\n\n```bash\ncmake ..\n```\n\nThis only needs to be done once.\n\nThereafter, the following commands are useful:\n\n```sh\nmake                # build the scanner\nmake doc            # build the documentation\nmake doc-full       # build more developer-oriented documentation\nmake install        # install the build\nmake rebuild_cache  # rebuild the cmake cache\n```\n\nPlease note that you may have to execute `make install` as root, especially if\nyou have specified a prefix for which your user does not have full permissions.\n\nTo clean up the build environment, simply remove the contents of the `build`\ndirectory you created above.\n\nIn case you have installed the Greenbone Security Assistant Daemon into a path\ndifferent from the other GVM modules, you might need to set some paths\nexplicitly before running `cmake`. See the top-level CMakeLists.txt.\n\n### Unit tests\n\nIn order to build and run unit tests use the commands below:\n\n```sh\ncmake -DBUILD_TESTING=1 ..  # enable building unit tests\nmake tests                  # build the unit tests\nmake test                   # run the unit tests\n```\n\n## Logging Configuration\n\nBy default, gsad writes logs to the file\n\n```text\n\u003cinstall-prefix\u003e/var/log/gvm/gsad.log\n```\n\nLogging is configured entirely by the file\n\n```text\n\u003cinstall-prefix\u003e/etc/gvm/gsad_log.conf\n```\n\nThe configuration is divided into domains like this one\n\n```ini\n[gsad main]\nprepend=%t %p\nprepend_time_format=%Y-%m-%d %Hh%M.%S %Z\nfile=/var/log/gvm/gsad.log\nlevel=debug\n```\n\nThe `level` field controls the amount of logging that is written.\nThe value of `level` can be:\n\n```text\nerror      4  Errors.\ncritical   8  Critical situation.\nwarning   16  Warnings.\nmessage   32  Messages.\ninfo      64  Information.\ndebug    128  Debug.  (Lots of output.)\n```\n\nEnabling any level includes all the levels above it. So enabling Information\nwill include Warnings, Critical situations and Errors.\n\nTo get absolutely all logging, set the level to 128 for all domains in the\nconfiguration file.\n\nLogging to `syslog` can be enabled in each domain like:\n\n```ini\n[gsad main]\nprepend=%t %p\nprepend_time_format=%Y-%m-%d %Hh%M.%S %Z\nfile=syslog\nsyslog_facility=daemon\nlevel=debug\n```\n\n## Usage\n\nIn case everything was installed using the defaults, then starting the HTTP\ndaemon of the Greenbone Security Assistant can be done with this simple command:\n\n```sh\ngsad\n```\n\nThe daemon will listen on port 443, making the web interface\navailable in your network at `https://\u003cyour host\u003e`.\n\nIf port 443 was not available or the user has no root privileges,\ngsad tries to serve at port 9392 as a fallback (`https://\u003cyour host\u003e:9392`).\n\nTo see all available command line options of gsad, enter this command:\n\n```sh\ngsad --help\n```\n\n## Development\n\nFor development a [Devcontainers](https://containers.dev/) setup can be used.\nDevcontainers are currently supported by [Visual Studio Code](https://code.visualstudio.com/docs/devcontainers/containers)\nand [IntelliJ IDEA](https://blog.jetbrains.com/idea/2024/07/using-dev-containers-in-jetbrains-ides-part-1/).\nThe provided Devcontainers setup comes with all required dependencies for building\ngsad out of the box.\n\n## Support\n\nFor any question on the usage of `gsad` please use the [Greenbone Community\nPortal](https://community.greenbone.net/). If you found a problem with the\nsoftware, please [create an issue](https://github.com/greenbone/gsad/issues) on\nGitHub. If you are a Greenbone customer you may alternatively or additionally\nforward your issue to the Greenbone Support Portal.\n\n## Maintainer\n\nThis project is maintained by [Greenbone Networks\nGmbH](https://www.greenbone.net/).\n\n## Contributing\n\nYour contributions are highly appreciated. Please [create a pull\nrequest](https://github.com/greenbone/gsad/pulls) on GitHub. Bigger changes need\nto be discussed with the development team via the [issues section at\ngithub](https://github.com/greenbone/gsad/issues) first.\n\n### Code style and formatting\n\nBefore creating a pull request, it is recommended to run the following command:\n\n```sh\nmake format\n```\n\nThis reformats the new code to ensure that it follows the code style and\nformatting guidelines.\n\n### CMake formatting\n\nAll CMake files are formatted using [gersemi](https://github.com/BlankSpruce/gersemi).\nTo install gersemi on a Debian based system the following commands can be used:\n\n```sh\nsudo apt install pipx\npipx install gersemi\n```\n\nTo format all CMake files run the command:\n\n```sh\ngersemi -i cmake .\n```\n\n## License\n\nCopyright (C) 2009-2026 [Greenbone AG](https://www.greenbone.net/)\n\nLicensed under the [GNU Affero General Public License v3.0 or later](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenbone%2Fgsad","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreenbone%2Fgsad","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenbone%2Fgsad/lists"}