セッションメタデータの設定

アプリケーションのセッションメタデータをContrastに送信するには、エージェントの設定ファイルにプロパティを追加で指定する必要があります。

エージェントが、メタデータとしてContrastサーバに報告できるのは、以下のビルドプロパティです。以下のプロパティの全てまたは一部を指定することができます。プロパティを設定ファイルに指定すると、メタデータが利用できるようになり、メタデータを各脆弱性の追加情報として参照したり、フィルターに使用することができます。

この設定は、システムプロパティ、環境設定、またはYAML設定ファイルのプロパティとして指定できます。

名前

コミットハッシュ

commitHash

コミットしたユーザ

committer

ブランチ名

branchName

Gitタグ

gitTag

リポジトリ

repository

テストラン

testRun

バージョン

version

ビルド番号

buildNumber

以下の例で、セッションメタデータを設定する方法をいくつか紹介します。

  • Javaのシステムプロパティを使用する場合:javaagentフラグを指定している行に、追加のプロパティを含めます。この場合、contrast.application.session_metadataプロパティを設定し、実行したテストを区別するためのキーと値をペアにして指定します。

    -Dcontrast.application.session_metadata="branchName=feature/some-new-thing,committer=Jane,repository=Contrast-Java"
  • .NET Frameworkでapp.configまたはweb.configを使用する場合: 設定ファイルに項目を追加して、メタデータのプロパティを指定します。

    <?xml version="1.0"?>
    <configuration>
      <connectionStrings />
          <appSettings>
            <add key="contrast.application.session_metadata" value="branchName=feature/some-new-thing,committer=Jane,repository=Contrast-DotNet" />
  • NET Coreでweb.configを使用する場合: 設定ファイルに項目を追加して、メタデータのプロパティを指定します。

    <?xml version="1.0"?>
    <configuration>
      <system.webServer>
        <aspNetCore>
          <environmentVariables>
            <environmentVariable name="CONTRAST_APPLICATION_SESSION_METADATA" value="branchName=feature/some-new-thing,committer=Jane,repository=Contrast-DotNet" />

    YAML設定ファイルの場合:contrast_security.yamlファイルに項目を追加して、メタデータのプロパティを指定します。

    application:
     session_metadata: branchName=feature/some-new-thing,committer=Jane,repository=Contrast-Ruby
  • CI(継続的インテグレーション)のビルドスクリプトの場合: 環境変数を使用して値を指定できます。

    -Dcontrast.application.session_metadata="branchName=feature/some-new-thing,committer=Jane,repository=Contrast-Java,buildNumber=$BUILD_NUMBER"
    -Dcontrast.application.session_metadata="branchName=$GIT_BRANCH,committer=$GIT_COMMITTER_NAME,commitHash=$GIT_COMMIT_HASH,repository=$GIT_URL,buildNumber=$BUILD_NUMBER"