diff --git a/README.md b/README.md index 122c022b..631c3b86 100644 --- a/README.md +++ b/README.md @@ -17,20 +17,19 @@ Vulnerability scanner for Linux, agentless, written in golang. # Abstract -- 毎日のように発見される脆弱性の調査、ソフトウェアアップデート作業はシステム管理者にとって大変なタスクである -- サービス停止リスクを恐れてパッケージマネージャの自動アップデート機能を使わずに手動で行うケースも多いが、手動での運用には以下の問題がある - - NVDやJVNなどの脆弱性データベースの新着情報をウォッチするのが大変 - - サーバにインストールされているソフトウェアは膨大であり、全てを人が把握するのは困難 - - 特にサーバ台数が多い場合は、新たに発見された脆弱性が自分の管理するどのサーバに該当するのかの調査コストが大きく、また漏れる可能性がある - - 最新情報を見逃したら脆弱性が放置されたままになる +毎日のように発見される脆弱性の調査やソフトウェアアップデート作業は、システム管理者にとって負荷の高いタスクである。 +プロダクション環境ではサービス停止リスクを避けるために、パッケージマネージャの自動更新機能を使わずに手動更新で運用するケースも多い。 +だが、手動更新での運用には以下の問題がある。 +- システム管理者がNVDなどで新着の脆弱性をウォッチし続けなければならない +- サーバにインストールされているソフトウェアは膨大であり、システム管理者が全てを把握するのは困難 +- 新着の脆弱性がどのサーバに該当するのかといった調査コストが大きく、漏れる可能性がある -- Vulsはサーバに存在する脆弱性を自動スキャンし、詳細情報をレポートする - - システムに関係あるもののみ教えてくれる - - その脆弱性に該当するサーバを教えてくれる - - 自動スキャンのため脆弱性対策漏れを防ぐことができる - - CRONなどで定期実行、レポートすることで脆弱性放置を防ぐことできる -- Vulsはシステム管理者の日々の脆弱性対応を助け、システムをセキュアに保つために有用なツールとなることを目指している +Vulsは上に挙げた手動運用での課題を解決するツールであり、以下の特徴がある。 +- システムに関係ある脆弱性のみ教えてくれる +- その脆弱性に該当するサーバを教えてくれる +- 自動スキャンのため脆弱性検知の漏れを防ぐことができる +- CRONなどで定期実行、レポートすることで脆弱性の放置を防ぐことできる ![Vuls-Motivation](img/vuls-motivation.png) @@ -46,14 +45,16 @@ Vulnerability scanner for Linux, agentless, written in golang. - CPEに登録されているソフトウェアが対象 - エージェントレスアーキテクチャ - スキャン対象サーバにSSH接続可能なマシン1台にセットアップするだけで動作 - - 複数のSSH認証方式をサポート - - SSH agent - - SSH public key authentication (with password, empty password) - - Password authentication - 設定ファイルのテンプレート自動生成 - CIDRを指定してサーバを自動検出、設定ファイルのテンプレートを生成 - EmailやSlackで通知可能(日本語でのレポートも可能) -- 付属するTerminal-Based User Interfaceビューアでは、Vim風キーバインドでスキャン結果を参照可能 +- 付属のTUIビューアを用いてターミナル上でスキャン結果を参照可能 + +---- + +# What Vuls Does'nt Do + +- Update the vulneable packages actually ---- @@ -412,7 +413,11 @@ You can customize your configuration using this template. # "cpe:/a:rubyonrails:ruby_on_rails:4.2.1", #] ``` - You can overwrite the default value that specified in default section. + You can overwrite the default value that specified in default section. + Vuls supports multiple SSH authentication method. + - SSH agent + - SSH public key authentication (with password, empty password) + - Password authentication ---- @@ -537,7 +542,7 @@ If you want to detect the vulnerbility of Ruby on Rails v4.2.1, define as below. ] ``` -# Usage: How to update NVD data. +# Usage: Update NVD Data. ``` $ go-cve-dictionary fetchnvd -h