Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make defect dojo able to tag duplicate findings #87

Merged
merged 2 commits into from
Mar 17, 2024
Merged

make defect dojo able to tag duplicate findings #87

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7de2e7b
make defect dojo able to tag duplicate findings
northdpole Feb 15, 2024
af26466
rebase main
northdpole Mar 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions components/consumers/defectdojo/client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,17 +62,21 @@ func (client *Client) CreateFinding(
title, description, severity, target, date, numericalSeverity string,
tags []string,
testID, line, cwe, foundBy int32,
falseP, duplicate, active bool,
falseP, duplicate bool,
cvssScore float64,
) (types.FindingCreateResponse, error) {
url := fmt.Sprintf("%s/findings", client.host)
active := true
if duplicate {
active = false
}
body := types.FindingCreateRequest{
Tags: tags,
Date: date,
Cwe: cwe,
Line: line,
FilePath: target,
Duplicate: false,
Duplicate: duplicate,
FalseP: falseP,
Active: active,
Verified: false,
Expand Down
12 changes: 2 additions & 10 deletions components/consumers/defectdojo/client/client_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,8 @@ func TestCreateFinding(t *testing.T) {
called = true
assert.Equal(t, r.Method, "POST")
assert.Equal(t, r.RequestURI, "/findings")

b, err := io.ReadAll(r.Body)
require.NoError(t, err)

var actual, exp types.FindingCreateRequest
exp = types.FindingCreateRequest{
Test: 1,
Expand All @@ -49,7 +47,7 @@ func TestCreateFinding(t *testing.T) {
FalseP: false,
Severity: "High",
Description: "description",
Active: false,
Active: true,
Verified: false,
Line: 1,
NumericalSeverity: "C:I",
Expand All @@ -59,11 +57,9 @@ func TestCreateFinding(t *testing.T) {
}
require.NoError(t, json.Unmarshal(b, &actual))
assert.Equal(t, actual, exp)

_, err = w.Write([]byte(expected))
require.NoError(t, err)
}))

c := &Client{host: mockTs.URL, apiToken: "test", user: ""}
_, err := c.CreateFinding("title",
"description",
Expand All @@ -74,7 +70,7 @@ func TestCreateFinding(t *testing.T) {
[]string{"tests"},
1,
1,
0, 0, false, false, false, 3.9)
0, 0, false, false, 3.9)
require.NoError(t, err)
assert.True(t, called)
}
Expand All @@ -85,10 +81,8 @@ func TestCreateEngagement(t *testing.T) {
called = true
assert.Equal(t, r.Method, "POST")
assert.Equal(t, r.RequestURI, "/engagements")

b, err := io.ReadAll(r.Body)
require.NoError(t, err)

var engagement types.EngagementRequest
require.NoError(t, json.Unmarshal(b, &engagement))

Expand All @@ -101,11 +95,9 @@ func TestCreateEngagement(t *testing.T) {
Product: 2,
}
assert.Equal(t, expectedEngagement, engagement)

_, err = w.Write([]byte(`{"id":4,"tags":["foo.git/somesha"],"name":"dracon scan foo","description":null,"version":"string","first_contacted":null,"target_start":"2022-06-01","target_end":"2022-06-01","reason":null,"updated":"2022-06-01T16:29:18.965507Z","created":"2022-06-01T16:29:18.908694Z","active":true,"tracker":null,"test_strategy":null,"threat_model":true,"api_test":true,"pen_test":true,"check_list":true,"status":"","progress":"threat_model","tmodel_path":"none","done_testing":false,"engagement_type":"Interactive","build_id":"foo","commit_hash":null,"branch_tag":null,"source_code_management_uri":null,"deduplication_on_engagement":false,"lead":null,"requester":null,"preset":null,"report_type":null,"product":2,"build_server":null,"source_code_management_server":null,"orchestration_engine":null,"notes":[],"files":[],"risk_acceptance":[]}`))
require.NoError(t, err)
}))

