Skip to main content

その他の設定

以下の共通変数は、システムプロパティ、環境変数、YAML設定ファイル、またはデフォルト値のいずれかで設定できます。

環境変数で設定するその他の設定値

以下の共通変数を使用して、システムを設定できます。

エージェント言語固有の設定や詳細な設定で更新もできますので、全ての設定の一覧については、Contrastエージェント設定エディタを参照してください。

環境変数

説明

言語

CONTRAST__API__TOKEN

Contrastとの通信に必要な値(URL、APIキー、サービスキー、ユーザ名)を設定します。

認証情報の設定に、この変数を使用することが推奨されます。

Java、.NET Framework、.NET Core、Node.js、Python、PHP、Goの最新のバージョン

CONTRAST__API__URL

ContrastのURLを設定します。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

CONTRAST__API__API_KEY

Contrastとの通信に必要なAPIキーを設定します。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

CONTRAST__API__SERVICE_KEY

Contrastとの通信に必要なサービスキーを設定します。これは認証ヘッダを計算するために使用されます。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

CONTRAST__API__USER_NAME

Contrastとの通信に使用するユーザ名を設定します。これは認証ヘッダを計算するために使用されます。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

CONTRAST__INVENTORY__TAGS

ライブラリにタグの一覧を適用します。タグは、カンマ区切りのリストとして書式設定する必要があります。例：label1, label2, label3

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP

CONTRAST__ASSESS__TAGS

脆弱性やプリフライトメッセージにタグの一覧を適用します。タグは、カンマ区切りのリストとして書式設定する必要があります。例：label1, label2, label3

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

CONTRAST__APPLICATION__NAME

Contrastに報告されるアプリケーション名を上書きします。注：Javaシステムで、複数の異なるアプリケーションが1つのプロセスで処理される可能性がある場合、この設定によって、検出された全てのアプリケーションが指定された名前で1つのアプリケーションとして報告されます。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

CONTRAST__APPLICATION__GROUP

Contrastでこのアプリケーションに関連付けるアプリケーショングループの名前を指定します。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

CONTRAST__APPLICATION__CODE

Contrastでこのアプリケーションに使用するアプリケーションのコード名称を指定します。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

CONTRAST__APPLICATION__VERSION

Contrastに報告されるアプリケーションのバージョンを上書きします。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

CONTRAST__APPLICATION__TAGS

アプリケーションにタグを適用します。タグは、カンマ区切りのリストとして書式設定する必要があります。例：label1, label2, label3

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

CONTRAST__SERVER__NAME

Contrastに報告されるサーバの名前を上書きします。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

CONTRAST__SERVER__ENVIRONMENT

Contrastに報告されるサーバの環境を上書きします。有効な値：QA、PRODUCTION、DEVELOPMENT

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

CONTRAST__SERVER__TAGS

サーバにタグの一覧を適用します。タグは、カンマ区切りのリストとして書式設定する必要があります。例：label1, label2, label3

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

web.configで設定するその他の設定値

.NET Frameworkまたは.NET Coreを次のいずれかで使用する場合、これらの変数も設定する必要があります。

プラットフォーム

変数セット

Web.config

(.NET CoreでのIISモジュール)

<environmentVariable name="CONTRAST__API__URL" value="https://app.contrastsecurity.com/Contrast/ " />
<environmentVariable name="CONTRAST__API__API_KEY" value="" />
<environmentVariable name="CONTRAST__API__SERVICE_KEY" value="" />
<environmentVariable name="CONTRAST__API__USER_NAME" value="" />
<environmentVariable name="CONTRAST__INVENTORY__TAGS" value="" />
<environmentVariable name="CONTRAST__ASSESS__TAGS" value="" />
<environmentVariable name="CONTRAST__APPLICATION__NAME" value="" />
<environmentVariable name="CONTRAST__APPLICATION__GROUP" value="" />
<environmentVariable name="CONTRAST__APPLICATION__CODE" value="" />
<environmentVariable name="CONTRAST__APPLICATION__VERSION" value="" />
<environmentVariable name="CONTRAST__APPLICATION__TAGS" value="" />
<environmentVariable name="CONTRAST__APPLICATION__METADATA" value="" />
<environmentVariable name="CONTRAST__APPLICATION__SESSION_ID" value="" />
<environmentVariable name="CONTRAST__APPLICATION__SESSION_METADATA" value="" />
<environmentVariable name="CONTRAST__SERVER__NAME" value="localhost" />
<environmentVariable name="CONTRAST__SERVER__ENVIRONMENT" value="development" />
<environmentVariable name="CONTRAST__SERVER__TAGS" value="" />

Azure App Service

[  
 {    
    "name": "CONTRAST__API__URL",    
    "value": "https://app.contrastsecurity.com/Contrast/ "  
 },  
 {    
   "name": "CONTRAST__API__API_KEY",    
   "value": ""  
},  
{    
    "name": "CONTRAST__API__SERVICE_KEY",    
    "value": ""  
},  
{    
    "name": "CONTRAST__API__USER_NAME",    
    "value": ""  
},  
{    
    "name": "CONTRAST__INVENTORY__TAGS",    
    "value": ""  
},  
{    
    "name": "CONTRAST__ASSESS__TAGS",    
    "value": ""  
},  
{    
    "name": "CONTRAST__APPLICATION__NAME",    
    "value": ""  
},  
{    
    "name": "CONTRAST__APPLICATION__GROUP",    
    "value": ""  
},  
{    
    "name": "CONTRAST__APPLICATION__CODE",    
    "value": ""  
},  
{    
    "name": "CONTRAST__APPLICATION__VERSION",    
    "value": ""  
},  
{    
    "name": "CONTRAST__APPLICATION__TAGS",    
    "value": ""  
},  
{    
    "name": "CONTRAST__APPLICATION__METADATA",    
    "value": ""  
},  
{    
    "name": "CONTRAST__APPLICATION__SESSION_ID",    
    "value": ""  
},  
{    
    "name": "CONTRAST__APPLICATION__SESSION_METADATA",    
    "value": ""  
},  
{    
    "name": "CONTRAST__SERVER__NAME",    
    "value": "localhost"  
},  
{    
    "name": "CONTRAST__SERVER__ENVIRONMENT",    
    "value": "development"  
},  
{    
    "name": "CONTRAST__SERVER__TAGS",    
    "value": ""  
   }
]

システムプロパティで設定するその他の設定値

設定値

言語

-Dcontrast.api.url

Java、.NET Framework、.NET Core、Node.js、PHP、Python、Ruby、Go

-Dcontrast.api.api_key

Java、.NET Framework、.NET Core、Node.js、PHP、Python、Ruby、Go

-Dcontrast.api.service_key

Java、.NET Framework、.NET Core、Node.js、PHP、Python、Ruby、Go

-Dcontrast.api.user_name

Java、.NET Framework、.NET Core、Node.js、PHP、Python、Ruby、Go

-Dcontrast.inventory.tags

Java、.NET Framework、.NET Core、Node.js、PHP、 Python、Ruby

-Dcontrast.assess.tags

Java、.NET Framework、.NET Core、Node.js、PHP、Python、Ruby、Go

-Dcontrast.application.name

Java、.NET Framework、.NET Core、Node.js、PHP、Python、Ruby、Go

-Dcontrast.application.group

Java、.NET Framework、.NET Core、Node.js、PHP、Python、Ruby、Go

-Dcontrast.application.code

Java、.NET Framework、.NET Core、Node.js、PHP、Python、Ruby、Go

-Dcontrast.application.version

Java、.NET Framework、.NET Core、Node.js、PHP、Python、Ruby、Go

-Dcontrast.application.tags

Java、.NET Framework、.NET Core、Node.js、PHP、Python、Ruby、Go

-Dcontrast.server.name

Java、.NET Framework、.NET Core、Node.js、PHP、Python、Ruby、Go

-Dcontrast.server.environment

Java、.NET Framework、.NET Core、Node.js、PHP、Python、Ruby、Go

-Dcontrast.server.tags

Java、.NET Framework、.NET Core、Node.js、PHP、Python、Ruby、Go

YAML設定ファイルで指定するその他の設定値

