Javaエージェントの設定

すべてのContrastエージェントには基本の設定があり、設定値には優先順位があります。

Javaエージェントは、以下を使用して設定できます。

  • Javaシステムプロパティ

    例:-Dcontrast.agent.java.standalone_app_name

  • 環境変数

    例:CONTRAST__AGENT__JAVA__STANDALONE_APP_NAME

  • Java YAMLテンプレート

    例:agent.java.standalone_app_name

ヒント

Contrastエージェント設定エディタを使用すると、 YAML設定ファイルの作成やアップロード、YAMLの検証、推奨される設定値の表示などができます。

システムで以下のような構成を使用している場合は、Contrastエージェントと効率的に連携させるために、アプリケーションのJava環境に設定が必要な場合もあります。

  • スタンドアロンアプリケーション:JVMアプリケーションサーバが単一のアプリケーションをホストしている場合は、agent.java.standalone_app_nameを使用してアプリケーション名を指定する必要があります。 ルートカバレッジセッションメタデータなどの一部の機能に、この指定が必要になります。

  • マルチテナントアプリケーション構成:デプロイ中にJVM アプリケションサーバが複数のアプリケーションをホストしている場合は、アプリケーションをそれぞれ区別して、個々の設定オプションを適用することができます。

    重要

    単一のアプリケーション名を使用するようエージェントを設定しても、アプリケーションサーバのコードをそのアプリケーションの一部として扱いたくない場合もあります。この場合には、代わりにapplication.nameを使用します。application.nameを使用すると、agent.java.standalone_app_nameの指定が必要な機能は動作しません。

  • TLS証明書

  • Java 9モジュール

  • Java 2セキュリティ

  • インテグレーション:Contrast Javaエージェントは、プラグインやサードパーティ製ツールを使用したり、外部のシステムと連携することができます。他の製品の動作については、その製品のマニュアルを参照してください。

Javaシステムプロパティ

<YourContrastJarPath>Contrast JARファイルへのパスに置き換えて以下のコマンドを実行すると、システムプロパティの詳細情報を確認できます。

  • 以下のコマンドにより、ContrastエージェントのJARファイルを使用して、一般的なプロパティの一覧を表示することができます。

     java -jar <YourContrastJarPath> properties
  • コマンドを検索するには、ツール名を指定してコマンドラインを使用します。例えば、以下のコマンドでプロキシ関連のプロパティの一覧が表示されます。

    filterオプションを使用する場合: 

    java -jar <YourContrastJarPath> properties --filter=proxy

JavaのYAML設定ファイルのテンプレート

YAML設定ファイルを使用してJavaエージェントを設定する場合には、以下のテンプレートをご利用ください(YAML設定については、こちらの説明を参照してください)。

YAML設定ファイルは、デフォルトの場所に配置します。

  • Unix: /etc/contrast/java/contrast_security.yaml

  • Windows: C:/ProgramData/contrast/java/contrast_security.yaml

https://docs.contrastsecurity.com/common-agent-config/java_contrast_security.yaml

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