スキャナの導入要件

サーバ要件

サーバスペック

スキャナ動作要件として、CPU・メモリの指定はございません。
スキャナをサーバにインストールする際には、以下のストレージ容量が必要となります。

スキャナタイプ サイズ
Linuxスキャナ 約120MB
Windowsスキャナ 約100MB

【Linux】ファイル・ログ出力

パス ファイル 内容
/opt/vuls-saas/ vuls スキャナ本体
/opt/vuls-saas/ vuls-saas.sh スキャン実行のシェルスクリプト
/opt/vuls-saas/ config.toml スキャン定義ファイル
/opt/vuls-saas/ config.toml.bak スキャン定義ファイルの自動バックアップ
/etc/cron.d/ vuls-saas スキャン実行クーロン
/opt/vuls-saas/ vuls-saas.log scan.logとreport.logの概要
/opt/vuls-saas/ scan.log 最新のスキャン状況
/opt/vuls-saas/ report.log 最新のファイルアップロード状況
/opt/vuls-saas/results/ yyyy-mm-ddThh-mm-ss+09:00/.json
ex. 2024-11-19T17-37-32+0900/UserAAA.json
スキャナが検知したパッケージ一覧

スキャナ -> FutureVulsへのファイルアップロードが失敗した場合のみ、results配下にファイルが残る
ファイルアップロード成功した場合は、このファイルは自動削除される

【Windows】ファイル・ログ出力

パス ファイル 内容
C:\Program Files\vuls-saas vuls.exe スキャナ本体
C:\Program Files\vuls-saas vuls-saas.bat スキャン実行のbatファイル
C:\Program Files\vuls-saas config.toml スキャン定義ファイル
C:\Program Files\vuls-saas config.toml.bak スキャン定義ファイルの自動バックアップ
タスクスケジューラ vuls-saas-scan スキャン実行スケジュール
C:\Program Files\vuls-saas batch_config.toml プロキシ設定ファイル
C:\Program Files\vuls-saas vuls-saas.log scan.logとreport.logの概要
C:\Program Files\vuls-saas scan.log 最新のスキャン状況
C:\Program Files\vuls-saas report.log 最新のファイルアップロード状況
C:\Program Files\vuls-saas\results\ yyyy-mm-ddThh-mm-ss+09:00/.json
ex. 2024-11-19T17-37-32+0900/UserAAA.json
スキャナが検知したパッケージ一覧

スキャナ -> FutureVulsへのファイルアップロードが失敗した場合のみ、results配下にファイルが残る
ファイルアップロード成功した場合は、このファイルは自動削除される

ネットワーク要件

スキャナのダウンロード時・動作時には、ご利用の環境から以下の通信が発生します。

目的 プロトコル ポート 通信発信元 通信の向き 宛先
DNSクエリ DNS 53 スキャナ導入サーバ
スキャン対象サーバ
Outgoing ご利用システム内の外部アドレス正引き用DNSサーバ
インストーラダウンロード
スキャナプログラムダウンロード
HTTPS 443 スキャナ導入サーバ Outgoing installer.vuls.biz

※スキャナ導入時、アップデート時のみ必要
スキャン結果アップロード HTTPS 443 スキャナ導入サーバ Outgoing auth.vuls.biz
vuls-results-tmp-prd.s3.ap-northeast-1.amazonaws.com
OSディストリビューション
リポジトリデータダウンロード

※スキャン対象がLinuxの場合のみ
HTTP(S) 80 or 443 スキャン対象サーバ Outgoing 各OSディストリビュータが用意するパッケージリポジトリサーバ
Windows Update

※スキャン対象がWindowsの場合のみ
HTTPS 443 スキャン対象サーバ Outgoing Microsoft Windows Update 提供サイト

※ FAQ: FutureVulsの通信要件について教えてください


■■■ 注意事項 ■■■


DNSクエリ

インストーラの実行時、及び、スキャナプログラムの実行時にインターネット接続を行います。
インターネット接続時の名前解決には、通常の「DNSクエリ」を使用します。

DNSクエリで名前解決が可能かは、以下コマンドによりご確認ください。

  • nslookup installer.vuls.biz

Name(名前): installer.vuls.biz に対して、Address(Addresses)がレスポンスされる環境であれば、DNSクエリの動作状況に問題はありません。

【Linux】DNSクエリの確認コマンド

$ nslookup installer.vuls.biz
Server:         x.xx.xxx.xxxx
Address:        x.xx.xxx.xxxx#53

Non-authoritative answer:
Name:   installer.vuls.biz
Address: 3.164.110.24
Name:   installer.vuls.biz
Address: 3.164.110.50
Name:   installer.vuls.biz
Address: 3.164.110.28
Name:   installer.vuls.biz
Address: 3.164.110.23

【Windows】DNSクエリの確認コマンド

コマンドプロンプトで以下コマンドを実行する。

$ nslookup installer.vuls.biz
サーバー:  server
Address:  x.xx.xxx.xxxx

権限のない回答:
名前:    installer.vuls.biz
Addresses:  3.164.110.28
          3.164.110.50
          3.164.110.23
          3.164.110.24

インストローラ・スキャナプログラムダウンロード

FutureVulsで利用する「スキャナ」や「インストールスクリプト」は、以下のURLから配信しております。

Linux・Windowsそれぞれの環境でダウンロードが可能かは、以下の【Linux】【Windows】疎通確認コマンドによりご確認ください。
また、閉域網等によりインターネット接続が難しい場合には「スキャン対象が閉域網の場合」をご参照ください。

【Linux】ダウンロードの疎通確認コマンド

