diff --git a/README.ja.md b/README.ja.md
deleted file mode 100644
index 2d50f9cf..00000000
--- a/README.ja.md
+++ /dev/null
@@ -1,1984 +0,0 @@
-
-# Vuls: VULnerability Scanner
-
-[](http://goo.gl/forms/xm5KFo35tu)
-
-
-
-Vulnerability scanner for Linux/FreeBSD, agentless, written in golang.
-
-[README in English](https://github.com/future-architect/vuls/blob/master/README.md)
-Slackチームは[こちらから](http://goo.gl/forms/xm5KFo35tu)参加できます。(日本語でオッケーです)
-Twitter: 日本語: [@vuls_ja](https://twitter.com/vuls_ja), 英語: [@vuls_en](https://twitter.com/vuls_en)
-
-
-
-[](https://asciinema.org/a/bazozlxrw1wtxfu9yojyihick)
-
-
-
-----
-
-# TOC
-
-Table of Contents
-=================
-
- * [Vuls: VULnerability Scanner](#vuls-vulnerability-scanner)
- * [TOC](#toc)
- * [Abstract](#abstract)
- * [Main Features](#main-features)
- * [What Vuls Doesn't Do](#what-vuls-doesnt-do)
- * [Setup Vuls](#setup-vuls)
- * [Tutorial](#tutorial)
- * [Tutorial: Local Scan Mode](#tutorial-local-scan-mode)
- * [Step1. Launch CentOS7](#step1-launch-centos7)
- * [Step2. Install requirements](#step2-install-requirements)
- * [Step3. Deploy go-cve-dictionary](#step3-deploy-go-cve-dictionary)
- * [Step4. Deploy goval-dictionary](#step4-deploy-goval-dictionary)
- * [Step5. Deploy Vuls](#step5-deploy-vuls)
- * [Step6. Config](#step6-config)
- * [Step7. Check config.toml and settings on the server before scanning](#step7-check-configtoml-and-settings-on-the-server-before-scanning)
- * [Step8. Start Scanning](#step8-start-scanning)
- * [Step9. Reporting](#step9-reporting)
- * [Step10. TUI](#step10-tui)
- * [Step11. Web UI](#step11-web-ui)
- * [Tutorial: Remote Scan Mode](#tutorial-remote-scan-mode)
- * [Step1. Launch new Ubuntu Linux (the server to be sacnned)](#step1-launch-new-ubuntu-linux-the-server-to-be-sacnned)
- * [Step2. Enable to SSH from localhost](#step2-enable-to-ssh-from-localhost)
- * [Step3. config.tomlの設定](#step3-configtomlの設定)
- * [Step4. Check config.toml and settings on the server before scanning](#step4-check-configtoml-and-settings-on-the-server-before-scanning)
- * [Step5. Start Scanning](#step5-start-scanning)
- * [Step6. Reporting](#step6-reporting)
- * [Architecture](#architecture)
- * [A. Scan via SSH Mode (Remote Scan Mode)](#a-scan-via-ssh-mode-remote-scan-mode)
- * [B. Scan without SSH (Local Scan Mode)](#b-scan-without-ssh-local-scan-mode)
- * [Fast Scan and Deep Scan](#fast-scan-and-deep-scan)
- * [Fast Scan](#fast-scan)
- * [Deep Scan](#deep-scan)
- * [Use Cases](#use-cases)
- * [Scan all servers](#scan-all-servers)
- * [Scan a single server](#scan-a-single-server)
- * [Support OS](#support-os)
- * [Usage: Automatic Server Discovery](#usage-automatic-server-discovery)
- * [Example](#example)
- * [Configuration](#configuration)
- * [Usage: Configtest](#usage-configtest)
- * [Fast Scan Mode](#fast-scan-mode)
- * [Deep Scan Mode](#deep-scan-mode)
- * [Dependencies and /etc/sudoers on Target Servers](#dependencies-and-etcsudoers-on-target-servers)
- * [Usage: Scan](#usage-scan)
- * [-deep option](#-deep-option)
- * [-ssh-native-insecure option](#-ssh-native-insecure-option)
- * [-ask-key-password option](#-ask-key-password-option)
- * [Example: Scan all servers defined in config file](#example-scan-all-servers-defined-in-config-file)
- * [Example: Scan specific servers](#example-scan-specific-servers)
- * [Example: Scan via shell instead of SSH.](#example-scan-via-shell-instead-of-ssh)
- * [cronで動かす場合](#cronで動かす場合)
- * [Example: Scan containers (Docker/LXD/LXC)](#example-scan-containers-dockerlxdlxc)
- * [Docker](#docker)
- * [LXDコンテナをスキャンする場合](#lxdコンテナをスキャンする場合)
- * [LXCコンテナをスキャンする場合](#lxcコンテナをスキャンする場合)
- * [Usage: Report](#usage-report)
- * [How to read a report](#how-to-read-a-report)
- * [Example](#example-1)
- * [Summary part](#summary-part)
- * [Detailed Part](#detailed-part)
- * [Example: Send scan results to Slack](#example-send-scan-results-to-slack)
- * [Example: Put results in S3 bucket](#example-put-results-in-s3-bucket)
- * [Example: Put results in Azure Blob storage](#example-put-results-in-azure-blob-storage)
- * [Example: IgnoreCves](#example-ignorecves)
- * [Example: Add optional key-value pairs to JSON](#example-add-optional-key-value-pairs-to-json)
- * [Example: Use MySQL as a DB storage back-end](#example-use-mysql-as-a-db-storage-back-end)
- * [Example: Use PostgreSQL as a DB storage back-end](#example-use-postgresql-as-a-db-storage-back-end)
- * [Example: Use Redis as a DB storage back-end](#example-use-redis-as-a-db-storage-back-end)
- * [Usage: Scan vulnerability of non-OS package](#usage-scan-vulnerabilites-of-non-os-packages)
- * [Usage: Integrate with OWASP Dependency Check to Automatic update when the libraries are updated (Experimental)](#usage-integrate-with-owasp-dependency-check-to-automatic-update-when-the-libraries-are-updated-experimental)
- * [Usage: TUI](#usage-tui)
- * [Display the latest scan results](#display-the-latest-scan-results)
- * [Display the previous scan results](#display-the-previous-scan-results)
- * [Display the previous scan results using peco](#display-the-previous-scan-results-using-peco)
- * [Usage: go-cve-dictionary on different server](#usage-go-cve-dictionary-on-different-server)
- * [Usage: Update NVD Data](#usage-update-nvd-data)
- * [Usage: goval-dictionary on different server](#usage-goval-dictionary-on-different-server)
- * [Usage: Update OVAL Data](#usage-update-oval-data)
- * [レポートの日本語化](#レポートの日本語化)
- * [fetchnvd, fetchjvnの実行順序の注意](#fetchnvd-fetchjvnの実行順序の注意)
- * [スキャン実行](#スキャン実行)
- * [How to Update to the Latest Version](#how-to-update-to-the-latest-version)
- * [Misc](#misc)
- * [Related Projects](#related-projects)
- * [Data Source](#data-source)
- * [Authors](#authors)
- * [Contribute](#contribute)
- * [Change Log](#change-log)
- * [Stargazers over time](#stargazers-over-time)
- * [License](#license)
-
-----
-
-# Abstract
-
-毎日のように発見される脆弱性の調査やソフトウェアアップデート作業は、システム管理者にとって負荷の高いタスクである。
-プロダクション環境ではサービス停止リスクを避けるために、パッケージマネージャの自動更新機能を使わずに手動更新で運用するケースも多い。
-だが、手動更新での運用には以下の問題がある。
-- システム管理者がNVDなどで新着の脆弱性をウォッチし続けなければならない
-- サーバにインストールされているソフトウェアは膨大であり、システム管理者が全てを把握するのは困難
-- 新着の脆弱性がどのサーバに該当するのかといった調査コストが大きく、漏れる可能性がある
-
-
-Vulsは上に挙げた手動運用での課題を解決するツールであり、以下の特徴がある。
-- システムに関係ある脆弱性のみ教えてくれる
-- その脆弱性に該当するサーバを教えてくれる
-- 自動スキャンのため脆弱性検知の漏れを防ぐことができる
-- CRONなどで定期実行、レポートすることで脆弱性の放置を防ぐことできる
-
-
-
-----
-
-# Main Features
-
-- サーバに存在する脆弱性をスキャン
- - Alpine, Ubuntu, Debian, CentOS, Amazon Linux, RHEL, Oracle Linux, SUSE Enterprise, Raspbian, FreeBSD に対応
- - クラウド、オンプレミス、Docker
-- 高精度なスキャン
- - Vulsは複数の脆弱性データベース、複数の検知方法を組み合わせることで高精度なスキャンを実現している
- - OVAL
- - RHSA/ALAS/ELSA/FreeBSD-SA
- - Changelog
-- FastスキャンとDeepスキャン
- - Fastスキャン
- - root権限必要なし
- - スキャン対象サーバの負荷ほぼなし
- - インターネットに接続していない環境でもスキャン可能 (RedHat, CentOS, OracleLinux, Ubuntu, Debian)
- - Deepスキャン
- - Changelogの差分を取得し、そこに書かれているCVE-IDを検知
- - スキャン対象サーバに負荷がかかる場合がある
-- リモートスキャンとローカルスキャン
- - リモートスキャン
- - スキャン対象サーバにSSH接続可能なマシン1台にセットアップするだけで動作
- - ローカルスキャン
- - もし中央のサーバから各サーバにSSH接続できない環境の場合はローカルスキャンモードでスキャン可能
-- **動的** スキャナ
- - サーバにSSH接続してコマンドを発行可能なのでサーバの状態を取得可能
- - カーネルアップデート後再起動していない場合に警告してくれる
-- OSパッケージ管理対象外のミドルウェアをスキャン
- - プログラミング言語のライブラリやフレームワーク、ミドルウェアの脆弱性スキャン
- - CPEに登録されているソフトウェアが対象
-- 非破壊スキャン(SSHでコマンド発行するだけ)
-- AWSでの脆弱性/侵入テスト事前申請は必要なし
- - 毎日スケジュール実行すれば新規に公開された脆弱性にすぐに気付くことができる
-- 設定ファイルのテンプレート自動生成
- - CIDRを指定してサーバを自動検出、設定ファイルのテンプレートを生成
-- EmailやSlackで通知可能（日本語でのレポートも可能）
-- 付属するTerminal-Based User Interfaceビューアでは、Vim風キーバインドでスキャン結果を参照可能
-- Web UI([VulsRepo](https://github.com/usiusi360/vulsrepo))を使えばピボットテーブルのように分析可能
-
-----
-
-# What Vuls Doesn't Do
-
-- Vulsはソフトウェアアップデートは行わない
-
-----
-
-# Setup Vuls
-
-Vulsのセットアップは以下の2パターンがある
-
-- Dockerコンテナ上にセットアップ
-see https://github.com/future-architect/vuls/tree/master/setup/docker
-
-- 手動でセットアップ
-チュートリアルでは手動でのセットアップ方法で説明する
-
-----
-
-# Tutorial
-
-1. Tutorial: Local Scan Mode
- - Launch CentOS on AWS
- - Deploy Vuls
- - Scan localhost, Reporting
-1. Tutorial: Remote Scan Mode
- - Launch Ubuntu Linux on AWS
- - このUbuntuを先程セットアップしたVulsからスキャンする
-
-----
-
-# Tutorial: Local Scan Mode
-
-本チュートリアルでは、Amazon EC2にVulsをセットアップし、自分に存在する脆弱性をスキャンする方法を説明する。
-手順は以下の通り
-
-1. CentOSを新規作成
-1. 必要なソフトウェアをインストール
-1. go-cve-dictionaryをデプロイ
-1. goval-dictionaryをデプロイ
-1. Vulsをデプロイ
-1. 設定
-1. 設定ファイルと、スキャン対象サーバの設定のチェック
-1. Scan
-1. Reporting
-1. TUI(Terminal-Based User Interface)で結果を参照する
-1. Web UI([VulsRepo](https://github.com/usiusi360/vulsrepo))で結果を参照する
-
-## Step1. Launch CentOS7
-
-- 今回は説明のために、脆弱性を含む古いAMIを使う
-- EC2作成時に自動アップデートされるとVulsスキャン結果が0件になってしまうので、cloud-initに以下を指定してEC2を作成する。
-
- ```
- #cloud-config
- repo_upgrade: none
- ```
-
- - [Q: How do I disable the automatic installation of critical and important security updates on initial launch?](https://aws.amazon.com/amazon-linux-ami/faqs/?nc1=h_ls)
-
-## Step2. Install requirements
-
-Vulsセットアップに必要な以下のソフトウェアをインストールする。
-
-- SQLite3, MySQL, PostgreSQL or Redis
-- git
-- gcc
-- GNU Make
-- go v1.8.3 or later (The latest version is recommended)
- - https://golang.org/doc/install
-
-```bash
-$ ssh centos@52.100.100.100 -i ~/.ssh/private.pem
-$ sudo yum -y install sqlite git gcc make wget
-$ wget https://storage.googleapis.com/golang/go1.8.3.linux-amd64.tar.gz
-$ sudo tar -C /usr/local -xzf go1.8.3.linux-amd64.tar.gz
-$ mkdir $HOME/go
-```
-/etc/profile.d/goenv.sh を作成し、下記を追加する。
-
-```bash
-export GOROOT=/usr/local/go
-export GOPATH=$HOME/go
-export PATH=$PATH:$GOROOT/bin:$GOPATH/bin
-```
-
-カレントシェルに上記環境変数をセットする。
-```bash
-$ source /etc/profile.d/goenv.sh
-```
-
-## Step3. Deploy go-cve-dictionary
-
-[go-cve-dictionary](https://github.com/kotakanbe/go-cve-dictionary)
-
-```bash
-$ sudo mkdir /var/log/vuls
-$ sudo chown centos /var/log/vuls
-$ sudo chmod 700 /var/log/vuls
-$
-$ mkdir -p $GOPATH/src/github.com/kotakanbe
-$ cd $GOPATH/src/github.com/kotakanbe
-$ git clone https://github.com/kotakanbe/go-cve-dictionary.git
-$ cd go-cve-dictionary
-$ make install
-```
-バイナリは、`$GOPATH/bin`以下に生成される
-もしもインストールプロセスが途中で止まる場合は、Out of memory errorが発生している可能性があるので、インスタンスタイプを大きくして再実行してみてください。
-
-NVDから脆弱性データベースを取得する。
-環境によって異なるが、AWS上では10分程度かかる。
-
-```bash
-$ cd $HOME
-$ for i in `seq 2002 $(date +"%Y")`; do go-cve-dictionary fetchnvd -years $i; done
-... snip ...
-$ ls -alh cve.sqlite3
--rw-r--r-- 1 ec2-user ec2-user 7.0M Mar 24 13:20 cve.sqlite3
-```
-
-脆弱性レポートを日本語化したい場合は、JVNから脆弱性データベースを取得する。
-
-```bash
-$ cd $HOME
-$ for i in `seq 1998 $(date +"%Y")`; do go-cve-dictionary fetchjvn -years $i; done
-```
-
-## Step4. Deploy goval-dictionary
-
-[goval-dictionary](https://github.com/kotakanbe/goval-dictionary)
-
-```bash
-$ mkdir -p $GOPATH/src/github.com/kotakanbe
-$ cd $GOPATH/src/github.com/kotakanbe
-$ git clone https://github.com/kotakanbe/goval-dictionary.git
-$ cd goval-dictionary
-$ make install
-```
-The binary was built under `$GOPATH/bin`
-もしもインストールプロセスが途中で止まる場合は、Out of memory errorが発生している可能性があるので、インスタンスタイプを大きくして再実行してみてください。
-
-今回はCentOSがスキャン対象なので、RedHatが公開しているOVAL情報を取り込む. [README](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-redhat)
-
-```bash
-$ goval-dictionary fetch-redhat 7
-```
-
-今回はスキャン対象がCentOS 7なので、RedHat 7のOVALを取得している。
-他の種類のOSをスキャンする場合は以下を参照し、スキャン対象用のOVALを取得しておくこと
-- [Alpine](https://github.com/kotakanbe/goval-dictionary#usage-fetch-alpine-secdb-as-oval-data-type)
-- [RedHat, CentOS](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-redhat)
-- [Debian](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-debian)
-- [Ubuntu](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-ubuntu)
-- [Oracle Linux](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-oracle)
-- [SUSE](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-suse)
-
-## Step5. Deploy Vuls
-
-新規にターミナルを起動し、先ほど作成したEC2にSSH接続する。
-```
-$ mkdir -p $GOPATH/src/github.com/future-architect
-$ cd $GOPATH/src/github.com/future-architect
-$ git clone https://github.com/future-architect/vuls.git
-$ cd vuls
-$ make install
-```
-
-The binary was built under `$GOPATH/bin`
-もしもインストールプロセスが途中で止まる場合は、Out of memory errorが発生している可能性があるので、インスタンスタイプを大きくして再実行してみてください。
-
-もし、あなたが以前にvulsをインストールしていて update をする場合は以下を実施してください。
-```
-$ rm -rf $GOPATH/pkg/linux_amd64/github.com/future-architect/vuls/
-$ rm -rf $GOPATH/src/github.com/future-architect/vuls/
-$ cd $GOPATH/src/github.com/future-architect
-$ git clone https://github.com/future-architect/vuls.git
-$ cd vuls
-$ make install
-```
-
-## Step6. Config
-
-Vulsの設定ファイルを作成する（TOMLフォーマット）
-
-```
-$ cd $HOME
-$ cat config.toml
-[servers]
-
-[servers.localhost]
-host = "localhost"
-port = "local"
-```
-
-## Step7. Check config.toml and settings on the server before scanning
-
-```
-$ vuls configtest
-```
-詳細は [Usage: configtest](#usage-configtest) を参照
-
-## Step8. Start Scanning
-
-
-```
-$ vuls scan
-
-... snip ...
-
-One Line Summary
-================
-localhost centos7.3.1611 31 updatable packages
-
-```
-
-## Step9. Reporting
-
-View one-line summary
-
-```
-$ vuls report -lang=ja -format-one-line-text -cvedb-path=$PWD/cve.sqlite3 -ovaldb-path=$PWD/oval.sqlite3
-
-One Line Summary
-================
-localhost Total: 101 (High:35 Medium:50 Low:16 ?:0) 31 updatable packages
-
-```
-
-View short summary.
-
-```
-$ vuls report -lang=ja -format-short-text |less
-
-localhost (centos7.3.1611)
-==========================
-Total: 101 (High:35 Medium:50 Low:16 ?:0) 31 updatable packages
-
-CVE-2017-7895 10.0 HIGH (nvd)
- Linux Kernel の NFSv2/NFSv3
- サーバの実装におけるポインタ演算エラーを誘発される脆弱性
- Linux Kernel の NFSv2/NFSv3
- サーバの実装は、バッファの終端に対する特定のチェックが欠落しているため、ポイン...
- (pointer-arithmetic error)
- を誘発されるなど、不特定の影響を受ける脆弱性が存在します。
- ---
- http://jvndb.jvn.jp/ja/contents/2017/JVNDB-2017-003674.html
- https://access.redhat.com/security/cve/CVE-2017-7895 (RHEL-CVE)
- 10.0/AV:N/AC:L/Au:N/C:C/I:C/A:C (nvd)
- 10.0/AV:N/AC:L/Au:N/C:C/I:C/A:C (jvn)
- https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator?name=CVE-2017-7895
- 6.5/CVSS:3.0/AV:N/AC:L/PR:L/UI:N/S:U/C:H/I:N/A:N (redhat)
- https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator?name=CVE-2017-7895
- Confidence: 100 / OvalMatch
-
-````
-
-View full report.
-
-```
-$ vuls report -lang=ja -format-full-text |less
-
-localhost (centos7.3.1611)
-==========================
-Total: 101 (High:35 Medium:50 Low:16 ?:0) 31 updatable packages
-
-CVE-2015-2806
-----------------
-Max Score 10.0 HIGH (nvd)
-nvd 10.0/AV:N/AC:L/Au:N/C:C/I:C/A:C
-redhat 2.6/AV:N/AC:H/Au:N/C:N/I:N/A:P
-redhat 3.3/CVSS:3.0/AV:L/AC:L/PR:N/UI:R/S:U/C:N/I:N/A:L
-CVSSv2 Calc https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator?name=CVE-2015-2806
-CVSSv3 Calc https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator?name=CVE-2015-2806
-Summary Stack-based buffer overflow in asn1_der_decoding in libtasn1 before 4.4 allows
- remote attackers to have unspecified impact via unknown vectors.
-Source https://nvd.nist.gov/vuln/detail/CVE-2015-2806
-RHEL-CVE https://access.redhat.com/security/cve/CVE-2015-2806
-CWE-119 (nvd) https://cwe.mitre.org/data/definitions/119.html
-Package/CPE libtasn1-3.8-3.el7 -
-Confidence 100 / OvalMatch
-
-... snip ...
-```
-
-## Step10. TUI
-
-Vulsにはスキャン結果の詳細を参照できるイカしたTUI(Terminal-Based User Interface)が付属している。
-
-```
-$ vuls tui
-```
-
-
-
-## Step11. Web UI
-
-[VulsRepo](https://github.com/usiusi360/vulsrepo)はスキャン結果をビボットテーブルのように分析可能にするWeb UIである。
-[Online Demo](http://usiusi360.github.io/vulsrepo/)があるので試してみて。
-
-----
-
-# Tutorial: Remote Scan Mode
-
-SSHを用いてリモートのホストをスキャンする方法を説明する。
-
-1. Ubuntu Linuxを新規に1台作成（スキャン対象）
-1. スキャン対象のRemoteホストにlocalhostからSSH可能にする
-1. config.tomlの設定
-1. 設定ファイルと、スキャン対象サーバの設定のチェック
-1. Scan
-1. Reporting
-
-先程のチュートリアルで作成したVulsサーバ(以下localhostと記述)を用いる。
-
-## Step1. Launch new Ubuntu Linux (the server to be sacnned)
-
-[Tutorial: Local Scan Mode#Step1. Launch Amazon Linux](#step1-launch-amazon-linux)と同じ
-[Tutorial: Local Scan Mode#Step1. Launch CentOS7](#step1-launch-centos7)のようにUbuntu Linuxを新規に作成する。
-新規にターミナルを開いて今作成したEC2にSSH接続する。
-$HOME/.ssh/known_hostsにリモートホストのHost Keyを追加するために、スキャン前にリモートホストにSSH接続する必要がある。
-
-## Step2. Enable to SSH from localhost
-
-VulsはSSHパスワード認証をサポートしてない。SSHの鍵認証の設定をしなければならない。
-localhost上でkeypairを作成し、remote host上のauthorized_keysに追加する。
-
-- localhost
-```bash
-$ ssh-keygen -t rsa
-```
-Copy ~/.ssh/id_rsa.pub to the clipboard.
-
-- Remote Host
-```
-$ mkdir ~/.ssh
-$ chmod 700 ~/.ssh
-$ touch ~/.ssh/authorized_keys
-$ chmod 600 ~/.ssh/authorized_keys
-$ vim ~/.ssh/authorized_keys
-```
-Paste from the clipboard to `~/.ssh/.authorized_keys`
-
-localhostのknown_hostsにremote hostのホストキーが登録されている必要があるので確認すること。
-`$HOME/.ssh/known_hosts`にリモートホストのHost Keyを追加するために、スキャン前にリモートホストにSSH接続する必要がある。
-
-
-- localhost
-```
-$ ssh ubuntu@172.31.4.82 -i ~/.ssh/id_rsa
-```
-
-## Step3. config.tomlの設定
-
-- localhost
-```
-$ cd $HOME
-$ cat config.toml
-[servers]
-
-[servers.ubuntu]
-host = "172.31.4.82"
-port = "22"
-user = "ubuntu"
-keyPath = "/home/centos/.ssh/id_rsa"
-```
-
-## Step4. Check config.toml and settings on the server before scanning
-
-```
-$ vuls configtest ubuntu
-```
-
-see [Usage: configtest](#usage-configtest)
-
-## Step5. Start Scanning
-
-```
-$ vuls scan ubuntu
-... snip ...
-
-One Line Summary
-================
-ubuntu ubuntu16.04 30 updatable packages
-```
-
-## Step6. Reporting
-
-See [Tutorial: Local Scan Mode#Step9. Reporting](#step9-reporting)
-See [Tutorial: Local Scan Mode#Step10. TUI](#step10-tui)
-See [Tutorial: Local Scan Mode#Step11. Web UI](#step11-web-ui)
-
-----
-
-# Architecture
-
-## A. Scan via SSH Mode (Remote Scan Mode)
-
-
-
-## B. Scan without SSH (Local Scan Mode)
-
-Vulsをスキャン対象サーバにデプロイする。Vulsはローカルホストにコマンドを発行する(SSH経由ではない）。スキャン結果のJSONを別サーバに集約する。スキャン結果の詳細化のためにはCVEデータベースへのアクセスが必要なので、事前にgo-cve-dictionaryをserver modeで起動しておく。
-その集約サーバ上で、あなたはWebUIやTUIを用いて各スキャン対象サーバのスキャン結果を参照することが可能。
-
-
-[詳細](#example-scan-via-shell-instead-of-ssh)
-
------
-
-## Fast Scan and Deep Scan
-
-### Fast Scan
-
-- Root権限不要でスキャン可能なモード（Raspbian以外）
-- OVALが提供されているディストリビューションは、スキャン時はパッケージのバージョンを取得するのみ。レポート時にOVAL DBとバージョン比較により脆弱性を検知する
-- OVALが提供されいていないディストリビューションはスキャン時にコマンドを発行して脆弱性を検知する
-
-| Distribution| Scan Speed | Need Root Privilege | OVAL | Need Internet Access
on scan tareget|
-|:------------|:--------------------------------------:|:-------------------:|:----------:|:---------------------------------------:|
-| Alpine | Fast | No | Supported | Need |
-| CentOS | Fast | No | Supported | No |
-| RHEL | Fast | No | Supported | No |
-| Oracle | Fast | No | Supported | No |
-| Ubuntu | Fast | No | Supported | No |
-| Debian | Fast | No | Supported | No |
-| Raspbian |1st time: Slow
From 2nd time: Fast | Need | No | Need |
-| FreeBSD | Fast | No | No | Need |
-| Amazon | Fast | No | No | Need |
-| SUSE Enterprise | Fast | No | Supported | No |
-
-----
-
-### Deep Scan
-
-- Root権限が必要なコマンドも発行し、より深いスキャンを行うモード
-- ChangelogをパースしてCVE-IDを検知するのでFastよりも検知漏れが減る
-
-| Distribution| Scan Speed | Need Root Privilege | OVAL | Need Internet Access
on scan tareget|
-|:------------|:-------------------------------------:|:-------------------------:|:---------:|:---------------------------------------:|
-| Alpine | Fast | No | Supported | Need |
-| CentOS | Slow | No | Supported | Need |
-| RHEL | Slow | Need | Supported | Need |
-| Oracle | Slow | Need | Supported | Need |
-| Ubuntu |1st time: Slow
From 2nd time: Fast| Need | Supported | Need |
-| Debian |1st time: Slow
From 2nd time: Fast| Need | Supported | Need |
-| Raspbian |1st time: Slow
From 2nd time: Fast| Need | No | Need |
-| FreeBSD | Fast | No | No | Need |
-| Amazon | Slow | No | No | Need |
-| SUSE Enterprise | Fast | No | Supported | No |
-
-
-- On Ubuntu, Debian and Raspbian
-`apt-get changelog`でアップデート対象のパッケージのチェンジログを取得し、含まれるCVE IDをパースする。
-アップデート対象のパッケージが沢山ある場合、チェンジログの取得に時間がかかるので、初回のスキャンは遅い。
-ただ、２回目以降はキャッシュしたchangelogを使うので速くなる。
-
-- On CentOS
-`yum changelog`でアップデート対象のパッケージのチェンジログを取得し、含まれるCVE IDをパースする。
-
-- On RHEL, Oracle, Amazon and FreeBSD
-`yum changelog`でアップデート対象のパッケージのチェンジログを取得する(パースはしない)。
-
-- On SUSE Enterprise Linux and Alpine Linux
-Same as fast scan mode for now.
-
-----
-
-# Use Cases
-
-## Scan all servers
-
-
-
-## Scan a single server
-
-web/app server in the same configuration under the load balancer
-
-
-
-----
-
-# Support OS
-
-| Distribution| Release |
-|:------------|-------------------:|
-| Alpine | 3.2 and later |
-| Ubuntu | 14, 16|
-| Debian | 7, 8, 9|
-| RHEL | 5, 6, 7|
-| CentOS | 6, 7|
-| Amazon Linux| All|
-| FreeBSD | 10, 11|
-| SUSE Enterprise | 11, 12|
-| Raspbian | Jessie, Stretch |
-
-----
-
-
-# Usage: Automatic Server Discovery
-
-Discoveryサブコマンドは指定されたCIDRレンジ内でpingが返ってくるサーバを発見して、ターミナル上にVulsの設定ファイルのテンプレートを出力する。
-
-```
-$ vuls discover -help
-discover:
- discover 192.168.0.0/24
-```
-
-## Example
-
-```
-$ vuls discover 172.31.4.0/24
-# Create config.toml using below and then ./vuls --config=/path/to/config.toml
-
-[slack]
-hookURL = "https://hooks.slack.com/services/abc123/defghijklmnopqrstuvwxyz"
-#legacyToken = "xoxp-11111111111-222222222222-3333333333"
-channel = "#channel-name"
-#channel = "${servername}"
-iconEmoji = ":ghost:"
-authUser = "username"
-notifyUsers = ["@username"]
-
-[email]
-smtpAddr = "smtp.gmail.com"
-smtpPort = "587"
-user = "username"
-password = "password"
-from = "from@address.com"
-to = ["to@address.com"]
-cc = ["cc@address.com"]
-subjectPrefix = "[vuls]"
-
-[default]
-#port = "22"
-#user = "username"
-#keyPath = "/home/username/.ssh/id_rsa"
-#cpeNames = [
-# "cpe:/a:rubyonrails:ruby_on_rails:4.2.1",
-#]
-#optional = [
-# ["key", "value"],
-#]
-
-[servers]
-
-[servers.172-31-4-82]
-host = "172.31.4.82"
-#port = "22"
-#user = "root"
-#keyPath = "/home/username/.ssh/id_rsa"
-#type = "pseudo"
-#cpeNames = [
-# "cpe:/a:rubyonrails:ruby_on_rails:4.2.1",
-#]
-#optional = [
-# ["key", "value"],
-#]
-#[servers.172-31-4-82.containers]
-#type = "lxd" # or "docker" or "lxc"
-#includes = ["${running}"]
-#excludes = ["container_name", "container_id"]
-```
-
-このテンプレート使ってVulsの設定ファイルを作ってもよい。
-
-----
-
-# Configuration
-
-- Slack section
- ```
- [slack]
- hookURL = "https://hooks.slack.com/services/abc123/defghijklmnopqrstuvwxyz"
- #legacyToken = "xoxp-11111111111-222222222222-3333333333"
- channel = "#channel-name"
- #channel = "${servername}"
- iconEmoji = ":ghost:"
- authUser = "username"
- notifyUsers = ["@username"]
- ```
-
- - hookURL or legacyToken
- どちらか一方を指定する。
- もし脆弱性が沢山有る場合はlegacyTokenの利用をおすすめする。legacyTokenはSlackのスレッド形式でポストされる。
- スキャンサーバ単位で集約されるのでSlack通知が氾濫しない。
-
- - hookURL : Incoming webhook's URL (legacyTokenが設定されている場合、hookURLは無視される。)
- 
-
- - legacyToken : slack legacy token (https://api.slack.com/custom-integrations/legacy-tokens)
- 
-
- - channel : channel name.
- channelに`${servername}`を指定すると、結果レポートをサーバごとに別チャネルにすることが出来る。
- 以下のサンプルでは、`#server1`チャネルと`#server2`チャネルに送信される。スキャン前にチャネルを作成する必要がある。
- **legacyTokenが設定されている場合、channelは実在するchannelでなければならない。**
- ```
- [slack]
- channel = "${servername}"
- ...snip...
-
- [servers]
-
- [servers.server1]
- host = "172.31.4.82"
- ...snip...
-
- [servers.server2]
- host = "172.31.4.83"
- ...snip...
- ```
-
- - iconEmoji: emoji
- - authUser: username of the slack team
- - notifyUsers: ここにユーザ名を指定すると、Slackで通知を受け取ることができる。たとえば `["@foo", "@bar"]`を指定すると、Slackのテキストに`@foo`と`@bar`が含まれるのでスマホなどにPush通知が可能。
-
-- Mail section
- ```
- [email]
- smtpAddr = "smtp.gmail.com"
- smtpPort = "587"
- user = "username"
- password = "password"
- from = "from@address.com"
- to = ["to@address.com"]
- cc = ["cc@address.com"]
- subjectPrefix = "[vuls]"
- ```
-
-- Default section
- ```
- [default]
- #port = "22"
- #user = "username"
- #keyPath = "/home/username/.ssh/id_rsa"
- #cpeNames = [
- # "cpe:/a:rubyonrails:ruby_on_rails:4.2.1",
- #]
- #ignoreCves = ["CVE-2016-6313"]
- #optional = [
- # ["key", "value"],
- #]
- #[servers.172-31-4-82.containers]
- #type = "lxd" # or "docker" or "lxc"
- #includes = ["${running}"]
- #excludes = ["container_name", "container_id"]
- ```
- 下記serversセクションで値が指定されなかった場合のデフォルト値
-
-- servers section
- ```
- [servers]
-
- [servers.172-31-4-82]
- host = "172.31.4.82"
- #port = "22"
- #user = "root"
- #keyPath = "/home/username/.ssh/id_rsa"
- #cpeNames = [
- # "cpe:/a:rubyonrails:ruby_on_rails:4.2.1",
- #]
- #type = "pseudo"
- #ignoreCves = ["CVE-2016-6314"]
- #optional = [
- # ["key", "value"],
- #]
- #containers = ["${running}"]
- #[servers.172-31-4-82.containers]
- #type = "lxd"
- ```
-
- serversセクションの値は、defaultセクションの値よりも優先される。
- defaultセクションの値を使いたい場合は `#` でコメントアウトする。
-
- - host: IP address or hostname of target server
- - port: SSH Port number
- - user: SSH username
- - keyPath: SSH private key path
- - type: "pseudo" for non-ssh scanning. see [#531](https://github.com/future-architect/vuls/pull/531)
- - cpeNames: see [Usage: Scan vulnerability of non-OS package](#usage-scan-vulnerability-of-non-os-package)
- - ignoreCves: CVE IDs that will not be reported. But output to JSON file.
- - optional: JSONレポートに含めたい追加情報
- - containers: see [Usage: Scan Docker containers](#usage-scan-docker-containers)
-
-
- Vulsは各サーバにSSHで接続するが、OSコマンドでの接続と、Goのネイティブ実装の２種類のSSH接続方法をサポートしている。
- 詳細は [-ssh-native-insecure option](#-ssh-native-insecure-option) を参照。
-
- また、以下のSSH認証をサポートしている。
- - SSH agent
- - SSH public key authentication (with password, empty password)
- SSH Password認証はサポートしていない
-
-----
-
-# Usage: Configtest
-
-```
-$ vuls configtest --help
-configtest:
- configtest
- [-deep]
- [-config=/path/to/config.toml]
- [-log-dir=/path/to/log]
- [-ask-key-password]
- [-ssh-native-insecure]
- [-containers-only]
- [-timeout=300]
- [-http-proxy=http://192.168.0.1:8080]
- [-debug]
-
- [SERVER]...
- -ask-key-password
- Ask ssh privatekey password before scanning
- -config string
- /path/to/toml (default "/Users/kotakanbe/go/src/github.com/future-architect/vuls/config.toml")
- -containers-only
- Test containers only. Default: Test both of hosts and containers
- -debug
- debug mode
- -deep
- Config test for deep scan mode
- -http-proxy string
- http://proxy-url:port (default: empty)
- -log-dir string
- /path/to/log (default "/var/log/vuls")
- -ssh-native-insecure
- Use Native Go implementation of SSH. Default: Use the external command
- -timeout int
- Timeout(Sec) (default 300)
-```
-
-configtestサブコマンドは、config.tomlで定義されたサーバ/コンテナに対してSSH可能かどうかをチェックする。
-
-## Fast Scan Mode
-
-| Distribution | Release | Requirements |
-|:-------------|-------------------:|:-------------|
-| Alpine | 3.2 and later | - |
-| Ubuntu | 12, 14, 16| - |
-| Debian | 7, 8, 9| reboot-notifier|
-| CentOS | 6, 7| - |
-| Amazon | All | yum-utils |
-| RHEL | 5, 6, 7 | - |
-| Oracle Linux | 5, 6, 7 | - |
-| SUSE Enterprise| 11, 12 | - |
-| FreeBSD | 10, 11 | - |
-| Raspbian | Jessie, Stretch | - |
-
-## Deep Scan Mode
-
-Deep Scan Modeではスキャン対象サーバ上にいくつかの依存パッケージが必要。
-configtestに--deepをつけて実行するとSSH接続に加えて以下もチェックする。
-- スキャン対象のサーバ上に依存パッケージがインストールされているか
-- /etc/sudoers
-
-### Dependencies and /etc/sudoers on Target Servers
-
-Deep Scan Modeでスキャンするためには、下記のパッケージが必要なので、手動かまたはAnsibleなどのツールで事前にインストールする必要がある。
-
-| Distribution | Release | Requirements |
-|:-------------|-------------------:|:-------------|
-| Alpine | 3.2 and later | - |
-| Ubuntu | 12, 14, 16| - |
-| Debian | 7, 8, 9| aptitude, reboot-notifier |
-| CentOS | 6, 7| yum-utils, yum-plugin-changelog |
-| Amazon | All | yum-utils, yum-plugin-changelog |
-| RHEL | 5 | yum-utils, yum-changelog, yum-security |
-| RHEL | 6 | yum-utils, yum-plugin-changelog, yum-plugin-security |
-| RHEL | 7 | yum-utils, yum-plugin-changelog |
-| Oracle Linux | 5 | yum-utils, yum-changelog, yum-security |
-| Oracle Linux | 6 | yum-utils, yum-plugin-changelog, yum-plugin-security |
-| Oracle Linux | 7 | yum-utils, yum-plugin-changelog |
-| SUSE Enterprise| 11, 12 | - |
-| FreeBSD | 10 | - |
-| Raspbian | Wheezy, Jessie | - |
-
-また、Deep Scan Modeで利用するコマンドの中にはRoot権限が必要なものものある。configtestサブコマンドでは、スキャン対象サーバに対してそのコマンドがパスワードなしでSUDO可能な状態か確認する。また、requirettyも定義されているかも確認する。(--ssh-native-insecureオプションでscanする場合はrequirettyは定義しなくても良い)
-```
-Defaults:vuls !requiretty
-```
-For details, see [-ssh-native-insecure option](#-ssh-native-insecure-option)
-
-スキャン対象サーバ上の`/etc/sudoers`のサンプル
-
-- RHEL 5 / Oracle Linux 5
-```
-vuls ALL=(ALL) NOPASSWD:/usr/bin/yum --color=never repolist, /usr/bin/yum --color=never list-security --security, /usr/bin/yum --color=never info-security, /usr/bin/repoquery, /usr/bin/yum --color=never changelog all *
-Defaults:vuls env_keep="http_proxy https_proxy HTTP_PROXY HTTPS_PROXY"
-```
-
-- RHEL 6, 7 / Oracle Linux 6, 7
-```
-vuls ALL=(ALL) NOPASSWD:/usr/bin/yum --color=never repolist, /usr/bin/yum --color=never --security updateinfo list updates, /usr/bin/yum --color=never --security updateinfo updates, /usr/bin/repoquery, /usr/bin/yum --color=never changelog all *
-Defaults:vuls env_keep="http_proxy https_proxy HTTP_PROXY HTTPS_PROXY"
-```
-
-- Debian/Ubuntu/Raspbian
-```
-vuls ALL=(ALL) NOPASSWD: /usr/bin/apt-get update
-Defaults:vuls env_keep="http_proxy https_proxy HTTP_PROXY HTTPS_PROXY"
-```
-
-- CentOS, Amazon Linux, SUSE Enterprise, FreeBSDは今のところRoot権限なしでスキャン可能
-
-----
-
-# Usage: Scan
-
-```
-$ vuls scan -help
-scan:
- scan
- [-deep]
- [-config=/path/to/config.toml]
- [-results-dir=/path/to/results]
- [-log-dir=/path/to/log]
- [-cachedb-path=/path/to/cache.db]
- [-ssh-native-insecure]
- [-containers-only]
- [-skip-broken]
- [-http-proxy=http://192.168.0.1:8080]
- [-ask-key-password]
- [-timeout=300]
- [-timeout-scan=7200]
- [-debug]
- [-pipe]
-
- [SERVER]...
- -ask-key-password
- Ask ssh privatekey password before scanning
- -cachedb-path string
- /path/to/cache.db (local cache of changelog for Ubuntu/Debian)
- -config string
- /path/to/toml
- -containers-only
- Scan containers only. Default: Scan both of hosts and containers
- -debug
- debug mode
- -deep
- Deep scan mode. Scan accuracy improves and information becomes richer. Since analysis of changelog, issue commands requiring sudo, but it may be slower and high load on the scan tareget server.
- -http-proxy string
- http://proxy-url:port (default: empty)
- -log-dir string
- /path/to/log (default "/var/log/vuls")
- -pipe
- Use stdin via PIPE
- -results-dir string
- /path/to/results
- -skip-broken
- [For CentOS] yum update changelog with --skip-broken option
- -ssh-native-insecure
- Use Native Go implementation of SSH. Default: Use the external command
- -timeout int
- Number of seconds for processing other than scan (default 300)
- -timeout-scan int
- Number of second for scaning vulnerabilities for all servers (default 7200)
-```
-
-## -deep option
-
-You need to execute `vuls configtest --deep` to check the configuration of the target server before scanning with -deep flag.
-
-For details about deep scan mode, see below.
-* [Architecture/Deep Scan](#deep-scan)
-* [Configtest/Deep Scan Mode](#deep-scan-mode)
-
-## -ssh-native-insecure option
-
-Vulsは２種類のSSH接続方法をサポートしている。
-
-
-デフォルトでは、外部SSHコマンドを使ってスキャンする。
-SSH Configが使えるので、ProxyCommandを使った多段SSHなどが可能。
-CentOSでは、スキャン対象サーバの/etc/sudoersに以下を追加する必要がある(user: vuls)
-```
-Defaults:vuls !requiretty
-```
-
--ssh-native-insecureを指定すると、Goのネイティブ実装 (crypto/ssh) を使ってスキャンする。これは、SSHコマンドがインストールされていない環境でも動作する（Windowsなど）。-ssh-native-insecureは、ホストキーのチェックをしないことに注意すべき。
-
-## -ask-key-password option
-
-| SSH key password | -ask-key-password | |
-|:-----------------|:-------------------|:----|
-| empty password | - | |
-| with password | required | or use ssh-agent |
-
-## Example: Scan all servers defined in config file
-```
-$ vuls scan -ask-key-password
-```
-この例では、
-- SSH公開鍵認証（秘密鍵パスフレーズ）を指定
-- configに定義された全サーバをスキャン
-
-## Example: Scan specific servers
-```
-$ vuls scan server1 server2
-```
-この例では、
-- SSH公開鍵認証（秘密鍵パスフレーズなし）
-- ノーパスワードでsudoが実行可能
-- configで定義されているサーバの中の、server1, server2のみスキャン
-
-## Example: Scan via shell instead of SSH.
-
-ローカルホストのスキャンする場合、SSHではなく直接コマンドの発行が可能。
-config.tomlのhostに`localhost または 127.0.0.1`かつ、portに`local`を設定する必要がある。
-For more details, see [Architecture section](#architecture)
-
-- config.toml
- ```
- [servers]
-
- [servers.localhost]
- host = "localhost" # or "127.0.0.1"
- port = "local"
- ```
-
-### cronで動かす場合
-
-RHEL/CentOSの場合、スキャン対象サーバの/etc/sudoersに以下を追加する必要がある。(user: vuls)
-```
-Defaults:vuls !requiretty
-```
-
-## Example: Scan containers (Docker/LXD/LXC)
-
-
-コンテナはSSHデーモンを起動しないで運用するケースが一般的。
- [Docker Blog:Why you don't need to run SSHd in your Docker containers](https://blog.docker.com/2014/06/why-you-dont-need-to-run-sshd-in-docker/)
-
-### Docker
-
-Vulsは、DockerホストにSSHで接続し、`docker exec`でDockerコンテナにコマンドを発行して脆弱性をスキャンする。
-詳細は、[Architecture section](#architecture)を参照
-
-- 全ての起動中のDockerコンテナをスキャン
- `"${running}"` をcontainersに指定する
- ```
- [servers]
-
- [servers.172-31-4-82]
- host = "172.31.4.82"
- user = "ec2-user"
- keyPath = "/home/username/.ssh/id_rsa"
-
- [servers.172-31-4-82.containers]
- includes = ["${running}"]
- ```
-
-- あるコンテナのみスキャン
- コンテナID、または、コンテナ名を、containersに指定する。
- 以下の例では、`container_name_a`と、`4aa37a8b63b9`のコンテナのみスキャンする
- スキャン実行前に、コンテナが起動中か確認すること。もし起動してない場合はエラーメッセージを出力してスキャンを中断する。
- ```
- [servers]
-
- [servers.172-31-4-82]
- host = "172.31.4.82"
- user = "ec2-user"
- keyPath = "/home/username/.ssh/id_rsa"
-
- [servers.172-31-4-82.containers]
- includes = ["container_name_a", "4aa37a8b63b9"]
- ```
-
-- あるコンテナ以外をスキャン
- ```
- [servers]
-
- [servers.172-31-4-82]
- host = "172.31.4.82"
- user = "ec2-user"
- keyPath = "/home/username/.ssh/id_rsa"
-
- [servers.172-31-4-82.containers]
- includes = ["${running}"]
- excludes = ["container_name_a", "4aa37a8b63b9"]
- ```
-
-- コンテナのみをスキャンする場合（ホストはスキャンしない）
- --containers-onlyオプションを指定する
-
-### LXDコンテナをスキャンする場合
-
-Vulsは、ホストにSSHで接続し、`lxc exec`でLXDコンテナにコマンドを発行して脆弱性をスキャンする。
-```
-[servers]
-
-[servers.172-31-4-82]
-host = "172.31.4.82"
-user = "ec2-user"
-keyPath = "/home/username/.ssh/id_rsa"
-
-[servers.172-31-4-82.containers]
-type = "lxd"
-includes = ["${running}"]
-```
-
-### LXC
-
-Vulsは、ホストにSSHで接続し、`lxc-attach`でLXCコンテナにコマンドを発行して脆弱性をスキャンする。
-```
-[servers]
-
-[servers.172-31-4-82]
-host = "172.31.4.82"
-user = "ec2-user"
-keyPath = "/home/username/.ssh/id_rsa"
-
-[servers.172-31-4-82.containers]
-type = "lxc"
-includes = ["${running}"]
-```
-
-LXCコンテナの操作にはroot権限が必要です。
-
-スキャン対象サーバ上の`/etc/sudoers`のサンプル
-
-```
-vuls ALL=(ALL) NOPASSWD:/usr/bin/lxc-attach -n *, /usr/bin/lxc-ls *
-```
-
-# Usage: Report
-
-```
-report:
- report
- [-lang=en|ja]
- [-config=/path/to/config.toml]
- [-results-dir=/path/to/results]
- [-log-dir=/path/to/log]
- [-refresh-cve]
- [-cvedb-type=sqlite3|mysql|postgres|redis]
- [-cvedb-path=/path/to/cve.sqlite3]
- [-cvedb-url=http://127.0.0.1:1323 or DB connection string]
- [-ovaldb-type=sqlite3|mysql]
- [-ovaldb-path=/path/to/oval.sqlite3]
- [-ovaldb-url=http://127.0.0.1:1324 or DB connection string]
- [-cvss-over=7]
- [-diff]
- [-ignore-unscored-cves]
- [-ignore-unfixed]
- [-to-email]
- [-to-slack]
- [-to-localfile]
- [-to-s3]
- [-to-azure-blob]
- [-format-json]
- [-format-xml]
- [-format-one-email]
- [-format-one-line-text]
- [-format-short-text]
- [-format-full-text]
- [-gzip]
- [-aws-profile=default]
- [-aws-region=us-west-2]
- [-aws-s3-bucket=bucket_name]
- [-aws-s3-results-dir=/bucket/path/to/results]
- [-azure-account=accout]
- [-azure-key=key]
- [-azure-container=container]
- [-http-proxy=http://192.168.0.1:8080]
- [-debug]
- [-debug-sql]
- [-pipe]
-
- [RFC3339 datetime format under results dir]
-
- -aws-profile string
- AWS profile to use (default "default")
- -aws-region string
- AWS region to use (default "us-east-1")
- -aws-s3-bucket string
- S3 bucket name
- -aws-s3-results-dir string
- /bucket/path/to/results (option)
- -azure-account string
- Azure account name to use. AZURE_STORAGE_ACCOUNT environment variable is used if not specified
- -azure-container string
- Azure storage container name
- -azure-key string
- Azure account key to use. AZURE_STORAGE_ACCESS_KEY environment variable is used if not specified
- -config string
- /path/to/toml
- -cvedb-path string
- /path/to/sqlite3 (For get cve detail from cve.sqlite3)
- -cvedb-type string
- DB type for fetching CVE dictionary (sqlite3, mysql, postgres or redis) (default "sqlite3")
- -cvedb-url string
- http://cve-dictionary.com:8080 or DB connection string
- -cvss-over float
- -cvss-over=6.5 means reporting CVSS Score 6.5 and over (default: 0 (means report all))
- -diff
- Difference between previous result and current result
- -debug
- debug mode
- -debug-sql
- SQL debug mode
- -format-full-text
- Detail report in plain text
- -format-json
- JSON format
- -format-one-email
- Send all the host report via only one EMail (Specify with -to-email)
- -format-one-line-text
- One line summary in plain text
- -format-short-text
- Summary in plain text
- -format-xml
- XML format
- -gzip
- gzip compression
- -http-proxy string
- http://proxy-url:port (default: empty)
- -ignore-unscored-cves
- Don't report the unscored CVEs
- -ignore-unfixed
- Don't report the unfixed CVEs
- -lang string
- [en|ja] (default "en")
- -log-dir string
- /path/to/log (default "/var/log/vuls")
- -ovaldb-path string
- /path/to/sqlite3 (For get oval detail from oval.sqlite3) (default "/Users/kotakanbe/go/src/github.com/future-architect/vuls/oval.sqlite3")
- -ovaldb-type string
- DB type for fetching OVAL dictionary (sqlite3 or mysql) (default "sqlite3")
- -ovaldb-url string
- http://goval-dictionary.com:1324 or mysql connection string
- -pipe
- Use stdin via PIPE
- -refresh-cve
- Refresh CVE information in JSON file under results dir
- -results-dir string
- /path/to/results
- -to-azure-blob
- Write report to Azure Storage blob (container/yyyyMMdd_HHmm/servername.json/xml/txt)
- -to-email
- Send report via Email
- -to-localfile
- Write report to localfile
- -to-s3
- Write report to S3 (bucket/dir/yyyyMMdd_HHmm/servername.json/xml/txt)
- -to-slack
- Send report via Slack
-```
-
-## How to read a report
-
-### Example
-
-```
-$ vuls report -format-full-text
-
-172-31-4-82 (amazon 2015.09)
-============================
-Total: 94 (High:19 Medium:54 Low:7 ?:14) 103 updatable packages
-
-CVE-2016-5636
--------------
-Score 10.0 (High)
-Vector (AV:N/AC:L/Au:N/C:C/I:C/A:C)
-Summary Integer overflow in the get_data function in zipimport.c in CPython (aka Python)
- before 2.7.12, 3.x before 3.4.5, and 3.5.x before 3.5.2 allows remote attackers
- to have unspecified impact via a negative data size value, which triggers a
- heap-based buffer overflow.
-CWE https://cwe.mitre.org/data/definitions/190.html
-NVD https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2016-5636
-MITRE https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2016-5636
-CVE Details http://www.cvedetails.com/cve/CVE-2016-5636
-CVSS Calculator https://nvd.nist.gov/cvss/v2-calculator?name=CVE-2016-5636&vector=(AV:N/AC:L/...
-RHEL-CVE https://access.redhat.com/security/cve/CVE-2016-5636
-ALAS-2016-724 https://alas.aws.amazon.com/ALAS-2016-724.html
-Package python27-2.7.10-4.119.amzn1 -> python27-2.7.12-2.120.amzn1
- python27-devel-2.7.10-4.119.amzn1 -> python27-devel-2.7.12-2.120.amzn1
- python27-libs-2.7.10-4.119.amzn1 -> python27-libs-2.7.12-2.120.amzn1
-Confidence 100 / YumUpdateSecurityMatch
-
-... snip ...
-```
-
-### Summary part
-
-```
-cent6 (centos6.6)
-=================
-Total: 145 (High:23 Medium:101 Low:21 ?:0) 83 updatable packages
-```
-
-- `cent6` means that it is a scan report of `servers.cent6` defined in cocnfig.toml.
-- `(centos6.6)` means that the version of the OS is CentOS6.6.
-- `Total: 145 (High:23 Medium:101 Low:21 ?:0)` means that a total of 145 vulnerabilities exist, and the distribution of CVSS Severity is displayed.
-- `83 updatable packages` means that there are 83 updateable packages on the target server.
-
-### Detailed Part
-
-```
-CVE-2016-0702
-----------------
-Max Score 2.6 IMPORTANT (redhat)
-nvd 1.9/AV:L/AC:M/Au:N/C:P/I:N/A:N
-redhat 2.6/AV:L/AC:H/Au:N/C:P/I:P/A:N
-jvn 1.9/AV:L/AC:M/Au:N/C:P/I:N/A:N
-CVSSv2 Calc https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator?name=CVE-2016-0702
-Summary The MOD_EXP_CTIME_COPY_FROM_PREBUF function in crypto/bn/bn_exp.c in OpenSSL
- 1.0.1 before 1.0.1s and 1.0.2 before 1.0.2g does not properly consider
- cache-bank access times during modular exponentiation, which makes it easier for
- local users to discover RSA keys by running a crafted application on the same
- Intel Sandy Bridge CPU core as a victim and leveraging cache-bank conflicts, aka
- a "CacheBleed" attack.
-Source https://nvd.nist.gov/vuln/detail/CVE-2016-0702
-RHEL-CVE https://access.redhat.com/security/cve/CVE-2016-0702
-CWE-200 (nvd) https://cwe.mitre.org/data/definitions/200.html
-Package/CPE openssl-1.0.1e-30.el6 - 1.0.1e-57.el6
-Confidence 100 / OvalMatch
-```
-
-- `Max Score` means Max CVSS Score.
-- `nvd` shows [CVSS Vector](https://nvd.nist.gov/CVSS/Vector-v2.aspx) of NVD
-- `redhat` shows [CVSS Vector](https://nvd.nist.gov/CVSS/Vector-v2.aspx) of RedHat OVAL
-- `jvn` shows [CVSS Vector](https://nvd.nist.gov/CVSS/Vector-v2.aspx) of JVN
-- `Summary` means Summary of the CVE.
-- `CWE` means [CWE - Common Weakness Enumeration](https://nvd.nist.gov/cwe.cfm) of the CVE.
-- `Package` shows the package version information including this vulnerability.
-- `Confidence` means the reliability of detection.
- - `100` is highly reliable
- - `YumUpdateSecurityMatch` is the method of detecting this vulnerability.
-- Item list of `Confidence`
-
- | Detection Method | Confidence | OS |Description|
- |:-----------------------|-------------------:|:---------------------------------|:--|
- | OvalMatch | 100 | CentOS, RHEL, Oracle, Ubuntu, Debian, SUSE |Detection using OVAL |
- | YumUpdateSecurityMatch | 100 | RHEL, Amazon, Oracle |Detection using yum-plugin-security|
- | ChangelogExactMatch | 95 | CentOS, Ubuntu, Debian, Raspbian |Exact version match between changelog and package version|
- | ChangelogLenientMatch | 50 | Ubuntu, Debian, Raspbian |Lenient version match between changelog and package version|
- | PkgAuditMatch | 100 | FreeBSD |Detection using pkg audit|
- | CpeNameMatch | 100 | All |Search for NVD information with CPE name specified in config.toml|
-
-
-## Example: Send scan results to Slack
-```
-$ vuls report \
- -to-slack \
- -cvss-over=7 \
- -cvedb-path=$PWD/cve.sqlite3
-```
-With this sample command, it will ..
-- Slack通知
-- CVSS score が 7.0以上のもののみ通知
-
-
-## Example: Put results in S3 bucket
-
-事前にAWS関連の設定を行う
-- S3バケットを作成 [Creating a Bucket](http://docs.aws.amazon.com/AmazonS3/latest/UG/CreatingaBucket.html)
-- いずれかの方法でS3リソースへアクセスする設定を行う
- - 環境変数を設定 [Configuring the AWS Command Line Interface](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html)
- - Security Credentialsを設定 [Configuring the AWS Command Line Interface](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html)
- - サービス用のIAMロールを作成し、サービス(EC2, AWS Lambda)にアタッチ [Creating a Role to Delegate Permissions to an AWS Service](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html)
-- 環境変数、Security Credentialsを設定する場合はアクセスキーを作成する [Managing Access Keys for IAM Users](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)
-
-IAMポリシーの例:
-
-```
-{
- "Version": "2012-10-17",
- "Statement": [
- {
- "Effect": "Allow",
- "Action": [
- "s3:ListAllMyBuckets"
- ],
- "Resource": "arn:aws:s3:::*"
- },
- {
- "Effect": "Allow",
- "Action": [
- "s3:PutObject"
- ],
- "Resource": "arn:aws:s3:::vuls/*"
- }
- ]
-}
-```
-
-```
-$ vuls scan \
- -cvedb-path=$PWD/cve.sqlite3 \
- -to-s3 \
- -format-json \
- -aws-region=ap-northeast-1 \
- -aws-s3-bucket=vuls \
- -aws-profile=default
-```
-この例では、
-- 結果をJSON形式でS3に格納する。
- - バケット名 ... vuls
- - リージョン ... ap-northeast-1
- - 利用するProfile ... default
-
-## Example: Put results in Azure Blob storage
-
-事前にAzure Blob関連の設定を行う
-- Azure Blob Containerを作成
-
-```
-$ vuls scan \
- -cvedb-path=$PWD/cve.sqlite3 \
- -to-azure-blob \
- -format-xml \
- -azure-container=vuls \
- -azure-account=test \
- -azure-key=access-key-string
-```
-この例では、
-- 結果をXML形式でBlobに格納する。
- - コンテナ名 ... vuls
- - ストレージアカウント名 ... test
- - アクセスキー ... access-key-string
-
-また、アカウント名とアクセスキーは環境変数でも定義が可能
-```
-$ export AZURE_STORAGE_ACCOUNT=test
-$ export AZURE_STORAGE_ACCESS_KEY=access-key-string
-$ vuls scan \
- -cve-dictionary-dbpath=$PWD/cve.sqlite3 \
- -report-azure-blob \
- -azure-container=vuls
-```
-
-## Example: IgnoreCves
-
-Slack, EMail, テキスト出力しないくないCVE IDがある場合は、設定ファイルに定義することでレポートされなくなる。
-ただ、JSONファイルには以下のように出力される。
-
-- config.toml
-```toml
-[default]
-ignoreCves = ["CVE-2016-6313"]
-
-[servers.bsd]
-host = "192.168.11.11"
-user = "kanbe"
-ignoreCves = ["CVE-2016-6314"]
-```
-
-- bsd.json
-```json
-[
- {
- "ServerName": "bsd",
- "Family": "FreeBSD",
- "Release": "10.3-RELEASE",
- "IgnoredCves" : [
- "CveDetail" : {
- "CVE-2016-6313",
- ...
- },
- "CveDetail" : {
- "CVE-2016-6314",
- ...
- }
- ]
- }
-]
-```
-
-## Example: Add optional key-value pairs to JSON
-
-追加情報をJSONに含めることができる。
-デフォルトセクションのkey-valueはserversセクションのもので上書きされる。
-使い方の例として、AzureリソースグループやVM名を指定しておくことで、結果のJSONをスクリプトでパースしてAzure VMの操作をする、などが可能。
-
-- config.toml
-```toml
-[default]
-optional = [
- ["key1", "default_value"],
- ["key3", "val3"],
-]
-
-[servers.bsd]
-host = "192.168.11.11"
-user = "kanbe"
-optional = [
- ["key1", "val1"],
- ["key2", "val2"],
-]
-```
-
-- bsd.json
-```json
-[
- {
- "ServerName": "bsd",
- "Family": "FreeBSD",
- "Release": "10.3-RELEASE",
- .... snip ...
- "Optional": [
- [ "key1", "val1" ],
- [ "key2", "val2" ],
- [ "key3", "val3" ]
- ]
- }
-]
-```
-
-## Example: Use MySQL as a DB storage back-end
-
-```
-$ vuls report \
- -cvedb-type=mysql \
- -cvedb-url="user:pass@tcp(localhost:3306)/dbname?parseTime=true"
-```
-
-## Example: Use PostgreSQL as a DB storage back-end
-
-```
-$ vuls report \
- -cvedb-type=postgres \
- -cvedb-url=""host=myhost user=user dbname=dbname sslmode=disable password=password""
-```
-
-## Example: Use Redis as a DB storage back-end
-
-```
-$ vuls report \
- -cvedb-type=redis -cvedb-url="redis://localhost/0"
- -ovaldb-type=redis -ovaldb-url="redis://localhost/1"
-```
-
-----
-
-# Usage: Scan vulnerability of non-OS package
-
-Vulsは、[CPE](https://nvd.nist.gov/cpe.cfm)に登録されているソフトウェアであれば、OSパッケージ以外のソフトウェアの脆弱性もスキャン可能。
-たとえば、自分でコンパイルしたものや、言語のライブラリ、フレームワークなど。
-
-- CPEの検索方法
- - [NVD: Search Common Platform Enumerations (CPE)](https://web.nvd.nist.gov/view/cpe/search)
- **Check CPE Naming Format: 2.2**
-
- - [go-cpe-dictionary](https://github.com/kotakanbe/go-cpe-dictionary) is a good choice for geeks.
- ターミナル上でCPEをインクリメンタル検索出来るツール
-
-- Configuration
-例えば、Ruby on Rails v4.2.1の脆弱性を検知したい場合は、serversセクションに以下のように定義する。
- ```
- [servers]
-
- [servers.172-31-4-82]
- host = "172.31.4.82"
- user = "ec2-user"
- keyPath = "/home/username/.ssh/id_rsa"
- cpeNames = [
- "cpe:/a:rubyonrails:ruby_on_rails:4.2.1",
- ]
- ```
-
-- Configuration
-ネットワーク機器など、スキャン対象にSSH接続しない場合は`type="pseudo"`を指定する。
- ```
- [servers]
-
- [servers.172-31-4-82]
- type = "pseudo"
- cpeNames = [
- "cpe:/a:rubyonrails:ruby_on_rails:4.2.1",
- ]
- ```
-
-
-# Usage: Integrate with OWASP Dependency Check to Automatic update when the libraries are updated (Experimental)
-[OWASP Dependency check](https://www.owasp.org/index.php/OWASP_Dependency_Check) は、プログラミング言語のライブラリを特定し（CPEを推測）、公開済みの脆弱性を検知するツール。
-
-VulsとDependency Checkを連携させる方法は以下
-- Dependency Checkを、--format=XMLをつけて実行する
-- そのXMLをconfig.toml内で以下のように定義する
-
- ```
- [servers]
-
- [servers.172-31-4-82]
- host = "172.31.4.82"
- user = "ec2-user"
- keyPath = "/home/username/.ssh/id_rsa"
- dependencyCheckXMLPath = "/tmp/dependency-check-report.xml"
- ```
-
-VulsとDependency Checkを連携すると以下の利点がある
-- ライブラリを更新した場合に、config.tomlのCPEの定義を変更しなくても良い
-- Vulsの機能でSlack, Emailで通知可能
-- 日本語のレポートが可能
- - Dependency Checkは日本語レポートに対応していない
-
-
-# Usage: TUI
-
-## Display the latest scan results
-
-```
-tui:
- tui
- [-cvedb-type=sqlite3|mysql|postgres|redis]
- [-cvedb-path=/path/to/cve.sqlite3]
- [-cvedb-url=http://127.0.0.1:1323 DB connection string]
- [-ovaldb-type=sqlite3|mysql]
- [-ovaldb-path=/path/to/oval.sqlite3]
- [-ovaldb-url=http://127.0.0.1:1324 or DB connection string]
- [-cvss-over=7]
- [-ignore-unscored-cves]
- [-ignore-unfixed]
- [-refresh-cve]
- [-results-dir=/path/to/results]
- [-log-dir=/path/to/log]
- [-debug]
- [-debug-sql]
- [-pipe]
-
- -cvedb-path string
- /path/to/sqlite3 (For get cve detail from cve.sqlite3)
- -cvedb-type string
- DB type for fetching CVE dictionary (sqlite3, mysql, postgres or redis) (default "sqlite3")
- -cvedb-url string
- http://cve-dictionary.com:8080 or DB connection string
- -ovaldb-path string
- /path/to/sqlite3 (For get oval detail from oval.sqlite3) (default "/Users/kotakanbe/go/src/github.com/future-architect/vuls/oval.sqlite3")
- -ovaldb-type string
- DB type for fetching OVAL dictionary (sqlite3 or mysql) (default "sqlite3")
- -ovaldb-url string
- http://goval-dictionary.com:1324 or mysql connection string
- -cvss-over float
- -cvss-over=6.5 means reporting CVSS Score 6.5 and over (default: 0 (means report all))
- -ignore-unfixed
- Don't report the unfixed CVEs
- -ignore-unscored-cves
- Don't report the unscored CVEs
- -debug
- debug mode
- -debug-sql
- debug SQL
- -log-dir string
- /path/to/log (default "/var/log/vuls")
- -pipe
- Use stdin via PIPE
- -refresh-cve
- Refresh CVE information in JSON file under results dir
- -results-dir string
- /path/to/results
-```
-
-
-Key binding is below.
-
-| key | |
-|:-----------------|:-------|
-| TAB | move cursor among the panes |
-| Arrow up/down | move cursor to up/down |
-| Ctrl+j, Ctrl+k | move cursor to up/down |
-| Ctrl+u, Ctrl+d | page up/down |
-
-For details, see https://github.com/future-architect/vuls/blob/master/report/tui.go
-
-## Display the previous scan results
-
-- Display the list of scan results.
-```
-$ vuls history
-20160524_1950 scanned 1 servers: amazon2
-20160524_1940 scanned 2 servers: amazon1, romantic_goldberg
-```
-
-- Display the result of scan 20160524_1949
-```
-$ vuls tui 20160524_1950
-```
-
-- Display the result of scan 20160524_1948
-```
-$ vuls tui 20160524_1940
-```
-
-# Display the previous scan results using peco
-
-```
-$ vuls history | peco | vuls tui -pipe
-```
-
-[](https://asciinema.org/a/emi7y7docxr60bq080z10t7v8)
-
-# Usage: go-cve-dictionary on different server
-
-Run go-cve-dictionary as server mode before scanning on 192.168.10.1
-```
-$ go-cve-dictionary server -bind=192.168.10.1 -port=1323
-```
-
-Run Vuls with -cve-dictionary-url option.
-
-```
-$ vuls report -cve-dictionary-url=http://192.168.0.1:1323
-```
-
-# Usage: Update NVD Data
-
-see [go-cve-dictionary#usage-fetch-nvd-data](https://github.com/kotakanbe/go-cve-dictionary#usage-fetch-nvd-data)
-
-----
-
-# Usage: goval-dictionary on different server
-
-```
-$ goval-dictionary server -bind=192.168.10.1 -port=1324
-```
-
-Run Vuls with -ovaldb-url option.
-
-```
-$ vuls report -ovaldb-url=http://192.168.0.1:1323
-```
-
-# Usage: Update OVAL Data
-
-- [RedHat, CentOS](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-redhat)
-- [Ubuntu](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-ubuntu)
-- [Debian](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-debian)
-- [Oracle](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-oracle)
-- [SUSE](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-suse)
-
-----
-
-# レポートの日本語化
-
-see [go-cve-dictionary#usage-fetch-jvn-data](https://github.com/kotakanbe/go-cve-dictionary#usage-fetch-jvn-data)
-
-
-## fetchnvd, fetchjvnの実行順序の注意
-
- **fetchjvn -> fetchnvdの順番だとすごく時間がかかる** (2016年9月現在)
- **fetchnvd -> fetchjvnの順番で実行すること**
-
-```
-$ for i in `seq 2002 $(date +"%Y")`; do go-cve-dictionary fetchnvd -years $i; done
-$ for i in `seq 1998 $(date +"%Y")`; do go-cve-dictionary fetchjvn -years $i; done
-```
-の順でやった場合、最初のコマンドが15分程度、二つ目のコマンドが10分程度（環境依存）
-
-
-```
-$ for i in `seq 1998 $(date +"%Y")`; do go-cve-dictionary fetchjvn -years $i; done
-$ for i in `seq 2002 $(date +"%Y")`; do go-cve-dictionary fetchnvd -years $i; done
-```
-の順で行うと、最初のコマンドは1時間くらいで終わるが二つ目のコマンドが21時間かかることもある(環境依存)。
-
-
-## スキャン実行
-
-```
-$ vuls scan -lang=ja
-```
-Scan時にlang=jaを指定すると脆弱性レポートが日本語になる
-slack, emailは日本語対応済み TUIは日本語表示未対応
-
-----
-
-# How to Update to the Latest Version
-
-- Update go-cve-dictionary
-If the DB schema was changed, please specify new SQLite3, MySQL, PostgreSQL or Redis DB file.
-```
-$ cd $GOPATH/src/github.com/kotakanbe/go-cve-dictionary
-$ git pull
-$ rm -r vendor
-$ make install
-```
-
-- Update goval-dictionary
-If the DB schema was changed, please specify new SQLite3, MySQL, PostgreSQL or Redis DB file.
-```
-$ cd $GOPATH/src/github.com/kotakanbe/goval-dictionary
-$ git pull
-$ rm -r vendor
-$ make install
-```
-
-- Update vuls
-```
-$ cd $GOPATH/src/github.com/future-architect/vuls
-$ git pull
-$ rm -r vendor
-$ make install
-```
-- バイナリファイルは`$GOPATH/bin`以下に作成される
-- もしエラーが出る場合は `$GOPATH/pkg` を削除してから実行する
-
----
-
-# Misc
-
-- go get時にエラーが出る
-Gitをv2にアップデートしてお試しを
-see https://groups.google.com/forum/#!topic/mgo-users/rO1-gUDFo_g
-
-- HTTP Proxy サポート
-プロキシ環境下では、-http-proxyオプションを指定
-
-- go-cve-dictionaryのデーモン化
-Use Systemd, Upstart or supervisord, daemontools...
-
-- NVD, JVNの脆弱性データベースの自動更新
-CRONなどを使えば可能
-
-- 自動定期スキャン
-CRONなどを使い、自動化のためにsudoと、秘密鍵のパスワードなしでも実行可能なようにする
- - スキャン対象サーバの /etc/sudoers に NOPASSWORD を設定する
- - 秘密鍵パスフレーズなしの公開鍵認証か、ssh-agentを使う
-
-- スキャンが重く感じる
-vulsのスキャン対象に脆弱性が溜まりすぎると実行時間が長くなります
-脆弱性のある状態は溜めすぎないようにしましょう
-
-- クロスコンパイル
- ```bash
- $ cd /path/to/your/local-git-reporsitory/vuls
- $ GOOS=linux GOARCH=amd64 go build -o vuls.amd64
- ```
-
-- Logging
-Log is under /var/log/vuls/
-
-- Debug
-Run with --debug, --sql-debug option.
-
-- Adjusting Open File Limit
-[Riak docs](http://docs.basho.com/riak/latest/ops/tuning/open-files-limit/) is awesome.
-
-- Does Vuls accept ssh connections with fish-shell or old zsh as the login shell?
-~~No, Vuls needs a user on the server for bash login. see also [#8](/../../issues/8)~~
-Yes, fixed in [#545](https://github.com/future-architect/vuls/pull/545)
-
-- Windows
-Use Microsoft Baseline Security Analyzer. [MBSA](https://technet.microsoft.com/en-us/security/cc184924.aspx)
-
-----
-
-# Related Projects
-
-- [k1LoW/ssh_config_to_vuls_config](https://github.com/k1LoW/ssh_config_to_vuls_config)
-ssh_config to vuls config TOML format
-
-- [usiusi360/vulsrepo](https://github.com/usiusi360/vulsrepo)
-VulsRepo is visualized based on the json report output in vuls.
-Youtube
-[](https://www.youtube.com/watch?v=DIBPoik4owc)
-
-
-----
-
-# Data Source
-
-- [NVD](https://nvd.nist.gov/)
-- [JVN(Japanese)](http://jvndb.jvn.jp/apis/myjvn/)
-- [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/)
-
-
-# Authors
-
-kotakanbe ([@kotakanbe](https://twitter.com/kotakanbe)) created vuls and [these fine people](https://github.com/future-architect/vuls/graphs/contributors) have contributed.
-
-----
-
-# Contribute
-
-1. fork a repository: github.com/future-architect/vuls to github.com/you/repo
-2. get original code: go get github.com/future-architect/vuls
-3. work on original code
-4. add remote to your repo: git remote add myfork https://github.com/you/repo.git
-5. push your changes: git push myfork
-6. create a new Pull Request
-
-- see [GitHub and Go: forking, pull requests, and go-getting](http://blog.campoy.cat/2014/03/github-and-go-forking-pull-requests-and.html)
-
-----
-
-# 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).
diff --git a/README.md b/README.md
index c80ee3b4..79c279b0 100644
--- a/README.md
+++ b/README.md
@@ -13,115 +13,16 @@ 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)
-[README 日本語](https://github.com/future-architect/vuls/blob/master/README.ja.md)
-
+
+
[](https://asciinema.org/a/3y9zrf950agiko7klg8abvyck)
----
-# TOC
-
-Table of Contents
-=================
-
- * [Vuls: VULnerability Scanner](#vuls-vulnerability-scanner)
- * [TOC](#toc)
- * [Abstract](#abstract)
- * [Main Features](#main-features)
- * [What Vuls Doesn't Do](#what-vuls-doesnt-do)
- * [Setup Vuls](#setup-vuls)
- * [Tutorial](#tutorial)
- * [Tutorial: Local Scan Mode](#tutorial-local-scan-mode)
- * [Step1. Launch CentOS7](#step1-launch-centos7)
- * [Step2. Install requirements](#step2-install-requirements)
- * [Step3. Deploy go-cve-dictionary](#step3-deploy-go-cve-dictionary)
- * [Step4. Deploy goval-dictionary](#step4-deploy-goval-dictionary)
- * [Step5. Deploy Vuls](#step5-deploy-vuls)
- * [Step6. Configuration](#step6-configuration)
- * [Step7. Check config.toml and settings on the server before scanning](#step7-check-configtoml-and-settings-on-the-server-before-scanning)
- * [Step8. Start Scanning](#step8-start-scanning)
- * [Step9. Reporting](#step9-reporting)
- * [Step10. TUI](#step10-tui)
- * [Step11. Web UI](#step11-web-ui)
- * [Tutorial: Remote Scan Mode](#tutorial-remote-scan-mode)
- * [Step1. Launch new Ubuntu Linux](#step1-launch-new-ubuntu-linux)
- * [Step2. Enable to SSH from localhost](#step2-enable-to-ssh-from-localhost)
- * [Step3. Configure (config.toml)](#step3-configure-configtoml)
- * [Step4. Check config.toml and settings on the server before scanning](#step4-check-configtoml-and-settings-on-the-server-before-scanning)
- * [Step5. Start Scanning](#step5-start-scanning)
- * [Step6. Reporting](#step6-reporting)
- * [Setup Vuls in a Docker Container](#setup-vuls-in-a-docker-container)
- * [Architecture](#architecture)
- * [A. Scan via SSH Mode (Remote Scan Mode)](#a-scan-via-ssh-mode-remote-scan-mode)
- * [B. Scan without SSH (Local Scan Mode)](#b-scan-without-ssh-local-scan-mode)
- * [Fast Scan and Deep Scan](#fast-scan-and-deep-scan)
- * [Fast Scan](#fast-scan)
- * [Deep Scan](#deep-scan)
- * [Use Cases](#use-cases)
- * [Scan All Servers](#scan-all-servers)
- * [Scan a Single Server](#scan-a-single-server)
- * [Scan Staging Environment](#scan-staging-environment)
- * [Support OS](#support-os)
- * [Usage: Automatic Server Discovery](#usage-automatic-server-discovery)
- * [Example](#example)
- * [Configuration](#configuration)
- * [Usage: Configtest](#usage-configtest)
- * [Fast Scan Mode](#fast-scan-mode)
- * [Deep Scan Mode](#deep-scan-mode)
- * [Dependencies and /etc/sudoers on Target Servers](#dependencies-and-etcsudoers-on-target-servers)
- * [Usage: Scan](#usage-scan)
- * [-deep option](#-deep-option)
- * [-ssh-native-insecure option](#-ssh-native-insecure-option)
- * [-ask-key-password option](#-ask-key-password-option)
- * [Example: Scan all servers defined in config file](#example-scan-all-servers-defined-in-config-file)
- * [Example: Scan specific servers](#example-scan-specific-servers)
- * [Example: Scan via shell instead of SSH.](#example-scan-via-shell-instead-of-ssh)
- * [cron](#cron)
- * [Example: Scan containers (Docker/LXD/LXC)](#example-scan-containers-dockerlxdlxc)
- * [Docker](#docker)
- * [LXD](#lxd)
- * [LXC](#lxc)
- * [Usage: Report](#usage-report)
- * [How to read a report](#how-to-read-a-report)
- * [Example](#example-1)
- * [Summary part](#summary-part)
- * [Detailed Part](#detailed-part)
- * [Example: Send scan results to Slack](#example-send-scan-results-to-slack)
- * [Example: Put results in S3 bucket](#example-put-results-in-s3-bucket)
- * [Example: Put results in Azure Blob storage](#example-put-results-in-azure-blob-storage)
- * [Example: IgnoreCves](#example-ignorecves)
- * [Example: Add optional key-value pairs to JSON](#example-add-optional-key-value-pairs-to-json)
- * [Example: Use MySQL as a DB storage back-end](#example-use-mysql-as-a-db-storage-back-end)
- * [Example: Use PostgreSQL as a DB storage back-end](#example-use-postgresql-as-a-db-storage-back-end)
- * [Example: Use Redis as a DB storage back-end](#example-use-redis-as-a-db-storage-back-end)
- * [Usage: Scan vulnerabilites of non-OS packages](#usage-scan-vulnerabilites-of-non-os-packages)
- * [Usage: Integrate with OWASP Dependency Check to Automatic update when the libraries are updated (Experimental)](#usage-integrate-with-owasp-dependency-check-to-automatic-update-when-the-libraries-are-updated-experimental)
- * [Usage: TUI](#usage-tui)
- * [Display the latest scan results](#display-the-latest-scan-results)
- * [Display the previous scan results](#display-the-previous-scan-results)
- * [Display the previous scan results using peco](#display-the-previous-scan-results-using-peco)
- * [Usage: go-cve-dictionary on different server](#usage-go-cve-dictionary-on-different-server)
- * [Usage: Update NVD Data](#usage-update-nvd-data)
- * [Usage: goval-dictionary on different server](#usage-goval-dictionary-on-different-server)
- * [Usage: Update OVAL Data](#usage-update-oval-data)
- * [How to Update to the Latest Version](#how-to-update-to-the-latest-version)
- * [Misc](#misc)
- * [Related Projects](#related-projects)
- * [Data Source](#data-source)
- * [Authors](#authors)
- * [Contribute](#contribute)
- * [Change Log](#change-log)
- * [Stargazers over time](#stargazers-over-time)
- * [License](#license)
-
-Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)
-
-----
-
# Abstract
For a system administrator, having to perform security vulnerability analysis and software update on a daily basis can be a burden.
@@ -149,7 +50,14 @@ Vuls is a tool created to solve the problems listed above. It has the following
- Cloud, on-premise, Docker
- High quality scan
- Vuls uses Multiple vulnerability databases
- - OVAL
+ - [NVD](https://nvd.nist.gov/)
+ - [JVN(Japanese)](http://jvndb.jvn.jp/apis/myjvn/)
+ - [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/)
- RHSA/ALAS/ELSA/FreeBSD-SA
- Changelog
- Fast scan and Deep scan
@@ -191,1755 +99,19 @@ Vuls is a tool created to solve the problems listed above. It has the following
----
-# Setup Vuls
+# Document
-There are 2 ways to setup Vuls.
-
-- Docker container
-Dockernized-Vuls with vulsrepo UI in it.
-You can run install and run Vuls on your machine with only a few commands.
-see https://github.com/future-architect/vuls/tree/master/setup/docker
-
-- Manually
-Tutorial shows how to setup vuls manually.
+For more information such as Installation, Tutorial, Usage, visit [vuls.io](https://vuls.io/)
+[日本語翻訳ドキュメント](https://vuls.io/ja/)
----
-# Tutorial
-
-To give you an idea of how easy Vuls is to use.
-This tutorial consists of three steps.
-1. Tutorial: Local Scan Mode
- - Launch CentOS on AWS
- - Deploy Vuls
- - Scan localhost, Reporting
-1. Tutorial: Remote Scan Mode
- - Launch Ubuntu Linux on AWS
- - Scan this Ubuntu from the Vuls you set up earlier
-
-----
-
-# Tutorial: Local Scan Mode
-
-This tutorial will let you scan the vulnerabilities on the localhost with Vuls.
-This can be done in the following steps.
-
-1. Launch CentOS
-1. Install requirements
-1. Deploy go-cve-dictionary
-1. Deploy goval-dictionary
-1. Deploy Vuls
-1. Configuration
-1. Check config.toml and settings on the server before scanning
-1. Scan
-1. Reporting
-1. TUI(Terminal-Based User Interface)
-1. Web UI ([VulsRepo](https://github.com/usiusi360/vulsrepo))
-
-## Step1. Launch CentOS7
-
-- We are using the old AMI for this example
-- Add the following to the cloud-init, to avoid auto-update at the first launch.
-
- ```
- #cloud-config
- repo_upgrade: none
- ```
-
- - [Q: How do I disable the automatic installation of critical and important security updates on initial launch?](https://aws.amazon.com/amazon-linux-ami/faqs/?nc1=h_ls)
-
-## Step2. Install requirements
-
-Vuls requires the following packages.
-
-- SQLite3, MySQL, PostgreSQL, Redis
-- git
-- gcc
-- GNU Make
-- go v1.8.3 or later (The latest version is recommended)
- - https://golang.org/doc/install
-
-```bash
-$ ssh centos@52.100.100.100 -i ~/.ssh/private.pem
-$ sudo yum -y install sqlite git gcc make wget
-$ wget https://storage.googleapis.com/golang/go1.8.3.linux-amd64.tar.gz
-$ sudo tar -C /usr/local -xzf go1.8.3.linux-amd64.tar.gz
-$ mkdir $HOME/go
-```
-Add these lines into /etc/profile.d/goenv.sh
-
-```bash
-export GOROOT=/usr/local/go
-export GOPATH=$HOME/go
-export PATH=$PATH:$GOROOT/bin:$GOPATH/bin
-```
-
-Set the OS environment variable to current shell
-```bash
-$ source /etc/profile.d/goenv.sh
-```
-
-## Step3. Deploy go-cve-dictionary
-
-[go-cve-dictionary](https://github.com/kotakanbe/go-cve-dictionary)
-
-```bash
-$ sudo mkdir /var/log/vuls
-$ sudo chown centos /var/log/vuls
-$ sudo chmod 700 /var/log/vuls
-$
-$ mkdir -p $GOPATH/src/github.com/kotakanbe
-$ cd $GOPATH/src/github.com/kotakanbe
-$ git clone https://github.com/kotakanbe/go-cve-dictionary.git
-$ cd go-cve-dictionary
-$ make install
-```
-The binary was built under `$GOPATH/bin`
-If the installation process stops halfway, try increasing the instance type of EC2. An out of memory error may have occurred.
-
-
-Fetch vulnerability data from NVD.
-It takes about 10 minutes (on AWS).
-
-```bash
-$ cd $HOME
-$ for i in `seq 2002 $(date +"%Y")`; do go-cve-dictionary fetchnvd -years $i; done
-... snip ...
-$ ls -alh cve.sqlite3
--rw-r--r--. 1 centos centos 51M Aug 6 08:10 cve.sqlite3
--rw-r--r--. 1 centos centos 32K Aug 6 08:10 cve.sqlite3-shm
--rw-r--r--. 1 centos centos 5.1M Aug 6 08:10 cve.sqlite3-wal
-```
-
-## Step4. Deploy goval-dictionary
-
-[goval-dictionary](https://github.com/kotakanbe/goval-dictionary)
-
-```bash
-$ mkdir -p $GOPATH/src/github.com/kotakanbe
-$ cd $GOPATH/src/github.com/kotakanbe
-$ git clone https://github.com/kotakanbe/goval-dictionary.git
-$ cd goval-dictionary
-$ make install
-```
-The binary was built under `$GOPATH/bin`
-If the installation process stops halfway, try increasing the instance type of EC2. An out of memory error may have occurred.
-
- Then fetch OVAL data of RedHat since the server to be scanned is CentOS. [README](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-redhat)
-
-```bash
-$ goval-dictionary fetch-redhat 7
-```
-
-If you want to scan other than CentOS 7, fetch OVAL data according to the OS type and version of scan target server in advance.
-- [Alpine](https://github.com/kotakanbe/goval-dictionary#usage-fetch-alpine-secdb-as-oval-data-type)
-- [RedHat, CentOS](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-redhat)
-- [Debian](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-debian)
-- [Ubuntu](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-ubuntu)
-- [Oracle Linux](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-oracle)
-- [SUSE](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-suse)
-
-## Step5. Deploy Vuls
-
-Launch a new terminal and SSH to the ec2 instance.
-
-```
-$ mkdir -p $GOPATH/src/github.com/future-architect
-$ cd $GOPATH/src/github.com/future-architect
-$ git clone https://github.com/future-architect/vuls.git
-$ cd vuls
-$ make install
-```
-If you have previously installed vuls and want to update, please do the following
-```
-$ rm -rf $GOPATH/pkg/linux_amd64/github.com/future-architect/vuls/
-$ rm -rf $GOPATH/src/github.com/future-architect/vuls/
-$ cd $GOPATH/src/github.com/future-architect
-$ git clone https://github.com/future-architect/vuls.git
-$ cd vuls
-$ make install
-```
-
-The binary was built under `$GOPATH/bin`
-If the installation process stops halfway, try increasing the instance type of EC2. An out of memory error may have occurred.
-
-## Step6. Configuration
-
-Create a config file(TOML format).
-```
-$ cd $HOME
-$ cat config.toml
-[servers]
-
-[servers.localhost]
-host = "localhost"
-port = "local"
-```
-
-
-## Step7. Check config.toml and settings on the server before scanning
-
-```
-$ vuls configtest
-```
-
-see [Usage: configtest](#usage-configtest)
-
-## Step8. Start Scanning
-
-```
-$ vuls scan
-
-... snip ...
-
-One Line Summary
-================
-localhost centos7.3.1611 31 updatable packages
-
-```
-
-## Step9. Reporting
-
-View one-line summary
-
-```
-$ vuls report -format-one-line-text -cvedb-path=$PWD/cve.sqlite3 -ovaldb-path=$PWD/oval.sqlite3
-
-One Line Summary
-================
-localhost Total: 109 (High:35 Medium:55 Low:16 ?:3) 31 updatable packages
-
-```
-
-View short summary
-
-```
-$ vuls report -format-short-text
-
-localhost (centos7.3.1611)
-==========================
-Total: 109 (High:35 Medium:55 Low:16 ?:3) 31 updatable packages
-
-CVE-2015-2806 10.0 HIGH (nvd)
- Stack-based buffer overflow in asn1_der_decoding in libtasn1 before 4.4 allows
- remote attackers to have unspecified impact via unknown vectors.
- ---
- https://nvd.nist.gov/vuln/detail/CVE-2015-2806
- https://access.redhat.com/security/cve/CVE-2015-2806 (RHEL-CVE)
- 10.0/AV:N/AC:L/Au:N/C:C/I:C/A:C (nvd)
- 2.6/AV:N/AC:H/Au:N/C:N/I:N/A:P (redhat)
- https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator?name=CVE-2015-2806
- 3.3/CVSS:3.0/AV:L/AC:L/PR:N/UI:R/S:U/C:N/I:N/A:L (redhat)
- https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator?name=CVE-2015-2806
- Confidence: 100 / OvalMatch
-
-... snip ...
-````
-
-View full report.
-
-```
-$ vuls report -format-full-text | less
-localhost (centos7.3.1611)
-==========================
-Total: 109 (High:35 Medium:55 Low:16 ?:3) 31 updatable packages
-
-CVE-2015-2806
-----------------
-Max Score 10.0 HIGH (nvd)
-nvd 10.0/AV:N/AC:L/Au:N/C:C/I:C/A:C
-redhat 2.6/AV:N/AC:H/Au:N/C:N/I:N/A:P
-redhat 3.3/CVSS:3.0/AV:L/AC:L/PR:N/UI:R/S:U/C:N/I:N/A:L
-CVSSv2 Calc https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator?name=CVE-2015-2806
-CVSSv3 Calc https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator?name=CVE-2015-2806
-Summary Stack-based buffer overflow in asn1_der_decoding in libtasn1 before 4.4 allows
- remote attackers to have unspecified impact via unknown vectors.
-Source https://nvd.nist.gov/vuln/detail/CVE-2015-2806
-RHEL-CVE https://access.redhat.com/security/cve/CVE-2015-2806
-CWE-119 (nvd) https://cwe.mitre.org/data/definitions/119.html
-Package/CPE libtasn1-3.8-3.el7 -
-Confidence 100 / OvalMatch
-
-... snip ...
-```
-
-## Step10. TUI
-
-Vuls has Terminal-Based User Interface to display the scan result.
-
-```
-$ vuls tui
-```
-
-
-
-## Step11. Web UI
-
-[VulsRepo](https://github.com/usiusi360/vulsrepo) is a awesome Web UI for Vuls.
-Check it out the [Online Demo](http://usiusi360.github.io/vulsrepo/).
-
-----
-
-# Tutorial: Remote Scan Mode
-
-This tutorial will let you scan the vulnerabilities on the remote host via SSH with Vuls.
-This can be done in the following steps.
-
-1. Launch new Ubuntu Linux
-1. Enable to SSH from localhost
-1. Configuration
-1. Check config.toml and settings on the server before scanning
-1. Scan
-1. Reporting
-
-We will use the Vuls server (called localhost) created in the previous tutorial.
-
-## Step1. Launch new Ubuntu Linux
-
-Same like as [Tutorial: Local Scan Mode#Step1. Launch CentOS7](#step1-launch-centos7)
-Launch a new terminal and SSH to the Remote host.
-To add the remote host's Host Key to $HOME/.ssh/known_hosts, you need to log in to the remote host through SSH before scanning.
-
-## Step2. Enable to SSH from localhost
-
-Vuls doesn't support SSH password authentication. So you have to use SSH key-based authentication.
-Create a keypair on the localhost then append the public key to authorized_keys on the remote host.
-
-- localhost
-```bash
-$ ssh-keygen -t rsa
-```
-Copy ~/.ssh/id_rsa.pub to the clipboard.
-
-- Remote Host
-```
-$ mkdir ~/.ssh
-$ chmod 700 ~/.ssh
-$ touch ~/.ssh/authorized_keys
-$ chmod 600 ~/.ssh/authorized_keys
-$ vim ~/.ssh/authorized_keys
-```
-Paste from the clipboard to `~/.ssh/.authorized_keys`
-
-And also, confirm that the host keys of scan target servers has been registered in the known_hosts of the localhost.
-To add the remote host's Host Key to `$HOME/.ssh/known_hosts`, you need to log in to the remote host through SSH before scanning.
-
-- localhost
-```
-$ ssh ubuntu@172.31.4.82 -i ~/.ssh/id_rsa
-```
-
-## Step3. Configure (config.toml)
-
-- localhost
-```
-$ cd $HOME
-$ cat config.toml
-[servers]
-
-[servers.ubuntu]
-host = "172.31.4.82"
-port = "22"
-user = "ubuntu"
-keyPath = "/home/centos/.ssh/id_rsa"
-```
-
-## Step4. Check config.toml and settings on the server before scanning
-
-```
-$ vuls configtest ubuntu
-```
-
-see [Usage: configtest](#usage-configtest)
-
-## Step5. Start Scanning
-
-```
-$ vuls scan ubuntu
-... snip ...
-
-One Line Summary
-================
-ubuntu ubuntu16.04 30 updatable packages
-```
-
-## Step6. Reporting
-
-See [Tutorial: Local Scan Mode#Step9. Reporting](#step9-reporting)
-See [Tutorial: Local Scan Mode#Step10. TUI](#step10-tui)
-See [Tutorial: Local Scan Mode#Step11. Web UI](#step11-web-ui)
-
-----
-
-# Setup Vuls in a Docker Container
-
-see https://github.com/future-architect/vuls/tree/master/setup/docker
-
-----
-
-# Architecture
-
-## A. Scan via SSH Mode (Remote Scan Mode)
-
-
-
-## B. Scan without SSH (Local Scan Mode)
-
-Deploy Vuls to the scan target server. Vuls issues a command to the local host (not via SSH). Aggregate the JSON of the scan result into another server. Since it is necessary to access the CVE database in order to refine the scan result, start go-cve-dictionary in server mode beforehand.
-On the aggregation server, you can refer to the scanning result of each scan target server using WebUI or TUI.
-
-
-[Details](#example-scan-via-shell-instead-of-ssh)
-
-----
-
-## Fast Scan and Deep Scan
-
-### Fast Scan
-
-- Scan without Root Privilege
-- Scan with No internet access on some OS.
-
-| Distribution| Scan Speed | Need Root Privilege | OVAL | Need Internet Access
on scan tareget|
-|:------------|:--------------------------------------:|:-------------------:|:----------:|:---------------------------------------:|
-| Alpine | Fast | No | Supported | Need |
-| CentOS | Fast | No | Supported | No |
-| RHEL | Fast | No | Supported | No |
-| Oracle | Fast | No | Supported | No |
-| Ubuntu | Fast | No | Supported | No |
-| Debian | Fast | No | Supported | No |
-| Raspbian |1st time: Slow
From 2nd time: Fast | Need | No | Need |
-| FreeBSD | Fast | No | No | Need |
-| Amazon | Fast | No | No | Need |
-| SUSE Enterprise | Fast | No | Supported | No |
-
----------
-
-### Deep Scan
-
-
-| Distribution| Scan Speed | Need Root Privilege | OVAL | Need Internet Access
on scan tareget|
-|:------------|:-------------------------------------:|:-------------------------:|:---------:|:---------------------------------------:|
-| Alpine | Fast | No | Supported | Need |
-| CentOS | Slow | No | Supported | Need |
-| RHEL | Slow | Need | Supported | Need |
-| Oracle | Slow | Need | Supported | Need |
-| Ubuntu |1st time: Slow
From 2nd time: Fast| Need | Supported | Need |
-| Debian |1st time: Slow
From 2nd time: Fast| Need | Supported | Need |
-| Raspbian |1st time: Slow
From 2nd time: Fast| Need | No | Need |
-| FreeBSD | Fast | No | No | Need |
-| Amazon | Slow | No | No | Need |
-| SUSE Enterprise | Fast | No | Supported | No |
-
-
-- On Ubuntu, Debian and Raspbian
-Vuls issues `apt-get changelog` for each upgradable packages and parse the changelog.
-`apt-get changelog` is slow and resource usage is heavy when there are many updatable packages on target server.
-Vuls stores these changelogs to KVS([boltdb](https://github.com/boltdb/bolt)).
-From the second time on, the scan speed is fast by using the local cache.
-
-- On CentOS
-Vuls issues `yum changelog` to get changelogs of upgradable packages at once and parse the changelog.
-
-- On RHEL, Oracle, Amazon and FreeBSD
-Detect CVE IDs by using package manager.
-
-- On SUSE Enterprise Linux and Alpine Linux
-Same as fast scan mode for now.
-
-----
-
-# Use Cases
-
-## Scan All Servers
-
-
-
-## Scan a Single Server
-
-web/app server in the same configuration under the load balancer
-
-
-
-## Scan Staging Environment
-
-If there is a staging environment with the same configuration as the production environment, you can scan the server in staging environment
-
-----
-
-# Support OS
-
-| Distribution | Release |
-|:-------------|-------------------:|
-| Alpine | 3.2 and later |
-| Ubuntu | 14, 16|
-| Debian | 7, 8, 9|
-| RHEL | 5, 6, 7|
-| Oracle Linux | 5, 6, 7|
-| CentOS | 6, 7|
-| Amazon Linux | All|
-| FreeBSD | 10, 11|
-| SUSE Enterprise | 11, 12|
-| Raspbian | Jessie, Stretch |
-
-----
-
-
-# Usage: Automatic Server Discovery
-
-Discovery subcommand discovers active servers specified in CIDR range, then display the template of config file(TOML format) to terminal.
-
-```
-$ vuls discover -help
-discover:
- discover 192.168.0.0/24
-```
-
-## Example
-
-```
-$ vuls discover 172.31.4.0/24
-# Create config.toml using below and then ./vuls --config=/path/to/config.toml
-
-[slack]
-hookURL = "https://hooks.slack.com/services/abc123/defghijklmnopqrstuvwxyz"
-#legacyToken = "xoxp-11111111111-222222222222-3333333333"
-channel = "#channel-name"
-#channel = "${servername}"
-iconEmoji = ":ghost:"
-authUser = "username"
-notifyUsers = ["@username"]
-
-[email]
-smtpAddr = "smtp.gmail.com"
-smtpPort = "587"
-user = "username"
-password = "password"
-from = "from@address.com"
-to = ["to@address.com"]
-cc = ["cc@address.com"]
-subjectPrefix = "[vuls]"
-
-[default]
-#port = "22"
-#user = "username"
-#keyPath = "/home/username/.ssh/id_rsa"
-#cpeNames = [
-# "cpe:/a:rubyonrails:ruby_on_rails:4.2.1",
-#]
-#ignoreCves = ["CVE-2016-6313"]
-#optional = [
-# ["key", "value"],
-#]
-
-[servers]
-
-[servers.172-31-4-82]
-host = "172.31.4.82"
-#port = "22"
-#user = "root"
-#keyPath = "/home/username/.ssh/id_rsa"
-#type = "pseudo"
-#cpeNames = [
-# "cpe:/a:rubyonrails:ruby_on_rails:4.2.1",
-#]
-#ignoreCves = ["CVE-2016-6313"]
-#optional = [
-# ["key", "value"],
-#]
-#[servers.172-31-4-82.containers]
-#type = "lxd" # or "docker" or "lxc"
-#includes = ["${running}"]
-#excludes = ["container_name", "container_id"]
-```
-
-You can customize your configuration using this template.
-
-----
-
-# Configuration
-
-- Slack section
- ```
- [slack]
- hookURL = "https://hooks.slack.com/services/abc123/defghijklmnopqrstuvwxyz"
- #legacyToken = "xoxp-11111111111-222222222222-3333333333"
- channel = "#channel-name"
- #channel = "${servername}"
- iconEmoji = ":ghost:"
- authUser = "username"
- notifyUsers = ["@username"]
- ```
-
- - hookURL or legacyToken.
- If there are a lot of vulnerabilities, it is better to use legacyToken since the Slack notification will be flooded.
-
- - hookURL : Incoming webhook's URL (hookURL is ignored when legacyToken is set.)
- 
-
- - legacyToken : slack legacy token (https://api.slack.com/custom-integrations/legacy-tokens)
- 
-
- - channel : channel name.
- If you set `${servername}` to channel, the report will be sent to each channel.
- In the following example, the report will be sent to the `#server1` and `#server2`.
- Be sure to create these channels before scanning.
- ```
- [slack]
- channel = "${servername}"
- ...snip...
-
- [servers]
-
- [servers.server1]
- host = "172.31.4.82"
- ...snip...
-
- [servers.server2]
- host = "172.31.4.83"
- ...snip...
- ```
-
- - iconEmoji: emoji
- - authUser: username of the slack team
- - notifyUsers: a list of Slack usernames to send Slack notifications.
- If you set `["@foo", "@bar"]` to notifyUsers, @foo @bar will be included in text.
- So @foo, @bar can receive mobile push notifications on their smartphone.
-
-- EMail section
- ```
- [email]
- smtpAddr = "smtp.gmail.com"
- smtpPort = "587"
- user = "username"
- password = "password"
- from = "from@address.com"
- to = ["to@address.com"]
- cc = ["cc@address.com"]
- subjectPrefix = "[vuls]"
- ```
-
-- Default section
- ```
- [default]
- #port = "22"
- #user = "username"
- #keyPath = "/home/username/.ssh/id_rsa"
- #cpeNames = [
- # "cpe:/a:rubyonrails:ruby_on_rails:4.2.1",
- #]
- #ignoreCves = ["CVE-2016-6313"]
- #optional = [
- # ["key", "value"],
- #]
- ```
- Items of the default section will be used if not specified.
-
-- servers section
- ```
- [servers]
-
- [servers.172-31-4-82]
- host = "172.31.4.82"
- #port = "22"
- #user = "root"
- #keyPath = "/home/username/.ssh/id_rsa"
- #type = "pseudo"
- #cpeNames = [
- # "cpe:/a:rubyonrails:ruby_on_rails:4.2.1",
- #]
- #ignoreCves = ["CVE-2016-6314"]
- #optional = [
- # ["key", "value"],
- #]
- #[servers.172-31-4-82.containers]
- #type = "lxd" # or "docker" or "lxc"
- #includes = ["${running}"]
- #excludes = ["container_name", "container_id"]
- ```
-
- You can overwrite the default value specified in default section.
-
- - host: IP address or hostname of target server
- - port: SSH Port number
- - user: SSH username
- - keyPath: SSH private key path
- - type: "pseudo" for non-ssh scanning. see [#531](https://github.com/future-architect/vuls/pull/531)
- - cpeNames: see [Usage: Scan vulnerability of non-OS package](#usage-scan-vulnerability-of-non-os-package)
- - ignoreCves: CVE IDs that will not be reported. But output to JSON file.
- - optional: Add additional information to JSON report.
- - containers: see [Example: Scan containers (Docker/LXD/LXC)(#example-scan-containers-dockerlxdlxc)
-
- Vuls supports two types of SSH. One is external command. The other is native go implementation. For details, see [-ssh-native-insecure option](#-ssh-native-insecure-option)
-
- Multiple SSH authentication methods are supported.
- - SSH agent
- - SSH public key authentication (with password and empty password)
- Password authentication is not supported.
-
-----
-
-# Usage: Configtest
-
-```
-$ vuls configtest --help
-configtest:
- configtest
- [-deep]
- [-config=/path/to/config.toml]
- [-log-dir=/path/to/log]
- [-ask-key-password]
- [-ssh-native-insecure]
- [-containers-only]
- [-timeout=300]
- [-debug]
-
- [SERVER]...
- -ask-key-password
- Ask ssh privatekey password before scanning
- -config string
- /path/to/toml (default "/Users/kotakanbe/go/src/github.com/future-architect/vuls/config.toml")
- -containers-only
- Test containers only. Default: Test both of hosts and containers
- -debug
- debug mode
- -deep
- Config test for deep scan mode
- -http-proxy string
- http://proxy-url:port (default: empty)
- -log-dir string
- /path/to/log (default "/var/log/vuls")
- -ssh-native-insecure
- Use Native Go implementation of SSH. Default: Use the external command
- -timeout int
- Timeout(Sec) (default 300)
-
-```
-
-The configtest subcommand checks whether vuls is able to connect via SSH to servers/containers defined in the config.toml
-
- ## Fast Scan Mode
-
-| Distribution | Release | Requirements |
-|:-------------|-------------------:|:-------------|
-| Alpine | 3.2 and later | - |
-| Ubuntu | 12, 14, 16| - |
-| Debian | 7, 8, 9| reboot-notifier|
-| CentOS | 6, 7| - |
-| Amazon | All | yum-utils |
-| RHEL | 5, 6, 7 | - |
-| Oracle Linux | 5, 6, 7 | - |
-| SUSE Enterprise| 11, 12 | - |
-| FreeBSD | 10, 11 | - |
-| Raspbian | Jessie, Stretch | - |
-
-## Deep Scan Mode
-
-Some dependent packages are needed in Deep Scan Mode.
-The configtest subcommand with --deep flag checks whether the packages are installed on the scan target server and also check /etc/sudoers
-
-### Dependencies and /etc/sudoers on Target Servers
-
-In order to scan with deep scan mode, the following dependencies are required, so you need to install them manually or with tools such as Ansible.
-
-| Distribution | Release | Requirements |
-|:-------------|-------------------:|:-------------|
-| Alpine | 3.2 and later | - |
-| Ubuntu | 12, 14, 16| - |
-| Debian | 7, 8, 9| aptitude, reboot-notifier |
-| CentOS | 6, 7| yum-utils, yum-plugin-changelog |
-| Amazon | All | yum-utils, yum-plugin-changelog |
-| RHEL | 5 | yum-utils, yum-changelog, yum-security |
-| RHEL | 6 | yum-utils, yum-plugin-changelog, yum-plugin-security |
-| RHEL | 7 | yum-utils, yum-plugin-changelog |
-| Oracle Linux | 5 | yum-utils, yum-changelog, yum-security |
-| Oracle Linux | 6 | yum-utils, yum-plugin-changelog, yum-plugin-security |
-| Oracle Linux | 7 | yum-utils, yum-plugin-changelog |
-| SUSE Enterprise| 11, 12 | - |
-| FreeBSD | 10 | - |
-| Raspbian | Wheezy, Jessie | - |
-
-The configtest subcommand also checks sudo settings on target servers whether Vuls is able to SUDO with nopassword via SSH. And if you run Vuls without -ssh-native-insecure option, requiretty must be defined in /etc/sudoers.
-```
-Defaults:vuls !requiretty
-```
-For details, see [-ssh-native-insecure option](#-ssh-native-insecure-option)
-
-Example of /etc/sudoers on target servers
-
-- RHEL 5 / Oracle Linux 5
-```
-vuls ALL=(ALL) NOPASSWD:/usr/bin/yum --color=never repolist, /usr/bin/yum --color=never list-security --security, /usr/bin/yum --color=never info-security, /usr/bin/repoquery, /usr/bin/yum --color=never changelog all *
-Defaults:vuls env_keep="http_proxy https_proxy HTTP_PROXY HTTPS_PROXY"
-```
-
-- RHEL 6, 7 / Oracle Linux 6, 7
-```
-vuls ALL=(ALL) NOPASSWD:/usr/bin/yum --color=never repolist, /usr/bin/yum --color=never --security updateinfo list updates, /usr/bin/yum --color=never --security updateinfo updates, /usr/bin/repoquery, /usr/bin/yum --color=never changelog all *
-Defaults:vuls env_keep="http_proxy https_proxy HTTP_PROXY HTTPS_PROXY"
-```
-
-- Debian/Ubuntu/Raspbian
-```
-vuls ALL=(ALL) NOPASSWD: /usr/bin/apt-get update
-Defaults:vuls env_keep="http_proxy https_proxy HTTP_PROXY HTTPS_PROXY"
-```
-
-- On CentOS, Amazon Linux, SUSE Enterprise, FreeBSD, it is possible to scan without root privilege for now.
-
-----
-
-# Usage: Scan
-
-```
-$ vuls scan -help
-scan:
- scan
- [-deep]
- [-config=/path/to/config.toml]
- [-results-dir=/path/to/results]
- [-log-dir=/path/to/log]
- [-cachedb-path=/path/to/cache.db]
- [-ssh-native-insecure]
- [-containers-only]
- [-skip-broken]
- [-http-proxy=http://192.168.0.1:8080]
- [-ask-key-password]
- [-timeout=300]
- [-timeout-scan=7200]
- [-debug]
- [-pipe]
-
- [SERVER]...
- -ask-key-password
- Ask ssh privatekey password before scanning
- -cachedb-path string
- /path/to/cache.db (local cache of changelog for Ubuntu/Debian)
- -config string
- /path/to/toml
- -containers-only
- Scan containers only. Default: Scan both of hosts and containers
- -debug
- debug mode
- -deep
- Deep scan mode. Scan accuracy improves and information becomes richer. Since analysis of changelog, issue commands requiring sudo, but it may be slower and high load on the scan tareget server.
- -http-proxy string
- http://proxy-url:port (default: empty)
- -log-dir string
- /path/to/log (default "/var/log/vuls")
- -pipe
- Use stdin via PIPE
- -results-dir string
- /path/to/results
- -skip-broken
- [For CentOS] yum update changelog with --skip-broken option
- -ssh-native-insecure
- Use Native Go implementation of SSH. Default: Use the external command
- -timeout int
- Number of seconds for processing other than scan (default 300)
- -timeout-scan int
- Number of second for scaning vulnerabilities for all servers (default 7200)
-```
-
-## -deep option
-
-You need to execute `vuls configtest --deep` to check the configuration of the target server before scanning with -deep flag.
-
-For details about deep scan mode, see below.
-* [Architecture/Deep Scan](#deep-scan)
-* [Configtest/Deep Scan Mode](#deep-scan-mode)
-
-## -ssh-native-insecure option
-
-Vuls supports different types of SSH.
-
-By Default, external SSH command will be used.
-This is useful If you want to use ProxyCommand or cipher algorithm of SSH that is not supported by native go implementation.
-Don't forget to add below line to /etc/sudoers on the target servers. (username: vuls)
-```
-Defaults:vuls !requiretty
-```
-
-To use native Go implementation from crypto/ssh, specify this option.
-This is useful in situations where you may not have access to traditional UNIX tools.
-But it is important to note that this mode does not check the host key.
-
-
-
-## -ask-key-password option
-
-| SSH key password | -ask-key-password | |
-|:-----------------|:-------------------|:----|
-| empty password | - | |
-| with password | required | or use ssh-agent |
-
-## Example: Scan all servers defined in config file
-```
-$ vuls scan -ask-key-password
-```
-With this sample command, it will ..
-- Ask SSH key password before scanning
-- Scan all servers defined in config file
-
-## Example: Scan specific servers
-```
-$ vuls scan server1 server2
-```
-With this sample command, it will ..
-- Use SSH Key-Based authentication with empty password (without -ask-key-password option)
-- Scan only 2 servers (server1, server2)
-
-## Example: Scan via shell instead of SSH.
-
-Vuls scans localhost instead of SSH if the host address is `localhst or 127.0.0.1` and the port is `local` in config.
-For more details, see [Architecture section](#architecture)
-
-- config.toml
- ```
- [servers]
-
- [servers.localhost]
- host = "localhost" # or "127.0.0.1"
- port = "local"
- ```
-
-### cron
-If you use local scan mode for cron jobs, don't forget to add below line to `/etc/sudoers` on RHEL/CentOS. (username: vuls)
-```
-Defaults:vuls !requiretty
-```
-
-## Example: Scan containers (Docker/LXD/LXC)
-
-It is common that keep containers running without SSHd daemon.
-see [Docker Blog:Why you don't need to run SSHd in your Docker containers](https://blog.docker.com/2014/06/why-you-dont-need-to-run-sshd-in-docker/)
-
-### Docker
-
-Vuls scans Docker containers via `docker exec` instead of SSH.
-For more details, see [Architecture section](#architecture)
-
-- To scan all of running containers
- `"${running}"` needs to be set in the containers item.
- ```
- [servers]
-
- [servers.172-31-4-82]
- host = "172.31.4.82"
- user = "ec2-user"
- keyPath = "/home/username/.ssh/id_rsa"
-
- [servers.172-31-4-82.containers]
- includes = ["${running}"]
- ```
-
-- To scan specific containers
- The container ID or container name needs to be set in the containers item.
- In the following example, only `container_name_a` and `4aa37a8b63b9` will be scanned.
- Be sure to check these containers are running state before scanning.
- If specified containers are not running, Vuls gives up scanning with printing error message.
- ```
- [servers]
-
- [servers.172-31-4-82]
- host = "172.31.4.82"
- user = "ec2-user"
- keyPath = "/home/username/.ssh/id_rsa"
-
- [servers.172-31-4-82.containers]
- includes = ["container_name_a", "4aa37a8b63b9"]
- ```
-
-- To scan except specific containers
- ```
- [servers]
-
- [servers.172-31-4-82]
- host = "172.31.4.82"
- user = "ec2-user"
- keyPath = "/home/username/.ssh/id_rsa"
-
- [servers.172-31-4-82.containers]
- includes = ["${running}"]
- excludes = ["container_name_a", "4aa37a8b63b9"]
- ```
-
-- To scan containers only
- - --containers-only option is available.
-
-### LXD
-
-Vuls scans lxd via `lxc exec` instead of SSH.
-```
-[servers]
-
-[servers.172-31-4-82]
-host = "172.31.4.82"
-user = "ec2-user"
-keyPath = "/home/username/.ssh/id_rsa"
-
-[servers.172-31-4-82.containers]
-type = "lxd"
-includes = ["${running}"]
-```
-
-### LXC
-
-Vuls scans lxc via `lxc-attach` instead of SSH.
-```
-[servers]
-
-[servers.172-31-4-82]
-host = "172.31.4.82"
-user = "ec2-user"
-keyPath = "/home/username/.ssh/id_rsa"
-
-[servers.172-31-4-82.containers]
-type = "lxc"
-includes = ["${running}"]
-```
-
-LXC required root privilege.
-
-Example of /etc/sudoers on target servers
-
-```
-vuls ALL=(ALL) NOPASSWD:/usr/bin/lxc-attach -n *, /usr/bin/lxc-ls *
-```
-
-----
-
-# Usage: Report
-
-```
-report:
- report
- [-lang=en|ja]
- [-config=/path/to/config.toml]
- [-results-dir=/path/to/results]
- [-log-dir=/path/to/log]
- [-refresh-cve]
- [-cvedb-type=sqlite3|mysql|postgres]
- [-cvedb-path=/path/to/cve.sqlite3]
- [-cvedb-url=http://127.0.0.1:1323 DB connection string]
- [-ovaldb-type=sqlite3|mysql]
- [-ovaldb-path=/path/to/oval.sqlite3]
- [-ovaldb-url=http://127.0.0.1:1324 or DB connection string]
- [-cvss-over=7]
- [-diff]
- [-ignore-unscored-cves]
- [-ignore-unfixed]
- [-to-email]
- [-to-slack]
- [-to-localfile]
- [-to-s3]
- [-to-azure-blob]
- [-format-json]
- [-format-xml]
- [-format-one-email]
- [-format-one-line-text]
- [-format-short-text]
- [-format-full-text]
- [-gzip]
- [-aws-profile=default]
- [-aws-region=us-west-2]
- [-aws-s3-bucket=bucket_name]
- [-aws-s3-results-dir=/bucket/path/to/results]
- [-azure-account=accout]
- [-azure-key=key]
- [-azure-container=container]
- [-http-proxy=http://192.168.0.1:8080]
- [-debug]
- [-debug-sql]
- [-pipe]
-
- [RFC3339 datetime format under results dir]
-
- -aws-profile string
- AWS profile to use (default "default")
- -aws-region string
- AWS region to use (default "us-east-1")
- -aws-s3-bucket string
- S3 bucket name
- -aws-s3-results-dir string
- /bucket/path/to/results (option)
- -azure-account string
- Azure account name to use. AZURE_STORAGE_ACCOUNT environment variable is used if not specified
- -azure-container string
- Azure storage container name
- -azure-key string
- Azure account key to use. AZURE_STORAGE_ACCESS_KEY environment variable is used if not specified
- -config string
- /path/to/toml
- -cvedb-path string
- /path/to/sqlite3 (For get cve detail from cve.sqlite3)
- -cvedb-type string
- DB type for fetching CVE dictionary (sqlite3, mysql or postgres) (default "sqlite3")
- -cvedb-url string
- http://cve-dictionary.com:8080 DB connection string
- -cvss-over float
- -cvss-over=6.5 means reporting CVSS Score 6.5 and over (default: 0 (means report all))
- -diff
- Difference between previous result and current result
- -debug
- debug mode
- -debug-sql
- SQL debug mode
- -format-full-text
- Detail report in plain text
- -format-json
- JSON format
- -format-one-email
- Send all the host report via only one EMail (Specify with -to-email)
- -format-one-line-text
- One line summary in plain text
- -format-short-text
- Summary in plain text
- -format-xml
- XML format
- -gzip
- gzip compression
- -http-proxy string
- http://proxy-url:port (default: empty)
- -ignore-unscored-cves
- Don't report the unscored CVEs
- -ignore-unfixed
- Don't report the unfixed CVEs
- -lang string
- [en|ja] (default "en")
- -log-dir string
- /path/to/log (default "/var/log/vuls")
- -ovaldb-path string
- /path/to/sqlite3 (For get oval detail from oval.sqlite3) (default "/Users/kotakanbe/go/src/github.com/future-architect/vuls/oval.sqlite3")
- -ovaldb-type string
- DB type for fetching OVAL dictionary (sqlite3 or mysql) (default "sqlite3")
- -ovaldb-url string
- http://goval-dictionary.com:1324 or mysql connection string
- -pipe
- Use stdin via PIPE
- -refresh-cve
- Refresh CVE information in JSON file under results dir
- -results-dir string
- /path/to/results
- -to-azure-blob
- Write report to Azure Storage blob (container/yyyyMMdd_HHmm/servername.json/xml/txt)
- -to-email
- Send report via Email
- -to-localfile
- Write report to localfile
- -to-s3
- Write report to S3 (bucket/dir/yyyyMMdd_HHmm/servername.json/xml/txt)
- -to-slack
- Send report via Slack
-```
-
-## How to read a report
-
-### Example
-
-```
-$ vuls report -format-full-text
-
-172-31-4-82 (amazon 2015.09)
-============================
-Total: 94 (High:19 Medium:54 Low:7 ?:14) 103 updatable packages
-
-CVE-2016-5636
--------------
-Score 10.0 (High)
-Vector (AV:N/AC:L/Au:N/C:C/I:C/A:C)
-Summary Integer overflow in the get_data function in zipimport.c in CPython (aka Python)
- before 2.7.12, 3.x before 3.4.5, and 3.5.x before 3.5.2 allows remote attackers
- to have unspecified impact via a negative data size value, which triggers a
- heap-based buffer overflow.
-CWE https://cwe.mitre.org/data/definitions/190.html
-NVD https://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2016-5636
-MITRE https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2016-5636
-CVE Details http://www.cvedetails.com/cve/CVE-2016-5636
-CVSS Calculator https://nvd.nist.gov/cvss/v2-calculator?name=CVE-2016-5636&vector=(AV:N/AC:L/...
-RHEL-CVE https://access.redhat.com/security/cve/CVE-2016-5636
-ALAS-2016-724 https://alas.aws.amazon.com/ALAS-2016-724.html
-Package python27-2.7.10-4.119.amzn1 -> python27-2.7.12-2.120.amzn1
- python27-devel-2.7.10-4.119.amzn1 -> python27-devel-2.7.12-2.120.amzn1
- python27-libs-2.7.10-4.119.amzn1 -> python27-libs-2.7.12-2.120.amzn1
-Confidence 100 / YumUpdateSecurityMatch
-
-... snip ...
-```
-
-### Summary part
-
-```
-cent6 (centos6.6)
-=================
-Total: 145 (High:23 Medium:101 Low:21 ?:0) 83 updatable packages
-```
-
-- `cent6` means that it is a scan report of `servers.cent6` defined in cocnfig.toml.
-- `(centos6.6)` means that the version of the OS is CentOS6.6.
-- `Total: 145 (High:23 Medium:101 Low:21 ?:0)` means that a total of 145 vulnerabilities exist, and the distribution of CVSS Severity is displayed.
-- `83 updatable packages` means that there are 83 updateable packages on the target server.
-
-### Detailed Part
-
-```
-CVE-2016-0702
-----------------
-Max Score 2.6 IMPORTANT (redhat)
-nvd 1.9/AV:L/AC:M/Au:N/C:P/I:N/A:N
-redhat 2.6/AV:L/AC:H/Au:N/C:P/I:P/A:N
-jvn 1.9/AV:L/AC:M/Au:N/C:P/I:N/A:N
-CVSSv2 Calc https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator?name=CVE-2016-0702
-Summary The MOD_EXP_CTIME_COPY_FROM_PREBUF function in crypto/bn/bn_exp.c in OpenSSL
- 1.0.1 before 1.0.1s and 1.0.2 before 1.0.2g does not properly consider
- cache-bank access times during modular exponentiation, which makes it easier for
- local users to discover RSA keys by running a crafted application on the same
- Intel Sandy Bridge CPU core as a victim and leveraging cache-bank conflicts, aka
- a "CacheBleed" attack.
-Source https://nvd.nist.gov/vuln/detail/CVE-2016-0702
-RHEL-CVE https://access.redhat.com/security/cve/CVE-2016-0702
-CWE-200 (nvd) https://cwe.mitre.org/data/definitions/200.html
-Package/CPE openssl-1.0.1e-30.el6 - 1.0.1e-57.el6
-Confidence 100 / OvalMatch
-```
-
-- `Max Score` means Max CVSS Score.
-- `nvd` shows [CVSS Vector](https://nvd.nist.gov/CVSS/Vector-v2.aspx) of NVD
-- `redhat` shows [CVSS Vector](https://nvd.nist.gov/CVSS/Vector-v2.aspx) of RedHat OVAL
-- `jvn` shows [CVSS Vector](https://nvd.nist.gov/CVSS/Vector-v2.aspx) of JVN
-- `Summary` means Summary of the CVE.
-- `CWE` means [CWE - Common Weakness Enumeration](https://nvd.nist.gov/cwe.cfm) of the CVE.
-- `Package` shows the package version information including this vulnerability.
-- `Confidence` means the reliability of detection.
- - `100` is highly reliable
- - `YumUpdateSecurityMatch` is the method of detecting this vulnerability.
-- Item list of `Confidence`
-
- | Detection Method | Confidence | OS |Description|
- |:-----------------------|-------------------:|:---------------------------------|:--|
- | OvalMatch | 100 | CentOS, RHEL, Oracle, Ubuntu, Debian, SUSE |Detection using OVAL |
- | YumUpdateSecurityMatch | 100 | RHEL, Amazon, Oracle |Detection using yum-plugin-security|
- | ChangelogExactMatch | 95 | CentOS, Ubuntu, Debian, Raspbian |Exact version match between changelog and package version|
- | ChangelogLenientMatch | 50 | Ubuntu, Debian, Raspbian |Lenient version match between changelog and package version|
- | PkgAuditMatch | 100 | FreeBSD |Detection using pkg audit|
- | CpeNameMatch | 100 | All |Search for NVD information with CPE name specified in config.toml|
-
-
-## Example: Send scan results to Slack
-```
-$ vuls report \
- -to-slack \
- -cvss-over=7 \
- -cvedb-path=$PWD/cve.sqlite3
-```
-With this sample command, it will ..
-- Send scan results to slack
-- Only Report CVEs that CVSS score is over 7
-
-
-```
-$ vuls report \
- -to-slack \
- -cvss-over=7 \
- -cvedb-path=$PWD/cve.sqlite3
-```
-With this sample command, it will ..
-- Send scan results to slack
-- Only Report CVEs that CVSS score is over 7
-
-
-## Example: Put results in S3 bucket
-To put results in S3 bucket, configure following settings in AWS before reporting.
-- Create S3 bucket. see [Creating a Bucket](http://docs.aws.amazon.com/AmazonS3/latest/UG/CreatingaBucket.html)
-- Configure access to S3 resources. You can do this in several ways:
- - Configure the environment variables. see [Configuring the AWS Command Line Interface](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html)
- - Configure the security credentials. see [Configuring the AWS Command Line Interface](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html)
- - Create an IAM role for the service and attach it to the service(EC2, AWS Lambda). [Creating a Role to Delegate Permissions to an AWS Service](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html)
-- To configure environment variables, security credentials, create an access key. see [Managing Access Keys for IAM Users](http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html)
-
-
-Example of IAM policy:
-
-```
-{
- "Version": "2012-10-17",
- "Statement": [
- {
- "Effect": "Allow",
- "Action": [
- "s3:ListAllMyBuckets"
- ],
- "Resource": "arn:aws:s3:::*"
- },
- {
- "Effect": "Allow",
- "Action": [
- "s3:PutObject"
- ],
- "Resource": "arn:aws:s3:::vuls/*"
- }
- ]
-}
-```
-
-```
-$ vuls report \
- -cvedb-path=$PWD/cve.sqlite3 \
- -to-s3 \
- -format-json \
- -aws-region=ap-northeast-1 \
- -aws-s3-bucket=vuls \
- -aws-profile=default
-```
-With this sample command, it will ..
-- Put scan result(JSON) in S3 bucket. The bucket name is "vuls" in ap-northeast-1 and profile is "default"
-
-## Example: Put results in Azure Blob storage
-
-To put results in Azure Blob Storage, configure following settings in Azure before reporting.
-- Create a Azure Blob container
-
-```
-$ vuls scan \
- -cvedb-path=$PWD/cve.sqlite3 \
- -report-azure-blob \
- -azure-container=vuls \
- -azure-account=test \
- -azure-key=access-key-string
-```
-With this sample command, it will ..
-- Put scan result(JSON) in Azure Blob Storage. The container name is "vuls", storage account is "test" and accesskey is "access-key-string"
-
-account and access key can be defined in environment variables.
-```
-$ export AZURE_STORAGE_ACCOUNT=test
-$ export AZURE_STORAGE_ACCESS_KEY=access-key-string
-$ vuls scan \
- -cvedb-path=$PWD/cve.sqlite3 \
- -report-azure-blob \
- -azure-container=vuls
-```
-
-## Example: IgnoreCves
-
-Define ignoreCves in config if you don't want to report(Slack, EMail, Text...) specific CVE IDs. But these ignoreCves will be output to JSON file like below.
-
-- config.toml
-```toml
-[default]
-ignoreCves = ["CVE-2016-6313"]
-
-[servers.bsd]
-host = "192.168.11.11"
-user = "kanbe"
-ignoreCves = ["CVE-2016-6314"]
-```
-
-- bsd.json
-```json
-[
- {
- "ServerName": "bsd",
- "Family": "FreeBSD",
- "Release": "10.3-RELEASE",
- "IgnoredCves" : [
- "CveDetail" : {
- "CVE-2016-6313",
- ...
- },
- "CveDetail" : {
- "CVE-2016-6314",
- ...
- }
- ]
- }
-]
-```
-
-
-## Example: Add optional key-value pairs to JSON
-
-Optional key-value can be outputted to JSON.
-The key-value in the default section will be overwritten by servers section's key-value.
-For instance, you can use this field for Azure ResourceGroup name, Azure VM Name and so on.
-
-- config.toml
-```toml
-[default]
-optional = [
- ["key1", "default_value"],
- ["key3", "val3"],
-]
-
-[servers.bsd]
-host = "192.168.11.11"
-user = "kanbe"
-optional = [
- ["key1", "val1"],
- ["key2", "val2"],
-]
-```
-
-- bsd.json
-```json
-[
- {
- "ServerName": "bsd",
- "Family": "FreeBSD",
- "Release": "10.3-RELEASE",
- .... snip ...
- "Optional": [
- [ "key1", "val1" ],
- [ "key2", "val2" ],
- [ "key3", "val3" ]
- ]
- }
-]
-```
-
-## Example: Use MySQL as a DB storage back-end
-
-```
-$ vuls report \
- -cvedb-type=mysql \
- -cvedb-url="user:pass@tcp(localhost:3306)/dbname?parseTime=true"
-```
-
-## Example: Use PostgreSQL as a DB storage back-end
-
-```
-$ vuls report \
- -cvedb-type=postgres \
- -cvedb-url=""host=myhost user=user dbname=dbname sslmode=disable password=password""
-```
-
-## Example: Use Redis as a DB storage back-end
-
-```
-$ vuls report \
- -cvedb-type=redis -cvedb-url="redis://localhost/0"
- -ovaldb-type=redis -ovaldb-url="redis://localhost/1"
-```
-
-----
-
-# Usage: Scan vulnerabilites of non-OS packages
-
-It is possible to detect vulnerabilities in non-OS packages, such as something you compiled by yourself, language libraries and frameworks, that have been registered in the [CPE](https://nvd.nist.gov/cpe.cfm).
-
-- How to search CPE name by software name
- - [NVD: Search Common Platform Enumerations (CPE)](https://web.nvd.nist.gov/view/cpe/search)
- **Check CPE Naming Format: 2.2**
-
- - [go-cpe-dictionary](https://github.com/kotakanbe/go-cpe-dictionary) is a good choice for geeks.
- You can search a CPE name by the application name incrementally.
-
-- Configuration
-To detect the vulnerability of Ruby on Rails v4.2.1, cpeNames needs to be set in the servers section.
- ```
- [servers]
-
- [servers.172-31-4-82]
- host = "172.31.4.82"
- user = "ec2-user"
- keyPath = "/home/username/.ssh/id_rsa"
- cpeNames = [
- "cpe:/a:rubyonrails:ruby_on_rails:4.2.1",
- ]
- ```
-
-- type="pseudo"
-Specify this when you want to detect vulnerability by specifying cpename without SSH connection.
-The pseudo type does not do anything when scanning.
-Search for NVD at report time and detect vulnerability of software specified as cpenamae.
- ```
- [servers]
-
- [servers.172-31-4-82]
- type = "pseudo"
- cpeNames = [
- "cpe:/a:rubyonrails:ruby_on_rails:4.2.1",
- ]
- ```
-
-# Usage: Integrate with OWASP Dependency Check to Automatic update when the libraries are updated (Experimental)
-[OWASP Dependency check](https://www.owasp.org/index.php/OWASP_Dependency_Check) is a utility that identifies project dependencies and checks if there are any known, publicly disclosed, vulnerabilities.
-
-Benefit of integrating Vuls And OWASP Dependency Check is below.
-- Automatic Update of Vuls config when the libraries are updated.
-- Reporting by Email or Slack by using Vuls.
-- Reporting in Japanese
- - OWASP Dependency Check supports only English
-
-How to integrate Vuls with OWASP Dependency Check
-- Execute OWASP Dependency Check with --format=XML option.
-- Define the xml file path of dependency check in config.toml.
-
- ```
- [servers]
-
- [servers.172-31-4-82]
- host = "172.31.4.82"
- user = "ec2-user"
- keyPath = "/home/username/.ssh/id_rsa"
- dependencyCheckXMLPath = "/tmp/dependency-check-report.xml"
- ```
-
-
-# Usage: TUI
-
-## Display the latest scan results
-
-```
-tui:
- tui
- [-refresh-cve]
- [-cvedb-type=sqlite3|mysql|postgres]
- [-cvedb-path=/path/to/cve.sqlite3]
- [-cvedb-url=http://127.0.0.1:1323 DB connection string]
- [-ovaldb-type=sqlite3|mysql]
- [-ovaldb-path=/path/to/oval.sqlite3]
- [-ovaldb-url=http://127.0.0.1:1324 or DB connection string]
- [-cvss-over=7]
- [-ignore-unscored-cves]
- [-ignore-unfixed]
- [-refresh-cve]
- [-results-dir=/path/to/results]
- [-log-dir=/path/to/log]
- [-debug]
- [-debug-sql]
- [-pipe]
-
- -cvedb-path string
- /path/to/sqlite3 (For get cve detail from cve.sqlite3)
- -cvedb-type string
- DB type for fetching CVE dictionary (sqlite3, mysql or postgres) (default "sqlite3")
- -cvedb-url string
- http://cve-dictionary.com:8080 DB connection string
- -ovaldb-path string
- /path/to/sqlite3 (For get oval detail from oval.sqlite3) (default "/Users/kotakanbe/go/src/github.com/future-architect/vuls/oval.sqlite3")
- -ovaldb-type string
- DB type for fetching OVAL dictionary (sqlite3 or mysql) (default "sqlite3")
- -ovaldb-url string
- http://goval-dictionary.com:1324 or mysql connection string
- -cvss-over float
- -cvss-over=6.5 means reporting CVSS Score 6.5 and over (default: 0 (means report all))
- -ignore-unfixed
- Don't report the unfixed CVEs
- -ignore-unscored-cves
- Don't report the unscored CVEs
- -debug
- debug mode
- -debug-sql
- debug SQL
- -log-dir string
- /path/to/log (default "/var/log/vuls")
- -pipe
- Use stdin via PIPE
- -refresh-cve
- Refresh CVE information in JSON file under results dir
- -results-dir string
- /path/to/results
-```
-
-Key binding is below.
-
-| key | |
-|:-----------------|:-------|
-| TAB | move cursor among the panes |
-| Arrow up/down | move cursor to up/down |
-| Ctrl+j, Ctrl+k | move cursor to up/down |
-| Ctrl+u, Ctrl+d | page up/down |
-
-For details, see https://github.com/future-architect/vuls/blob/master/report/tui.go
-
-## Display the previous scan results
-
-- Display the list of scan results.
-```
-$ vuls history
-2016-12-30T10:34:38+09:00 1 servers: u16
-2016-12-28T19:15:19+09:00 1 servers: ama
-2016-12-28T19:10:03+09:00 1 servers: cent6
-```
-
-- Display the result of scan 2016-12-30T10:34:38+09:00
-```
-$ vuls tui 2016-12-30T10:34:38+09:00
-```
-
-# Display the previous scan results using peco
-
-```
-$ vuls history | peco | vuls tui -pipe
-```
-
-[](https://asciinema.org/a/emi7y7docxr60bq080z10t7v8)
-
-----
-
-# Usage: go-cve-dictionary on different server
-
-Run go-cve-dictionary as server mode before scanning on 192.168.10.1
-```
-$ go-cve-dictionary server -bind=192.168.10.1 -port=1323
-```
-
-Run Vuls with -cvedb-url option.
-
-```
-$ vuls report -cvedb-url=http://192.168.0.1:1323
-```
-
-# Usage: Update NVD Data
-
-see [go-cve-dictionary#usage-fetch-nvd-data](https://github.com/kotakanbe/go-cve-dictionary#usage-fetch-nvd-data)
-
-----
-
-# Usage: goval-dictionary on different server
-
-```
-$ goval-dictionary server -bind=192.168.10.1 -port=1324
-```
-
-Run Vuls with -ovaldb-url option.
-
-```
-$ vuls report -ovaldb-url=http://192.168.0.1:1323
-```
-
-# Usage: Update OVAL Data
-
-- [RedHat, CentOS](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-redhat)
-- [Ubuntu](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-ubuntu)
-- [Debian](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-debian)
-- [Oracle](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-oracle)
-- [SUSE](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-suse)
-
-----
-
-# How to Update to the Latest Version
-
-- Update go-cve-dictionary
-If the DB schema was changed, please specify new SQLite3, MySQL, PostgreSQL or Redis DB file.
-```
-$ cd $GOPATH/src/github.com/kotakanbe/go-cve-dictionary
-$ git pull
-$ rm -r vendor
-$ make install
-```
-
-- Update goval-dictionary
-If the DB schema was changed, please specify new SQLite3, MySQL, PostgreSQL or Redis DB file.
-```
-$ cd $GOPATH/src/github.com/kotakanbe/goval-dictionary
-$ git pull
-$ rm -r vendor
-$ make install
-```
-
-- Update vuls
-```
-$ cd $GOPATH/src/github.com/future-architect/vuls
-$ git pull
-$ rm -r vendor
-$ make install
-```
-
-- Binary file was built under $GOPATH/bin
-- If an error occurs, delete `$GOPATH/pkg` before executing it
-
----
-
-# Misc
-
-- Unable to go get vuls
-Update git to the latest version. Old version of git can't get some repositories.
-see https://groups.google.com/forum/#!topic/mgo-users/rO1-gUDFo_g
-
-- HTTP Proxy Support
-If your system is behind HTTP proxy, you have to specify --http-proxy option.
-
-- How to Daemonize go-cve-dictionary
-Use Systemd, Upstart or supervisord, daemontools...
-
-- How to Enable Automatic-Update of Vulnerability Data.
-Use job scheduler like Cron (with -last2y option).
-
-- How to Enable Automatic-Scan.
-Use job scheduler like Cron.
-Set NOPASSWORD option in /etc/sudoers on target servers.
-Use SSH Key-Based Authentication with no passphrase or ssh-agent.
-
-- How to cross compile
- ```bash
- $ cd /path/to/your/local-git-reporsitory/vuls
- $ GOOS=linux GOARCH=amd64 go build -o vuls.amd64
- ```
-
-- Logging
-Log is under /var/log/vuls/
-
-- Debug
-Run with --debug, --sql-debug option.
-
-- Adjusting Open File Limit
-[Riak docs](http://docs.basho.com/riak/latest/ops/tuning/open-files-limit/) is awesome.
-
-- Does Vuls accept SSH connections with fish-shell or old zsh as the login shell?
-~~No, Vuls needs a user on the server for bash login. see also [#8](/../../issues/8)~~
-Yes, fixed in [#545](https://github.com/future-architect/vuls/pull/545)
-
-- Windows
-Use Microsoft Baseline Security Analyzer. [MBSA](https://technet.microsoft.com/en-us/security/cc184924.aspx)
-
-----
-
-# Related Projects
-
-- [k1LoW/ssh_config_to_vuls_config](https://github.com/k1LoW/ssh_config_to_vuls_config)
-ssh_config to vuls config TOML format
-
-- [usiusi360/vulsrepo](https://github.com/usiusi360/vulsrepo)
-VulsRepo is visualized based on the json report output in vuls.
-Youtube
-[](https://www.youtube.com/watch?v=DIBPoik4owc)
-
-
-----
-
-# Data Source
-
-- [NVD](https://nvd.nist.gov/)
-- [JVN(Japanese)](http://jvndb.jvn.jp/apis/myjvn/)
-- [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/)
-
-
# Authors
kotakanbe ([@kotakanbe](https://twitter.com/kotakanbe)) created vuls and [these fine people](https://github.com/future-architect/vuls/graphs/contributors) have contributed.
----
-# Contribute
-
-1. fork a repository: github.com/future-architect/vuls to github.com/you/repo
-2. get original code: go get github.com/future-architect/vuls
-3. work on original code
-4. add remote to your repo: git remote add myfork https://github.com/you/repo.git
-5. push your changes: git push myfork
-6. create a new Pull Request
-
-- see [GitHub and Go: forking, pull requests, and go-getting](http://blog.campoy.cat/2014/03/github-and-go-forking-pull-requests-and.html)
-
-----
-
# Change Log
Please see [CHANGELOG](https://github.com/future-architect/vuls/blob/master/CHANGELOG.md).
diff --git a/setup/docker/README.md b/setup/docker/README.md
index 7fbf1baf..912ded21 100644
--- a/setup/docker/README.md
+++ b/setup/docker/README.md
@@ -1,225 +1,5 @@
-# Vuls Docker components
-This is the Git repo of the official Docker image for vuls.
-# Supported tags and respective `Dockerfile` links
-
-- go-cve-dictionary
- - [`latest` (*go-cve-dictionary:latest Dockerfile*)]()
-- goval-dictionary
- - [`latest` (*goval-dictionary:latest Dockerfile*)]()
-- vuls
- - [`latest` (*vuls:latest Dockerfile*)]()
-- vulsrepo
- - [`latest` (*vulsrepo:latest Dockerfile*)]()
-
-This image version is same as the github repository version.
-
-# Caution
-
-This image is built per commit.
-If you want to use the latest docker image, you should remove the existing image, and pull it once again.
-
-1. Confirm your vuls version
-
-- go-cve-dictionary
-
-```console
-$ docker run --rm vuls/go-cve-dictionary -v
-
-go-cve-dictionary v0.0.xxx xxxx
-```
-
-- goval-dictionary
-
-```console
-$ docker run --rm vuls/goval-dictionary -v
-
-goval-dictionary v0.0.xxx xxxx
-```
-
-- vuls
-
-```console
-$ docker run --rm vuls/vuls -v
-
-vuls v0.0.xxx xxxx
-```
-
-2. Remove your old docker images
-
-- go-cve-dictionary
-
-```
-$ docker rmi vuls/go-cve-dictionary
-```
-
-- goval-dictionary
-
-```
-$ docker rmi vuls/goval-dictionary
-```
-
-- vuls
-
-```
-$ docker rmi vuls/vuls
-```
-
-3. Pull new vuls docker images
-
-- go-cve-dictionary
-
-```
-$ docker pull vuls/go-cve-dictionary
-```
-
-- goval-dictionary
-
-```
-$ docker pull vuls/goval-dictionary
-```
-
-- vuls
-
-```
-$ docker pull vuls/vuls
-```
-
-4. Confirm your vuls version
-
-```console
-$ docker run --rm vuls/go-cve-dictionary -v
-
-go-cve-dictionary v0.1.xxx xxxx
-```
-
-```console
-$ docker run --rm vuls/goval-dictionary -v
-
-goval-dictionary v0.1.xxx xxxx
-```
-
-- vuls
-
-```console
-$ docker run --rm vuls/vuls -v
-
-vuls v0.1.xxx xxxx
-```
-
-
-# How to use this image
-
-1. fetch nvd (vuls/go-cve-dictionary)
-1. fetch oval (vuls/goval-dictionary)
-1. configuration (vuls/vuls)
-1. configtest (vuls/vuls)
-1. scan (vuls/vuls)
-1. vulsrepo (vuls/vulsrepo)
-
-## Step1. Fetch NVD
-
-```console
-$ for i in `seq 2002 $(date +"%Y")`; do \
- docker run --rm -it \
- -v $PWD:/vuls \
- -v $PWD/go-cve-dictionary-log:/var/log/vuls \
- vuls/go-cve-dictionary fetchnvd -years $i; \
- done
-```
-
-- To fetch JVN(Japanese), See [README](https://github.com/kotakanbe/go-cve-dictionary#usage-fetch-jvn-data)
-
-## Step2. Fetch OVAL (e.g. redhat)
-
-```console
-$ docker run --rm -it \
- -v $PWD:/vuls \
- -v $PWD/goval-dictionary-log:/var/log/vuls \
- vuls/goval-dictionary fetch-redhat 5 6 7
-```
-
-- To fetch other OVAL, See [README](https://github.com/kotakanbe/goval-dictionary#usage-fetch-oval-data-from-redhat)
-
-## Step2. Configuration
-
-Create config.toml referring to [this](https://github.com/future-architect/vuls#configuration).
-
-```toml
-[servers]
-
-[servers.amazon]
-host = "54.249.93.16"
-port = "22"
-user = "vuls-user"
-keyPath = "/root/.ssh/id_rsa" # path to ssh private key in docker
-```
-
-
-## Step3. Configtest
-
-```console
-$ docker run --rm -it\
- -v ~/.ssh:/root/.ssh:ro \
- -v $PWD:/vuls \
- -v $PWD/vuls-log:/var/log/vuls \
- vuls/vuls configtest \
- -config=./config.toml # path to config.toml in docker
-```
-
-## Step4. Scan
-
-```console
-$ docker run --rm -it \
- -v ~/.ssh:/root/.ssh:ro \
- -v $PWD:/vuls \
- -v $PWD/vuls-log:/var/log/vuls \
- -v /etc/localtime:/etc/localtime:ro \
- -e "TZ=Asia/Tokyo" \
- vuls/vuls scan \
- -config=./config.toml # path to config.toml in docker
-```
-
-## Step5. Report
-
-```console
-$ docker run --rm -it \
- -v ~/.ssh:/root/.ssh:ro \
- -v $PWD:/vuls \
- -v $PWD/vuls-log:/var/log/vuls \
- -v /etc/localtime:/etc/localtime:ro \
- vuls/vuls report \
- -cvedb-path=/vuls/cve.sqlite3 \
- -ovaldb-path=/vuls/oval.sqlite3 \
- -format-short-text \
- -config=./config.toml # path to config.toml in docker
-```
-
-## Step6. vulsrepo
-
-```console
-$docker run -dt \
- -v $PWD:/vuls \
- -p 5111:5111 \
- vuls/vulsrepo
-```
-
-# User Feedback
-
-## Documentation
-
-Documentation for this image is stored in the [`docker/` directory]() of the [`future-architect/vuls` GitHub repo](https://github.com/future-architect/vuls).
-
-## Issues
-
-If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/future-architect/vuls/issues).
-
-## Contributing
-
-1. fork a repository: github.com/future-architect/vuls to github.com/you/repo
-1. get original code: go get github.com/future-architect/vuls
-1. work on original code
-1. add remote to your repo: git remote add myfork https://github.com/you/repo.git
-1. push your changes: git push myfork
-1. create a new Pull Request
+See Vulsdoc
+- [Install with Docker](https://vuls.io/docs/en/install-with-docker.html)
+- [Scan using Docker](https://vuls.io/docs/en/tutorial-docker.html)
diff --git a/setup/docker/go-cve-dictionary/latest/README.md b/setup/docker/go-cve-dictionary/latest/README.md
deleted file mode 100644
index 84f249e6..00000000
--- a/setup/docker/go-cve-dictionary/latest/README.md
+++ /dev/null
@@ -1,89 +0,0 @@
-# go-cve-dictionary-Docker
-
-This is the Git repo of the official Docker image for go-cve-dictionary.
-See the [Hub page](https://hub.docker.com/r/vuls/go-cve-dictionary/) for the full readme on how to use the Docker image and for information regarding contributing and issues.
-
-# Supported tags and respective `Dockerfile` links
-
-- [`latest` (*go-cve-dictionary:latest Dockerfile*)](https://github.com/future-architect/vuls/blob/master/setup/docker/go-cve-dictionary/latest/Dockerfile)
-
-# Caution
-
-This image is built per commit.
-If you want to use the latest docker image, you should remove the existing image, and pull it once again.
-
-- Remove old docker image
-
-```
-$ docker rmi vuls/go-cve-dictionary
-```
-
-- Pull new docker image
-
-```
-$ docker pull vuls/go-cve-dictionary
-```
-
-# What is go-cve-dictionary?
-
-This is tool to build a local copy of the NVD (National Vulnerabilities Database) [1] and the Japanese JVN [2], which contain security vulnerabilities according to their CVE identifiers [3] including exhaustive information and a risk score. The local copy is generated in sqlite format, and the tool has a server mode for easy querying.
-
-[1] https://en.wikipedia.org/wiki/National_Vulnerability_Database
-[2] https://en.wikipedia.org/wiki/Common_Vulnerabilities_and_Exposures
-[3] http://jvndb.jvn.jp/apis/termsofuse.html
-
-# How to use this image
-
-## check vuls version
-
-```
-$ docker run --rm vuls/go-cve-dictionary -v
-```
-
-## fetchnvd
-
-```console
-$ for i in `seq 2002 $(date +"%Y")`; do \
- docker run --rm -it \
- -v $PWD:/vuls \
- -v $PWD/go-cve-dictionary-log:/var/log/vuls \
- vuls/go-cve-dictionary fetchnvd -years $i; \
- done
-```
-
-## server
-
-```console
-$ docker run -dt \
- --name go-cve-dictionary \
- -v $PWD:/vuls \
- -v $PWD/go-cve-dictionary-log:/var/log/vuls \
- --expose 1323 \
- -p 1323:1323 \
- vuls/go-cve-dictionary server --bind=0.0.0.0
-```
-
-Prease refer to [this](https://hub.docker.com/r/vuls/go-cve-dictionary).
-
-## vuls
-
-Please refer to [this](https://hub.docker.com/r/vuls/vuls/).
-
-# User Feedback
-
-## Documentation
-
-Documentation for this image is stored in the [`docker/` directory](https://github.com/future-architect/vuls/tree/master/setup/docker) of the [`future-architect/vuls` GitHub repo](https://github.com/future-architect/vuls).
-
-## Issues
-
-If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/future-architect/vuls/issues).
-
-## Contributing
-
-1. fork a repository: github.com/future-architect/vuls to github.com/you/repo
-1. get original code: go get github.com/future-architect/vuls
-1. work on original code
-1. add remote to your repo: git remote add myfork https://github.com/you/repo.git
-1. push your changes: git push myfork
-1. create a new Pull Request
diff --git a/setup/docker/goval-dictionary/latest/README.md b/setup/docker/goval-dictionary/latest/README.md
deleted file mode 100644
index 48b33e68..00000000
--- a/setup/docker/goval-dictionary/latest/README.md
+++ /dev/null
@@ -1,125 +0,0 @@
-# goval-dictionary-Docker
-
-This is the Git repo of the official Docker image for goval-dictionary.
-See the [Hub page](https://hub.docker.com/r/vuls/goval-dictionary/) for the full readme on how to use the Docker image and for information regarding contributing and issues.
-
-# Supported tags and respective `Dockerfile` links
-
-- [`latest` (*goval-dictionary:latest Dockerfile*)](https://github.com/future-architect/vuls/blob/master/setup/docker/goval-dictionary/latest/Dockerfile)
-
-# Caution
-
-This image is built per commit.
-If you want to use the latest docker image, you should remove the existing image, and pull it once again.
-
-- Remove old docker image
-
-```
-$ docker rmi vuls/goval-dictionary
-```
-
-- Pull new docker image
-
-```
-$ docker pull vuls/goval-dictionary
-```
-
-# What is goval-dictionary?
-
-This is tool to build a local copy of the OVAL. The local copy is generated in sqlite format, and the tool has a server mode for easy querying.
-
-# How to use this image
-
-## check vuls version
-
-```
-$ docker run --rm vuls/goval-dictionary -v
-```
-
-## fetch-redhat
-
-```console
-$ for i in `seq 5 7`; do \
- docker run --rm -it \
- -v $PWD:/vuls \
- -v $PWD/goval-dictionary-log:/var/log/vuls \
- vuls/goval-dictionary fetch-redhat $i; \
- done
-```
-
-## fetch-debian
-
-```console
-$ for i in `seq 7 10`; do \
- docker run --rm -it \
- -v $PWD:/vuls \
- -v $PWD/goval-dictionary-log:/var/log/vuls \
- vuls/goval-dictionary fetch-debian $i; \
- done
-```
-
-## fetch-ubuntu
-
-```console
-$ for i in `seq 12 2 16`; do \
- docker run --rm -it \
- -v $PWD:/vuls \
- -v $PWD/goval-dictionary-log:/var/log/vuls \
- vuls/goval-dictionary fetch-ubuntu $i; \
- done
-```
-
-## fetch-suse
-
-```console
-$ docker run --rm -it \
- -v $PWD:/vuls \
- -v $PWD/goval-dictionary-log:/var/log/vuls \
- vuls/goval-dictionary fetch-suse -opensuse 13.2
-```
-
-## fetch-oracle
-
-```console
-$ docker run --rm -it \
- -v $PWD:/vuls \
- -v $PWD/goval-dictionary-log:/var/log/vuls \
- vuls/goval-dictionary fetch-oracle
-```
-
-## server
-
-```console
-$ docker run -dt \
- --name goval-dictionary \
- -v $PWD:/vuls \
- -v $PWD/goval-dictionary-log:/var/log/vuls \
- --expose 1324 \
- -p 1324:1324 \
- vuls/goval-dictionary server --bind=0.0.0.0
-```
-
-Prease refer to [this](https://hub.docker.com/r/vuls/goval-dictionary).
-
-## vuls
-
-Please refer to [this](https://hub.docker.com/r/vuls/vuls/).
-
-# User Feedback
-
-## Documentation
-
-Documentation for this image is stored in the [`docker/` directory](https://github.com/future-architect/vuls/tree/master/setup/docker) of the [`future-architect/vuls` GitHub repo](https://github.com/future-architect/vuls).
-
-## Issues
-
-If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/future-architect/vuls/issues).
-
-## Contributing
-
-1. fork a repository: github.com/future-architect/vuls to github.com/you/repo
-1. get original code: go get github.com/future-architect/vuls
-1. work on original code
-1. add remote to your repo: git remote add myfork https://github.com/you/repo.git
-1. push your changes: git push myfork
-1. create a new Pull Request
diff --git a/setup/docker/vuls/latest/README.md b/setup/docker/vuls/latest/README.md
deleted file mode 100644
index 33ce9b38..00000000
--- a/setup/docker/vuls/latest/README.md
+++ /dev/null
@@ -1,125 +0,0 @@
-# Vuls-Docker
-
-This is the Git repo of the official Docker image for vuls.
-See the [Hub page](https://hub.docker.com/r/vuls/vuls/) for the full readme on how to use the Docker image and for information regarding contributing and issues.
-
-# Supported tags and respective `Dockerfile` links
-
-- [`latest` (*vuls:latest Dockerfile*)](https://github.com/future-architect/vuls/blob/master/setup/docker/vuls/latest/Dockerfile)
-
-# Caution
-
-This image is built per commit.
-If you want to use the latest docker image, you should remove the existing image, and pull it once again.
-
-- Remove old docker image
-
-```
-$ docker rmi vuls/vuls
-```
-
-- Pull new docker image
-
-```
-$ docker pull vuls/vuls
-```
-
-# What is Vuls?
-
-Vuls is the Vulnerability scanner for Linux/FreeBSD, agentless, written in golang.
-Please see the [Documentation](https://github.com/future-architect/vuls)
-
-
-
-# How to use this image
-
-## check vuls version
-
-```
-$ docker run --rm vuls/vuls -v
-```
-
-## config
-
-Create config.toml referring to [this](https://github.com/future-architect/vuls#configuration).
-
-```toml
-[servers]
-
-[servers.amazon]
-host = "54.249.93.16"
-port = "22"
-user = "vuls-user"
-keyPath = "/root/.ssh/id_rsa" # path to ssh private key in docker
-```
-
-
-## configtest
-
-```console
-$ docker run --rm -it \
- -v ~/.ssh:/root/.ssh:ro \
- -v $PWD:/vuls \
- -v $PWD/vuls-log:/var/log/vuls \
- vuls/vuls configtest \
- -config=./config.toml # path to config.toml in docker
-```
-
-## scan
-
-```console
-$ docker run --rm -it \
- -v ~/.ssh:/root/.ssh:ro \
- -v $PWD:/vuls \
- -v $PWD/vuls-log:/var/log/vuls \
- -v /etc/localtime:/etc/localtime:ro \
- vuls/vuls scan \
- -config=./config.toml # path to config.toml in docker
-```
-
-## Report
-
-```console
-$ docker run --rm -it \
- -v ~/.ssh:/root/.ssh:ro \
- -v $PWD:/vuls \
- -v $PWD/vuls-log:/var/log/vuls \
- -v /etc/localtime:/etc/localtime:ro \
- vuls/vuls report \
- -cvedb-path=/vuls/cve.sqlite3 \
- -format-short-text \
- -config=./config.toml # path to config.toml in docker
-```
-
-## tui
-
-```console
-$ docker run --rm -it \
- -v $PWD:/vuls \
- -v $PWD/vuls-log:/var/log/vuls \
- vuls/vuls tui \
- -cvedb-path=/vuls/cve.sqlite3
-```
-
-## vulsrepo
-
-Prease refer to [this](https://hub.docker.com/r/vuls/vulsrepo/).
-
-# User Feedback
-
-## Documentation
-
-Documentation for this image is stored in the [`docker/` directory](https://github.com/future-architect/vuls/tree/master/setup/docker) of the [`future-architect/vuls` GitHub repo](https://github.com/future-architect/vuls).
-
-## Issues
-
-If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/future-architect/vuls/issues).
-
-## Contributing
-
-1. fork a repository: github.com/future-architect/vuls to github.com/you/repo
-1. get original code: go get github.com/future-architect/vuls
-1. work on original code
-1. add remote to your repo: git remote add myfork https://github.com/you/repo.git
-1. push your changes: git push myfork
-1. create a new Pull Request
diff --git a/setup/docker/vulsrepo/latest/README.md b/setup/docker/vulsrepo/latest/README.md
deleted file mode 100644
index fdf1c763..00000000
--- a/setup/docker/vulsrepo/latest/README.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# VulsRepo-Docker
-
-This is the Git repo of the official Docker image for vulsrepo.
-See the [Hub page](https://hub.docker.com/r/vuls/vulsrepo/) for the full readme on how to use the Docker image and for information regarding contributing and issues.
-
-# Supported tags and respective `Dockerfile` links
-
-- [`latest` (*vulsrepo:latest Dockerfile*)](https://github.com/future-architect/vuls/blob/master/setup/docker/vulsrepo/latest/Dockerfile)
-
-# Caution
-
-This image is built per commit.
-If you want to use the latest docker image, you should remove the existing image, and pull it once again.
-
-# What is vulsrepo?
-
-VulsRepo is visualized based on the json report output in [vuls](https://github.com/future-architect/vuls).
-
-# How to use this image
-
-## vulsrepo
-
-```console
-$docker run -dt \
- -v $PWD:/vuls \
- -p 5111:5111 \
- vuls/vulsrepo
-```
-
-# User Feedback
-
-## Documentation
-
-Documentation for this image is stored in the [`docker/` directory](https://github.com/future-architect/vuls/tree/master/setup/docker) of the [`future-architect/vuls` GitHub repo](https://github.com/future-architect/vuls).
-
-## Issues
-
-If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/future-architect/vuls/issues).
-
-## Contributing
-
-1. fork a repository: github.com/future-architect/vuls to github.com/you/repo
-1. get original code: go get github.com/future-architect/vuls
-1. work on original code
-1. add remote to your repo: git remote add myfork https://github.com/you/repo.git
-1. push your changes: git push myfork
-1. create a new Pull Request