Skip to main content

Contrast CodeSecコマンド

auth：認証

GitHubまたはGoogleアカウントを使用して認証します。ログイン用の新しいブラウザ画面が開きます。

  • 使用法：contrast auth

audit：監査

依存関係のセキュリティ検査を行うために、作業ディレクトリから該当するファイルを検索し、結果を返します。

Java

pom.xmlとMavenビルドプラットフォーム(依存関係プラグインを含む)

または

build.gradleファイルおよび、gradle dependenciesか./gradlew dependenciesに対応している必要あり

Node

package.jsonとロックファイル(package-lock.jsonかyarn.lock)

PHP

composer.jsonファイルとcomposer.lockファイル

Python

pipfileファイルとpipfile.lockファイル

Ruby

gemfileファイルとgemfile.lockファイル

Go

go.modファイル

使用法： contrast audit

  • オプション：

    • --file

      依存関係が宣言されているディレクトリまたはファイルを指定します(デフォルトでは、現在のディレクトリ内でプロジェクトファイルが検索されます)。ディレクトリ内で複数のプロジェクトファイルが見つかった場合、監査するファイルを確認するプロンプトが表示されます。

      エイリアス： -f

    • --help

      使用方法を表示します。

      エイリアス： -h

    • --ignore-dev

      検査結果から開発・試験用ライブラリの依存関係を除外します。デフォルトでは、全ての依存関係が結果に含まれます。

      エイリアス： -i

    • --save

      SBOM(ソフトウェア部品表)をSPDXやCycloneDX形式で生成して保存します。有効なオプション：--save spdx、--save cyclonedx (CycloneDX形式がデフォルト)

      エイリアス： -s

config：設定

保存されている認証情報を表示します。

  • 使用法：contrast config

  • オプション：

    • -c、--clear

      保存されている認証情報を削除します。

scan：スキャン実行

SASTスキャンを実行します。

  • 使用法： contrast scan [オプション]

  • オプション：

    • --file

      スキャンするファイルのパスを指定します。ファイルが指定されていない場合は、Contrastはサポート対象ファイル(.jar、 .war、.js、.zipファイル)を作業ディレクトリ内で検索します。

      エイリアス： -f

    • --name

      Contrastのプロジェクト名を指定します。指定されていない場合、Contrastはcontrast.settingsを使用してプロジェクトを識別するか、プロジェクトを作成します。

      エイリアス：–n

    • --save

      検出結果をSARIF(Static Analysis Results Interchange Format)ファイルでダウンロードします。ファイルは、デフォルトの名前のresults.sarifで現在の作業ディレクトリにダウンロードされます。このファイルは、任意のテキストエディタで表示できます。

      エイリアス：-s

    • --timeout

      スキャンが完了するまでの待機時間(wait)を秒数で指定します。デフォルトの値は、300秒です。

      エイリアス：-t

lambda ：Lambda関数のスキャン

スキャンするAWS Lambdaの関数名を指定します。

  • 使用法：contrast lambda --function-name

  • エイリアス：-f

  • オプション：

    • contrast lambda --function-name --endpoint-url

      AWSエンドポイントを上書きします。AWS CLIと同様です。

      エイリアス：-e

    • contrast lambda --function-name --region

      AWSリージョンを上書きします。デフォルトは、AWS_DEFAULT_REGIONです。AWS CLIと同様です。

      エイリアス：-r

    • contrast lambda --function-name --profile

      AWSの設定プロファイルを上書きします。AWS CLIと同様です。

      エイリアス：-p

    • contrast lambda --function-name --json

      人が判読できるデフォルトのフォーマットではなく、レスポンスをJSON形式で返します。

      エイリアス：-j

    • contrast lambda -–function-name -–verbose

      ターミナルに詳細情報を返します。

      エイリアス：-v

    • contrast lambda -–function-name --list-functions

      スキャン可能なLambda関数を一覧表示します。

    • contrast lambda --function-name -–help

      使用方法を表示します。

      エイリアス：-h

help：ヘルプ

使用方法を表示します。CLIコマンドの詳細なヘルプを一覧表示 するには、-hか--helpフラグをコマンドに追加します。

  • 使用法：contrast scan --help

  • エイリアス：-h

version ：バージョン

Contrast CLIのバージョンを表示します。

  • 使用法：contrast version

: