Skip to main content

Goエージェントの設定

エージェントを設定するには、環境変数を指定する方法を推奨します。環境変数を使用すると、コンテナやCI/CDパイプラインでContrastを使用する場合に便利です。

contrast_security.yamlというYAML ファイルで設定を指定することもできます。

設定できる変数は次のとおりです。

ヒント

環境変数とエージェントのYAMLファイルで値を設定した場合は、優先順位に従って環境変数が使用されます。

設定できる変数は次のとおりです。

  • エージェントトークン:この変数はbase64でエンコードされたJSONオブジェクトで、url、api_key、service_key、user_nameの構成の設定が含まれます。これらの構成の設定を、この1つの変数で設定できます。

  • CONTRAST__API__TOKEN
    

    エージェントの設定で、従来の設定とエージェントトークンの両方を参照している場合(環境変数またはYAMLファイル内)、従来の設定が優先されます。エージェントトークンの値のみを使用するには、従来の設定への参照を削除してください。

  • 従来の設定:6.11.0より前のバージョンのGoエージェントを使用している場合、以下の変数が必要です。

    CONTRAST__API__URL
    CONTRAST__API__API_KEY
    CONTRAST__API__SERVICE_KEY
    CONTRAST__API__USER_NAME
    
    
    

また、Contrast Webインターフェイスで組織の設定 > エージェントにて、エージェントキーを見つけることができます。

Go設定ファイルの場所

設定にcontrast_security.yamlファイルを使用している場合、Go エージェントはファイルが見つかるまで、以下のディレクトリファイルを検索します。

  • 現在のディレクトリ

  • /etc/contrast/go/

  • /etc/contrast/

  • Darwin:$HOME/Library/Preferences/contrast/

  • Darwin:$HOME/Library/Preferences/contrast/go/

  • Linux:$XDG_CONFIG_DIR/contrast/

  • Linux:$XDG_CONFIG_DIR/contrast/go/

GoエージェントのYAMLテンプレート

YAMLテンプレートには、Goエージェントで使用可能な全ての設定が含まれています。(YAML設定については、こちらの説明を参照してください。)

また、Contrastエージェント設定エディタを使用して、設定を検索して、カスタムの設定ファイルを作成することもできます。

https://docs.contrastsecurity.jp/common-agent-config/go_contrast_security.yaml