Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This section will show you how to integrate the Kiuwan IDE Plug-In into Eclipse-based IDEs. 

Info

The Kiuwan Plug-In for JetBrains IDEs is available only in Viewer mode.

It has been successfully tested with for JetBrains 2018.*.* version of following products :

  • Intellij IDEA (2017.1 and above)
  • PhpStorm
  • PyCharm
  • Android Studio (3.0.1 and above)
  • CLion (2019.1)


Contents

Table of Contents

Excerpt Include
Kiuwan for Developers
Kiuwan for Developers
nopaneltrue

Installation

Installation steps of the Kiuwan IDE Plug-In for JetBrains are the same for all the JetBrains' family of products. 

  1. Open File > Settings > Plugins 

  2. Then click Browse repositories .. 

    Image Modified

  3. A new window will open. Here click Manage Repositories

    Image Modified

  4. The following window will appear. 

...


  1. Image Added

  2. Click

...

  1. + (Add) button and add the Kiuwan Repository URL:

...

  1. https://

...

  1. static.kiuwan.com/

...

  1. download/jetbrains/plugins.xml

...

  1. Image Added

  2. After adding it, select the Kiuwan repository just created and click OK. You will see the Kiuwan plug-in, select it and click install

    Image Modified

  3. After downloading it, click Restart IntelliJ IDEA

Configuration

Connect to Kiuwan

After the installation, you need to configure the Kiuwan Plug-In to connect to Kiuwan. Please remember that you need to have a valid Kiuwan Account.

InstructionsImage

Go to File > Settings and select Tools > Kiuwan > Connection Settings

Info
titleProxy settings

If you are using a proxy, please configure Proxy configuration.

The Kiuwan server URL comes preconfigured (leave it with default value)

Fill in User and Password fields with your Kiuwan account's credentials.

Click Save and check configuration before applying changes.

Image Modified

...

 

...



Map your Idea Project to the Kiuwan Application

After the installation, you are ready to map your Idea project to a Kiuwan application.

Info
This action will allow synchronizing defects and vulnerabilities found by Kiuwan in your source code, getting them ready for fixing.


To map your Idea project to Kiuwan, open File >  Settings and select Tools > Kiuwan > Remote Application.

A dialog will open with a combination of available applications where you can select the application that matches your project in the Kiuwan account.

...


Image Modified

 



Kiuwan Defects List

Once mapped, go to Tools > Show Kiuwan Defects to open the Kiuwan Defects List.

The Kiuwan Defect List window will appear docked to your Idea layout. Double-click on a defect to open the file and highlight the line of the defect.

Image Modified

 


Right-click the defect and select Rule information to open a browser with the documentation of the Kiuwan rule that detected the selected vulnerability.

Info

To get access to Rule information, please use same credentials as those configured in Connection Properties.

 


Refreshing the Defects List

To be sure you are working on the latest list of defects found by Kiuwan, you need to manually refresh the defect list.

Clicking on the  Image Modified icon will update the Kiuwan Defects List to the latest contents of the Kiuwan servers.

Configuring the Contents of the Defects List

Clicking on the  Image Modified icon will allow the configuration of the contents of the Kiuwan Defects List.

Image Modified

...


Please visit K4D for Eclipse - Server defects list for a full description of available options.

Support and Troubleshooting 

If you experience problems with the Kiuwan plugin for IntelliJ IDEA, you can read the Kiuwan Documentation to find a solution, or if you prefer you can collect troubleshooting information and send it to us.

Info
titleSupport Information

Important information for troubleshooting is scattered across several log and configuration files.

To make this process easier to you, just go to Settings >> Tools >> Kiuwan >> Support and press the Extract support data button.

Choose the folder where you want to save this information, and submit to our technical support team the compressed file generated there. 

Visit Contact Kiuwan Technical Support on how to contact us. We will address your problem as soon as possible.

...