c := &Client{host: mockTs.URL, apiToken: "test", user: ""}
_, err := c.CreateEngagement("dracon scan foo", "2022-06-01", []string{"foo.git/somesha"}, 2)
require.NoError(t, err)
Expand Down
2 changes: 0 additions & 2 deletions components/consumers/defectdojo/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ func handleRawResults(product int, dojoClient *client.Client, responses []*v1.La
dojoClient.UserID,
false,
false,
true,
iss.GetCvss())
if err != nil {
log.Fatalf("Could not create raw finding error: %v\n", err)
Expand Down Expand Up @@ -129,7 +128,6 @@ func handleEnrichedResults(product int, dojoClient *client.Client, responses []*
test.ID, 0, 0, dojoClient.UserID,
iss.GetFalsePositive(),
duplicate,
true,
rawIss.GetCvss())
if err != nil {
log.Fatalf("Could not create enriched finding error: %v\n", err)
Expand Down
20 changes: 15 additions & 5 deletions components/consumers/defectdojo/main_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ func createObjects(product int, scanType string) ([]*v1.LaunchToolResponse, []*t
var issues []*v1.Issue
var enrichedIssues []*v1.EnrichedIssue
for j := 0; j <= 3%(i+1); j++ {
duplicateTimes, _ := time.Parse(time.RFC3339, "2000-01-19T18:09:06.370037788Z")
duplicateTimestamp := timestamppb.New(duplicateTimes)
x := v1.Issue{
Target: fmt.Sprintf("myTarget %d-%d", i, j),
Type: fmt.Sprintf("type %d-%d", i, j),
Expand All @@ -72,7 +74,7 @@ func createObjects(product int, scanType string) ([]*v1.LaunchToolResponse, []*t
y := v1.EnrichedIssue{
RawIssue: &x,
FirstSeen: response.ScanInfo.ScanStartTime,
Count: uint64(i),
Count: 1,
FalsePositive: false,
UpdatedAt: response.ScanInfo.ScanStartTime,
Hash: "d41d8cd98f00b204e9800998ecf8427e",
Expand All @@ -81,6 +83,10 @@ func createObjects(product int, scanType string) ([]*v1.LaunchToolResponse, []*t
"Policy.Blah.Decision": "failed",
},
}
if j%2 == 0 {
y.FirstSeen = duplicateTimestamp
y.Count = uint64(j)
}
issues = append(issues, &x)
enrichedIssues = append(enrichedIssues, &y)

Expand All @@ -98,7 +104,7 @@ func createObjects(product int, scanType string) ([]*v1.LaunchToolResponse, []*t
}
d = desc
}
findingsRequests = append(findingsRequests, &types.FindingCreateRequest{
findingsReq := &types.FindingCreateRequest{
Tags: []string{"DraconScan", scanType + "Finding", scanID, toolName},
Title: x.Title,
Date: times.Format(DojoTimeFormat),
Expand All @@ -108,7 +114,13 @@ func createObjects(product int, scanType string) ([]*v1.LaunchToolResponse, []*t
FoundBy: []int32{1},
Description: *d,
Active: true,
})
Duplicate: false,
}
if j%2 == 0 && scanType != "Raw" {
findingsReq.Active = false
findingsReq.Duplicate = true
}
findingsRequests = append(findingsRequests, findingsReq)
}
response.Issues = issues
enrichedResponse.OriginalResults = response // duplication here is important since we use this enrichedResponse in getEnrichedIssues above
Expand Down Expand Up @@ -156,7 +168,6 @@ func TestHandleRawResults(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
body, err := io.ReadAll(r.Body)
require.NoError(t, err)

switch string(r.URL.Path) {
case "/users":
assert.Equal(t, r.Method, http.MethodGet)
Expand Down Expand Up @@ -230,7 +241,6 @@ func TestHandleEnrichedResults(t *testing.T) {
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
body, err := io.ReadAll(r.Body)
require.NoError(t, err)

switch string(r.URL.String()) {
case "/users":
assert.Equal(t, r.Method, http.MethodGet)
Expand Down
Loading