diff --git a/README.ja.md b/README.ja.md index 31481e0a..a634981b 100644 --- a/README.ja.md +++ b/README.ja.md @@ -288,14 +288,13 @@ $ vuls tui - NVDとJVN(日本語)から脆弱性データベースを取得し、SQLite3に格納する。 ## Vuls +![Vuls-Scan-Flow](img/vuls-scan-flow.png) - SSHでサーバに存在する脆弱性をスキャンし、CVE IDのリストを作成する - Dockerコンテナのスキャンする場合、VulsはまずDockerホストにSSHで接続する。その後、Dockerホスト上で `docker exec` 経由でコマンドを実効する。Dockerコンテナ内にSSHデーモンを起動する必要はない - 検出されたCVEの詳細情報をgo-cve-dictionaryから取得する -- スキャン結果をSQLite3に格納する - スキャン結果レポートを生成し、SlackやEmailなどで送信する -- スキャン結果の詳細情報はターミナル上で参照可能 +- スキャン結果をJSONファイルに出力すると詳細情報をターミナル上で参照可能 -![Vuls-Scan-Flow](img/vuls-scan-flow.png) ---- # Performance Considerations @@ -1094,7 +1093,8 @@ $ go install # Update Vuls With Glide -- Update go-cve-dictionary +- Update go-cve-dictionary +If the DB schema was changed, please specify new SQLite3 DB file. ``` $ cd $GOPATH/src/github.com/kotakanbe/go-cve-dictionary $ git pull @@ -1109,8 +1109,7 @@ $ git pull $ glide install $ go install ``` -- The binaries are created under $GOPARH/bin -- If the DB schema was changed, please specify new SQLite3 DB file. +- バイナリファイルは`$GOPARH/bin`以下に作成される --- diff --git a/README.md b/README.md index 97d5ed85..8b6fef7f 100644 --- a/README.md +++ b/README.md @@ -284,15 +284,13 @@ see https://github.com/future-architect/vuls/tree/master/setup/docker ## [go-cve-dictinary](https://github.com/kotakanbe/go-cve-dictionary) - Fetch vulnerability information from NVD and JVN(Japanese), then insert into SQLite3. -## Vuls +## Scanning Flow +![Vuls-Scan-Flow](img/vuls-scan-flow.png) - Scan vulnerabilities on the servers via SSH and create a list of the CVE ID - To scan Docker containers, Vuls connect via ssh to the Docker host and then `docker exec` to the containers. So, no need to run sshd daemon on the containers. - Fetch more detailed information of the detected CVE from go-cve-dictionary -- Insert scan result into SQLite3 - Send a report by Slack and Email -- Show the latest report on your terminal - -![Vuls-Scan-Flow](img/vuls-scan-flow.png) +- Write scan results to JSON file to show the latest report on your terminal ---- # Performance Considerations @@ -1007,7 +1005,8 @@ $ go install # Update Vuls With Glide -- Update go-cve-dictionary +- Update go-cve-dictionary +If the DB schema was changed, please specify new SQLite3 DB file. ``` $ cd $GOPATH/src/github.com/kotakanbe/go-cve-dictionary $ git pull @@ -1022,8 +1021,8 @@ $ git pull $ glide install $ go install ``` -- The binaries are created under $GOPARH/bin -- If the DB schema was changed, please specify new SQLite3 DB file. + +Binary Files are created under $GOPARH/bin --- diff --git a/img/vuls-scan-flow.graphml b/img/vuls-scan-flow.graphml index ab1269a4..1409090b 100644 --- a/img/vuls-scan-flow.graphml +++ b/img/vuls-scan-flow.graphml @@ -168,22 +168,6 @@ FreeBSD: pkg audit - - - - - - Vuls DB - - - - - - - - - - @@ -199,13 +183,13 @@ FreeBSD: pkg audit - + - Insert results into DB + Write results to JSON files Reporting @@ -216,7 +200,7 @@ Reporting - + @@ -233,7 +217,7 @@ CentOS: yum update --changelog - + @@ -364,7 +348,7 @@ FreeBSD - + @@ -374,7 +358,7 @@ FreeBSD - + @@ -386,17 +370,7 @@ FreeBSD - - - - - - - - - - - + @@ -414,7 +388,7 @@ FreeBSD - + @@ -424,7 +398,7 @@ FreeBSD - + diff --git a/img/vuls-scan-flow.png b/img/vuls-scan-flow.png index 4bb215c2..a82b9403 100644 Binary files a/img/vuls-scan-flow.png and b/img/vuls-scan-flow.png differ