FutureVulsでは、OSのパッケージだけではなくアプリケーションの依存ライブラリの脆弱性を検知、管理する機能があります。
検知方法はいくつかあり、それぞれスキャン可能な種類、検知性能の違いがありますので実際に試した上で選択、あるいは組み合わせて検知されることをおすすめします。
それぞれの検知方法の特徴はスキャン方法の選択肢と特徴に記載しています。
ブラウザにLockFileの内容をペーストしてスキャンする方法です。
登録されたLockFileに影響する脆弱性が公開されたタイミングでFutureVulsにて検知され、自動でタスク登録されユーザに通知されます。 依存ライブラリをバージョンアップしてLockFileの内容が更新された場合は、FutureVulsの画面上からLockFileの内容を更新してください。FutureVulsで検知済みタスクのステータスが「patch_applied」に自動更新されます。
ペーストスキャンでサポートするLockFileは以下の通りです。
スキャン可能なLockfileやバイナリは対応環境を参照してください。
LockFileをFutureVuls画面から登録する方法を説明します。
trivy fs
、trivy rootfs
を実行すると、指定したディレクトリ以下に格納されているアプリケーション依存ライブラリを自動検出して、それらの脆弱性をスキャンできます。FutureVulsでは trivy fs
、trivy rootfs
のスキャン結果を取り込み、FutureVuls上でアプリケーションライブラリの脆弱性を管理できます。
サーバ追加
ボタンからダイアログを開き、ファイルシステム上のライブラリをスキャン
を選択する
様々な言語のロックファイルやjarのようなバイナリをスキャンできます。 サポート対象の言語やパッケージエコシステムの詳細は、Trivy Language-specific PackagesのFilesysetm列、Rootfs列を参照してください。
登録している依存ライブラリに変更があった場合は、本手順に従ってFutureVulsに反映してください。
構成情報を更新
ボタンをクリックしてダイアログを開く
futurevuls/fvuls-lockfile-uploaderを使い、git push
時にLockfileが更新されたかをチェックし、Lockfileが更新された場合のみ、FutureVuls登録済みのLockfileをREST API経由で更新する方法を解説します。
下記のサンプルでは、release
ブランチにプッシュされた場合かつ、./go.sum
または ./web/yarn.lock
が変更された場合のみ実行されます。
サンプル内の以下の環境変数は、Encrypted Secretsにてセットして下さい。
環境変数名 | 確認方法 |
---|---|
FVULS_SERVER_UUID | サーバ一覧から確認する |
FVULS_TOKEN | グループ設定 > 開発者APIから確認する |
on:
push:
## https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#onpushpull_requestpaths
paths:
- 'go.sum'
- 'web/yarn.lock'
branches:
- release
name: Check lockfiles
jobs:
build:
env:
FVULS_SERVER_UUID: ${{ secrets.FVULS_SERVER_UUID }}
FVULS_TOKEN: ${{ secrets.FVULS_TOKEN }}
name: Upload lockfile
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Upload go.sum
uses: futurevuls/fvuls-lockfile-uploader@v1
with:
repoName: ${{ github.repository }}
path: './go.sum'
- name: Upload web/yarn.lock
uses: futurevuls/fvuls-lockfile-uploader@v1
with:
repoName: ${{ github.repository }}
path: './web/yarn.lock'
trivyのrepositoryスキャンと連携することで、GitHub/GitLab 上にある言語ライブラリの脆弱性を検知し、FutureVuls上で管理できます。 これにより、trivyをインストールするローカル環境内にスキャン対象のライブラリファイルが存在しない場合でも、ライブラリスキャンをご利用いただけます。
trivyによるローカルなファイルシステム上のライブラリスキャンと比較して、サポート対象言語が少ないため、ご注意ください。
サポート対象の言語やパッケージエコシステムの詳細は、Trivy Language-specific PackagesのRepository列を参照してください。
curl -s https://api.github.com/repos/aquasecurity/trivy/releases/latest | \
grep "browser_download_url.*_Linux-64bit.tar.gz" | \
cut -d : -f 2-3 | \
xargs wget
tar zxvf trivy_*
curl -s https://api.github.com/repos/future-architect/vuls/releases/latest | \
grep "browser_download_url.*trivy-to-vuls.*_linux_amd64.tar.gz" | \
cut -d : -f 2-3 | \
xargs wget
tar zxvf trivy-to-vuls*
curl -s https://api.github.com/repos/future-architect/vuls/releases/latest | \
grep "browser_download_url.*future-vuls.*_linux_amd64.tar.gz" | \
cut -d : -f 2-3 | \
xargs wget
tar zxvf future-vuls*
export FVULS_GROUP_ID=xxx
export FVULS_TOKEN=xxx
export FVULS_SERVER_UUID=`uuidgen`
export REPOSITORY_URL=https://xxx.xxxxx/xxx
# プロキシ環境下の場合は経由するプロキシサーバをセット
export https_proxy=http://name:pass@proxy:port
# スキャン対象レポジトリによってセットする変数を選択する
export GITHUB_TOKEN=xxxxxxxx
export GITLAB_TOKEN=xxxxxxxx
環境変数 | 説明 | 詳細 |
---|---|---|
FVULS_GROUP_ID | グループID | グループ設定を開き、URLから確認する。https://console.vuls.biz/org/xxx/group/[ココ]/setting/profile |
FVULS_TOKEN | トークン | グループ設定>トークンを開き、スキャン権限を持つトークンを選択する。 |
FVULS_SERVER_UUID | UUID | uuidgen などのコマンドを使って任意に作成する。FutureVuls上でサーバの識別に利用される。 |
REPOSITORY_URL | レポジトリURL | スキャン対象のレポジトリのURL。 |
GITHUB_TOKEN | GitHubトークン | スキャン対象レポジトリに読み取り権限をもつGitHubトークン。 |
GITLAB_TOKEN | GitLabトークン | スキャン対象レポジトリに読み取り権限をもつGitLabトークン。 |
GITHUB_TOKEN
と GITLAB_TOKEN
が両方設定されている場合は、常に GITHUB_TOKEN
を認証トークンとして利用するため、GitLab上のレポジトリをスキャンする場合は GITHUB_TOKEN
を環境変数から削除してください。
./trivy repo -q -f json --list-all-pkgs ${REPOSITORY_URL} | \
./trivy-to-vuls parse --stdin | \
./future-vuls upload --stdin --url https://auth.vuls.biz/one-time-auth --group-id ${FVULS_GROUP_ID} --token ${FVULS_TOKEN} --uuid ${FVULS_SERVER_UUID}
FutureVulsを開いて確認すると、新しくサーバが登録され、言語ライブラリの脆弱性が検知されているのが確認できます。
既に一度登録したライブラリを更新する場合は、環境変数 FVULS_SERVER_UUID
に、対象サーバのUUIDをセットしてからスキャン・アップロードしてください。
# trivy, trivy-to-vuls, future-vulsのインストールは省略
export FVULS_GROUP_ID=xxx
export FVULS_TOKEN=xxx
export FVULS_SERVER_UUID=xxx
export REPOSITORY_URL=https://xxx.xxxxx/xxx
# スキャン対象レポジトリによってセットする変数を選択する
export GITHUB_TOKEN=xxxxxxxx
export GITLAB_TOKEN=xxxxxxxx
./trivy repo -q -f json --list-all-pkgs ${REPOSITORY_URL} | \
./trivy-to-vuls parse --stdin | \
./future-vuls upload --stdin --url https://auth.vuls.biz/one-time-auth --group-id ${FVULS_GROUP_ID} --token ${FVULS_TOKEN} --uuid ${FVULS_SERVER_UUID}
サーバ上に配置されているLockfileやバイナリのパスを指定して依存ライブラリの脆弱性をスキャンする方法です。
スキャン可能なLockfileやバイナリは対応環境を参照してください。
本機能はローカルスキャンモード、リモートスキャンモードの両方に対応しています。
config.tomlに、スキャン対象のLockFileのパスを指定します。scan時に指定されたパスのLockfileを解析し依存ライブラリのリストを取得します。
config.tomlに、スキャン対象サーバ上のLockFileのパスを指定します。scan時にSSHで接続したリモートサーバの指定したパスのLockfileを解析し、依存ライブラリのリストを取得します。
/opt/vuls-saas/config.tomlにlockfileのパスを指定して下さい。
[servers]
[servers.sample]
user = "vuls-saas"
host = "localhost"
port = "local"
lockfiles = [
"/home/user/lockfiles/package-lock.json",
"/home/user/lockfiles/Gemfile.lock",
"/home/user/lockfiles/yarn.lock"
]
また、config.tomlで findLock = true
を指定すると、スキャン対象サーバ上のLockFileを自動検索してスキャン可能です。
[servers]
[servers.sample]
user = "vuls-saas"
host = "localhost"
port = "local"
findLock = true
GitHubの機能である、GitHub Security Alertsは、レポジトリ内のLockfileに記載された依存ライブラリの脆弱性をスキャンする機能です。FutureVulsではGitHubとAPI連携し、GitHubにて検知された脆弱性をFutureVulsに取り込むことが出来ます。
ソースコードをGitHubで管理してない場合でも、LockfileのみをGitHub上で管理することにより、GitHubにて脆弱性検知が可能となります。
サポート対象の言語と種類はGitHub:Supported package ecosystemsを参照してください。
FutureVuls画面上からCPEを登録してライブラリの脆弱性スキャンをする方法です。CPEを用いたスキャンの情報ソースがNVDとJVNですので、NVD, JVNに登録されていないライブラリ脆弱性は検知出来ません。また、登録対象のライブラリがさらに依存するライブラリも登録する必要がありますので、通常は他の方法を採用するのが良いでしょう。