Skip to main content

Contrast Security IntelliJプラグイン

Contrast IDE(統合開発環境)プラグインを使用して、プロジェクト(Contrast Scan)とアプリケーション(Contrast Assess)に関するセキュリティ脆弱性の情報を統合できます。Contrastプラグインによって、プロジェクトやアプリケーションで検出された脆弱性に関する情報をほぼリアルタイムで取得できます。また、このプラグインでは、深刻度、ステータス、検出日によるフィルタリングが可能で、脆弱性データの表示をカスタマイズできます。

Key features

The plugin offers Assess and Scan, designed to provide a seamless experience for identifying and managing security vulnerabilities in commonly supported programming languages within the IntelliJ Community Edition.

  • Vulnerability report:

    • View vulnerabilities associated with applications for Assess and Projects in Scan

    • Provide filters such as severity, status, and discovery dates to refine the search on the vulnerability list

  • Current file:

    • Provide a Tree view on the list of vulnerabilities associated with the current file open in the IDE, with visual indicators based on criticality

    • Provide the ability to navigate to the Line of Code with contextual annotations

  • Detailed Vulnerability Information:

    • Assess provides in-depth details about each vulnerability, such as remediation steps, event logs, and options to mark or categorize the issue

    • The user interface provides a seamless navigation of the associated details related to each vulnerability in a dedicated tab view to enhance the user experience

  • Schedulers:

    • Automate the fetching of vulnerabilities for applications (for Assess) and projects (for Scan) based on a configurable schedule without manual intervention

These features enable developers to proactively identify, analyze, and address vulnerabilities, thereby improving overall code security and efficiency.

Before you begin

Make sure you have the supported recommendations and requirements.

System Requirements

Component

Recommendation

CPU

Quad-core

RAM

16 GB

Storage

SSD, 128 GB

Monitor

1080p

Software Requirements

Software

Requirements

Operating System

Ubuntu 22.04.5 LTS or Windows 11 or macOS Sequoia 14.x

JRE

21.0.8

JVM Heap Size

-Xms 2g -Xmx 4g

Supported IDE and Versions

IDE

Version

IntelliJ Community Edition

Version 2025.3.1.1 and 2025.2

Rider version 2025.3.1 and 2025.2.1

JDK(Java Development Kit)のインストール

Linux

  1. OracleのWeb サイトからJDK 17.0.13をインストールします。

  2. お使いのシステムに適したtar.gzファイルをダウンロードして下さい(例：jdk-17.0.13_linux-x64_bin.tar.gz)。

  3. ターミナルを開き、tar.gzファイルをダウンロードしたディレクトリに移動します。

  4. コマンド(以下の例)を使用してファイルを解凍します。

    tar -xvzf jdk-21.0.8_linux-x64_bin.tar.gz

  5. 解凍したJDKを/usr/lib/jvm/ディレクトリに移動します。

    sudo mv jdk-21.0.8 /usr/lib/jvm/

  6. JAVA_HOME環境変数を設定し、PATHを更新します。

  7. .bashrcまたは.profile(シェルによって異なります)を編集します。

    nano ~/.bashrc

  8. ファイルの最後に以下の行を追加します。

    export JAVA_HOME=/usr/lib/jvm/jdk-21.0.8
export PATH=$JAVA_HOME/bin:$PATH

  9. .bashrcをを再読み込みして変更を適用します。

    source ~/.bashrc

  10. 以下のコマンドを実行して、Javaが正しくインストールされていることを確認します。

    java -version

  11. 続けてヒープサイズを設定します。

Windows

  1. OracleのWeb サイトからJDK 17.0.13をインストールします。

  2. お使いのシステムに適したtar.gzファイルをダウンロードして下さい(例：jdk-17.0.13_windows-x64_bin.tar.gz）。

  3. tar.gzファイルをダウンロードしたディレクトリに移動します。

  4. 環境変数を設定します。

    • JAVA_HOMEを追加

    • Win + Sを選択

    • 環境変数を入力

    • システム環境変数の編集を選択

    • システムのプロパティ画面で、環境変数をクリック

    • システム変数で新規を選択して以下を入力：

      Variable name: JAVA_HOME
Variable value: Path to your JDK installation (e.g., C:\Program Files\Java\jdk21).

  5. システム変数で Pathを見つけます。

  6. 新規を選択し、以下を追加します。

    %JAVA_HOME%\bin

  7. OKを選択します。

  8. 新しいコマンドプロンプトを開き、設定を確認します。

    java -version

  9. 続けてヒープサイズを設定します。

macOS

  1. OracleのWeb サイトからJDK 17.0.13をインストールします。

  2. お使いのシステムに適したtar.gzファイルをダウンロードして下さい(例：jdk-17.0.13_macos-x64_bin.tar.gz）。

  3. tar.gzファイルをダウンロードしたディレクトリに移動します。

  4. コマンド(以下の例)を使用してファイルを解凍します。

    tar -xvzf jdk-21.0.8_macos-x64_bin.tar.gz

  5. 解凍したフォルダをJDKディレクトリに移動します。

    sudo mv jdk-21.0.8 /Library/Java/JavaVirtualMachines/

  6. JAVA_HOME環境変数を設定します。JDKパスを確認します。解凍したJDKは、 /Library/Java/JavaVirtualMachines/jdk-17.0.13/Contents/Homeにあります。

  7. シェルの設定ファイルを開きます。

    nano ~/.zshrc

  8. 以下の行を追加してJAVA_HOMEを設定し、PATHを更新します。

    export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk-21.0.8/Contents/Home
export PATH=$JAVA_HOME/bin:$PATH

  9. 変更を保存します。

  10. nanoでCtrl+Oを選択して、保存します。

  11. Ctrl+Xを選択して、終了します。

  12. 変更を適用します。

    source ~/.zshrc

  13. 新しいコマンドプロンプトを開き、設定を確認します。

    java -version

  14. 続けてヒープサイズを設定します。

ヒープサイズの設定

  1. IntelliJ IDEAを開きます。

  2. ヘルプ > カスタム VM オプションの編集にアクセスします。

  3. 以下の行を追加または更新します。

    -Xms1024m    # Initial heap size (1 GB)
-Xmx4096m    # Maximum heap size (4 GB)

  4. ファイルを保存し、 IntelliJ IDEAを再起動します。

Contrast IntelliJプラグインのインストール

以下のいずれかの方法を選択して下さい。

JetBrains MarketplaceからContrast IntelliJプラグインをインストール

  1. IntelliJ IDEを開き、IntelliJ IDE > 設定 > プラグインに進みます。

  2. MarketplaceでContrast IDEを検索して見つけたら、インストールボタンを選択します。

  3. インストール後、適用を選択し、OKを選択します。

手動インストールでContrast IntelliJプラグインをインストール

  1. プラグインの.zipファイルをダウンロードして、マシンにダウンロードします。

  2. お使いのシステムでIntelliJ IDEAを起動します。

  3. プラグインの設定を行います。

    • IntelliJ IDEA > 設定に進みます。

    • 設定画面でプラグインを選択します。

  4. ディスクからプラグインをインストールします。

    • プラグイン画面の右上にある歯車アイコンをクリックします。

    • ドロップダウンメニューよりディスクからプラグインをインストールを選択します。

  5. 表示された画面で、 .zipファイルの場所に移動し、選択します。

    IntelliJ IDEAによってプラグインが検証されて、インストールされます。プロンプトが表示されたら、インストールを確定します。

  6. IntelliJ IDEAを再起動します。

    • インストール後、IntelliJ IDEAの再起動を求めるプロンプトが表示される場合があります。

    • IDE再起動をクリックして、インストールプロセスを完了します。

  7. インストールを確認します。

    • IntelliJ IDEAが再起動したら、設定画面のプラグインに戻ります。

    • プラグインが インストール済みの下にリストされ、有効になっていることを確認します。

Contrast IntelliJプラグインの設定

  1. IntelliJ IDEAでContrastプラグインを見つけ、設定アイコン(icon-settings.svg)を選択します。

  2. 以下を入力します。

    • Contrast URL：ContrastインスタンスのURL。例、https://app.contrastsecurity.com

    • ユーザ名 ：Contrastへのログインに使用するユーザ名またはメールアドレスです。

    • APIキー、サービスキー、組織ID：これらの値はContrast Webインターフェイスのユーザプロファイルからコピーして下さい。

      これらの値を見つけるには：

      1. Contrast Webインターフェイスで、ページの右上にある自分の名前を選択します。

      2. ユーザの設定を選択します。

      3. 「あなたのキー」の下に、APIキー、サービスキー、組織IDがあります。

        重要

        組織のエージェントキー (ユーザメニュー > 組織の設定 > エージェントキー)は使用しないで下さい。このエージェントキーのアクセス権は、より制限されており、Contrast Intellijプラグインでは機能しません。

  3. OKを選択します。

このセクションの内容: