Integrating Invicti Enterprise with GitHub
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 team members.
This topic explains how to configure Invicti Enterprise to send a detected vulnerability to GitHub.
For further information, see What Systems Does Invicti Integrate With?.
GitHub Fields
This table lists and explains the GitHub fields in the New GitHub Integration window.
|
Button/Section/Field |
Description |
|
Name |
This is the name of the configuration that will be shown in menus. |
|
Mandatory |
This section contains fields that must be completed. |
|
Server URL |
This is the GitHub server’s project URL. Change it for GitHub Enterprise (On-Premise). |
|
Repository |
This is the repository name, which includes the issue. |
|
Username |
This is the name of the user. If you are using a personal access token (see below), leave this field blank. |
|
Personal Access Token |
This is a token that is used for authorization. |
|
Title Format |
This is the string format that is used to create the vulnerability title. |
|
Optional |
This section contains optional fields. |
|
Labels |
These are the issue labels. |
|
Assignee |
This is the user to whom the issue is assigned. |
|
Organization |
This is the organization’s name. |
How to Integrate Invicti Enterprise with GitHub
- Log in to Invicti Enterprise.
- From the main page, go to Integrations > New Integration.
- From the Issue Tracking Systems section, select GitHub.
- In the Name field, enter a name for the integration.
- In the Mandatory section, complete the connection details:
- Server URL (Github/Github Enterprise Server URL)
- Repository
- Username
- Personal Access Token
- Title Format
- In the Optional section, complete as required.
- If the Organization name is entered, issues will be sent to that organization’s repository.
- Select Create Sample Issue to confirm that Invicti Enterprise can connect to the configured system. A confirmation message is displayed to confirm that the sample issue has been successfully created.
In the confirmation message, select the Issue number link to open the issue in your default browser.
- Select Save to save the integration.
How to Export Reported Vulnerabilities to Projects in GitHub
There are several ways to send issues to GitHub with Invicti Enterprise:
- Once notifications have been configured, you can configure Invicti Enterprise to automatically send vulnerabilities after scanning has been completed (see How to Configure a Notification to Report Vulnerabilities to an Issue Tracking System).
- You can send one or more issues from the Issues window:
- From the main menu, select Issues > All Issues.
- From the Issues page, select one or more issues you want to send.
- Select Send To > GitHub.
A pop-up is displayed, with a link to the issue you have sent to GitHub. If there is no error, this information will be displayed instead.
- You can send an issue from the Recent Scans window:
- From the main menu, select Scans > Recent Scans.
- Next to the relevant scan, select Report.
If you have previously submitted this vulnerability to GitHub, it will already be accessible. You cannot submit the same issue twice.