CLIコマンド
CLIで-h
または--help
オプションを指定すると、コマンドラインのヘルプを参照できます。このヘルプにより以下のようなコマンドが表示されます。Contrastの設定、アプリケーション、脆弱性などに関する情報を得るために使用できます。
下記の例では、<string>
や<level>
をご利用の環境に合わせた値で置き換えてください。
コマンド | 説明 |
---|---|
| YAMLファイルからパラメータを読み込む場合に指定するYAMLファイルへのパス(任意) |
| Contrastで提供されるエージェントのAPIキー(必須) |
| Contrastで提供されるエージェントの認証ヘッダ(必須) |
| Contrastでの組織ID(必須) |
| Contrastに登録されているアプリケーションのID(必須) |
| Contrastに登録されているアプリケーションの名前(任意) |
| アプリケーションの登録が必要な場合に指定するオプション( |
| アプリケーションの言語。有効な値は、 JAVA、NODE、PYTHON、RUBY、GO(注: Goエージェントは現在ベータ)。 |
|
|
| Proxyサーバ経由の接続を許可します。認証が必要な場合は、ユーザ名とパスワード、プロトコル、ホスト、ポートを例のように指定します。例:http://username:password@<host>:<port> (任意) |
| ホスト名。オプションでポートを |
| 解析するプロジェクトやアプリケーションのディレクトリのルート。デフォルトは現在のディレクトリです。 (任意) |
|
|
| ビルドが失敗するまでに許容するCVEの数をしきい値として設定します。しきい値を超えるCVEがあると、ビルドは失敗になります。 |
| 脆弱性が検出された場合、ビルドを失敗にします。 |
| コンパイル時のアプリケーションの脆弱性情報を表示します。 |
| JSON出力をサイレントにします。 (任意) |
| 現在使用しているCLIバージョンを表示します。 |
[en] | [en] Specifies the subproject within a gradle application. (optional) |
| ヘルプを表示します。 |
注記
特殊文字の問題を回避するために、これらのコマンドのパラメータを引用符で囲む必要がある場合があります。例:
--application_name = "My_app_name_$+=(/\"
ヒント
--report
コマンドを使用すると、全ての脆弱なライブラリの情報がターミナル に返されます。検出された全てのCVEは、以下のように出力されます。
org.webjars/jquery-ui/1.11.4 is vulnerable CVE-2016-7103 MEDIUMCross-site scripting (XSS) vulnerability in jQuery UI before 1.12.0 might allow remote attackers to inject arbitrary web script or HTML via the closeText parameter of the dialog function.
cve_severity
パラメータを使用して、レポートするCVEの最小しきい値を設定することで、出力される脆弱性情報を制限できます。
--fail
パラメータを、自動化されたCI/CDパイプラインの一部に使用することで、深刻度のしきい値を超えたライブラリでアプリケーションがデプロイされないようにできます。例えば、次のようにYAMLファイルを使用してCLIを実行できます。
contrast-cli --yamlPath path/to/yaml --report --cve_severity high --fail