エージェントのインストールと設定

Contrastでアプリケーションを検査するには、アプリケーションで使用している言語に応じてContrastエージェントをインストールして設定する必要があります。ほとんどのContrastエージェントが、パッケージマネージャやリポジトリからダウンロードできます。

インストール方法は、インストールするContrastエージェントや使用するContrast製品、Contrastをインストールする場所によって異なります。 例えば、以下のようなことが考えられます。

  • アプリケーションサーバやWebサーバ上

  • ビルドパイプラインやコンテナ内

  • 開発、テスト(QA)、本番などの環境

インストール

ご利用の環境に応じて、Contrastエージェントを直接インストールするか、Contrastと連携するインテグレーションを使ってインストールしてください。

Contrastを利用する目的を考え、使用するContrastエージェントのインストール手順を確認してください。

設定

Contrastエージェントをインストールしたら、アプリケーションが認識されて、Contrastサーバに情報を通信できるように設定しなければなりません。最低限、4つの基本のエージェントキー(検索方法はこちらを参照)を指定する必要があります。

  • api.api_key: 所属する組織のAPIキー

  • api.user_name: Contrastのユーザアカウント名(通常、自分のログインID)

  • api.service_key: Contrastのユーザアカウントのサービスキー

  • api.url: Contrastエージェントが報告するContrastサーバのアドレス。デフォルト:https://app.contrastsecurity.com

ヒント

組織のキーがあらかじめ入力されているYAML設定ファイルをダウンロードすることができます。Contrast UI(Webインターフェイス)でエージェントを追加を選択し、アプリケーションの言語を選択すると、YAML設定ファイルをダウンロードするリンクが表示されます。

This image shows the Add new button

Contrastエージェントの設定は、環境変数、 YAML設定ファイル、 コマンドラインを使用したり、お使いの言語やツール固有の方法などによって、さらに指定できます。設定した値が有効になる優先順位があります。

Contrastを利用する状況に合わせて、使用するContrastエージェントを設定する方法を確認してください。