スキャナをインストールする環境で以下のコマンドを実行後、ステータスコード200 がレスポンスされれば、スキャナのインストールが可能です。

  • curl -o /dev/null -s -w "%{http_code}\n" https://installer.vuls.biz/vuls-installer.sh
$ curl -o /dev/null -s -w "%{http_code}\n" https://installer.vuls.biz/vuls-installer.sh
200 #スキャナインストール可能

$ curl -o /dev/null -s -w "%{http_code}\n" https://installer.vuls.biz/vuls-installer.sh
500 #200番台以外の場合は、スキャナインストール不可

インストローラの処理内容は、以下コマンドにより確認可能です。

$ curl -s https://installer.vuls.biz/vuls-installer.sh
(略)

【Windows】ダウンロードの疎通確認コマンド

コマンドプロンプトで以下のコマンドを実行後、ステータスコード200 がレスポンスされれば、スキャナのインストールが可能です。

  • curl -o NUL -s -w "%{http_code}\n" https://installer.vuls.biz/vuls-installer.sh
$ curl -o NUL -s -w "%{http_code}\n" https://installer.vuls.biz/vuls-installer.sh
200 #スキャナインストール可能

$ curl -o NUL -s -w "%{http_code}\n" https://installer.vuls.biz/vuls-installer.sh
500 #200番台以外の場合は、スキャナインストール不可

インストローラの処理内容は、以下コマンドにより確認可能です。

$ curl -s https://installer.vuls.biz/vuls-installer-v2.bat
(略)

スキャン結果アップロード

スキャナによる資産情報の取得後、以下に向けた通信とファイルアップロードを行います。

以下コマンドの レスポンスが得られる 環境であれば、auth.vuls.biz/one-time-auth の名前解決は正常に行われております。

項目 意味
http_code: %{http_code} サーバーが返したHTTPステータスコードを表示します
time_namelookup: %{time_namelookup} DNS名前解決にかかった時間を表示します(リクエスト開始からDNS解決完了まで)
time_connect: %{time_connect} TCP接続の確立にかかった時間を表示します(リクエスト開始からTCP接続完了まで)
time_appconnect: %{time_appconnect} SSL/TLSハンドシェイクにかかった時間を表示します(TCP接続完了からSSL/TLSハンドシェイク完了まで)
time_pretransfer: %{time_pretransfer} サーバーにリクエストを送信できる状態になるまでの時間を表示します(TCP接続とSSL/TLSハンドシェイクを含む)
time_starttransfer: %{time_starttransfer} サーバーが最初のデータをクライアントに送信するまでの時間を表示します(リクエスト送信から応答の最初のバイトを受信するまで)
time_total: %{time_total} リクエストの開始から応答が完了するまでの総時間を表示します

【Linux】アップロードの疎通確認コマンド

$ curl -X POST https://auth.vuls.biz/one-time-auth -d "test" -w"http_code: %{http_code}\ntime_namelookup: %{time_namelookup}\ntime_connect: %{time_connect}\ntime_appconnect: %{time_appconnect}\ntime_pretransfer: %{time_pretransfer}\ntime_starttransfer: %{time_starttransfer}\ntime_total: %{time_total}\n" -o /dev/null

  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100    16  100    12  100     4     56     18 --:--:-- --:--:-- --:--:--    75
http_code: 400
time_namelookup: 0.013480
time_connect: 0.020119
time_appconnect: 0.148787
time_pretransfer: 0.148951
time_starttransfer: 0.212617
time_total: 0.212655


# 各項目の意味
time_namelookup: 0.013480     #DNS名前解決完了
time_connect: 0.020119        #TCP接続完了
time_appconnect: 0.148787     #SSL/TLSハンドシェイク完了
time_pretransfer: 0.148951    #リクエストを送信可能な状態に
time_starttransfer: 0.212617  #サーバが最初の応答を返す
time_total: 0.212655          #リクエスト全体が完了

【Windows】アップロードの疎通確認コマンド

$ curl -X POST https://auth.vuls.biz/one-time-auth -d "test" -w "http_code: %{http_code}\ntime_namelookup: %{time_namelookup}\ntime_connect: %{time_connect}\ntime_appconnect: %{time_appconnect}\ntime_pretransfer: %{time_pretransfer}\ntime_starttransfer: %{time_starttransfer}\ntime_total: %{time_total}\n" -o NUL
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100    16  100    12  100     4     58     19 --:--:-- --:--:-- --:--:--    79
http_code: 400
time_namelookup: 0.013773
time_connect: 0.028131
time_appconnect: 0.187459
time_pretransfer: 0.187599
time_starttransfer: 0.204314
time_total: 0.204376

【Linux】OSディストリビューション・リポジトリダウンロード

OSディストリビューションにより、スキャナ動作時に「リポジトリダウンロード」が発生する場合がございます。
以下の dpkg-query、または、rpm コマンドによりパッケージ一覧が表示できるかをご確認ください。

対応環境

Ubuntu系

dpkg-query -W -f="\${binary:Package},\${db:Status-Abbrev},\${Version},\${source:Package},\${source:Version}\n"

RedHat系

rpm -qa --queryformat "%{NAME} %{EPOCHNUM} %{VERSION} %{RELEASE} %{ARCH} %{MODULARITYLABEL}\n"

【Windows】Windows Update

Windowsスキャナによるスキャン時には、インターネット経由で Windows Update(http://update.microsoft.com/microsoftupdate)への通信を行います。
デフォルトの設定ではインターネットに向けた通信を行いますが、WSUS環境をご利用中の場合は「WSUS配下のWindowsのスキャン」をご参照ください。