Skip to content

Commit d9b071e

Browse files
devGregAMaffooch
andauthored
docs(connectors): add GitHub Advanced Security, Qualys, Rapid7 InsightVM, Veracode (#15198)
Backfills the connector reference for four connectors that had no customer-facing docs. Each section covers credential/token setup, the connector field mappings, and what a Record maps to: - GitHub Advanced Security — PAT scopes (code scanning / Dependabot / secret scanning), org, api.github.com vs GHES. - Qualys — VMDR API user + per-subscription platform (pod) URL. - Rapid7 InsightVM — Security Console URL (:3780) + console credentials. - Veracode — API ID + secret (HMAC) + regional API base URL. Stories: sc-13490, sc-12691, sc-13485, sc-13464 Co-authored-by: Cody Maffucci <46459665+Maffooch@users.noreply.github.com>
1 parent 1fb8436 commit d9b071e

1 file changed

Lines changed: 72 additions & 0 deletions

File tree

docs/content/import_data/pro/connectors/connectors_tool_reference.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,27 @@ You will need a GitGuardian API key. We recommend a **Service Account token** (r
331331

332332
Only **open** incidents (status `TRIGGERED` or `ASSIGNED`) are imported; incidents you resolve or ignore in GitGuardian are automatically mitigated in DefectDojo on the next sync. A confirmed-live secret (validity *valid*) is imported as a verified finding.
333333

334+
## **GitHub Advanced Security**
335+
336+
The GitHub Advanced Security connector imports **code scanning**, **Dependabot**, and **secret scanning** alerts from GitHub, as three separate finding types (`GitHub:CodeScanning`, `GitHub:Dependabot`, and `GitHub:SecretScanning`). DefectDojo discovers every non\-archived repository in the configured organization and creates a Record for each one.
337+
338+
#### Prerequisites
339+
340+
GitHub Advanced Security features must be enabled for the repositories you want to import. The connector authenticates with a GitHub **personal access token**:
341+
342+
1. In GitHub, open **Settings \> Developer settings \> Personal access tokens** and create a token owned by (or with access to) the target organization.
343+
2. Grant it read access to the security alerts: a *fine\-grained* token needs **Read\-only** access to **Code scanning alerts**, **Dependabot alerts**, and **Secret scanning alerts** on the organization's repositories; a *classic* token needs the **`repo`** and **`security_events`** scopes.
344+
3. Confirm the token's owner can see the repositories you intend to import — the connector only sees repositories the token can access.
345+
346+
#### Connector Mappings
347+
348+
1. Enter `https://api.github.com` in the **Location** field. For GitHub Enterprise Server, use `https://<your-host>/api/v3`.
349+
2. Enter the organization login in the **Organization** field.
350+
3. Enter the personal access token in the **Secret** field.
351+
4. Optionally, set a **Minimum Severity** to limit which findings are imported.
352+
353+
Each non\-archived repository becomes a Record, queried across the three alert families for open alerts. An alert family that is not enabled for a repository is skipped rather than reported as resolved, so disabled features do not cause false closures.
354+
334355
## **Google Cloud Security Command Center**
335356

336357
The Google Cloud SCC connector uses the Security Command Center v2 REST API to import active security findings from your Google Cloud organization, folder, or project. DefectDojo creates a Record for each Google Cloud **project** that has open findings.
@@ -515,6 +536,40 @@ This connector uses the Probely REST API to fetch data.
515536
You can find an API key under the User \> API Keys menu in Probely.
516537
See [Probely documentation](https://help.probely.com/en/articles/8592281-how-to-generate-an-api-key) for more info.
517538

539+
## Qualys
540+
541+
The Qualys connector imports **VMDR host vulnerability detections** — each joined with its Qualys KnowledgeBase (QID) metadata — from the Qualys Cloud Platform. DefectDojo creates a Record for each Qualys **host** in your subscription.
542+
543+
#### Prerequisites
544+
545+
A Qualys user account with **VMDR API access**, and your subscription's **API server (platform) URL** — this differs per subscription. Find it in the Qualys UI under **Help \> About**, or on the Qualys [Platform Identification](https://www.qualys.com/platform-identification/) page (for example `https://qualysapi.qualys.com` for US Platform 1, or `https://qualysapi.qg2.apps.qualys.com` for US Platform 2).
546+
547+
#### Connector Mappings
548+
549+
1. Enter your Qualys API server URL in the **Location** field (for example `https://qualysapi.qualys.com`).
550+
2. Enter the Qualys API username in the **Username** field.
551+
3. Enter the Qualys API password in the **Secret** field.
552+
4. Optionally, set a **Minimum Severity** to limit which findings are imported.
553+
554+
Each Qualys host becomes a Record. Detections Qualys has marked **Fixed** are excluded, so reimport closes remediated findings.
555+
556+
## **Rapid7 InsightVM**
557+
558+
The Rapid7 InsightVM connector imports asset vulnerability findings from your InsightVM **Security Console** (API v3), enriched with the console's global vulnerability catalog. DefectDojo creates a Record for each InsightVM **site**.
559+
560+
#### Prerequisites
561+
562+
Network access from DefectDojo to your Security Console, and a console **user account** — its login is used for HTTP Basic authentication. The console API is served on port **3780** by default.
563+
564+
#### Connector Mappings
565+
566+
1. Enter your Security Console URL, including the port, in the **Location** field — for example `https://console.example.com:3780`.
567+
2. Enter the console username in the **Username** field.
568+
3. Enter the console password in the **Secret** field.
569+
4. Optionally, set a **Minimum Severity** to limit which findings are imported.
570+
571+
Each InsightVM site becomes a Record; the connector walks the site's assets and imports their vulnerable findings.
572+
518573
## **Semgrep**
519574

520575
This connector uses the Semgrep REST API to fetch data.
@@ -588,6 +643,23 @@ On\-premise Tenable Connectors are not available at this time.
588643

589644
See [Tenable's API Documentation](https://docs.tenable.com/vulnerability-management/Content/Settings/my-account/GenerateAPIKey.htm) for more info.
590645

646+
## **Veracode**
647+
648+
The Veracode connector imports application findings from the Veracode platform, split by scan type into **SAST**, **DAST**, **SCA**, and **Manual** finding types. DefectDojo creates a Record for each Veracode **application**.
649+
650+
#### Prerequisites
651+
652+
Generate a Veracode **API credential** for an account that can see the applications you want to import: in the Veracode Platform, open your account menu \> **API Credentials** and select **Generate API Credentials** (see [Managing Veracode API credentials](https://docs.veracode.com/r/c_api_credentials3)). Copy both the **API ID** and the **API Secret Key** — the secret is shown only once.
653+
654+
#### Connector Mappings
655+
656+
1. Enter the Veracode API base URL in the **Location** field: `https://api.veracode.com` (commercial region), `https://api.veracode.eu` (European region), or `https://api.veracode.us` (US federal region).
657+
2. Enter the API ID in the **API ID** field.
658+
3. Enter the API secret key in the **Secret** field.
659+
4. Optionally, set a **Minimum Severity** to limit which findings are imported.
660+
661+
Each Veracode application becomes a Record. Only **open** findings are imported, so reimport closes findings Veracode reports as resolved.
662+
591663
## **Wazuh**
592664

593665
The Wazuh connector uses the Wazuh Indexer (OpenSearch) to fetch vulnerability findings. Wazuh 4.8 and later store detected CVEs in the Indexer rather than the Wazuh server API, so this connector reads them directly from the `wazuh-states-vulnerabilities-*` index.

0 commit comments

Comments
 (0)