CLIコマンド

CLIで-hまたは--helpオプションを指定すると、コマンドラインのヘルプを参照できます。このヘルプにより以下のようなコマンドが表示されます。Contrastの設定、アプリケーション、脆弱性などに関する情報を得るために使用できます。

下記の例では、<string><level>をご利用の環境に合わせた値で置き換えてください。

コマンド

説明

--yamlPath <string>

YAMLファイルからパラメータを読み込む場合に指定するYAMLファイルへのパス(任意)

--api_key <string>

Contrastで提供されるエージェントのAPIキー(必須)

--authorization <string>

Contrastで提供されるエージェントの認証ヘッダ(必須)

--organization_id <string>

Contrastでの組織ID(必須)

--application_id <string>

Contrastに登録されているアプリケーションのID(必須)

--application_name <string>

Contrastに登録されているアプリケーションの名前(任意)

--catalogue_application

アプリケーションの登録が必要な場合に指定するオプション(catalogue操作には必須)

--language <string>

アプリケーションの言語。有効な値は、 JAVA、NODE、PYTHON、RUBY、GO(注: Goエージェントは現在ベータ)。project_path, に複数のプロジェクトの設定ファイルがある場合は、言語の指定が必須。(catalogue操作には必須)

--app_groups <string>

catalogueコマンドを使用時に、アプリケーションを1つ以上の既存のグループに割り当てます。グループリストは、カンマで句切る必要があります。(catalogue操作には任意)

--proxy <string>

Proxyサーバ経由の接続を許可します。認証が必要な場合は、ユーザ名とパスワード、プロトコル、ホスト、ポートを例のように指定します。例:http://username:password@<host>:<port> (任意)

--cli_host <string>

ホスト名。オプションでポートを<host>:<port>と指定することもできます。URLのプロトコル要素(https://)は含めません。デフォルトは、app.contrastsecurity.comです。 (任意)

--project_path <string>

解析するプロジェクトやアプリケーションのディレクトリのルート。デフォルトは現在のディレクトリです。 (任意)

--cve_severity <level>

--reportと組み合わせると、選択した深刻度以上の脆弱性が報告されます。例えば、cve_severity mediumの場合は、(Medium)と中より高い深刻度の脆弱性のみが報告されます。

--cve_threshold <number>

ビルドが失敗するまでに許容するCVEの数をしきい値として設定します。しきい値を超えるCVEがあると、ビルドは失敗になります。

--fail

脆弱性が検出された場合、ビルドを失敗にします。cve_severityと組み合わせて使用すると、定義した深刻度の脆弱性検出時にビルドを失敗にすることができます。

--report

コンパイル時のアプリケーションの脆弱性情報を表示します。

--silent

JSON出力をサイレントにします。 (任意)

-v、--version

現在使用しているCLIバージョンを表示します。

[en] --sub_project <string>

[en] Specifies the subproject within a gradle application. (optional)

-h、--help

ヘルプを表示します。

注記

特殊文字の問題を回避するために、これらのコマンドのパラメータを引用符で囲む必要がある場合があります。例:

--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