LinuxスキャンのFAQ

Installer実行時にエラーが出る

以下をご確認下さい。

• インストール対象のサーバがプロキシ配下の場合はプロキシ設定を参照してください。 Download binary failuer.[type: linux_x86_64]

• root権限でインストールする

スキャン結果が反映されない

以下を確認してください。

• /opt/vuls-saas/以下のファイル所有者がvuls-saasになっているか

スキャン対象サーバ上に以下のログファイルが生成されます。

• /opt/vuls-saas/scan.log
• /opt/vuls-saas/report.log

解決できない場合はサポートまで連絡ください。

任意のタイミングで手動でスキャンできますか

はい、できます。

サーバ上でスキャナを実行する

スキャナを設置しているホスト上で下記のコマンドを実行ください。

sudo -H -u vuls-saas /opt/vuls-saas/vuls-saas.sh > /dev/null 2>&1

もしrootユーザでコマンドを実行しpermission deniedエラーが出るようになった場合はこちらを参照ください。

画面上から再スキャンする

2021/1/28リリースにて、画面上から再スキャンできるようになり した。

サーバに対してどの程度の負荷がかかりますか

ほぼ負荷はかかりません。 心配な場合はScan時に実行しているコマンドを確認してください。 いずれも、サーバに対して高い負荷をかけるものではありません。

スキャナのファイルサイズはどれくらいでしょうか

スキャナは/opt/vuls-saas以下に配備されます。 2021年3月現在のスキャナの容量は 22MB 程度です。

スキャンで生成されるログなどのファイルサイズはどれくらいでしょうか

ディストリビューションや、Debugモードかで異なりますが、おおまかな目安は下記のとおりです。正確にはスキャン時に生成されたファイルのサイズを参照ください。

最新版のスキャナでは以下のファイルの改廃処理が不要になりました。参考: 2021/4/16リリース

• /opt/vuls-saas/results 以下にJSONファイル(100KB - 1MB程度)。
• /opt/vuls-saas/ にログファイルが上書きされる(scan.log, report.logそれぞれ10KB未満)
• /var/log/vuls のログ

Scan時に実行しているコマンドのリストを知りたい

以下のコマンドでScan時にスキャン対象サーバ上で実行されるコマンドが表示されます。 vuls-saasユーザにて実行して下さい。vuls-saas以外で実行するとconfig.tomlの所有者が変更されpermission deniedになり実行できなくなる可能性があります。

$ su - vuls-saas
$ pwd
/opt/vuls-saas
$ ./vuls scan --debug 2>&1 | grep Executing

scannerが実行するコマンドとその出力結果を見たい場合は、–debugオプションを付けて実行して下さい。

$ su - vuls-saas
$ pwd
/opt/vuls-saas
$ ./vuls scan --debug 

scannerが実行するコマンドとその出力結果をファイルに保存する場合は以下を実行してください。

$ su - vuls-saas
$ pwd
/opt/vuls-saas
$ ./vuls scan --debug 2> /tmp/vuls-output.txt

上記で保存したファイルをシェル上で表示するためには以下を実行して下さい。

$ cat /tmp/vuls-output.txt | sed ':a;N;$!ba;s/\\n/\n/g'  |less -R

scan.logにpermission deniedと出力されscanできない

ターミナルからrootユーザにて手動スキャンすると、/opt/vuls-saas/config.toml が再作成されるためファイルのownerがrootに変更されます。この状態でvuls-saasユーザがスキャンすると、権限エラーになるのが原因です。(仕様によりconfig.tomlは毎回作成されます)

解決策

/opt/vuls-saas 以下のownerをまるまるvuls-saasユーザに変更してください。

root@dev:/opt/vuls-saas# chown -R vuls-saas:vuls-saas /opt/vuls-saas/

原因

config.tomlのownerはvuls-saasだったがrootでスキャンするとownerがrootとなる。

root@dev:/opt/vuls-saas# ls -alh config.toml
-rw-------  1 vuls-saas vuls-saas 1.4K Apr 21 13:47 config.toml
root@dev:/opt/vuls-saas# ./vuls-saas.sh
root@dev:/opt/vuls-saas# ls -alh config.toml
-rw-------  1 root      root      1.4K Apr 21 18:32 config.toml

この状態において、vuls-saasユーザでスキャンするとエラーとなります。

root@dev:/opt/vuls-saas# su - vuls-saas 
vuls-saas@dev:/opt/vuls-saas$ ./vuls-saas.sh
vuls-saas@dev:/opt/vuls-saas$ cat scan.log 
time="Apr 21 18:33:47" level=error msg="Error loading /opt/vuls-saas/config.toml\nIf you update Vuls and get this error, there may be incompatible changes in config.toml\nPlease check config.toml template : https://vuls.io/docs/en/usage-settings.html\nopen /opt/vuls-saas/config.toml: permission denied" 

FutureVulsにアップロードされる情報を知りたい

# sudo su - vuls-saas
$ cd /opt/vuls-saas
$ ./vuls-saas.sh --debug

スキャンモードの F / FR はFastとFast-Rootの両方、FRのみ はFast-Rootのみアップロードされるという意味です。

FutureVulsにアップロードされる情報を絞れますか

可能です。 config.tomlの IgnoredJSONKeys にJSONのkeyを配列形式で定義してください。

• サンプル：スキャン対象サーバのIPアドレスとスキャナのIPアドレスをアップロードしない設定

[Servers]
  [servers.dev]
    user = "vuls-saas"
    host = "localhost"
    port = "local"
    scanMode = ["fast-root"]
    ignoredJSONKeys = [
            "scannedIpv4Addrs",
            "ipv4Addrs"
    ]
    [servers.dev.uuids]
      dev = "xxxxxx"

ignoredJSONKeys に指定するkeyの確認方法を説明します。 /opt/vuls-saas/vuls-saas.sh を実行すると /opt/vuls-saas/results 以下にjsonファイルが生成されます。 このJSONファイルがFutureVulsにアップロードされます。 JSONを直接参照し、アップロードしない情報のkeyをconfig.tomlに定義してください。 なお、jsonファイルの第1階層のキーのみ指定可能です。第2階層より深いキーは指定できません。

ログファイルの改廃は必要ですか

はい、/var/log/vuls 以下にログが出力されますので必要に応じて改廃してください。