Update README

2016-09-20 11:51:30 +09:00
parent 0a52fc9a56
commit 97c3f5d642
4 changed files with 21 additions and 49 deletions
--- 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`以下に作成される

 ---

--- 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

 ---

--- a/img/vuls-scan-flow.graphml
+++ b/img/vuls-scan-flow.graphml
@@ -168,22 +168,6 @@ FreeBSD: pkg audit<y:LabelModel>
      </data>
    </node>
    <node id="n9">
-      <data key="d6">
-        <y:GenericNode configuration="com.yworks.flowchart.dataBase">
-          <y:Geometry height="64.1719342604298" width="111.96965865992411" x="687.3850119398792" y="807.0697396491782"/>
-          <y:Fill color="#E8EEF7" color2="#B7C9E3" transparent="false"/>
-          <y:BorderStyle color="#000000" type="line" width="1.0"/>
-          <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="18.1328125" modelName="custom" textColor="#000000" visible="true" width="48.56640625" x="31.701626204962054" y="23.019560880214726">Vuls DB<y:LabelModel>
-              <y:SmartNodeLabelModel distance="4.0"/>
-            </y:LabelModel>
-            <y:ModelParameter>
-              <y:SmartNodeLabelModelParameter labelRatioX="0.0" labelRatioY="0.0" nodeRatioX="0.0" nodeRatioY="-8.881784197001252E-16" offsetX="0.0" offsetY="0.0" upX="0.0" upY="-1.0"/>
-            </y:ModelParameter>
-          </y:NodeLabel>
-        </y:GenericNode>
-      </data>
-    </node>
-    <node id="n10">
      <data key="d6">
        <y:GenericNode configuration="com.yworks.flowchart.dataBase">
          <y:Geometry height="65.22882427307195" width="136.83944374209864" x="411.5802781289507" y="687.385587863464"/>
@@ -199,13 +183,13 @@ FreeBSD: pkg audit<y:LabelModel>
        </y:GenericNode>
      </data>
    </node>
-    <node id="n11">
+    <node id="n10">
      <data key="d6">
        <y:GenericNode configuration="com.yworks.flowchart.process">
          <y:Geometry height="56.0" width="268.0" x="609.3698412698412" y="716.4553275126422"/>
          <y:Fill color="#E8EEF7" color2="#B7C9E3" transparent="false"/>
          <y:BorderStyle color="#000000" type="line" width="1.0"/>
-          <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="32.265625" modelName="custom" textColor="#000000" visible="true" width="126.396484375" x="70.8017578125" y="11.8671875">Insert results into DB
+          <y:NodeLabel alignment="center" autoSizePolicy="content" fontFamily="Dialog" fontSize="12" fontStyle="plain" hasBackgroundColor="false" hasLineColor="false" height="32.265625" modelName="custom" textColor="#000000" visible="true" width="152.634765625" x="57.6826171875" y="11.8671875">Write results to JSON files
 Reporting<y:LabelModel>
              <y:SmartNodeLabelModel distance="4.0"/>
            </y:LabelModel>
@@ -216,7 +200,7 @@ Reporting<y:LabelModel>
        </y:GenericNode>
      </data>
    </node>
-    <node id="n12">
+    <node id="n11">
      <data key="d6">
        <y:GenericNode configuration="com.yworks.flowchart.process">
          <y:Geometry height="56.0" width="268.0" x="309.6849206349206" y="287.8409153761062"/>
@@ -233,7 +217,7 @@ CentOS: yum update --changelog<y:LabelModel>
        </y:GenericNode>
      </data>
    </node>
-    <node id="n13">
+    <node id="n12">
      <data key="d6">
        <y:GenericNode configuration="com.yworks.flowchart.process">
          <y:Geometry height="56.0" width="268.0" x="309.6849206349206" y="373.8409153761062"/>
@@ -364,7 +348,7 @@ FreeBSD<y:LabelModel>
        </y:PolyLineEdge>
      </data>
    </edge>
-    <edge id="e9" source="n7" target="n11">
+    <edge id="e9" source="n7" target="n10">
      <data key="d10">
        <y:PolyLineEdge>
          <y:Path sx="0.0" sy="28.0" tx="0.0" ty="-28.0"/>
@@ -374,7 +358,7 @@ FreeBSD<y:LabelModel>
        </y:PolyLineEdge>
      </data>
    </edge>
-    <edge id="e10" source="n7" target="n10">
+    <edge id="e10" source="n7" target="n9">
      <data key="d10">
        <y:PolyLineEdge>
          <y:Path sx="-134.01566143419018" sy="6.159084623893818" tx="0.0" ty="-29.333162136535975">
@@ -386,17 +370,7 @@ FreeBSD<y:LabelModel>
        </y:PolyLineEdge>
      </data>
    </edge>
-    <edge id="e11" source="n11" target="n9">
-      <data key="d10">
-        <y:PolyLineEdge>
-          <y:Path sx="0.0" sy="28.0" tx="0.0" ty="-28.86721713021484"/>
-          <y:LineStyle color="#000000" type="line" width="1.0"/>
-          <y:Arrows source="none" target="none"/>
-          <y:BendStyle smoothed="false"/>
-        </y:PolyLineEdge>
-      </data>
-    </edge>
-    <edge id="e12" source="n1" target="n12">
+    <edge id="e11" source="n1" target="n11">
      <data key="d10">
        <y:PolyLineEdge>
          <y:Path sx="0.0" sy="20.0" tx="0.0" ty="-28.0"/>
@@ -414,7 +388,7 @@ FreeBSD<y:LabelModel>
        </y:PolyLineEdge>
      </data>
    </edge>
-    <edge id="e13" source="n12" target="n13">
+    <edge id="e12" source="n11" target="n12">
      <data key="d10">
        <y:PolyLineEdge>
          <y:Path sx="0.0" sy="28.0" tx="0.0" ty="-28.0"/>
@@ -424,7 +398,7 @@ FreeBSD<y:LabelModel>
        </y:PolyLineEdge>
      </data>
    </edge>
-    <edge id="e14" source="n13" target="n7">
+    <edge id="e13" source="n12" target="n7">
      <data key="d10">
        <y:PolyLineEdge>
          <y:Path sx="134.00000000000006" sy="0.0" tx="0.0" ty="-28.0">
--- a/img/vuls-scan-flow.png
+++ b/img/vuls-scan-flow.png