Skip to content

Commit 2ad779f

Browse files
author
Paul Osinski
committed
mv source-code article to new directory
1 parent 4cbcfb8 commit 2ad779f

1 file changed

Lines changed: 11 additions & 10 deletions

File tree

docs/content/en/open_source/archived_docs/integrations/source-code-repositories.md renamed to docs/content/en/working_with_findings/organizing_engagements_tests/source-code-repositories.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
---
2-
title: "Source code repositories"
2+
title: "Link Findings to source code"
33
description: "Integration of repositories to navigate to the locaction of findings in the source code."
44
draft: false
55
weight: 5
66
---
77

8-
Findings can have a filepath and a line number as the location of the vulnerability. This is typically set when scanning an application with a Static Application Security Test (SAST) tool. If the repository of the source code is specified in the Engagement, DefectDojo will present the filepath as a link and the user can navigate directly to the location of the vulnerability.
8+
Certain tools (particularly SAST tools) will include the associated file name and line number in vulnerability data. If the repository of the source code is specified in the Engagement, DefectDojo will present the filepath as a link and the user can navigate directly to the location of the vulnerability.
99

1010
## Setting the repository in the Engagement and Test
1111

1212
### Engagement
1313
While editing the Engagement, users can set the URL of the specific SCM repo.
14-
For Interactive Engagement it needs to be the URL including the branch:
14+
15+
For an Interactive Engagement, it needs to be a URL that specifies the branch:
1516
- for GitHub - like https://github.com/DefectDojo/django-DefectDojo/tree/dev
1617
![Edit Engagement (GitHub)](images/source-code-repositories_1.png)
1718
- for GitLab - like https://gitlab.com/gitlab-org/gitlab/-/tree/master
@@ -21,13 +22,13 @@ For Interactive Engagement it needs to be the URL including the branch:
2122
- for standalone/onpremise BitBucket https://bb.example.com/scm/some-project/some-repo.git or https://bb.example.com/scm/some-user-name/some-repo.git for user public repo (like git clone url)
2223
![Edit Engagement (Bitbucket standalone)](images/source-code-repositories-bitbucket-onpremise_1.png)
2324

24-
For CI/CD Engagement, where user could set commit hash, branch/tag and code line it should look like examples below:
25-
- for GitHub - like https://github.com/DefectDojo/django-DefectDojo
26-
- for GitLab - like https://gitlab.com/gitlab-org/gitlab
27-
- for public BitBucket, Gitea and Codeberg - like https://bitbucket.org/some-user/some-project.git (like git clone url)
28-
- for standalone/onpremise BitBucket https://bb.example.com/scm/some-project.git or https://bb.example.com/scm/some-user-name/some-repo.git for user public repo (like git clone url)
25+
For CI/CD Engagements, the commit hash, branch/tag and code line can vary, so you only need to include the URL of the repository.
26+
- for GitHub - like `https://github.com/DefectDojo/django-DefectDojo`
27+
- for GitLab - like `https://gitlab.com/gitlab-org/gitlab`
28+
- for public BitBucket, Gitea and Codeberg - like `https://bitbucket.org/some-user/some-project.git` (like git clone url)
29+
- for standalone/onpremise BitBucket `https://bb.example.com/scm/some-project.git` or `https://bb.example.com/scm/some-user-name/some-repo.git` for user public repo (like git clone url)
2930

30-
If user does not set commit hash or branch/tag in appropriate fields of CI/CD Engagement edit form, the URL should look like in Interactive Engagement edit form.
31+
In a CI/CD Engagement, you can specify a commit hash or branch/tag in the **Edit Engagement** form, which will be appended to any links rendered by DefectDojo. If these are not set, the SCM URL will need to contain a complete link which includes the code branch.
3132

3233
SCM navigation URL is composed from Repo URL using SCM Type. A specific SCM type can be set in Product custom field "scm-type". If no "scm-type" is set and the URL contains "https://github.com", a "github" SCM type is assumed.
3334

@@ -42,7 +43,7 @@ Product SCM type add:
4243
Possible SCM types could be 'github', 'gitlab', 'bitbucket', 'bitbucket-standalone', 'gitea', 'codeberg' or nothing (for default github).
4344

4445

45-
## Link in Finding
46+
## Source code Links in Findings
4647

4748
When viewing a finding, the location will be presented as a link, if the repository of the source code has been set in the Engagement:
4849

0 commit comments

Comments
 (0)