Skip to content

Commit c20601d

Browse files
devGregAclaude
authored andcommitted
docs(connectors): Contrast, GitGuardian, Google Cloud SCC, HackerOne, Shodan setup
Add tool-specific setup sections to the connector reference for five findings connectors, following the existing per-tool format (description, prerequisites, connector mappings). - Contrast: username + API key + service key + organization id. - GitGuardian: single API key; documents the leak-proof behavior (only incident metadata is imported, never the secret value) and the open-incident / auto-mitigation semantics. - Google Cloud Security Command Center: service-account JSON key + parent resource; notes SCC activation and the findingsViewer role. - HackerOne: organization API token (identifier + token), with the personal-vs-organization token caveat. - Shodan: API key + search query scoping to the org's own assets; notes the membership requirement and query-credit usage. Veracode and Qualys are covered separately in the connector-docs backfill PR (#15198). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 12b4d48 commit c20601d

1 file changed

Lines changed: 102 additions & 0 deletions

File tree

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

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,30 @@ DefectDojo's Checkmarx ONE connector calls the Checkmarx API to fetch data.
129129
3. Enter your tenant location in the **Location** field. This URL is formatted as follows:
130130
`https://<your-region>.ast.checkmarx.net/` . Your Region can be found at the beginning of your Checkmarx URL when using the Checkmarx app. **<https://ast.checkmarx.net>** is the primary US server (which has no region prefix).
131131

132+
## **Contrast**
133+
134+
The Contrast connector uses the Contrast Assess REST API to import application vulnerabilities. DefectDojo discovers the applications in your Contrast organization and creates a Record for each one.
135+
136+
#### Prerequisites
137+
138+
You will need four values from Contrast. We recommend creating a dedicated service account so automated activity is easy to distinguish from your team's manual actions. In the Contrast UI, under **User Settings > Profile > Your Keys**, you can find:
139+
140+
* Your organization **API Key**.
141+
* Your personal **Service Key**.
142+
* The **username** the credentials belong to (the account's login email).
143+
* Your **Organization ID** — the UUID of the organization to import from, also shown under **Organization Settings**.
144+
145+
#### Connector Mappings
146+
147+
1. Enter the base URL you use to access Contrast in the **Location** field — for the hosted product this is typically `https://app.contrastsecurity.com` (or your regional / self-hosted Team Server URL).
148+
2. Enter the account login email in the **Username** field.
149+
3. Enter the organization **API Key** in the **API Key** field.
150+
4. Enter the personal **Service Key** in the **Service Key** field.
151+
5. Enter the **Organization ID** (UUID) in the **Organization ID** field.
152+
6. Optionally, set a **Minimum Severity** to limit which findings are imported.
153+
154+
Each Contrast application becomes a Record, and its vulnerabilities are imported as findings.
155+
132156
## Dependency\-Track
133157

134158
This connector fetches data from a on\-premise Dependency\-Track instance, via REST API.
@@ -148,6 +172,67 @@ To generate a Dependency\-Track API key:
148172

149173
For more information, see **[Dependency\-Track Documentation](https://docs.dependencytrack.org/integrations/rest-api/)**.
150174

175+
## **GitGuardian**
176+
177+
The GitGuardian connector uses the GitGuardian REST API to import **secret incidents** — exposed credentials GitGuardian has detected across your monitored sources. DefectDojo creates a Record for each monitored source (repository or perimeter) that currently has open incidents, and imports each open incident as a finding.
178+
179+
For your security, the connector imports only incident **metadata** — the detector, severity, validity, status, and a link back to GitGuardian. The exposed secret value itself is never retrieved or stored by DefectDojo; follow the link in each finding to review the affected locations in GitGuardian.
180+
181+
#### Prerequisites
182+
183+
You will need a GitGuardian API key. We recommend a **Service Account token** (rather than a personal access token) so automated activity is easy to distinguish. Create it under **API** in the GitGuardian dashboard and grant these read scopes:
184+
185+
* `incidents:read`
186+
* `sources:read`
187+
188+
#### Connector Mappings
189+
190+
1. Enter your GitGuardian API URL in the **Location** field: `https://api.gitguardian.com` for the SaaS platform, or your self-hosted instance's API URL.
191+
2. Enter the API key in the **Secret** field.
192+
193+
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.
194+
195+
## **Google Cloud Security Command Center**
196+
197+
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.
198+
199+
#### Prerequisites
200+
201+
Security Command Center must be **activated** on your organization (the Standard tier is free). You will then need a service account that can list findings, and a JSON key for it:
202+
203+
1. In Google Cloud, create a service account — a dedicated one for DefectDojo is recommended.
204+
2. Grant it the **Security Center Findings Viewer** role (`roles/securitycenter.findingsViewer`) at the scope you want to import (organization, folder, or project).
205+
3. Create a **JSON key** for the service account and download it.
206+
207+
#### Connector Mappings
208+
209+
1. Leave the **Location** field at the default `https://securitycenter.googleapis.com` unless you use a non-standard endpoint.
210+
2. In the **Parent Resource** field, enter the scope to import from: `organizations/{id}`, `folders/{id}`, or `projects/{id}`.
211+
3. Paste the full contents of the service-account **JSON key** file into the **Service Account Key** field.
212+
4. Optionally, set a **Minimum Severity** to limit which findings are imported.
213+
214+
Only `ACTIVE`, un-muted findings are imported, so findings you deactivate or mute in SCC are automatically mitigated in DefectDojo on the next sync. Each finding's affected GCP project becomes its Record.
215+
216+
## **HackerOne**
217+
218+
The HackerOne connector uses the HackerOne REST API to import reports from your bug bounty or vulnerability disclosure program. DefectDojo creates a Record for each program the token can access and imports its reports as findings.
219+
220+
#### Prerequisites
221+
222+
The connector uses HackerOne's **customer** API, which requires an **organization API token** — a personal token from your user settings only works against the hacker API and will not authenticate here.
223+
224+
1. In HackerOne, go to **Organization Settings > API Tokens**.
225+
2. Create a token and note both the **identifier** and the **token** value. Read access to the program is sufficient.
226+
227+
#### Connector Mappings
228+
229+
1. Enter `https://api.hackerone.com` in the **Location** field.
230+
2. Enter the token **identifier** in the **API Token Identifier** field.
231+
3. Enter the token value in the **API Token** field.
232+
4. Optionally, set a **Minimum Severity** to limit which findings are imported.
233+
234+
Each program becomes a Record, and its reports are imported as findings with the HackerOne severity rating preserved.
235+
151236
## **IriusRisk**
152237

153238
The IriusRisk connector uses an API token to pull threat modeling data from your IriusRisk instance.
@@ -222,6 +307,23 @@ Enter `https://semgrep.dev/api/v1/` in the **Location** field.
222307

223308
See [Semgrep documentation](https://semgrep.dev/docs/semgrep-cloud-platform/semgrep-api/#tag__badge-list) for more info.
224309

310+
## **Shodan**
311+
312+
The Shodan connector uses the Shodan REST API to import the vulnerabilities (CVEs) Shodan has observed on your internet-exposed hosts. You provide a Shodan search query that scopes the import to your own assets; DefectDojo creates a Record for each matching host and imports its CVEs as findings.
313+
314+
#### Prerequisites
315+
316+
You will need a Shodan API key, found on your Shodan **Account** page. Host search with vulnerability data requires a Shodan membership or a paid API plan — the free tier cannot page through search results.
317+
318+
#### Connector Mappings
319+
320+
1. Enter `https://api.shodan.io` in the **Location** field.
321+
2. Enter your Shodan API key in the **API Key** field.
322+
3. In the **Search Query** field, enter a Shodan query that scopes the import to your organization's assets — for example `hostname:example.com`, `net:203.0.113.0/24`, or `org:"Example Inc"`. Only hosts matching this query are imported, so keep it scoped to infrastructure you own.
323+
4. Optionally, set a **Minimum Severity** to limit which findings are imported.
324+
325+
Each matching host becomes a Record, and each CVE Shodan detected on that host's exposed services is imported as a finding — severity is derived from the CVSS score, with EPSS and CISA KEV context included where available. Each page of search results consumes one Shodan query credit.
326+
225327
## SonarQube
226328

227329
The SonarQube Connector can fetch data from either a SonarCloud account or from a local SonarQube instance.

0 commit comments

Comments
 (0)