Skip to main content

.NET Coreエージェントの設定

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

ご利用の環境に合わせて、.NET Coreエージェントを設定してください。

ヒント

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

.NETプロファイリング変数と診断変数

.NET 8以降では、DOTNET_EnableProfiling環境変数に0を設定すると、プロファイリングを含むプロセスのすべての診断が無効になります。この設定によって、Contrastエージェントはアプリケーションに接続できなくなります。DOTNET_EnableDiagnostics_Profiler環境変数に0を設定すると、 プロファイリングのみが無効になりますが、Contrastエージェントが.NET 8のアプリケーションと接続することもできなくなります。

これは、.NET 7以前のアプリケーションでの動きとは異なります。

注記

COMPlus_EnableProfilingDOTNET_EnableProfilingのエイリアスであるため、この変数を0に設定しても、Contrastエージェントに対しては同じ結果となります。

診断ポートのみをオフにし、プロファイリングをオンのままにするには、以下の環境変数を設定します:

DOTNET_EnableDiagnostics=1

DOTNET_EnableDiagnostics_IPC=0

これらの環境変数に関する詳しい情報は、.NET環境変数をご覧ください。

Azure App Serviceの.NET Coreエージェントを設定

Azure App Serviceを使用している場合、次の方法で.NET Coreエージェントを設定できます。

  • Azure Portal: 環境変数を使用して.NET Coreエージェントを設定します。

    環境変数の構文を使用して、構成メニューのアプリケーション設定の画面で全ての設定を追加します。

  • Web.configファイルの環境変数:<aspNetCore> 要素の<environmentVariables>セクションに、環境変数の構文を使用してオーバライドを指定します。

  • YAML設定ファイル: アプリケーションのデプロイメントに含めるか、Kuduコンソールを使用して、このファイルをAzure Webアプリケーションにアップロードします。

    構成\アプリケーション設定 画面で、CONTRAST_CONFIG_PATHという新しいアプリケーション設定を追加して、このファイルを指す値を指定します。

    例えば、アプリケーションルートのcontrast_security.yamlファイルを使用するには、 構成\アプリケーション設定画面にアクセスし、CONTRAST_CONFIG_PATHというキーにD:\Home\site\wwwroot\contrast_security.yamlという値で、新しいアプリケーション設定を追加します。Azure App Serviceのアプリケーションファイルが、D:\home\site\wwwrootにデプロイされます。

関連項目

環境変数を使用して.NET Coreエージェントを設定する

環境変数は、いくつかの方法で設定できます。

ヒント

.NET CoreエージェントのYAMLテンプレートにあるプロパティは、いずれも環境変数に変換できます。

  • エージェントのログレベル(agent.logger.level)を"TRACE"に変更するには、CONTRAST__AGENT__LOGGER__LEVELというキーに"TRACE"という値を指定します。

  • エージェントのサーバ名(server.name)を"MyServer"に変更するには、CONTRAST__SERVER__NAMEというキーに"MyServer"という値を指定します。

最も一般的な設定のいくつかは次のとおりです。

環境変数

目的

CONTRAST__APPLICATION__NAME

Contrastサーバに報告されるアプリケーション名を指定

CONTRAST__APPLICATION__GROUP

このアプリケーションを関連付けるアクセスグループを指定(アクセスグループは作成済みであること)。

CONTRAST__APPLICATION__SESSION_METADATA

Contrastでセッションの新規作成時に使用されるメタデータを指定。エージェントによって検出された脆弱性は、この新しいセッションメタデータに関連付けられます。

CONTRAST__SERVER__NAME

Contrastに報告されるサーバ名を指定

CONTRAST__SERVER__ENVIRONMENT

アプリケーションを実行する環境を指定(Development、QA、Production)

その他の利用可能なプロパティの説明は、.NET CoreエージェントのYAMLテンプレートを参照してください。

.NET CoreのYAML設定ファイルのテンプレート

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

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

  • Windows:C:/ProgramData/contrast/dotnet-core/contrast_security.yaml

  • Unix:/etc/contrast/dotnet-core/contrast_security.yaml

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