-
Notifications
You must be signed in to change notification settings - Fork 0
/
querymerge.go
579 lines (524 loc) · 17.3 KB
/
querymerge.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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
package CxSASTClientGo
import (
"bufio"
"fmt"
"regexp"
"slices"
"strconv"
"strings"
"time"
"github.com/pkg/errors"
)
func (q *Query) MergeDependencies(other *Query) {
for _, qid := range other.Dependencies {
if !slices.Contains(q.Dependencies, qid) {
q.Dependencies = append(q.Dependencies, qid)
}
}
for _, qid := range other.CustomDependencies {
if !slices.Contains(q.CustomDependencies, qid) {
q.CustomDependencies = append(q.CustomDependencies, qid)
}
}
for _, qid := range other.UnknownCalls {
if !slices.Contains(q.UnknownCalls, qid) {
q.UnknownCalls = append(q.UnknownCalls, qid)
}
}
}
// Merges all team-level queries in the source query's inheritance chain
func (qc QueryCollection) MakeMergedTeamQuery(source *Query, destName string, teamsById *map[uint64]Team) (*Query, error) {
merger := QueryMerger{}
var owner string
q := source
mergeString := []string{}
newQuery := *source
for {
team, ok := (*teamsById)[q.OwningGroup.OwningTeamID]
if !ok {
break
}
owner = team.String()
merger.Insert(q, owner)
mergeString = append(mergeString, fmt.Sprintf(" - %v", q.StringDetailed()))
newQuery.MergeDependencies(q)
if q.BaseQueryID != q.QueryID {
q = qc.GetQueryByID(q.BaseQueryID)
if q.OwningGroup.PackageType != TEAM_QUERY {
break
}
} else {
break
}
}
if len(mergeString) <= 1 && destName == source.Name {
//e.Logger.Tracef("No queries to merge, returning original")
return source, nil
}
code, err := merger.Merge(destName)
if err != nil {
return source, err
}
newQuery.Source = code
return &newQuery, nil
}
const STATUS_OK = 0 // All good
const STATUS_REMERGE = 1 // Detected query code merged before, this is dangerous and must be reported or logged
// const STATUS_BROKEN_CHAIN = 1 // Detected broken chains (base.<x> not called), fixed
// const STATUS_ASSIGNMENT = 2 // Detected base assignments not to result (xvar = base.<x>), fixed
const STATUS_EMPTY = 8 // No queries to process
const STATUS_INVALID = 9 // Invalid content for processing
type CxQuery struct {
SourceCode string
QueryId uint64
QueryName string
Language string
PackageId uint64
PackageName string
Severity int
Level string
TeamOrProjId uint64
TeamOrProjName string
// For internal use
tag string
callsbase bool
issafe bool
}
type QueryMerger []CxQuery
// Gets a list of queries
func Merger() *QueryMerger {
return &QueryMerger{}
}
// Append a new query code to the end of the queries list to be processed
func (q *QueryMerger) Add(query *Query, owner string) {
// Compose the query element
var owningId uint64
if query.OwningGroup.OwningProjectID > 0 {
owningId = query.OwningGroup.OwningProjectID
} else {
owningId = query.OwningGroup.OwningTeamID
}
var qqry = q.constructqueryrecord(query.Source, query.QueryID, query.Name, query.Language, query.OwningGroup.PackageID, query.Group, query.Severity, query.OwningGroup.PackageType, owningId, owner)
// Add the query to the list
*q = append(*q, qqry)
}
// Insert a new query code at the top of the queries list to be processed
func (q *QueryMerger) Insert(query *Query, owner string) {
// Compose the query element
var owningId uint64
if query.OwningGroup.OwningProjectID > 0 {
owningId = query.OwningGroup.OwningProjectID
} else {
owningId = query.OwningGroup.OwningTeamID
}
var qqry = q.constructqueryrecord(query.Source, query.QueryID, query.Name, query.Language, query.OwningGroup.PackageID, query.Group, query.Severity, query.OwningGroup.PackageType, owningId, owner)
// Insert at the top od the list
*q = append([]CxQuery{qqry}, *q...)
}
// Clears the queries list (slice), to be ready for the next processing
func (q *QueryMerger) Clear() {
if len(*q) > 0 {
*q = nil
}
}
// Count the number of queries in queries list
func (q *QueryMerger) Count() int {
return len(*q)
}
// Removes the last query on the list
func (q *QueryMerger) Delete() {
if q.Count() > 0 {
*q = QueryMerger(*q)[:q.Count()-1]
}
}
// Retrieves a query object from list given its index
func (q *QueryMerger) Query(index int) (xquery CxQuery, err error) {
if index < 0 || index > q.Count()-1 {
return CxQuery{}, errors.New("Query index out of bounds")
}
return QueryMerger(*q)[index], nil
}
// Gets the last ververity or the highest severity from the queries list
func (q *QueryMerger) Severity(highest bool) int {
var severity = 0
var querieslist QueryMerger = *q
for i := range querieslist {
qry := querieslist[i]
if (!highest) || (qry.Severity > severity) {
severity = qry.Severity
}
}
return severity
}
// Initialize CxQuery
func (q *QueryMerger) constructqueryrecord(sourcecode string, queryid uint64, queryname string, language string, packageid uint64, packagename string, severity int, level string, teamorprojid uint64, teamorprojname string) CxQuery {
// Ensure same query name and language are the same
var qtimestamp time.Time = time.Now()
// Trim strings (never know what's comming)
var qqueryname = strings.TrimSpace(queryname)
var qlanguage = strings.TrimSpace(language)
var qpackagename = strings.TrimSpace(packagename)
var qteamorprojname = strings.TrimSpace(teamorprojname)
// Severity
var qseverity = ""
switch severity {
case 0:
qseverity = "0 - Info"
case 1:
qseverity = "1 - Low"
case 2:
qseverity = "2 - Medium"
case 3:
qseverity = "3 - High"
default:
qseverity = "Invalid (" + strconv.Itoa(severity) + ")"
}
// Compose the tag
var qtag = "// ======================================================\n"
switch level {
case CORP_QUERY:
qtag = qtag + "// MERGED - CORPORATE LEVEL\n"
case TEAM_QUERY:
qtag = qtag + "// MERGED - TEAM LEVEL\n"
qtag = qtag + "// TEAM: " + strconv.FormatUint(teamorprojid, 10) + " - " + qteamorprojname + "\n"
case PROJECT_QUERY:
qtag = qtag + "// MERGED - PROJECT LEVEL\n"
qtag = qtag + "// PROJECT: " + strconv.FormatUint(teamorprojid, 10) + " - " + qteamorprojname + "\n"
}
qtag = qtag + "// QUERY: " + strconv.FormatUint(queryid, 10) + " - " + qqueryname + "\n"
qtag = qtag + "// LANGUAGE: " + qlanguage + "\n"
qtag = qtag + "// PACKAGE: " + strconv.FormatUint(packageid, 10) + " - " + qpackagename + "\n"
qtag = qtag + "// SEVERITY: " + qseverity + "\n"
qtag = qtag + "// TIMESTAMP: " + qtimestamp.Format("01-02-2006 15:04:05.000000") + "\n"
qtag = qtag + "// ======================================================\n"
var qqry = CxQuery{sourcecode, queryid, qqueryname, qlanguage, packageid, qpackagename, severity, level, teamorprojid, qteamorprojname, qtag, false, true}
return qqry
}
// Find word in an array of words, private
func wordindex(vs []string, t string, prefixed bool) int {
for i, v := range vs {
if prefixed {
if strings.HasPrefix(v, t) {
return i
}
} else {
if v == t {
return i
}
}
}
return -1
}
// Indent the code, and comment it if needed, private
func arrangecode(sourcecode string, commented bool) string {
var xcode string = ""
var xline string
var xorig string = strings.TrimSpace(sourcecode)
scanner := bufio.NewScanner(strings.NewReader(xorig))
for scanner.Scan() {
xline = scanner.Text()
if commented {
xcode = xcode + "\t//NO-BASE//\t " + xline + "\n"
} else {
xcode = xcode + "\t" + xline + "\n"
}
}
return xcode
}
// Get code without comments, private
func uncommentedcode(sourcecode string) string {
// C style comments
var ccmt1 = regexp.MustCompile(`/\*([^*]|[\r\n]|(\*+([^*/]|[\r\n])))*\*+/`)
// C++ style comments
var ccmt2 = regexp.MustCompile(`//.*`)
// Holder
var rawbytes []byte
rawbytes = ccmt1.ReplaceAll([]byte(sourcecode), []byte(""))
rawbytes = ccmt2.ReplaceAll(rawbytes, []byte(""))
return string(rawbytes)
}
// Check if the code calls base.<queryname> in a recongized way, private
func codecallsbase(sourcecode string, qname string) (qcallsbase bool, qissafe bool) {
var callsbase bool = false
var issafe bool = true
var uncommented = uncommentedcode(sourcecode)
// Check base invocation
var thebase = "base." + qname + "()"
callsbase = strings.Contains(uncommented, thebase)
// Check for assignments that will indicate danger suggesting code needs fix or manual review
// Such as assignement to a variable that is not "result"
// The patterns recognized as VALID are:
// result = base.<queryname>
// result= base.<queryname>
// result =base.<queryname>
// result=base.<queryname>
if callsbase {
var found bool = strings.Contains(uncommented, "result="+thebase)
if !found {
var pos = strings.Index(uncommented, thebase) + len(thebase) + 10
if pos >= len(uncommented) {
pos = len(uncommented) - 1
}
var xtext = uncommented[:pos]
// Remove unwanted escaped chars
xtext = strings.ReplaceAll(xtext, "\n", " ")
xtext = strings.ReplaceAll(xtext, "\r", " ")
xtext = strings.ReplaceAll(xtext, "\t", " ")
xtext = strings.ReplaceAll(xtext, "\b", " ")
var words = strings.Split(xtext, " ")
pos = wordindex(words, thebase, true)
// Check for direct assignment
found = ((pos >= 2) && (words[pos-2] == "result") && (words[pos-1] == "=")) || ((pos >= 1) && (words[pos-1] == "result="))
// Last chance
if !found {
pos = 0
for {
if pos > len(words)-2 {
break
}
if words[pos] == "result" && strings.HasPrefix(words[pos-1], "="+thebase) {
found = true
break
}
pos++
}
}
}
if !found {
issafe = false
}
}
return callsbase, issafe
}
// Merge the all queries in list into a single query
func (q *QueryMerger) merge_queries(destqueryname string) (qquerycode string, qstatus int, qstatusmessage string) {
var status int = STATUS_OK
var statusmessage string = ""
var result string = ""
var querycount int = 0
var querieslist QueryMerger = *q
var index int
var firstindex int = 0
var extratag string
var querycode string
var queryinject string
var sbase string
var xbase string
var xresult string
var xcounter int
var xqueryname string
var xdestqueryname string
// Precheck status
status, statusmessage = q.validate_queries_struct()
// Check we have some queries
if len(*q) == 0 {
result = ""
status = STATUS_EMPTY
return result, status, statusmessage
}
// Get query name from first query
xqueryname = querieslist[0].QueryName
xdestqueryname = destqueryname
if destqueryname == "" {
xdestqueryname = xqueryname
}
// If only one query, aggegation and identation are not needed
if len(querieslist) == 1 {
qry := &querieslist[0]
extratag = ""
querycode = qry.SourceCode
// If query name changed, must ensure the right base.<newname> is being called/referred
if xqueryname != xdestqueryname {
extratag = extratag + "// QUERY RENAMED FROM " + xqueryname + " TO " + xdestqueryname + "\n"
extratag = extratag + "// ======================================================= \n"
querycode = strings.Replace(querycode, "base."+xqueryname+"()", "base."+xdestqueryname+"()", -1)
}
result = qry.tag + extratag + "\n" + querycode + "\n"
status = STATUS_OK
return result, status, statusmessage
}
// Analyze query code for:
// - Broken chain, base.<queryname> not called
// - Unhandled code, base.<queryname> is not assigned to "result" directly
index = 0
for i := range querieslist {
qry := &querieslist[i]
qry.callsbase, qry.issafe = codecallsbase(qry.SourceCode, qry.QueryName)
if !(qry.callsbase) {
firstindex = index
}
index++
}
// Inject code fixes into the queries
for i := range querieslist {
qry := &querieslist[i]
extratag = ""
querycode = qry.SourceCode
if result != "" {
result = result + "\n\n\n"
}
// If query name changed, must ensure the right base.<newname> is being called/referred
if xqueryname != xdestqueryname {
extratag = extratag + "// QUERY RENAMED FROM " + xqueryname + " TO " + xdestqueryname + "\n"
querycode = strings.Replace(querycode, "base."+xqueryname+"()", "base."+xdestqueryname+"()", -1)
}
// Other injections are not relevant for the first query in the chain. Only for the next
if querycount >= firstindex {
if !(qry.callsbase) {
extratag = extratag + "// BASE CALL CHAIN BROKEN - QUERY DOES NOT CALL BASE\n"
} else if !(qry.issafe) {
extratag = extratag + "// DIRECT RESULT ASSIGNMENT UNDETECTED - result = base.<x> \n"
}
}
if extratag != "" {
extratag = extratag + "// ======================================================= \n"
}
// Now check fixes
if querycount > firstindex {
if !(qry.callsbase) {
queryinject = "\n"
queryinject = queryinject + "// ---------- >> AUTO ADDED BY MERGE\n"
queryinject = queryinject + "result.Clear();\n"
queryinject = queryinject + "// << ---------- AUTO ADDED BY MERGE\n\n"
querycode = queryinject + querycode
} else if !(qry.issafe) {
sbase = "base." + xdestqueryname + "()"
xbase = "_merged_base_" + xdestqueryname
xcounter = 0
xresult = xbase
for {
if !(strings.Contains(querycode, xresult)) {
break
}
xcounter++
xresult = xbase + strconv.Itoa(xcounter)
}
// Inject the fix in the code ...
querycode = strings.Replace(querycode, sbase, xresult, -1)
queryinject = "\n"
queryinject = queryinject + "// ---------- >> AUTO ADDED BY MERGE\n"
queryinject = queryinject + "CxList " + xresult + " = result.Clone();\n"
queryinject = queryinject + "result.Clear();\n"
queryinject = queryinject + "// << ---------- AUTO ADDED BY MERGE\n\n"
querycode = queryinject + querycode
} else {
sbase = "base." + xdestqueryname + "()"
querycode = strings.Replace(querycode, sbase, "result", -1)
}
}
result = result + qry.tag + extratag + "{\n" + arrangecode(querycode, (querycount < firstindex)) + "\n}"
querycount++
}
return result, status, statusmessage
}
// Validate if the
func (q *QueryMerger) validate_queries_struct() (status int, message string) {
var querieslist QueryMerger = *q
var queryremerge bool
var queryname string
var querylang string
//var queryteam string
// No queries to process
if len(querieslist) < 1 {
return STATUS_EMPTY, "Cannot process an empty set of queries"
}
queryname = querieslist[0].QueryName
querylang = querieslist[0].Language
//queryteam = querieslist[0].TeamOrProjName
// Detect if this query is a remerge
if strings.Contains(querieslist[0].SourceCode, "// MERGED - PROJECT LEVEL\n") || strings.Contains(querieslist[0].SourceCode, "// MERGED - TEAM LEVEL\n") || strings.Contains(querieslist[0].SourceCode, "// MERGED - CORPORATE LEVEL\n") {
queryremerge = true
} else {
queryremerge = false
}
// If only one query, we can go
if len(querieslist) == 1 {
// Query severity must be between 0 and 3
if querieslist[0].Severity < 0 || querieslist[0].Severity > 3 {
return STATUS_INVALID, "Query severity out of range"
} else {
if queryremerge {
return STATUS_REMERGE, ""
} else {
return STATUS_OK, ""
}
}
}
// Corp level queries can't be used in aggregation
for i := range querieslist {
// Query name must be the same
if querieslist[i].QueryName != queryname {
return STATUS_INVALID, "Query name must be the same"
}
// Query language must be the same
if querieslist[i].Language != querylang {
return STATUS_INVALID, "Query language must be the same"
}
// Query severity must be between 0 and 3
if querieslist[i].Severity < 0 || querieslist[i].Severity > 3 {
return STATUS_INVALID, "Query severity out of range"
}
// Corp level queries can't be used in aggregation
if querieslist[i].Level == CORP_QUERY {
return STATUS_INVALID, "Corp level queries cannot be merged"
}
// Project level query in aggregation must be unique and the last on the list
if querieslist[i].Level == PROJECT_QUERY && i < len(querieslist)-1 {
return STATUS_INVALID, "Project level query must be the last on the list"
}
// Check team sequence
/*if querieslist[i].Level == TEAM_QUERY {
if strings.HasPrefix(querieslist[i].TeamOrProjName, queryteam) {
queryteam = querieslist[i].TeamOrProjName
} else {
return STATUS_INVALID, "Team level query not in same tree hierachy"
}
}*/
}
if queryremerge {
return STATUS_REMERGE, ""
} else {
return STATUS_OK, ""
}
}
// Merge the list of queries int a singe code
// Parameter:
// - destqueryname to detect and process query renames
// use an empty string if this check is not needed
// Example:
// JS: Potentially_Vulnerable_To_Xsrf in v9.3
// Found as Potentially_Vulnerable_To_CSRF in v9.5.5 and CXONE
//
// Returns:
// - qquerycode the merged query code
// - qstatus the status of the merged query
func (q *QueryMerger) Merge(destqueryname string) (qquerycode string, err error) {
var xstatus int = STATUS_OK
var xstatusmessage string = ""
var xresult string
xresult, xstatus, xstatusmessage = q.merge_queries(destqueryname)
if xstatus > STATUS_REMERGE {
return xresult, errors.New(xstatusmessage)
} else {
return xresult, nil
}
}
// Helper funtion to check the contents
func (q *QueryMerger) CheckStatus() (status int, message string) {
var xstatus int
var xstatusmessage string
xstatus, xstatusmessage = q.validate_queries_struct()
return xstatus, xstatusmessage
}
// Helper funtion to get CxQL code without comments
// Returns:
// - quncommentedcode the uncommented and merged query code
// It does not check for errors, just deliver the uncommented code
func (q *QueryMerger) UncommentedCode() (quncommentedcode string) {
var xresult string
xresult, _, _ = q.merge_queries("")
if xresult != "" {
xresult = uncommentedcode(xresult)
}
return xresult
}