Skip to main content

Contrast Scanの対象からファイルやフォルダを除外する

指定したファイルやフォルダをスキャンの対象から除外するオプションがあります。この機能は、大量のノイズを生成するアーティファクトや、スキャンに関係のないアーティファクトを除外する場合に便利です。

一部のファイルとフォルダはデフォルトで除外されます。

開始する前に

  • この機能は、ローカルスキャンエンジンを使用した多言語ソースコードのスキャンでのみ使用できます。

  • 以前にスキャンしたプロジェクトからファイルを除外すると、除外の影響を受ける脆弱性のステータスが修復済に変更されます。例えば、ファイルを除外した後、スキャン結果の脆弱性の数が元の検出結果より減少し、修復済の脆弱性の数が増加する可能性があります。

  • 指定されたファイル名やフォルダ名は、大文字と小文字が区別されます。

手順

  1. スキャンするソースコードのルートフォルダに、.contrast-scan.jsonという名前のファイルを作成します。

  2. JSONファイルで、次の形式を使用して除外するファイルとフォルダを指定します。

    {
  "excludes": [
    "**/MavenWrapperDownloader.java",
    "**/*.js"
  ]
}

    上記例のMavenWrapperDownloader.javaと*.js の箇所を除外したいファイル名やフォルダ名に置き換えてください。

パターン例

以下の例は、除外するファイルやフォルダを指定する方法を示しています。

パターンは相対パスと見なされます。

パターン例

除外されるもの

*.java

.java拡張子の前に0文字以上の文字があるファイル。例：.java、x.java、FooBar.java

除外されない：ファイル名に.javaの拡張子があってもスキャン対象のルートディレクトリにないファイル。

?.java

.java拡張子の前に1文字があるファイル。例：x.java、A.java

除外されない：.javaやxyz.javaなどのファイル。.java拡張子の前が1文字ではないため。

**/*.java

拡張子が.javaの全てのフォルダと全てのファイル。

**/CVS/*

ディレクトリツリー内の任意の場所に存在するCVSディレクトリにある全てのファイル。

org/apache/jakarta/**

org/apache/jakartaディレクトリツリーにある全てのファイル。

除外されない： org/apache/xyz.javaというファイル。jakartaはパスに含まれていないため。

org/apache/**/CVS/*

org/apache以下のディレクトリツリーの任意の場所にあるCVSディレクトリの全てのファイル。

除外されない：org/apache/CVS/foo/bar/Entriesという名前のファイル。 foo/bar/がパターンに一致しないため。

**/test/**

パスにtestが含まれる全てのファイル(ファイル名の一部としてのtestを含む)。

**/*test*/**

文字列testがパス内にあれば、それは除外されます。

デフォルトで除外されるもの

Contrast Scanでは、デフォルトで、以下のファイル、フォルダ、パターン、拡張子は除外されます。

除外されるファイルとフォルダのパターン

除外される拡張子

除外されるファイル

  • /src/test/

  • /__MACOSX/

  • /*.min.js,

  • /.Designer.vb

  • **/.designer.vb

  • /*Reference.vb

  • /Service.vb

  • /*Silverlight.vb

  • /.Designer.cs

  • /*.designer.cs

  • /Reference.cs

  • /*Service.cs

  • /Silverlight.cs

  • **/.

  • /Pods/BuildHeaders//.h

  • /Pods/Headers//*.h

  • /node_modules/

  • /bower_components/

  • /target/

  • /bin/

  • /obj/

  • /dist/

  • /lib/

  • exe

  • dll

  • so

  • bin

  • arc

  • arj

  • zip

  • rar

  • ear

  • tar

  • tgz

  • gz

  • gzip

  • z

  • readme

  • changelog

  • changes

  • todo

  • license

  • copying

  • maintainers

  • thumbs.db

関連項目

ディレクトリベースのタスクにて、 ファイルとフォルダを指定するためのパターンに関する追加の情報を参照できます。

このセクションの内容: