-
Notifications
You must be signed in to change notification settings - Fork 1
/
report_artifacts_html.py
581 lines (449 loc) · 22.4 KB
/
report_artifacts_html.py
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
580
581
'''
Copyright 2021 Flexera Software LLC
See LICENSE.TXT for full license text
SPDX-License-Identifier: MIT
Author : sgeary
Created On : Fri Nov 05 2021
File : report_artifacts_html.py
'''
import logging
import os
import base64
import _version
logger = logging.getLogger(__name__)
#------------------------------------------------------------------#
def generate_html_report(reportData):
logger.info(" Entering generate_html_report")
reportName = reportData["reportName"]
projectName = reportData["projectName"]
reportFileNameBase = reportData["reportFileNameBase"]
reportTimeStamp = reportData["reportTimeStamp"]
vulnerabilityDetails = reportData["vulnerabilityDetails"]
projectList = reportData["projectList"]
projectSummaryData = reportData["projectSummaryData"]
applicationSummaryData = reportData["applicationSummaryData"]
cvssVersion = projectSummaryData["cvssVersion"] # 2.0/3.x
includeAssociatedFiles = projectSummaryData["includeAssociatedFiles"] #True/False
scriptDirectory = os.path.dirname(os.path.realpath(__file__))
cssFile = os.path.join(scriptDirectory, "common/branding/css/revenera_common.css")
logoImageFile = os.path.join(scriptDirectory, "common/branding/images/logo_reversed.svg")
iconFile = os.path.join(scriptDirectory, "common/branding/images/favicon-revenera.ico")
#########################################################
# Encode the image files
encodedLogoImage = encodeImage(logoImageFile)
encodedfaviconImage = encodeImage(iconFile)
htmlFile = reportFileNameBase + ".html"
#---------------------------------------------------------------------------------------------------
# Create a simple HTML file to display
#---------------------------------------------------------------------------------------------------
try:
html_ptr = open(htmlFile,"w", encoding="utf-8")
except:
logger.error(" Failed to open htmlfile %s:" %htmlFile)
raise
html_ptr.write("<html>\n")
html_ptr.write(" <head>\n")
html_ptr.write(" <!-- Required meta tags --> \n")
html_ptr.write(" <meta charset='utf-8'> \n")
html_ptr.write(" <meta name='viewport' content='width=device-width, initial-scale=1, shrink-to-fit=no'> \n")
html_ptr.write('''
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.1/css/bootstrap.min.css" integrity="sha384-VCmXjywReHh4PwowAiWNagnWcLhlEJLA5buUprzK8rxFgeH0kww/aWY76TfkUoSX" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.1.3/css/bootstrap.css">
<link rel="stylesheet" href="https://cdn.datatables.net/1.10.21/css/dataTables.bootstrap4.min.css">
''')
html_ptr.write(" <style>\n")
# Add the contents of the css file to the head block
try:
f_ptr = open(cssFile)
for line in f_ptr:
html_ptr.write(" %s" %line)
f_ptr.close()
except:
logger.error(" Unable to open %s" %cssFile)
print("Unable to open %s" %cssFile)
html_ptr.write(" </style>\n")
html_ptr.write(" <link rel='icon' type='image/png' href='data:image/png;base64, {}'>\n".format(encodedfaviconImage.decode('utf-8')))
html_ptr.write(" <title>%s</title>\n" %(reportName))
html_ptr.write(" </head>\n")
html_ptr.write("<body>\n")
html_ptr.write("<div class=\"container-fluid\">\n")
#---------------------------------------------------------------------------------------------------
# Report Header
#---------------------------------------------------------------------------------------------------
html_ptr.write("<!-- BEGIN HEADER -->\n")
html_ptr.write("<div class='header'>\n")
html_ptr.write(" <div class='logo'>\n")
html_ptr.write(" <img src='data:image/svg+xml;base64,{}' style='height: 5%;'>\n".format(encodedLogoImage.decode('utf-8')))
html_ptr.write(" </div>\n")
html_ptr.write("<div class='report-title'>%s</div>\n" %reportName)
html_ptr.write("</div>\n")
html_ptr.write("<!-- END HEADER -->\n")
#---------------------------------------------------------------------------------------------------
# Body of Report
#---------------------------------------------------------------------------------------------------
html_ptr.write("<!-- BEGIN BODY -->\n")
#######################################################################
# Create table to hold the application summary charts.
# js script itself is added later
html_ptr.write("<table id='applicationSummary' class='table' style='width:90%'>\n")
html_ptr.write(" <thead>\n")
html_ptr.write(" <tr>\n")
if len(projectList) > 1:
html_ptr.write(" <th colspan='8' class='text-center'><h4>Application Summary</h4></th>\n")
else:
html_ptr.write(" <th colspan='8' class='text-center'><h4>%s Summary</h4></th>\n" %projectName)
html_ptr.write(" </tr>\n")
html_ptr.write(" </thead>\n")
html_ptr.write("</table>\n")
html_ptr.write("<div class='container'>\n")
html_ptr.write(" <div class='row'>\n")
html_ptr.write(" <div class='col-sm'>\n")
html_ptr.write(" <canvas id='applicationVulnerabilities'></canvas>\n")
html_ptr.write(" </div>\n")
html_ptr.write(" </div>\n")
html_ptr.write("</div>\n")
# If there is some sort of hierarchy then show specific project summeries
if len(projectList) > 1:
# How much space to we need to give each canvas
# based on the amount of projects in the hierarchy
canvasHeight = len(projectList) * 30
# We need a minimum size to cover font as well
if canvasHeight < 180:
canvasHeight = 180
# The entire column needs to the vulnerability summary
columnHeight = canvasHeight
html_ptr.write("<hr class='small'>\n")
#######################################################################
# Create table to hold the project summary charts.
# js script itself is added later
html_ptr.write("<table id='projectSummary' class='table' style='width:90%'>\n")
html_ptr.write(" <thead>\n")
html_ptr.write(" <tr>\n")
html_ptr.write(" <th colspan='8' class='text-center'><h4>Project Summaries</h4></th>\n")
html_ptr.write(" </tr>\n")
html_ptr.write(" </thead>\n")
html_ptr.write("</table>\n")
html_ptr.write("<div class='container'>\n")
html_ptr.write(" <div class='row'>\n")
html_ptr.write(" <div class='col-sm'>\n")
html_ptr.write("<h6 class='gray' style='padding-top: 10px;'><center>Project Hierarchy</center></h6>")
html_ptr.write(" <div id='project_hierarchy'></div>\n")
html_ptr.write(" </div>\n")
html_ptr.write(" <div class='col-sm' style='height: %spx;'>\n" %(columnHeight) )
html_ptr.write(" <div class='col-sm' style='height: %spx'>\n"%(canvasHeight))
html_ptr.write(" <canvas id='projectVulnerabilities'></canvas>\n")
html_ptr.write(" </div>\n")
html_ptr.write(" </div>\n")
html_ptr.write(" </div>\n")
html_ptr.write("</div>\n")
html_ptr.write("<hr class='small'>")
html_ptr.write("<table id='vulnerabilityData' class='table table-hover table-sm row-border' style='width:90%'>\n")
html_ptr.write(" <thead>\n")
html_ptr.write(" <tr>\n")
if includeAssociatedFiles:
html_ptr.write(" <th colspan='10' class='text-center'><h4>Vulnerabilities</h4></th>\n")
else:
html_ptr.write(" <th colspan='9' class='text-center'><h4>Vulnerabilities</h4></th>\n")
html_ptr.write(" </tr>\n")
html_ptr.write(" <tr>\n")
html_ptr.write(" <th style='width: 15%' class='text-center'>VULNERABILITY</th>\n")
html_ptr.write(" <th style='width: 20%' class='text-center'>COMPONENT</th>\n")
if cvssVersion == "3.x":
html_ptr.write(" <th style='width: 5%; white-space:nowrap !important' class='text-center'>CVSS v3.x</th>\n")
else:
html_ptr.write(" <th style='width: 5%; white-space:nowrap !important' class='text-center'>CVSS v2.0</th>\n")
html_ptr.write(" <th style='width: 5%' class='text-center'>SEVERITY</th>\n")
if cvssVersion == "3.x":
html_ptr.write(" <th style='width: 5%' class='text-center'>CVSS v3.x VECTOR</th>\n")
else:
html_ptr.write(" <th style='width: 5%' class='text-center'>CVSS v2 VECTOR</th>\n")
html_ptr.write(" <th style='width: 5%' class='text-center'>SOURCE</th>\n")
html_ptr.write(" <th style='width: 5%' class='text-center'>PUBLISHED</th>\n")
html_ptr.write(" <th style='width: 5%' class='text-center'>LAST MODIFIED</th>\n")
html_ptr.write(" <th style='width: 40%' class='text-center'>DESCRIPTION</th>\n")
if includeAssociatedFiles:
html_ptr.write(" <th style='width: 40%' class='text-center'>ASSOCIATED FILES</th>\n")
html_ptr.write(" </tr>\n")
html_ptr.write(" </thead>\n")
html_ptr.write(" <tbody>\n")
for vulnerability in vulnerabilityDetails:
vulnerabilityDescription = vulnerabilityDetails[vulnerability]["vulnerabilityDescription"]
# Just in case there are any "tags" that need to be cleaned up
vulnerabilityDescription = vulnerabilityDescription.replace('<', '<').replace('>', '>')
vulnerabilitySource = vulnerabilityDetails[vulnerability]["vulnerabilitySource"]
vulnerabilityUrl = vulnerabilityDetails[vulnerability]["vulnerabilityUrl"]
vulnerabilitySeverity = vulnerabilityDetails[vulnerability]["vulnerabilitySeverity"]
vulnerabilityVector = vulnerabilityDetails[vulnerability]["vulnerabilityVector"]
vulnerabilityVectorLink = vulnerabilityDetails[vulnerability]["vulnerabilityVectorLink"]
vulnerabilityScore = vulnerabilityDetails[vulnerability]["vulnerabilityScore"]
publishedDate = vulnerabilityDetails[vulnerability]["publishedDate"]
modifiedDate = vulnerabilityDetails[vulnerability]["modifiedDate"]
if vulnerabilityScore == "N/A":
vulnerabilityScore = "-"
html_ptr.write("<td style=\"vertical-align:middle\"><a href=\"%s\" target=\"_blank\">%s</a></td>\n" %(vulnerabilityUrl, vulnerability))
affectedComponents = vulnerabilityDetails[vulnerability]["affectedComponents"]
html_ptr.write("<td style=\"vertical-align:middle\">")
# sort by componentName and then version
for affectedComponent in sorted(affectedComponents, key=lambda x: (x[1], x[2])):
inventoryID = affectedComponent[0]
componentName = affectedComponent[1]
componentVersionName = affectedComponent[2]
projectName = affectedComponent[3]
projectLink = affectedComponent[4]
inventoryItemLink = affectedComponent[5]
if includeAssociatedFiles:
associatedFiles = "\n".join(affectedComponent[6])
if len(projectList) > 1:
html_ptr.write("<a href=\"%s\" target=\"_blank\">%s - %s</a>\n" %(inventoryItemLink, componentName, componentVersionName))
html_ptr.write("<a href=\"%s\" target=\"_blank\"> (%s)</a><br>\n" %(projectLink, projectName))
else:
html_ptr.write("<a href=\"%s\" target=\"_blank\">%s - %s</a><br>\n" %(inventoryItemLink, componentName, componentVersionName))
html_ptr.write("</td>\n")
html_ptr.write("<td style=\"vertical-align:middle\" class='text-center' data-order=\"%s\"> <span class=\"btn btn-%s\">%s</span></td>\n" %(vulnerabilityScore, vulnerabilitySeverity.lower(), vulnerabilityScore))
html_ptr.write("<td style=\"vertical-align:middle\">%s</td>\n" %vulnerabilitySeverity)
if vulnerabilityVectorLink:
html_ptr.write("<td style=\"vertical-align:middle\"><a href=\"%s\" target=\"_blank\">%s</a></td>\n" %(vulnerabilityVectorLink, vulnerabilityVector))
else:
html_ptr.write("<td style=\"vertical-align:middle\">%s</td>\n" %vulnerabilityVector)
html_ptr.write("<td style=\"vertical-align:middle\">%s</td>\n" %vulnerabilitySource)
html_ptr.write("<td style=\"vertical-align:middle\">%s</td>\n" %publishedDate)
html_ptr.write("<td style=\"vertical-align:middle\">%s</td>\n" %modifiedDate)
html_ptr.write("<td style=\"vertical-align:middle\">%s</td>\n" %vulnerabilityDescription)
if includeAssociatedFiles:
html_ptr.write("<td style=\"vertical-align:middle\">%s</td>\n" %associatedFiles)
html_ptr.write("</tr>\n")
html_ptr.write(" </tbody>\n")
html_ptr.write("</table>\n")
html_ptr.write("<!-- END BODY -->\n")
#---------------------------------------------------------------------------------------------------
# Report Footer
#---------------------------------------------------------------------------------------------------
html_ptr.write("<!-- BEGIN FOOTER -->\n")
html_ptr.write("<div class='report-footer'>\n")
html_ptr.write(" <div style='float:right'>Generated on %s</div>\n" %reportTimeStamp)
html_ptr.write("<br>\n")
html_ptr.write(" <div style='float:right'>Report Version: %s</div>\n" %_version.__version__)
html_ptr.write("</div>\n")
html_ptr.write("<!-- END FOOTER -->\n")
html_ptr.write("</div>\n")
#---------------------------------------------------------------------------------------------------
# Add javascript
#---------------------------------------------------------------------------------------------------
html_ptr.write('''
<script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
<script src="https://cdn.datatables.net/1.10.21/js/jquery.dataTables.min.js"></script>
<script src="https://cdn.datatables.net/1.10.21/js/dataTables.bootstrap4.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jstree/3.3.10/jstree.min.js"></script>
''')
html_ptr.write("<script>\n")
html_ptr.write('''
$(document).ready(function (){
var table = $('#vulnerabilityData').DataTable({
"order": [[ 2, "desc" ]],
"lengthMenu": [ [25, 50, 100, -1], [25, 50, 100, "All"] ],
});
});
''')
# Add the common chartjs config
add_default_chart_options(html_ptr)
# Add the js for the application summary stacked bar charts
generate_application_summary_chart(html_ptr, applicationSummaryData)
if len(projectList) > 1:
# Add the js for the project summary stacked bar charts
generate_project_hierarchy_tree(html_ptr, projectList)
# Add the js for the project summary stacked bar charts
generate_project_summary_charts(html_ptr, projectSummaryData)
html_ptr.write("</script>\n")
html_ptr.write("</body>\n")
html_ptr.write("</html>\n")
html_ptr.close()
logger.info(" Exiting generate_html_report")
return htmlFile
####################################################################
def encodeImage(imageFile):
#############################################
# Create base64 variable for branding image
try:
with open(imageFile,"rb") as image:
encodedImage = base64.b64encode(image.read())
return encodedImage
except:
logger.error("Unable to open %s" %imageFile)
raise
#----------------------------------------------------------------------------------------#
def add_default_chart_options(html_ptr):
# Add commont defaults for display charts
html_ptr.write('''
var defaultBarChartOptions = {
responsive: true,
maintainAspectRatio: false,
layout: {
padding: {
bottom: 25 //set that fits the best
}
},
tooltips: {
enabled: true,
yAlign: 'center'
},
title: {
display: true,
fontColor: "#323E48"
},
scales: {
xAxes: [{
ticks: {
beginAtZero:true,
fontSize:11,
fontColor: "#323E48",
precision:0
},
scaleLabel:{
display:false
},
gridLines: {
},
stacked: true
}],
yAxes: [{
gridLines: {
display:false,
color: "#fff",
zeroLineColor: "#fff",
zeroLineWidth: 0,
fontColor: "#323E48"
},
ticks: {
fontSize:11,
fontColor: "#323E48"
},
stacked: true
}]
},
legend:{
display:false
},
}; ''')
#----------------------------------------------------------------------------------------#
def generate_application_summary_chart(html_ptr, applicationSummaryData):
logger.info(" Entering generate_application_summary_chart")
cvssVersion = applicationSummaryData["cvssVersion"]
html_ptr.write('''
var applicationVulnerabilities= document.getElementById("applicationVulnerabilities");
var applicationVulnerabilityChart = new Chart(applicationVulnerabilities, {
type: 'horizontalBar',
data: {
datasets: [''')
if cvssVersion == "3.x":
html_ptr.write(''' {
// Critical Vulnerabilities
label: 'Critical',
data: [%s],
backgroundColor: "#400000"
},''' %applicationSummaryData["numCriticalVulnerabilities"])
html_ptr.write('''
{
// High Vulnerabilities
label: 'High',
data: [%s],
backgroundColor: "#C00000"
},{
// Medium Vulnerabilities
label: 'Medium',
data: [%s],
backgroundColor: "#FFA500"
},{
// Low Vulnerabilities
label: 'Low',
data: [%s],
backgroundColor: "#FFFF00"
},{
// N/A Vulnerabilities
label: 'N/A',
data: [%s],
backgroundColor: "#D3D3D3"
},
]
},
options: defaultBarChartOptions,
});
applicationVulnerabilityChart.options.tooltips.titleFontSize = 0
''' %(applicationSummaryData["numHighVulnerabilities"], applicationSummaryData["numMediumVulnerabilities"], applicationSummaryData["numLowVulnerabilities"], applicationSummaryData["numNoneVulnerabilities"]) )
#----------------------------------------------------------------------------------------#
def generate_project_hierarchy_tree(html_ptr, projectHierarchy):
logger.info(" Entering generate_project_hierarchy_tree")
html_ptr.write('''var hierarchy = [\n''')
for project in projectHierarchy:
# is this the top most parent or a child project with a parent
if "uniqueID" in project:
projectIdentifier = project["uniqueID"]
else:
projectIdentifier = project["projectID"]
html_ptr.write('''{
'id': '%s',
'parent': '%s',
'text': '%s',
'a_attr': {
'href': '%s'
}
},\n''' %(projectIdentifier, project["parent"], project["projectName"], project["projectLink"]))
html_ptr.write('''\n]''')
html_ptr.write('''
$('#project_hierarchy').jstree({ 'core' : {
'data' : hierarchy
} });
$('#project_hierarchy').on('ready.jstree', function() {
$("#project_hierarchy").jstree("open_all");
$("#project_hierarchy").on("click", ".jstree-anchor", function(evt)
{
var link = $(evt.target).attr("href");
window.open(link, '_blank');
});
});
''' )
#----------------------------------------------------------------------------------------#
def generate_project_summary_charts(html_ptr, projectSummaryData):
logger.info(" Entering generate_project_summary_charts")
cvssVersion = projectSummaryData["cvssVersion"]
html_ptr.write('''
var projectVulnerabilities= document.getElementById("projectVulnerabilities");
var projectVulnerabilityChart = new Chart(projectVulnerabilities, {
type: 'horizontalBar',
data: {
labels: %s,
datasets: [''' %projectSummaryData["projectNames"])
if cvssVersion == "3.x":
html_ptr.write('''{
// Critical Vulnerabilities
label: 'Critical',
data: %s,
backgroundColor: "#400000"
},''' %projectSummaryData["numCriticalVulnerabilities"])
html_ptr.write('''{
// High Vulnerabilities
label: 'High',
data: %s,
backgroundColor: "#C00000"
},{
// Medium Vulnerabilities
label: 'Medium',
data: %s,
backgroundColor: "#FFA500"
},{
// Low Vulnerabilities
label: 'Low',
data: %s,
backgroundColor: "#FFFF00"
},{
// N/A Vulnerabilities
label: 'N/A',
data: %s,
backgroundColor: "#D3D3D3"
},
]
},
options: defaultBarChartOptions,
});
projectVulnerabilityChart.options.title.text = "Vulnerability Summary"
''' %( projectSummaryData["numHighVulnerabilities"], projectSummaryData["numMediumVulnerabilities"], projectSummaryData["numLowVulnerabilities"], projectSummaryData["numNoneVulnerabilities"]) )