Skip to main content

Installing and Setting Up the Checkmarx One Visual Studio Extension

The Checkmarx One extension for Visual Studio is available on Visual Studio marketplace and can be installed directly from your Visual Studio console.

To install and set up the extension:

  1. In the Visual Studio console header bar, click on Extensions > Manage Extensions.

    6353616975.png

    The Manage Extensions window opens with the Online tab selected by default.

  2. In the search box, start entering 'Checkmarx One'.

  3. When the Checkmarx One extension is shown, click Download for that extension.

    Image_1100.png

    A notification at the bottom of the window prompts you to restart Visual Studio.

  4. Click Close and then Exit the program.

    The VSIX Installer dialog opens.

    Image_1101.png

  5. Click Modify.

  6. Open Visual Studio and in the header bar, click View > Other Windows > Checkmarx.

    6337134597.png

    A new Checkmarx pane opens.

    6337396751.png

  7. Click on Open Settings.

    The Options window opens showing the Checkmarx settings.

    Image_829.png

  8. In the API key field, enter your Checkmarx One API key.

    Notice

    To create an API key, see Generating an API Key

    The roles (permissions) assigned to the API Key are inherited from the user account that generates the key. Therefore, make sure that you are logged in to an account with the appropriate roles.

    In order to use this integration for running an end-to-end flow of scanning a project and viewing results, the API Key must have at a minimum the out-of-the-box composite role ast-scanner as well as the IAM role default-roles.

  9. In the Additional parameters section you can specify any CLI arguments that you would like to apply as global flags (e.g., proxy servers). See documentation here.

  10. Click on Validate connection, to test that the connection works.

    Notice

    If the connection fails, you can view detailed error logs by entering --debug in the Additional parameters section and retrying the connection.

  11. Click OK at the bottom of the screen.

In this section: