Skip to main content

Integrating Invicti Standard with GitHub

This document is for:
Invicti Standard

GitHub is a web-based hosting service for version control. GitHub is mostly used for code but it has an issue tracking feature with labels, milestones, assignees and a search engine. Every issue is referenced in a card, which can then be dropped into a repository, used to track the progress of the bug, discuss fixes and assign relevant tasks to teammates.

This topic explains how to configure Invicti Standard to send a detected vulnerability to GitHub, enabling seamless integration with your development workflow for efficient vulnerability issue tracking and remediation management.

GitHub Fields

The following table lists and describes the GitHub fields available in the Send to Actions configuration:

Button/Section/FieldDescription
AddClick to add an integration.
DeleteClick to delete the integration and clear all fields.
Create Sample IssueOnce all relevant fields have been configured, click to create a sample issue.
ActionThis section contains general fields about the Send To Action.
Display NameThis is the name of the configuration that will be shown in menus.
MandatoryThis section contains fields that must be completed.
Server URLThis is the GitHub instance Server URL.
RepositoryThis is the repository name, which includes the issue.
UsernameThis is the name of the user. If you are using a personal access token (see below), leave this field blank.
Access TokenThis is the personalized access token of the user.
VulnerabilityThis section contains fields with vulnerability details.
Body TemplateThis is the template file that is used to create description fields.
Title FormatThis is the string format that is used to create the vulnerability title.
OptionalThis section contains optional fields.
LabelsThese are the issue labels.
AssigneeThis is the user to whom the issue is assigned. Accepted values are:
  • Email address
  • User identifier
  • 'me' keyword

How to Integrate Invicti Standard with GitHub

Follow these steps to configure GitHub integration for automated vulnerability issue creation:

  1. Open Invicti Standard
  2. From the Home tab on the ribbon, click Options. The Options dialog is displayed
  3. Click Send To Actions
Invicti Standard Options dialog showing Send To Actions menu for GitHub configuration
  1. From the Add dropdown, select GitHub. The GitHub fields are displayed
Add dropdown menu showing GitHub option selection for integration setup
  1. In the Mandatory section, complete the connection details:

    • Server URL
    • Repository
    • Username
    • Access Token (This can be generated from GitHub's User Options menu.)
  2. In the Vulnerability section you can change the Body Template and Title Format

Template Location

Body templates are stored in %userprofile%\Documents\Invicti\Resources\Send To Templates. If you use your own custom templates, store them in this location.

  1. In the Optional settings you can specify:

    • Labels
    • Assignee
  2. Click Create Sample Issue to confirm that Invicti Standard can connect to the configured system. The Send To Action Test confirmation dialog is displayed

Create Sample Issue button and test confirmation dialog for GitHub connection verification
  1. In the Send To Action Test dialog, click the Issue number link to open the issue in GitHub in the default browser
Successfully created sample issue in GitHub repository showing issue details and tracking

How to Export Reported Vulnerabilities to Projects in GitHub

After configuring the GitHub integration, follow these steps to export specific vulnerabilities:

Prerequisites

Please ensure that you have first configured GitHub integration (see How to Integrate Invicti Standard with GitHub).

  1. Open Invicti Standard
  2. From the ribbon, select the File tab. Local Scans are displayed. Double-click the relevant scan to display its results
  3. In the Issues panel, right click the vulnerability you want to export and select Send to GitHub. (Alternatively, from the ribbon, click the Vulnerability tab, then Send to GitHub.) A confirmation message and link is displayed at the bottom of the screen.
Send to GitHub
  1. Click the GitHub Send to Action is executed for the selected vulnerability link to view the newly-created issue in GitHub
  2. The vulnerability is automatically exported to GitHub. You can view it in GitHub's Issues tab
Send to GitHub

Need help?

Invicti Support team is ready to provide you with technical help. Go to Help Center

Was this page useful?