CLIコマンド

CLIで--hまたは--helpオプションを使用すると、コマンドラインのヘルプガイドが提供されます。このヘルプガイドでは、Contrastの設定、アプリケーション、脆弱性の詳細を理解するために使用できる以下のコマンドが表示されます。

以下の例では、<string>または<level>を実際の状況で適用される文字列またはレベルの値に置き換えてください。

コマンド

説明

--yamlPath <string>

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、DOTNET、NODE、PYTHON、RUBYなどのアプリケーション言語。これはアプリケーションをカタログ化するときに指定します(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以上の深刻度の脆弱性のみが報告されます。

--fail

脆弱性が検出された場合は、ビルドが失敗します。cve_severityと組み合わせて使用でき、ユーザが定義した深刻度レベルの脆弱性があるビルドは失敗します。

--report

コンパイル時からのアプリケーションの脆弱性レポートを表示します。

--silent

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

-v、--version

現在使用中のCLIバージョンを表示します。

-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の最小しきい値を設定するcve_severityパラメータを使用して、返される脆弱性の記録を制限できます。

深刻度のしきい値を超えるライブラリを使用するアプリケーションがデプロイされないようにする場合は、--failパラメータを自動CI/CDパイプラインの一部として使用できます。例えば、以下の方法でYAMLファイルを使用してCLIを実行できます。

contrast-cli --yamlPath path/to/yaml --report --cve_severity high --fail