{"id":19844459,"url":"https://github.com/vulnerscom/vulners-agent","last_synced_at":"2025-04-05T09:06:54.645Z","repository":{"id":37692670,"uuid":"100047580","full_name":"vulnersCom/vulners-agent","owner":"vulnersCom","description":"Agent scanner for vulners.com","archived":false,"fork":false,"pushed_at":"2025-03-27T15:56:00.000Z","size":318,"stargazers_count":90,"open_issues_count":9,"forks_count":38,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-03-29T08:06:59.205Z","etag":null,"topics":["linux","scanner","vulnerabilities","vulnerability-scanners"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vulnersCom.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-11T15:48:10.000Z","updated_at":"2025-03-27T15:56:05.000Z","dependencies_parsed_at":"2024-02-05T20:34:17.019Z","dependency_job_id":"1cc8ac5b-252e-4cfd-9875-7b011d3b38c3","html_url":"https://github.com/vulnersCom/vulners-agent","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vulnersCom%2Fvulners-agent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vulnersCom%2Fvulners-agent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vulnersCom%2Fvulners-agent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vulnersCom%2Fvulners-agent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vulnersCom","download_url":"https://codeload.github.com/vulnersCom/vulners-agent/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247312077,"owners_count":20918344,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["linux","scanner","vulnerabilities","vulnerability-scanners"],"created_at":"2024-11-12T13:04:17.309Z","updated_at":"2025-04-05T09:06:54.607Z","avatar_url":"https://github.com/vulnersCom.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vulners agent\n\n![Vulners Agent](img/vulners_logo.png)\n\nVulners agent is an open source solution, which provides vulnerability assessment for Linux-based and Windows operating systems. The agent performs scans with minimum execution commands and, as a result, achieves extremely fast scanning speed. You will need the **Python 3** to install the agent.\n\nThe agent gathers information about your operating system, its version, and any installed packages. This information is then sent to Vulners API to find out which software is vulnerable. You can check how it works in [manual mode](https://vulners.com/audit) to evaluate the results.\n\n![Vulners Audit IP Summary](img/audit_ipsummary.png)\n\n## Installation for Linux-based operating systems\n\n### Configure a repository for RHEL-based Linux:\n\nCreate file **/etc/yum.repos.d/vulners.repo**\n\nFor rhel6:\n\n```\n[vulners]\nname=Vulners Agent\nbaseurl=https://repo.vulners.com/redhat/el6/\nenabled=1\ngpgcheck=1\ngpgkey=https://repo.vulners.com/pubkey.txt\n```\n\nFor rhel7:\n```\n[vulners]\nname=Vulners Agent\nbaseurl=https://repo.vulners.com/redhat/el7/\nenabled=1\ngpgcheck=1\ngpgkey=https://repo.vulners.com/pubkey.txt\n```\n\n### Configure a repository for Debian-based Linux:\n\nFirst, add vulners.com pubkey:\n```\nwget -O- https://repo.vulners.com/pubkey.txt | apt-key add -\n```\n\nThen, create file **/etc/apt/sources.list.d/vulners.list**\n```\ndeb http://repo.vulners.com/debian focal main\n```\n\n### Install packet:\n\n#### RHEL\n```yum install vulners-agent```\n\n#### Debian\n```apt-get update \u0026\u0026 apt-get install vulners-agent```\n\n### Source code (NOT recommended)\nYou could clone the source code of a package and perform scans using Python. According to best practices, this should be done in a virtual environment:\n\n* install poetry as it's described on official website - https://python-poetry.org/docs/\n* install requirements ```poetry install --no-root```,\n* configure the agent as described below\n* run ```poetry run ./application.py --app Scanner```.\n\n## Configuration for Linux-based operating systems\nNow, you have to generate an API key to register the agent. [Log in](https://vulners.com/userinfo) to Vulners, go to the userinfo space and click on the API KEYS tab. In the \"Scope\" field, select \"scan\", click SAVE and then copy the generated key. The result should look something like this:\n\n**RGB9YPJG7CFAXP35PMDVYFFJPGZ9ZIRO1VGO9K9269B0K86K6XQQQR32O6007NUK**\n\nNow, you can embed the generated key into the agent. The agent configuration file is located at /etc/vulners/vulners_agent.conf.\n\nExample of the config file:\n\n```\n[DEFAULT]\napi_key = RGB9YPJG7CFAXP35PMDVYFFJPGZ9ZIRO1VGO9K9269B0K86K6XQQQR32O6007NUK\n```\nYou can use one API key for all your agents.\n\n### Execution\n\nDuring the first run, the agent will be automatically registered with the configured API key.\n\nPerform a system scan by running ```vulners-agent --app Scanner```.\n\nOnce finished, you can view agent status and scan results in the [Audit](https://vulners.com/linux-scanner/audit) section of your personal account. \n\n### Advanced configuration\n\nUsing /etc/vulners/vulners_agent.conf you can override part of the identification parameters.\n\n```\n[DEFAULT]\napi_key = RGB9YPJG7CFAXP35PMDVYFFJPGZ9ZIRO1VGO9K9269B0K86K6XQQQR32O6007NUK\n\n[Ticker]\nip_address = 10.0.0.1\nfqdn = my.host.example.com\nmac_address = 00:01:02:03:04:06\ninterval = 3h30m\ntags = tag1,tag2 ;comma separated user defined values\n```\n\n## Installation and configuration for Windows\nRun VulnersAgentInstaller_v2.2.0.msi and follow wizard.\n\nGenerate API-key to register the agent and paste it during the configuration step. \nIf necessary, you can set an alternate Vulners host or Vulners proxy address. You can also set agent identification parameters, such as IP address and FQDN. You will see these parameters in the Dashboard. \n\n\u003cimg src=\"img/configuration.png\" alt=\"drawing\" width=\"450\"/\u003e\n\nPress Next and finish installation. Scanning process will be started automatically.\n\nTo run installer silently use following arguments\n- APIKEY (required)\n- INSTALLDIR\n- HOST\n- IP\n- FQDN\n- MAC\n\nThe installation process will create a scheduled task that performs the scan and a configuration file. You can use the Windows Task Scheduler console to adjust the scan interval. The configuration and logs are located in the Program Data folder. ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvulnerscom%2Fvulners-agent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvulnerscom%2Fvulners-agent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvulnerscom%2Fvulners-agent/lists"}