YAML設定ファイルを使用して、以下の追加の設定値を指定できます。

プロパティ

説明

言語

contrast.api.url

ContrastのURLを設定します。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.api.api_key

Contrastとの通信に必要なAPIキーを設定します。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.api.service_key

Contrastとの通信に必要なサービスキーを設定します。これは認証ヘッダを計算するために使用されます。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.api.user_name

Contrastとの通信に使用するユーザ名を設定します。これは認証ヘッダを計算するために使用されます。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.inventory.tags

ライブラリにタグの一覧を適用します。タグは、カンマ区切りのリストとして書式設定する必要があります。例：label1, label2, label3

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP

contrast.assess.tags

脆弱性やプリフライトメッセージにタグの一覧を適用します。タグは、カンマ区切りのリストとして書式設定する必要があります。例：label1, label2, label3

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.application.name

Contrastに報告されるアプリケーション名を上書きします。注：Javaシステムで、複数の異なるアプリケーションが1つのプロセスで処理される可能性がある場合、この設定によって、検出された全てのアプリケーションが指定された名前で1つのアプリケーションとして報告されます。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.application.group

Contrastでこのアプリケーションに関連付けるアプリケーショングループの名前を指定します。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.application.code

Contrastでこのアプリケーションに使用するアプリケーションのコード名称を指定します。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.application.metadata

アプリケーションに関連付けるユーザ定義のメタデータを指定するための、key=value(キーと値)のペアの設定(RFC 2253に準拠)を定義します。設定は、key=valueをペアにしたカンマ区切りのリストとして書式設定する必要があります。例：business-unit=accounting、office=Baltimore

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.application.session_id

Contrastに既に存在するセッションのIDを指定します。エージェントによって検出された脆弱性が、このセッションに関連付けられます。無効なIDが指定された場合、エージェントは無効になります。このオプションとapplication.session_metadataは排他関係にあり、両方が設定されている場合エージェントは無効になります。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.application.session_metadata

Contrastでセッションの新規作成時に使用されるメタデータを指定します。エージェントによって検出された脆弱性は、この新しいセッションに関連付けられます。この値は、key=valueをペアにして書式設定(RFC2253に準拠)する必要があります。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.application.version

Contrastに報告されるアプリケーションのバージョンを上書きします。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.application.tags

アプリケーションにタグを適用します。タグは、カンマ区切りのリストとして書式設定する必要があります。例：label1, label2, label3

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.server.name

Contrastに報告されるサーバの名前を上書きします。

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.server.environment

Contrastに報告されるサーバの環境を上書きします。有効な値：QA、PRODUCTION、DEVELOPMENT

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

contrast.server.tags

サーバにタグの一覧を適用します。タグは、カンマ区切りのリストとして書式設定する必要があります。例：label1, label2, label3

Java、.NET Framework、.NET Core、Node.js、Python、Ruby、PHP、Go

タグおよびデータ

タグ

ユーザ定義の基準に基づいて、アプリケーションやサーバのフィルタリングが必要な場合があります。この場合、メタデータの代わり、またはメタデータに加えてタグを使用することができます。タグは、アプリケーション、サーバ、ライブラリ、脆弱性に適用できます。このようなタグを使用することで、Contrastで項目を整理して、効率的に検索ができます。

メタデータ

エージェントの設定時にアプリケーションメタデータを作成して、アプリケーションのメタデータを収集できます。特定のアプリケーションの所有者や事業部門、場所、またはアプリケーションに関するその他の重要な情報を識別するためのフィールドを設定できます。

セッションメタデータ

特定のフィールドの情報に対する脆弱性データをフィルタリングする必要がある場合があります。セッションメタデータをエージェントの設定に指定するとアプリケーションの脆弱性タブで、フィルタとして使用できます。

指定できるフィールドは以下の通り：

名前

値

コミットハッシュ

commitHash

コミットしたユーザ

committer

ブランチ名

branchName

Gitタグ

gitTag

Repository

リポジトリ

テストラン

testRun

バージョン

version

ビルド番号

buildNumber

詳細は、セッションメタデータを参照ください。

このセクションの内容: