エージェントの設定
Contrastエージェントをインストールしたら、エージェントがアプリケーションを認識して、Contrastサーバに情報を通信できるように設定しなければなりません。
設定した値が有効になる優先順位があります。
注記
ライセンスの有効期限が切れていたり、ライセンス数を超えていたりすると、設定に関係なく全てのエージェントの動作が無効になります。
手順
最低限必要な認証情報の変数(Contrast Webインターフェイスで確認できます)を指定します。
api: url: https://app.contrastsecurity.com user_name: contrast_user api_key: demo service_key: demo
指定する値:
url: Contrastエージェントが報告するContrastサーバのアドレス。デフォルトは、https://app.contrastsecurity.comです。
user_name:Contrastのユーザアカウント(通常、自分のログインID)
api_key:所属する組織のAPIキー
service_key:Contrastのユーザアカウントのサービスキー
これらの認証変数は、以下のいずれかで設定できます。
環境変数
YAML設定ファイル
組織のキーがあらかじめ入力されているYAML設定ファイルをダウンロードすることができます。Contrast Webインターフェイスで新規登録を選択し、アプリケーションカードを選択したら、アプリケーションの言語を選択すると、YAML設定ファイルをダウンロードするリンクが表示されます。
また、「YAML設定エディタを開く」のリンクからContrastエージェント設定エディタを開いて、ファイルを編集することもできます。
システムプロパティやコマンドラインフラグなど、使用している言語およびツールにネィティブなその他の方法については、各ドキュメントのページを参照してください。
注記
設定オプションの一覧およびデフォルト値は、Contrastエージェント設定エディタで参照できます。
その他の変数を必要に応じて設定します。
セッションメタデータを使用すると、特定のブランチ、ビルド、コミットしたユーザ、リポジトリなどによって、脆弱性やルート情報をフィルタリングできます。
アプリケーションメタデータを使用すると、カスタム値でアプリケーションをフィルタリングすることができます。
エージェントの設定ファイルにメタデータとして必要な設定情報を追加すれば、標準の脆弱性データとともに追加の情報がエージェントによってContrastに報告されるようになります。設定値の一覧や、上記で説明した必要な値以外に何があるかは、こちらをご覧ください。