172 lines
7.5 KiB
Markdown
172 lines
7.5 KiB
Markdown
|
|
# Vuls: VULnerability Scanner
|
|
|
|
[](http://goo.gl/forms/xm5KFo35tu)
|
|
[](https://github.com/future-architect/vuls/blob/master/LICENSE)
|
|
[](https://travis-ci.org/future-architect/vuls)
|
|
[](https://goreportcard.com/report/github.com/future-architect/vuls)
|
|
[](https://github.com/future-architect/vuls/graphs/contributors)
|
|
|
|
|
|
|
|
Vulnerability scanner for Linux/FreeBSD, agentless, written in golang.
|
|
We have a slack team. [Join slack team](http://goo.gl/forms/xm5KFo35tu)
|
|
Twitter: [@vuls_en](https://twitter.com/vuls_en)
|
|
|
|
|
|
|
|
|
|
|
|
[](https://asciinema.org/a/3y9zrf950agiko7klg8abvyck)
|
|
|
|
|
|
|
|
----
|
|
|
|
# Abstract
|
|
|
|
For a system administrator, having to perform security vulnerability analysis and software update on a daily basis can be a burden.
|
|
To avoid downtime in production environment, it is common for system administrator to choose not to use the automatic update option provided by package manager and to perform update manually.
|
|
This leads to the following problems.
|
|
|
|
- System administrator will have to constantly watch out for any new vulnerabilities in NVD(National Vulnerability Database) or similar databases.
|
|
- It might be impossible for the system administrator to monitor all the software if there are a large number of software installed in server.
|
|
- It is expensive to perform analysis to determine the servers affected by new vulnerabilities. The possibility of overlooking a server or two during analysis is there.
|
|
|
|
Vuls is a tool created to solve the problems listed above. It has the following characteristics.
|
|
|
|
- Informs users of the vulnerabilities that are related to the system.
|
|
- Informs users of the servers that are affected.
|
|
- Vulnerability detection is done automatically to prevent any oversight.
|
|
- Report is generated on regular basis using CRON or other methods. to manage vulnerability.
|
|
|
|
|
|
|
|
----
|
|
|
|
# Main Features
|
|
|
|
## Scan for any vulnerabilities in Linux/FreeBSD Server
|
|
|
|
[Supports major Linux/FreeBSD](https://vuls.io/docs/en/supported-os.html)
|
|
|
|
- Alpine, Ubuntu, Debian, CentOS, Amazon Linux, RHEL, Oracle Linux, SUSE Enterprise Linux and Raspbian, FreeBSD
|
|
- Cloud, on-premise, Docker
|
|
|
|
## High quality scan
|
|
|
|
Vuls uses Multiple vulnerability databases
|
|
|
|
- [NVD](https://nvd.nist.gov/)
|
|
- [JVN(Japanese)](http://jvndb.jvn.jp/apis/myjvn/)
|
|
- OVAL
|
|
- [RedHat](https://www.redhat.com/security/data/oval/)
|
|
- [Debian](https://www.debian.org/security/oval/)
|
|
- [Ubuntu](https://people.canonical.com/~ubuntu-security/oval/)
|
|
- [SUSE](http://ftp.suse.com/pub/projects/security/oval/)
|
|
- [Oracle Linux](https://linux.oracle.com/security/oval/)
|
|
|
|
- [Alpine-secdb](https://git.alpinelinux.org/cgit/alpine-secdb/)
|
|
- [Red Hat Security Advisories](https://access.redhat.com/security/security-updates/)
|
|
- [Debian Security Bug Tracker](https://security-tracker.debian.org/tracker/)
|
|
- Commands(yum, zypper, pkg-audit)
|
|
- RHSA/ALAS/ELSA/FreeBSD-SA
|
|
- [Exploit Database](https://www.exploit-db.com/)
|
|
- [US-CERT](https://www.us-cert.gov/ncas/alerts)
|
|
- [JPCERT](http://www.jpcert.or.jp/at/2019.html)
|
|
- Changelog
|
|
|
|
## Fast scan and Deep scan
|
|
|
|
[Fast Scan](https://vuls.io/docs/en/architecture-fast-scan.html)
|
|
|
|
- Scan without root privilege, no dependencies
|
|
- Almost no load on the scan target server
|
|
- Offline mode scan with no internet access. (Red Hat, CentOS, OracleLinux, Ubuntu, Debian)
|
|
|
|
[Fast Root Scan](https://vuls.io/docs/en/architecture-fast-root-scan.html)
|
|
|
|
- Scan with root privilege
|
|
- Almost no load on the scan target server
|
|
- Detect processes affected by update using yum-ps (RedHat, CentOS, Oracle Linux and Amazon Linux)
|
|
- Detect processes which updated before but not restarting yet using checkrestart of debian-goodies (Debian and Ubuntu)
|
|
- Offline mode scan with no internet access. (RedHat, CentOS, OracleLinux, Ubuntu, Debian)
|
|
|
|
[Deep Scan](https://vuls.io/docs/en/architecture-deep-scan.html)
|
|
|
|
- Scan with root privilege
|
|
- Parses the Changelog
|
|
Changelog has a history of version changes. When a security issue is fixed, the relevant CVE ID is listed.
|
|
By parsing the changelog and analysing the updates between the installed version of software on the server and the newest version of that software
|
|
it's possible to create a list of all vulnerabilities that need to be fixed.
|
|
- Sometimes load on the scan target server
|
|
|
|
## [Remote scan and Local scan](https://vuls.io/docs/en/architecture-remote-local.html)
|
|
|
|
[Remote Scan](https://vuls.io/docs/en/architecture-remote-scan.html)
|
|
|
|
- User is required to only setup one machine that is connected to other target servers via SSH
|
|
|
|
[Local Scan](https://vuls.io/docs/en/architecture-local-scan.html)
|
|
|
|
- If you don't want the central Vuls server to connect to each server by SSH, you can use Vuls in the Local Scan mode.
|
|
|
|
## **Dynamic** Analysis
|
|
|
|
- It is possible to acquire the state of the server by connecting via SSH and executing the command.
|
|
- Vuls warns when the scan target server was updated the kernel etc. but not restarting it.
|
|
|
|
## Scan vulnerabilites of non-OS packages
|
|
|
|
- [Common Platform Enumeration (CPE) based Scan](https://vuls.io/docs/en/usage-scan-non-os-packages.html#how-to-search-cpe-name-by-software-name)
|
|
- NW equipment, middleware, programming language libraries and framework for vulnerability
|
|
- Integrate with [GitHub Security Alerts](https://vuls.io/docs/en/usage-scan-non-os-packages.html#usage-integrate-with-github-security-alerts)
|
|
- Integrate with [OWASP Dependency Check](https://vuls.io/docs/en/usage-scan-non-os-packages.html#usage-integrate-with-owasp-dependency-check-to-automatic-update-when-the-libraries-are-updated-experimental)
|
|
|
|
## MISC
|
|
|
|
- Nondestructive testing
|
|
- Pre-authorization is *NOT* necessary before scanning on AWS
|
|
- Vuls works well with Continuous Integration since tests can be run every day. This allows you to find vulnerabilities very quickly.
|
|
- Auto generation of configuration file template
|
|
- Auto detection of servers set using CIDR, generate configuration file template
|
|
- Email and Slack notification is possible (supports Japanese language)
|
|
- Scan result is viewable on accessory software, TUI Viewer on terminal or Web UI ([VulsRepo](https://github.com/usiusi360/vulsrepo)).
|
|
|
|
----
|
|
|
|
# What Vuls Doesn't Do
|
|
|
|
- Vuls doesn't update the vulnerable packages.
|
|
|
|
----
|
|
|
|
# Document
|
|
|
|
For more information such as Installation, Tutorial, Usage, visit [vuls.io](https://vuls.io/)
|
|
[日本語翻訳ドキュメント](https://vuls.io/ja/)
|
|
|
|
----
|
|
|
|
# Authors
|
|
|
|
kotakanbe ([@kotakanbe](https://twitter.com/kotakanbe)) created vuls and [these fine people](https://github.com/future-architect/vuls/graphs/contributors) have contributed.
|
|
|
|
----
|
|
|
|
# Change Log
|
|
|
|
Please see [CHANGELOG](https://github.com/future-architect/vuls/blob/master/CHANGELOG.md).
|
|
|
|
----
|
|
|
|
# Stargazers over time
|
|
|
|
[](https://starcharts.herokuapp.com/future-architect/vuls)
|
|
|
|
-----;
|
|
|
|
# License
|
|
|
|
Please see [LICENSE](https://github.com/future-architect/vuls/blob/master/LICENSE).
|