-
Notifications
You must be signed in to change notification settings - Fork 2
/
issue.go
292 lines (248 loc) · 9.59 KB
/
issue.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
package db
import (
"fmt"
"sort"
"github.com/pyneda/sukyan/lib"
"github.com/rs/zerolog/log"
)
// Issue holds table for storing issues found
type Issue struct {
BaseModel
Code string `gorm:"index" json:"code"`
Title string `gorm:"index" json:"title"`
Description string `json:"description"`
Details string `json:"details"`
Remediation string `json:"remediation"`
Cwe int `json:"cwe"`
URL string `gorm:"index" json:"url"`
StatusCode int `gorm:"index" json:"status_code"`
HTTPMethod string `gorm:"index" json:"http_method"`
Payload string `json:"payload"`
Request []byte `json:"request"`
Response []byte `json:"response"`
FalsePositive bool `gorm:"index" json:"false_positive"`
Confidence int `gorm:"index" json:"confidence"`
References StringSlice `json:"references"`
Severity severity `gorm:"index,type:severity;default:'Info'" json:"severity"`
CURLCommand string `json:"curl_command"`
Note string `json:"note"`
Workspace Workspace `json:"-" gorm:"constraint:OnUpdate:CASCADE,OnDelete:CASCADE;"`
WorkspaceID *uint `json:"workspace_id" gorm:"index"`
// OriginalHistory History `json:"original_history" gorm:"constraint:OnUpdate:CASCADE,OnDelete:SET NULL;"`
// OriginalHistoryID *uint `json:"original_history_id" gorm:"index"`
Interactions []OOBInteraction `json:"interactions" gorm:"constraint:OnUpdate:CASCADE,OnDelete:CASCADE;"`
Requests []History `json:"requests" gorm:"many2many:issue_requests;constraint:OnUpdate:CASCADE,OnDelete:CASCADE;"`
TaskID *uint `json:"task_id" gorm:"index"`
Task Task `json:"-" gorm:"foreignKey:TaskID;constraint:OnUpdate:CASCADE,OnDelete:CASCADE;"`
TaskJobID *uint `json:"task_job_id" gorm:"index;constraint:OnUpdate:CASCADE,OnDelete:SET NULL;"`
TaskJob TaskJob `json:"-" gorm:"foreignKey:TaskJobID;constraint:OnUpdate:CASCADE,OnDelete:SET NULL;"`
}
func (i Issue) TableHeaders() []string {
return []string{"ID", "Title", "Code", "Severity", "Confidence", "False Positive", "URL", "Status Code", "HTTP Method", "Description"}
}
func (i Issue) TableRow() []string {
formattedURL := i.URL
if len(i.URL) > PrintMaxURLLength {
formattedURL = i.URL[0:PrintMaxURLLength] + "..."
}
formattedDescription := i.Description
if len(i.Description) > PrintMaxDescriptionLength {
formattedDescription = i.Description[0:PrintMaxDescriptionLength] + "..."
}
return []string{
fmt.Sprintf("%d", i.ID),
i.Title,
i.Code,
i.Severity.String(),
fmt.Sprintf("%d", i.Confidence),
fmt.Sprintf("%t", i.FalsePositive),
formattedURL,
fmt.Sprintf("%d", i.StatusCode),
i.HTTPMethod,
formattedDescription,
}
}
func (i Issue) String() string {
return fmt.Sprintf(
"ID: %d\nCode: %s\nTitle: %s\nCWE: %d\nURL: %s\nStatus Code: %d\nHTTP Method: %s\nPayload: %s\nFalse Positive: %t\nConfidence: %d\nReferences: %v\nSeverity: %s\nCURL Command: %s\nNote: %s\nWorkspace ID: %v\nTask ID: %v\nDescription: %s\nDetails: %s\nRemediation: %s\nRequest: %s\nResponse: %s",
i.ID, i.Code, i.Title, i.Cwe, i.URL, i.StatusCode, i.HTTPMethod, i.Payload, i.FalsePositive, i.Confidence, i.References, i.Severity, i.CURLCommand, i.Note, *i.WorkspaceID, *i.TaskID, i.Description, i.Details, i.Remediation, string(i.Request), string(i.Response),
)
}
func (i Issue) Pretty() string {
return fmt.Sprintf(
"%sID:%s %d\n%sCode:%s %s\n%sTitle:%s %s\n%sCWE:%s %d\n%sURL:%s %s\n%sStatus Code:%s %d\n%sHTTP Method:%s %s\n%sPayload:%s %s\n%sFalse Positive:%s %t\n%sConfidence:%s %d\n%sReferences:%s %v\n%sSeverity:%s %s\n%sCURL Command:%s %s\n%sNote:%s %s\n%sWorkspace ID:%s %v\n%sTask ID:%s %v\n\n%sDescription:%s %s\n\n%sDetails:%s %s\n\n%sRemediation:%s %s\n\n%sRequest:%s %s\n\n%sResponse:%s %s\n",
lib.Blue, lib.ResetColor, i.ID,
lib.Blue, lib.ResetColor, i.Code,
lib.Blue, lib.ResetColor, i.Title,
lib.Blue, lib.ResetColor, i.Cwe,
lib.Blue, lib.ResetColor, i.URL,
lib.Blue, lib.ResetColor, i.StatusCode,
lib.Blue, lib.ResetColor, i.HTTPMethod,
lib.Blue, lib.ResetColor, i.Payload,
lib.Blue, lib.ResetColor, i.FalsePositive,
lib.Blue, lib.ResetColor, i.Confidence,
lib.Blue, lib.ResetColor, i.References,
lib.Blue, lib.ResetColor, i.Severity,
lib.Blue, lib.ResetColor, i.CURLCommand,
lib.Blue, lib.ResetColor, i.Note,
lib.Blue, lib.ResetColor, *i.WorkspaceID,
lib.Blue, lib.ResetColor, *i.TaskID,
lib.Blue, lib.ResetColor, i.Description,
lib.Blue, lib.ResetColor, i.Details,
lib.Blue, lib.ResetColor, i.Remediation,
lib.Blue, lib.ResetColor, string(i.Request),
lib.Blue, lib.ResetColor, string(i.Response),
)
}
type GroupedIssue struct {
Title string `json:"title"`
Code string `json:"code"`
Count int `json:"count"`
Severity string `json:"severity"`
Items []*IssueItem `json:"items"`
}
type IssueItem struct {
ID uint `json:"id"`
URL string `json:"url"`
Confidence int `json:"confidence"`
}
// AddInteraction adds an interaction to an issue in the database.
func (i Issue) AddInteraction(interaction OOBInteraction) error {
return Connection.db.Model(&i).Association("Interactions").Append(&interaction)
}
// UpdateFalsePositive updates the FalsePositive attribute of an issue in the database.
func (i Issue) UpdateFalsePositive(value bool) error {
i.FalsePositive = value
return Connection.db.Model(&i).Update("false_positive", value).Error
}
func (i Issue) IsEmpty() bool {
return i.ID == 0
}
// IssueFilter represents available issue filters
type IssueFilter struct {
Codes []string
WorkspaceID uint
TaskID uint
TaskJobID uint
URL string
}
// ListIssues Lists issues
func (d *DatabaseConnection) ListIssues(filter IssueFilter) (issues []*Issue, count int64, err error) {
query := d.db
if len(filter.Codes) > 0 {
query = query.Where("code IN ?", filter.Codes)
}
if filter.WorkspaceID != 0 {
query = query.Where("workspace_id = ?", filter.WorkspaceID)
}
if filter.URL != "" {
query = query.Where("url = ?", filter.URL)
}
if filter.TaskID != 0 {
query = query.Where("task_id = ?", filter.TaskID)
}
if filter.TaskJobID != 0 {
query = query.Where("task_job_id = ?", filter.TaskJobID)
}
result := query.Order(severityOrderQuery).Order("title ASC, created_at DESC").Find(&issues).Count(&count)
if result.Error != nil {
err = result.Error
}
return issues, count, err
}
func (d *DatabaseConnection) ListIssuesGrouped(filter IssueFilter) ([]*GroupedIssue, error) {
var issues []Issue
query := d.db.Model(&Issue{}).Select("id, url, confidence, title, code, severity")
// Apply filters
if len(filter.Codes) > 0 {
query = query.Where("code IN ?", filter.Codes)
}
if filter.WorkspaceID != 0 {
query = query.Where("workspace_id = ?", filter.WorkspaceID)
}
if filter.TaskID != 0 {
query = query.Where("task_id = ?", filter.TaskID)
}
if filter.TaskJobID != 0 {
query = query.Where("task_job_id = ?", filter.TaskJobID)
}
// Execute the query
err := query.Find(&issues).Error
if err != nil {
return nil, err
}
// Post-process to build grouped structure
issueMap := make(map[string]*GroupedIssue)
for _, issue := range issues {
// Create a composite key from Code, Severity, and Title
key := issue.Code + "|" + issue.Severity.String() + "|" + issue.Title
grouped, exists := issueMap[key]
if !exists {
grouped = &GroupedIssue{
Title: issue.Title,
Code: issue.Code,
Severity: issue.Severity.String(),
Items: []*IssueItem{},
}
issueMap[key] = grouped
}
item := &IssueItem{
ID: issue.ID,
URL: issue.URL,
Confidence: issue.Confidence,
}
grouped.Items = append(grouped.Items, item)
grouped.Count = len(grouped.Items) // Update the count
}
var groupedIssues []*GroupedIssue
for _, v := range issueMap {
groupedIssues = append(groupedIssues, v)
}
sort.Slice(groupedIssues, func(i, j int) bool {
return GetSeverityOrder(groupedIssues[i].Severity) < GetSeverityOrder(groupedIssues[j].Severity)
})
return groupedIssues, nil
}
// ListIssuesGrouped Lists grouped issues
// func (d *DatabaseConnection) ListIssuesGrouped(filter IssueFilter) (issues []*GroupedIssue, err error) {
// query := d.db.Model(&Issue{}).Select("title, severity, code, COUNT(*)").Group("title,severity,code")
// query = query.Order(severityOrderQuery).Order("title ASC")
// if len(filter.Codes) > 0 {
// query = query.Where("code IN ?", filter.Codes)
// }
// if filter.WorkspaceID != 0 {
// query = query.Where("workspace_id = ?", filter.WorkspaceID)
// }
// if filter.TaskID != 0 {
// query = query.Where("task_id = ?", filter.TaskID)
// }
// if filter.TaskJobID != 0 {
// query = query.Where("task_job_id = ?", filter.TaskJobID)
// }
// err = query.Find(&issues).Error
// return issues, err
// }
// CreateIssue saves an issue to the database
func (d *DatabaseConnection) CreateIssue(issue Issue) (Issue, error) {
// result := d.db.Create(&issue)
if issue.TaskID != nil && *issue.TaskID == 0 {
issue.TaskID = nil
}
if issue.TaskJobID != nil && *issue.TaskJobID == 0 {
issue.TaskJobID = nil
}
result := d.db.FirstOrCreate(&issue, issue)
if result.Error != nil {
log.Error().Err(result.Error).Interface("issue", issue).Msg("Failed to create web issue")
}
return issue, result.Error
}
// GetIssue get a single issue by ID
func (d *DatabaseConnection) GetIssue(id int, includeRelated bool) (issue Issue, err error) {
query := d.db
if includeRelated {
query = query.Preload("Interactions").Preload("Requests")
}
err = query.First(&issue, id).Error
return issue, err
}