-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathsunshine.py
1120 lines (926 loc) · 44.8 KB
/
sunshine.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
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import json
import argparse
import os
import html
import copy
VERSION = "0.9"
NAME = "Sunshine"
PREFERRED_VULNERABILITY_RATING_METHODS_ORDER = ["CVSSv4",
"CVSSv31"
"CVSSv3",
"CVSSv2",
"OWASP",
"SSVC",
"other"]
VALID_SEVERITIES = {"critical": 4,
"high": 3,
"medium": 2,
"low": 1,
"info": 0,
"information": 0,
"clean": -1}
GREY = '#bcbcbc'
GREEN = '#7dd491'
YELLOW = '#fccd58'
ORANGE = '#ff9335'
RED = '#ff4633'
DARK_RED = '#a10a0a'
LIGHT_BLUE = '#9fc5e8'
BASIC_STYLE = { "color": GREY, "borderWidth": 2 }
INFORMATION_STYLE = { "color": GREEN, "borderWidth": 2 }
LOW_STYLE = { "color": YELLOW, "borderWidth": 2 }
MEDIUM_STYLE = { "color": ORANGE, "borderWidth": 2 }
HIGH_STYLE = { "color": RED, "borderWidth": 2 }
CRITICAL_STYLE = { "color": DARK_RED, "borderWidth": 2 }
TRANSITIVE_VULN_STYLE = { "color": LIGHT_BLUE, "borderWidth": 2 }
STYLES = {"critical": CRITICAL_STYLE,
"high": HIGH_STYLE,
"medium": MEDIUM_STYLE,
"low": LOW_STYLE,
"information": INFORMATION_STYLE,
"clean": BASIC_STYLE}
HTML_TEMPLATE = """
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Sunshine - SBOM visualization tool</title>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css">
<link rel="stylesheet" href="https://cdn.datatables.net/1.13.7/css/dataTables.bootstrap5.min.css">
<script src="https://code.jquery.com/jquery-3.7.1.js"></script>
<script src="https://cdn.datatables.net/1.13.7/js/jquery.dataTables.min.js"></script>
<script src="https://cdn.datatables.net/1.13.7/js/dataTables.bootstrap5.min.js"></script>
<script src="https://cdn.datatables.net/buttons/2.4.2/js/dataTables.buttons.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jszip/3.10.1/jszip.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.2.8/pdfmake.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/pdfmake/0.2.8/vfs_fonts.js"></script>
<script src="https://cdn.datatables.net/buttons/2.4.2/js/buttons.html5.min.js"></script>
<script src="https://cdn.datatables.net/buttons/2.4.2/js/buttons.print.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js"></script>
<script src="https://fastly.jsdelivr.net/npm/[email protected]/dist/echarts.min.js"></script>
<style>
body {
margin: 20px;
height: 100vh;
background: linear-gradient(to right, #032c57, #1C538E);
}
#output {
white-space: pre-line;
background-color: #ffffff;
padding: 10px;
border: 1px solid #ddd;
border-radius: 4px;
margin-top: 10px;
font-family: "Courier New", "Lucida Console", monospace;
}
#chart-container {
background-color: #ffffff;
padding: 10px;
border: 1px solid #ddd;
border-radius: 4px;
position: relative;
}
#chart-container-inner {
background-color: #ffffff;
padding: 10px;
position: relative;
height: 90vh;
overflow: hidden;
}
#chart-container-placeholder {
background-color: #fffffF;
padding: 10px;
border: 1px solid #ddd;
border-radius: 4px;
}
#table-container {
background-color: #fffffF;
padding: 10px;
border: 1px solid #ddd;
border-radius: 4px;
}
#table-container-placeholder {
background-color: #fffffF;
padding: 10px;
border: 1px solid #ddd;
border-radius: 4px;
}
#upload-file-container {
background-color: #fffffF;
padding: 10px;
border: 1px solid #ddd;
border-radius: 4px;
}
#file-input {
margin: 20px;
}
.dataTables_filter {
display: none;
}
th input {
width: 100%;
box-sizing: border-box;
}
.dataTables_length {
padding-bottom: 10px !important;
}
.light-text {
color: #baccde;
}
.dt-buttons {
float: right;
}
.active>.page-link, .page-link.active {
background-color: #1C538E !important;
color: white !important;
}
.page-link {
color: #1C538E;
}
#components-table_paginate {
float: right;
margin-top: -33px;
}
.bg-dark-red {
background-color: #a10a0a;
color: white;
}
.bg-orange {
background-color: #ff9335;
color: white;
}
.bg-yellow {
background-color: #fccd58;
color: white;
}
.bg-light-blue {
background-color: #9fc5e8;
color: black;
}
#footer {
position: fixed;
bottom: 0;
left: 0;
width: 100%;
background-color: #032c57;
color: #baccde;
text-align: center;
z-index: 100000;
}
#footer a {
color: #baccde;
}
</style>
</head>
<body>
<h1 class="light-text">Sunshine - SBOM visualization tool</h1>
<br>
<div id="upload-file-container">
<span>Analyzed CycloneDX JSON file: <i><FILE_NAME_HERE></i></span>
</div>
<br><br>
<h3 class="light-text">Components chart</h3>
<div id="chart-container">
This chart visualizes components and their dependencies, with each segment representing a single component. The chart provides a hierarchical view of the dependency structure, with relationships radiating outward from the core components.<br>
<ul>
<li><b>Innermost circle:</b> represents components that are independent and not dependencies for any other components.</li>
<li><b>Outer circles:</b> each segment represents a dependency of the corresponding segment in the circle immediately inside it. The farther a segment is from the center, the deeper the dependency level.</li>
</ul>
<i>Note: If there is only one circle, it means that no dependency relationships are defined in the input file.</i>
<br><br>
The colors of the segments indicate the vulnerability status of the components:
<ul>
<li><b>Dark red:</b> affected by at least one critical severity vulnerability.</li>
<li><b>Red:</b> affected by at least one high severity vulnerability.</li>
<li><b>Orange:</b> affected by at least one medium severity vulnerability.</li>
<li><b>Yellow:</b> affected by at least one low severity vulnerability.</li>
<li><b>Green:</b> affected by at least one informational severity vulnerability.</li>
<li><b>Light blue:</b> not directly affected by vulnerabilities but has at least one vulnerable dependency.</li>
<li><b>Grey:</b> neither the component nor its dependencies are affected by any vulnerabilities.</li>
</ul>
The chart is interactive:
<ul>
<li><b>Hovering:</b> displays details about a component, including its name, version, and list of vulnerabilities.</li>
<li><b>Clicking:</b> refocuses the chart. The clicked segment becomes the center (second innermost circle), showing only that component and its dependencies. In this view, the innermost circle is always blue. Clicking the blue circle navigates back up one level in the dependency hierarchy.</li>
</ul>
<hr>
<div id="chart-container-inner"></div>
</div>
<br>
<h3 class="light-text">Components table</h3>
<div id="table-container">
This table visualizes components, their dependencies, vulnerabilities and licenses.<br>
The colors of the elements in columns "Component", "Depends on" and "Dependency of" indicate the vulnerability status of the components:
<ul>
<li><b>Dark red:</b> affected by at least one critical severity vulnerability.</li>
<li><b>Red:</b> affected by at least one high severity vulnerability.</li>
<li><b>Orange:</b> affected by at least one medium severity vulnerability.</li>
<li><b>Yellow:</b> affected by at least one low severity vulnerability.</li>
<li><b>Green:</b> affected by at least one informational severity vulnerability.</li>
<li><b>Light blue:</b> not directly affected by vulnerabilities but has at least one vulnerable dependency.</li>
<li><b>Grey:</b> neither the component nor its dependencies are affected by any vulnerabilities.</li>
</ul>
<br>
The colors of the elements in columns "Direct vulnerabilities" and "Transitive vulnerabilities" indicate the severity of the vulnerabilities:
<ul>
<li><b>Dark red:</b> critical.</li>
<li><b>Red:</b> high.</li>
<li><b>Orange:</b> medium.</li>
<li><b>Yellow:</b>low.</li>
<li><b>Green:</b>informational.</li>
</ul>
<hr><br>
<div id="table-container-inner">
<table id="components-table" class="table table-striped table-bordered" style="width:100%"><TABLE_HERE></table>
</div>
</div>
<script type="text/javascript">
var dom = document.getElementById('chart-container-inner');
var myChart = echarts.init(dom, null, {
renderer: 'canvas',
useDirtyRect: false
});
var app = {};
var option;
const data = <CHART_DATA_HERE>;
option = {
tooltip: {
formatter: function(params) {
return `${params.name}`;
},
},
series: {
radius: ['15%', '100%'],
type: 'sunburst',
sort: undefined,
emphasis: {
focus: 'ancestor'
},
data: data,
label: {
rotate: 'radial',
show: false
},
levels: []
}
};
if (option && typeof option === 'object') {
myChart.setOption(option);
}
window.addEventListener('resize', myChart.resize);
let table = $('#components-table').DataTable({
"order": [[ 1, "asc" ]],
pageLength: 10,
dom: 'Blfrtip',
lengthMenu: [
[10, 25, 50, -1],
[10, 25, 50, 'All']
],
buttons: [
{ extend: 'copy', className: 'btn btn-dark mb-3 btn-sm' },
{ extend: 'csv', className: 'btn btn-secondary mb-3 btn-sm' },
{ extend: 'excel', className: 'btn btn-success mb-3 btn-sm' },
{ extend: 'pdf', className: 'btn btn-danger mb-3 btn-sm' },
{ extend: 'print', className: 'btn btn-info mb-3 btn-sm' }
],
orderCellsTop: true,
"autoWidth": true
});
$('#components-table thead input').on('keyup change', function () {
let columnIndex = $(this).parent().index();
table.column(columnIndex).search(this.value).draw();
});
</script>
<br><br>
<div id="footer">Sunshine - SBOM visualization tool by <a href="https://www.linkedin.com/in/lucacapacci/">Luca Capacci</a> | <a href="https://github.com/lucacapacci/Sunshine/">GitHub repository</a> | <a href="https://github.com/lucacapacci/Sunshine/blob/main/LICENSE">License</a> | <a href="https://github.com/lucacapacci/Sunshine/blob/main/THIRD_PARTY_LICENSES">Third party licenses</a></div>
</body>
</html>
"""
def custom_print(text):
if __name__ == "__web__":
from js import writeToLog
writeToLog(text)
else:
print(text)
class SetEncoder(json.JSONEncoder):
def default(self, obj):
if isinstance(obj, set):
return list(obj)
return super().default(obj)
def create_fake_component(bom_ref):
return {"name": bom_ref,
"version": "-",
"type": "-",
"license": set(),
"depends_on": set(),
"dependency_of": set(),
"vulnerabilities": [],
"transitive_vulnerabilities": [],
"max_vulnerability_severity": "clean",
"has_transitive_vulnerabilities": False,
"visited": False}
def create_base_component(component):
new_component = {"name": component["name"],
"version": component["version"] if "version" in component else "-",
"type": component["type"] if "type" in component else "-",
"license": parse_licenses(component),
"depends_on": set(),
"dependency_of": set(),
"vulnerabilities": [],
"transitive_vulnerabilities": [],
"max_vulnerability_severity": "clean",
"has_transitive_vulnerabilities": False,
"visited": False}
return new_component
def get_severity_by_score(score):
score = float(score)
if score >= 9:
return "critical"
elif score >= 7:
return "high"
elif score >= 4:
return "medium"
elif score > 0:
return "low"
else:
return "information"
def parse_vulnerability_data(vulnerability):
vuln_id = vulnerability["id"]
vuln_severity = None
if "ratings" in vulnerability:
for rating in vulnerability["ratings"]:
if "method" not in rating:
continue
for preferred_rating_method in PREFERRED_VULNERABILITY_RATING_METHODS_ORDER:
if rating["method"] == preferred_rating_method:
if "severity" in rating:
rating_vuln_severity = rating["severity"]
if rating_vuln_severity.lower() in VALID_SEVERITIES:
if rating_vuln_severity.lower() == "info":
rating_vuln_severity = "information"
vuln_severity = rating_vuln_severity.lower()
break
if "score" in rating:
vuln_severity = get_severity_by_score(rating["score"])
break
if vuln_severity is None:
if "ratings" not in vulnerability:
custom_print(f"WARNING: vulnerability with id '{vulnerability['id']}' does not have a 'ratings' field. I'll set a default 'INFORMATION' severity...")
vuln_severity = get_severity_by_score(0)
elif len(vulnerability["ratings"]) == 0:
custom_print(f"WARNING: vulnerability with id '{vulnerability['id']}' does have an empty 'ratings' field. I'll set a default 'INFORMATION' severity...")
vuln_severity = get_severity_by_score(0)
else:
for rating in vulnerability["ratings"]:
if "severity" in rating:
rating_vuln_severity = rating["severity"]
if rating_vuln_severity.lower() in VALID_SEVERITIES:
vuln_severity = rating_vuln_severity.lower()
break
if "score" in rating:
vuln_severity = get_severity_by_score(rating["score"])
break
if vuln_severity is None:
custom_print(f"WARNING: could not detect severity of vulnerability with id '{vulnerability['id']}'. I'll set a default 'INFORMATION' severity...")
vuln_severity = get_severity_by_score(0)
return vuln_id, vuln_severity
def get_bom_ref(component_json, all_bom_refs):
if "bom-ref" in component_json:
bom_ref = component_json["bom-ref"]
else:
custom_print(f"WARNING: component with name '{component_json['name']}' and version '{component_json['version']}' does not have a 'bom-ref'. I'll search for a match...")
for potential_bom_ref in all_bom_refs:
guessed_name_01 = f'{component_json["name"]}@{component_json["version"]}'
guessed_name_02 = f'{component_json["name"]}::{component_json["version"]}'
guessed_name_03 = f'{component_json["name"]}:{component_json["version"]}'
for test in [guessed_name_01, guessed_name_02, guessed_name_03]:
if potential_bom_ref.endswith(f"/{test}"):
custom_print(f"Match found: {potential_bom_ref}")
return potential_bom_ref
if potential_bom_ref.endswith(f"/{test}:"):
custom_print(f"Match found: {potential_bom_ref}")
return potential_bom_ref
if potential_bom_ref.endswith(f":{test}"):
custom_print(f"Match found: {potential_bom_ref}")
return potential_bom_ref
if potential_bom_ref.endswith(f":{test}:"):
custom_print(f"Match found: {potential_bom_ref}")
return potential_bom_ref
# another try with version not in the end of the string
number_of_results = 0
result = None
for potential_bom_ref in all_bom_refs:
guessed_name_01 = f'{component_json["name"]}@{component_json["version"]}'
guessed_name_02 = f'{component_json["name"]}::{component_json["version"]}'
guessed_name_03 = f'{component_json["name"]}:{component_json["version"]}'
for test in [guessed_name_01, guessed_name_02, guessed_name_03]:
if f"/{test}:" in bom_ref:
number_of_results += 1
result = potential_bom_ref
elif f":{test}:" in bom_ref:
number_of_results += 1
result = potential_bom_ref
if number_of_results == 1: # I want just one result, otherwise it means the sbom is ambiguous and I can't make any educated guess
return result
custom_print(f"Match not found. I'll create a fake one.")
bom_ref = f"{hash(json.dumps(component_json, sort_keys=True, cls=SetEncoder))}"
return bom_ref
def create_or_update_bom_ref_entry(bom_refs, component):
if component["bom-ref"] not in bom_refs:
bom_refs[component["bom-ref"]] = {"name": component["name"] if "name" in component else "-",
"version": component["version"] if "version" in component else "-"}
else:
if bom_refs[component["bom-ref"]]["name"] == "-" and "name" in component:
bom_refs[component["bom-ref"]]["name"] = component["name"]
if bom_refs[component["bom-ref"]]["version"] == "-" and "version" in component:
bom_refs[component["bom-ref"]]["version"] = component["version"]
def normalize_bom_ref(bom_refs, bom_ref, only_valid_components=True):
for component_bom_ref, component_data in bom_refs.items():
if only_valid_components is False:
if bom_ref == component_bom_ref:
return bom_ref
else:
if bom_ref == component_bom_ref and component_data["name"] != "-" and component_data["version"] != "-":
return bom_ref
for component_bom_ref, component_data in bom_refs.items():
# look with version
guessed_name_01 = f'{component_data["name"]}@{component_data["version"]}'
guessed_name_02 = f'{component_data["name"]}::{component_data["version"]}'
guessed_name_03 = f'{component_data["name"]}:{component_data["version"]}'
for test in [guessed_name_01, guessed_name_02, guessed_name_03]:
if bom_ref.endswith(f"/{test}"):
return bom_ref
if bom_ref.endswith(f"/{test}:"):
return bom_ref
if bom_ref.endswith(f":{test}"):
return bom_ref
if bom_ref.endswith(f":{test}:"):
return bom_ref
# another try with version not in the end of the string
number_of_results = 0
result = None
for component_bom_ref, component_data in bom_refs.items():
guessed_name_01 = f'{component_data["name"]}@{component_data["version"]}'
guessed_name_02 = f'{component_data["name"]}::{component_data["version"]}'
guessed_name_03 = f'{component_data["name"]}:{component_data["version"]}'
for test in [guessed_name_01, guessed_name_02, guessed_name_03]:
if f"/{test}:" in bom_ref:
number_of_results += 1
result = component_bom_ref
elif f":{test}:" in bom_ref:
number_of_results += 1
result = component_bom_ref
if number_of_results == 1: # I want just one result, otherwise it means the sbom is ambiguous and I can't make any educated guess
return result
# final try: without version
number_of_results = 0
result = None
for component_bom_ref, component_data in bom_refs.items():
# look without version
if f'/{component_data["name"]}@' in bom_ref:
number_of_results += 1
result = component_bom_ref
elif f'/{component_data["name"]}:' in bom_ref:
number_of_results += 1
result = component_bom_ref
elif f':{component_data["name"]}:' in bom_ref:
number_of_results += 1
result = component_bom_ref
elif f':{component_data["name"]}@' in bom_ref:
number_of_results += 1
result = component_bom_ref
if number_of_results == 1: # I want just one result, otherwise it means the sbom is ambiguous and I can't make any educated guess
return result
return None
def has_bom_ref_components(bom_refs, bom_ref):
return normalize_bom_ref(bom_refs, bom_ref, only_valid_components=False) is not None
def add_nested_components(component, components, all_bom_refs):
for child_key in ["services", "components"]:
if child_key in component:
for sub_component in component[child_key]:
new_component = create_base_component(sub_component)
bom_ref = get_bom_ref(sub_component, all_bom_refs)
components[bom_ref] = new_component
add_nested_components(sub_component, components, all_bom_refs)
def detect_nested_bom_refs(component, bom_refs):
for child_key in ["services", "components"]:
if child_key in component:
for sub_component in component[child_key]:
if "bom-ref" in sub_component:
create_or_update_bom_ref_entry(bom_refs, sub_component)
def get_all_bom_refs(data):
bom_refs = {}
meta_bom_ref_is_used = False
root_keywords = []
if "components" in data:
root_keywords.append("components")
if "services" in data:
root_keywords.append("services")
for root_keyword in root_keywords:
for component in data[root_keyword]:
if "bom-ref" in component:
create_or_update_bom_ref_entry(bom_refs, component)
detect_nested_bom_refs(component, bom_refs)
for root_keyword in root_keywords:
for component in data[root_keyword]:
if "dependencies" in component:
for dependency in component["dependencies"]:
if "ref" in dependency:
create_or_update_bom_ref_entry(bom_refs, {"bom-ref": dependency["ref"]})
if "dependencies" in data:
for dependency in data["dependencies"]:
if "ref" in dependency:
create_or_update_bom_ref_entry(bom_refs, {"bom-ref": dependency["ref"]})
if "dependsOn" in dependency:
for depends_on in dependency["dependsOn"]:
create_or_update_bom_ref_entry(bom_refs, {"bom-ref": depends_on})
if "metadata" in data:
if "component" in data["metadata"]:
if "bom-ref" in data["metadata"]["component"]:
if has_bom_ref_components(bom_refs, data["metadata"]["component"]["bom-ref"]):
meta_bom_ref_is_used = True
create_or_update_bom_ref_entry(bom_refs, data["metadata"]["component"])
return bom_refs, meta_bom_ref_is_used
def parse_licenses(component):
licenses = set()
if "licenses" in component:
for license in component["licenses"]:
if "license" in license:
if "id" in license["license"]:
licenses.add(license["license"]["id"])
elif "name" in license["license"]:
licenses.add(license["license"]["name"])
return sorted(list(licenses))
def parse_json_data(data):
all_bom_refs, meta_bom_ref_is_used = get_all_bom_refs(data)
components = {}
root_keywords = []
if "components" in data:
root_keywords.append("components")
if "services" in data:
root_keywords.append("services")
if "metadata" in data:
if "component" in data["metadata"]:
component = data["metadata"]["component"]
if meta_bom_ref_is_used is True:
new_component = create_base_component(component)
bom_ref = get_bom_ref(component, all_bom_refs)
components[bom_ref] = new_component
for root_keyword in root_keywords:
for component in data[root_keyword]:
new_component = create_base_component(component)
bom_ref = get_bom_ref(component, all_bom_refs)
components[bom_ref] = new_component
add_nested_components(component, components, all_bom_refs)
# sometimes dependencies are declared inside a component, I'll check that now
for component in data[root_keyword]:
bom_ref = get_bom_ref(component, all_bom_refs)
if "dependencies" in component:
for dependency in component["dependencies"]:
depends_on = dependency["ref"]
if depends_on not in components:
custom_print(f"WARNING: 'ref' '{depends_on}' is used in 'dependencies' inside a component but it's not declared in 'components'. I'll search for a match...")
guessed_bom_ref = normalize_bom_ref(all_bom_refs, depends_on)
if guessed_bom_ref is None:
custom_print(f"Match not found. I'll create a fake one.")
components[depends_on] = create_fake_component(depends_on)
else:
custom_print(f"Match found: {guessed_bom_ref}")
depends_on = guessed_bom_ref
components[bom_ref]["depends_on"].add(depends_on)
components[depends_on]["dependency_of"].add(bom_ref)
# sometimes vulnerabilities are declared inside a component, I'll check that now
for component in data[root_keyword]:
bom_ref = get_bom_ref(component, all_bom_refs)
if "vulnerabilities" in component:
for vulnerability in component["vulnerabilities"]:
vuln_id, vuln_severity = parse_vulnerability_data(vulnerability)
vulnerability_data = {"id": vuln_id, "severity": vuln_severity}
if vulnerability_data not in components[bom_ref]["vulnerabilities"]:
components[bom_ref]["vulnerabilities"].append(vulnerability_data)
if VALID_SEVERITIES[vuln_severity] > VALID_SEVERITIES[components[bom_ref]["max_vulnerability_severity"]]:
components[bom_ref]["max_vulnerability_severity"] = vuln_severity
if "dependencies" in data:
for dependency in data["dependencies"]:
bom_ref = dependency["ref"]
if bom_ref not in components:
custom_print(f"WARNING: 'ref' '{bom_ref}' is used in 'dependencies' but it's not declared in 'components'. I'll search for a match...")
guessed_bom_ref = normalize_bom_ref(all_bom_refs, bom_ref)
if guessed_bom_ref is None:
custom_print(f"Match not found. I'll create a fake one.")
components[bom_ref] = create_fake_component(bom_ref)
else:
custom_print(f"Match found: {guessed_bom_ref}")
bom_ref = guessed_bom_ref
if "dependsOn" in dependency:
for depends_on in dependency["dependsOn"]:
if depends_on not in components:
custom_print(f"WARNING: 'dependsOn' '{depends_on}' is used in 'dependencies' but it's not declared in 'components'. I'll search for a match...")
guessed_bom_ref = normalize_bom_ref(all_bom_refs, depends_on)
if guessed_bom_ref is None:
custom_print(f"Match not found. I'll create a fake one.")
components[depends_on] = create_fake_component(depends_on)
else:
custom_print(f"Match found: {guessed_bom_ref}")
depends_on = guessed_bom_ref
components[bom_ref]["depends_on"].add(depends_on)
components[depends_on]["dependency_of"].add(bom_ref)
if "vulnerabilities" in data:
for vulnerability in data["vulnerabilities"]:
vuln_id, vuln_severity = parse_vulnerability_data(vulnerability)
for affects in vulnerability["affects"]:
bom_ref = affects["ref"]
if bom_ref not in components:
custom_print(f"WARNING: 'ref' '{bom_ref}' is used in 'vulnerabilities' but it's not declared in 'components'. I'll create a fake one.")
components[bom_ref] = create_fake_component(bom_ref)
vulnerability_data = {"id": vuln_id, "severity": vuln_severity}
if vulnerability_data not in components[bom_ref]["vulnerabilities"]:
components[bom_ref]["vulnerabilities"].append(vulnerability_data)
if VALID_SEVERITIES[vuln_severity] > VALID_SEVERITIES[components[bom_ref]["max_vulnerability_severity"]]:
components[bom_ref]["max_vulnerability_severity"] = vuln_severity
return components
def parse_string(input_string):
custom_print("Parsing input string...")
data = json.loads(input_string)
return parse_json_data(data)
def parse_file(input_file_path):
custom_print("Parsing input file...")
with open(input_file_path, 'r') as file:
data = json.load(file)
return parse_json_data(data)
def prepare_chart_element_name(component):
if component["version"] != "-":
name = f'{html.escape(component["name"])} <b>{html.escape(component["version"])}</b>'
else:
name = f'{html.escape(component["name"])}'
if len(component["vulnerabilities"]) > 0:
name += "<br><br>Vulnerabilities:<br>"
vulns = {}
for vulnerability in component["vulnerabilities"]:
vulns[f'<li>{html.escape(vulnerability["id"])} ({html.escape(vulnerability["severity"].title())})</li>'] = VALID_SEVERITIES[vulnerability["severity"]]
vulns = dict(sorted(vulns.items(), key=lambda item: (-item[1], item[0])))
vulns_to_be_shown = list(vulns.keys())
if len(vulns_to_be_shown) > 10:
vulns_to_be_shown = vulns_to_be_shown[:10]
vulns_to_be_shown.append("<li>...</li>")
name += "".join(vulns_to_be_shown)
if len(component["license"]) > 0:
if len(component["vulnerabilities"]) == 0:
name += "<br>"
name += "<br>License:<br>"
licenses = []
for license in component["license"]:
licenses.append(f'<li>{html.escape(license)}</li>')
if len(licenses) > 10:
licenses = licenses[:10]
licenses.append("<li>...</li>")
name += "".join(licenses)
return name
def determine_style(component):
if component["max_vulnerability_severity"] != "clean":
return STYLES[component["max_vulnerability_severity"]]
if component["has_transitive_vulnerabilities"] is True:
return TRANSITIVE_VULN_STYLE
else:
return STYLES[component["max_vulnerability_severity"]]
def add_transitive_vulnerabilities_to_component(component, vulnerabilities):
for vulnerability in vulnerabilities:
if vulnerability not in component["transitive_vulnerabilities"]:
component["transitive_vulnerabilities"].append(vulnerability)
def format_dependency_chain(parents_branch, depends_on):
parents_branch.append(depends_on)
return " --> ".join(parents_branch)
def get_children(components, component, parents):
children = []
value = 0
has_vulnerable_children_or_is_vulnerable = False
if len(component["vulnerabilities"]) > 0:
has_vulnerable_children_or_is_vulnerable = True
for depends_on in component["depends_on"]:
parents_branch = copy.deepcopy(parents)
child_name = prepare_chart_element_name(components[depends_on])
child_component = components[depends_on]
child_component["visited"] = True
if depends_on not in parents_branch: # this is done to avoid infinite recursion in case of circular dependencies
parents_branch.append(depends_on)
child_children, children_value, has_vulnerable_children_or_is_vulnerable = get_children(components, child_component, parents_branch)
if len(child_component["vulnerabilities"]) > 0 or child_component["has_transitive_vulnerabilities"] is True or has_vulnerable_children_or_is_vulnerable is True:
component["has_transitive_vulnerabilities"] = True
add_transitive_vulnerabilities_to_component(component, child_component["vulnerabilities"])
add_transitive_vulnerabilities_to_component(component, child_component["transitive_vulnerabilities"])
has_vulnerable_children_or_is_vulnerable = True
value += children_value
children.append({"name": child_name,
"children": child_children,
"value": children_value,
"itemStyle": determine_style(child_component)
})
else:
custom_print(f"WARNING: component with bom-ref '{depends_on}' may be a circular dependency. Dependency chain: {format_dependency_chain(parents_branch, depends_on)}")
value += 1
for child_depends_on in child_component["depends_on"]:
child_depends_on = components[child_depends_on]
if len(child_depends_on["vulnerabilities"]) > 0 or child_depends_on["has_transitive_vulnerabilities"] is True:
child_component["has_transitive_vulnerabilities"] = True
add_transitive_vulnerabilities_to_component(child_component, child_depends_on["vulnerabilities"])
add_transitive_vulnerabilities_to_component(child_component, child_depends_on["transitive_vulnerabilities"])
children.append({"name": child_name,
"children": [],
"value": 1,
"itemStyle": determine_style(child_component)
})
if value == 0:
value = 1
return children, value, has_vulnerable_children_or_is_vulnerable
def add_root_component(components, component, data, bom_ref):
component["visited"] = True
parents = [bom_ref]
root_name = prepare_chart_element_name(component)
root_children, root_value, has_vulnerable_children_or_is_vulnerable = get_children(components, component, parents)
if has_vulnerable_children_or_is_vulnerable is True:
component["has_transitive_vulnerabilities"] = True
for depends_on in component["depends_on"]:
child = components[depends_on]
add_transitive_vulnerabilities_to_component(component, child["vulnerabilities"])
add_transitive_vulnerabilities_to_component(component, child["transitive_vulnerabilities"])
new_element = {"name": root_name,
"children": root_children,
"value": root_value,
"itemStyle": determine_style(component)
}
data.append(new_element)
def build_echarts_data(components):
data = []
for bom_ref, component in components.items():
if len(component["dependency_of"]) != 0:
continue
add_root_component(components, component, data, bom_ref)
return data
def double_check_if_all_components_were_taken_into_account(components, echart_data):
# this should happen only for circular dependencies
for bom_ref, component in components.items():
if component["visited"] is False:
add_root_component(components, component, echart_data, bom_ref)
def component_badge_for_table(component):
component_on_display = ""
if component["max_vulnerability_severity"] == "critical":
badge_class = 'bg-dark-red'
elif component["max_vulnerability_severity"] == "high":
badge_class = 'bg-danger'
elif component["max_vulnerability_severity"] == "medium":
badge_class = 'bg-orange'
elif component["max_vulnerability_severity"] == "low":
badge_class = 'bg-yellow'
elif component["max_vulnerability_severity"] in ["information", "info"]:
badge_class = 'bg-success'
elif component["max_vulnerability_severity"] == "clean":
if component["has_transitive_vulnerabilities"]:
badge_class = 'bg-light-blue'
else:
badge_class = 'bg-secondary'
component_on_display += f'<span class="badge {badge_class}">' + html.escape(component["name"])
if component["version"] != "-":
component_on_display += " " + html.escape(component["version"])
return component_on_display + "</span>"
def vulnerability_badge_for_table(component, key="vulnerabilities"):
vulns = {}
for vulnerability in component[key]:
if vulnerability["severity"] == "critical":
badge_class = 'bg-dark-red'
elif vulnerability["severity"] == "high":
badge_class = 'bg-danger'
elif vulnerability["severity"] == "medium":
badge_class = 'bg-orange'
elif vulnerability["severity"] == "low":
badge_class = 'bg-yellow'
elif vulnerability["severity"] in ["information", "info"]:
badge_class = 'bg-success'
vulns[f'<span class="badge {badge_class}">{html.escape(vulnerability["severity"].title())} → {html.escape(vulnerability["id"])}</span>'] = VALID_SEVERITIES[vulnerability["severity"]]
vulns = vulns = dict(sorted(vulns.items(), key=lambda item: (-item[1], item[0])))
vulns_to_be_shown = list(vulns.keys())
return vulns_to_be_shown
def license_badge_for_table(component):
licenses = []
for license in component["license"]:
licenses.append(f'<span class="badge border border-dark text-dark">{html.escape(license)}</span>')
return licenses
def build_table_content(components):
rows = ["""<thead>
<tr>
<th>Component</th>
<th>Depends on</th>
<th>Dependency of</th>
<th>Direct <br>vulnerabilities</th>
<th>Transitive <br>vulnerabilities</th>
<th>License</th>
</tr>
<tr>
<th><input type="text" placeholder="Search Component" class="form-control search-in-table"></th>
<th><input type="text" placeholder="Search Depends on" class="form-control search-in-table"></th>
<th><input type="text" placeholder="Search Dependency of" class="form-control search-in-table"></th>
<th><input type="text" placeholder="Search Direct vulnerabilities" class="form-control search-in-table"></th>
<th><input type="text" placeholder="Search Transitive vulnerabilities" class="form-control search-in-table"></th>
<th><input type="text" placeholder="Search License" class="form-control search-in-table"></th>
</tr>
</thead>"""]
rows.append("<tbody>")
for bom_ref, component in components.items():
new_row = "<tr>"
new_row += "<td>" + component_badge_for_table(component) + "</td>"
if len(component["depends_on"]) == 0:
new_row += "<td>-</td>"
else:
new_row += "<td>"
depends_on_components_list = []
for depends_on in component["depends_on"]:
component_depends_on = components[depends_on]
component_depends_on_display = component_badge_for_table(component_depends_on)