forked from CycloneDX/cyclonedx-python-lib
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtest_output_json.py
394 lines (368 loc) · 20.3 KB
/
test_output_json.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
# encoding: utf-8
# This file is part of CycloneDX Python Lib
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# Copyright (c) OWASP Foundation. All Rights Reserved.
import base64
from decimal import Decimal
from datetime import datetime, timezone
from os.path import dirname, join
from packageurl import PackageURL
from cyclonedx.model import Encoding, ExternalReference, ExternalReferenceType, HashType, LicenseChoice, Note, \
NoteText, OrganizationalContact, OrganizationalEntity, Property, Tool, XsUri
from cyclonedx.model.bom import Bom
from cyclonedx.model.component import Component, ComponentType
from cyclonedx.model.issue import IssueClassification, IssueType
from cyclonedx.model.release_note import ReleaseNotes
from cyclonedx.model.vulnerability import ImpactAnalysisState, ImpactAnalysisJustification, ImpactAnalysisResponse, \
ImpactAnalysisAffectedStatus, Vulnerability, VulnerabilityCredits, VulnerabilityRating, VulnerabilitySeverity, \
VulnerabilitySource, VulnerabilityScoreSource, VulnerabilityAdvisory, VulnerabilityReference, \
VulnerabilityAnalysis, BomTarget, BomTargetVersionRange
from cyclonedx.output import get_instance, OutputFormat, SchemaVersion
from cyclonedx.output.json import Json, JsonV1Dot4, JsonV1Dot3, JsonV1Dot2
from tests.base import BaseJsonTestCase
class TestOutputJson(BaseJsonTestCase):
def test_simple_bom_v1_4(self) -> None:
bom = Bom()
c = Component(
name='setuptools', version='50.3.2', bom_ref='pkg:pypi/[email protected]?extension=tar.gz',
purl=PackageURL(
type='pypi', name='setuptools', version='50.3.2', qualifiers='extension=tar.gz'
)
)
bom.add_component(c)
outputter = get_instance(bom=bom, output_format=OutputFormat.JSON, schema_version=SchemaVersion.V1_4)
self.assertIsInstance(outputter, JsonV1Dot4)
with open(join(dirname(__file__), 'fixtures/bom_v1.4_setuptools.json')) as expected_json:
self.assertValidAgainstSchema(bom_json=outputter.output_as_string(), schema_version=SchemaVersion.V1_4)
self.assertEqualJsonBom(expected_json.read(), outputter.output_as_string())
expected_json.close()
def test_simple_bom_v1_3(self) -> None:
bom = Bom()
c = Component(
name='setuptools', version='50.3.2', bom_ref='pkg:pypi/[email protected]?extension=tar.gz',
purl=PackageURL(
type='pypi', name='setuptools', version='50.3.2', qualifiers='extension=tar.gz'
), license_str='MIT License'
)
bom.add_component(c)
outputter = get_instance(bom=bom, output_format=OutputFormat.JSON)
self.assertIsInstance(outputter, JsonV1Dot3)
with open(join(dirname(__file__), 'fixtures/bom_v1.3_setuptools.json')) as expected_json:
self.assertValidAgainstSchema(bom_json=outputter.output_as_string(), schema_version=SchemaVersion.V1_3)
self.assertEqualJsonBom(expected_json.read(), outputter.output_as_string())
expected_json.close()
def test_simple_bom_v1_2(self) -> None:
bom = Bom()
bom.add_component(
Component(
name='setuptools', version='50.3.2', bom_ref='pkg:pypi/[email protected]?extension=tar.gz',
purl=PackageURL(
type='pypi', name='setuptools', version='50.3.2', qualifiers='extension=tar.gz'
), author='Test Author'
)
)
outputter = get_instance(bom=bom, output_format=OutputFormat.JSON, schema_version=SchemaVersion.V1_2)
self.assertIsInstance(outputter, JsonV1Dot2)
with open(join(dirname(__file__), 'fixtures/bom_v1.2_setuptools.json')) as expected_json:
self.assertValidAgainstSchema(bom_json=outputter.output_as_string(), schema_version=SchemaVersion.V1_2)
self.assertEqualJsonBom(expected_json.read(), outputter.output_as_string())
expected_json.close()
def test_simple_bom_v1_4_with_cpe(self) -> None:
bom = Bom()
c = Component(
name='setuptools', version='50.3.2', bom_ref='pkg:pypi/[email protected]?extension=tar.gz',
cpe='cpe:2.3:a:python:setuptools:50.3.2:*:*:*:*:*:*:*',
purl=PackageURL(
type='pypi', name='setuptools', version='50.3.2', qualifiers='extension=tar.gz'
)
)
bom.add_component(c)
outputter = get_instance(bom=bom, output_format=OutputFormat.JSON, schema_version=SchemaVersion.V1_4)
self.assertIsInstance(outputter, JsonV1Dot4)
with open(join(dirname(__file__), 'fixtures/bom_v1.4_setuptools_with_cpe.json')) as expected_json:
self.assertValidAgainstSchema(bom_json=outputter.output_as_string(), schema_version=SchemaVersion.V1_4)
self.assertEqualJsonBom(expected_json.read(), outputter.output_as_string())
expected_json.close()
def test_simple_bom_v1_3_with_cpe(self) -> None:
bom = Bom()
c = Component(
name='setuptools', version='50.3.2', bom_ref='pkg:pypi/[email protected]?extension=tar.gz',
cpe='cpe:2.3:a:python:setuptools:50.3.2:*:*:*:*:*:*:*',
purl=PackageURL(
type='pypi', name='setuptools', version='50.3.2', qualifiers='extension=tar.gz'
), license_str='MIT License'
)
bom.add_component(c)
outputter = get_instance(bom=bom, output_format=OutputFormat.JSON)
self.assertIsInstance(outputter, JsonV1Dot3)
with open(join(dirname(__file__), 'fixtures/bom_v1.3_setuptools_with_cpe.json')) as expected_json:
self.assertValidAgainstSchema(bom_json=outputter.output_as_string(), schema_version=SchemaVersion.V1_3)
self.assertEqualJsonBom(expected_json.read(), outputter.output_as_string())
expected_json.close()
def test_simple_bom_v1_2_with_cpe(self) -> None:
bom = Bom()
bom.add_component(
Component(
name='setuptools', version='50.3.2', bom_ref='pkg:pypi/[email protected]?extension=tar.gz',
cpe='cpe:2.3:a:python:setuptools:50.3.2:*:*:*:*:*:*:*',
purl=PackageURL(
type='pypi', name='setuptools', version='50.3.2', qualifiers='extension=tar.gz'
), author='Test Author'
)
)
outputter = get_instance(bom=bom, output_format=OutputFormat.JSON, schema_version=SchemaVersion.V1_2)
self.assertIsInstance(outputter, JsonV1Dot2)
with open(join(dirname(__file__), 'fixtures/bom_v1.2_setuptools_with_cpe.json')) as expected_json:
self.assertValidAgainstSchema(bom_json=outputter.output_as_string(), schema_version=SchemaVersion.V1_2)
self.assertEqualJsonBom(expected_json.read(), outputter.output_as_string())
expected_json.close()
def test_bom_v1_3_with_component_hashes(self) -> None:
bom = Bom()
c = Component(
name='toml', version='0.10.2', bom_ref='pkg:pypi/[email protected]?extension=tar.gz',
purl=PackageURL(
type='pypi', name='toml', version='0.10.2', qualifiers='extension=tar.gz'
)
)
c.add_hash(
HashType.from_composite_str('sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b')
)
bom.add_component(c)
outputter: Json = get_instance(bom=bom, output_format=OutputFormat.JSON)
self.assertIsInstance(outputter, JsonV1Dot3)
with open(join(dirname(__file__), 'fixtures/bom_v1.3_toml_with_component_hashes.json')) as expected_json:
self.assertValidAgainstSchema(bom_json=outputter.output_as_string(), schema_version=SchemaVersion.V1_3)
self.assertEqualJsonBom(a=outputter.output_as_string(), b=expected_json.read())
expected_json.close()
def test_bom_v1_3_with_component_external_references(self) -> None:
bom = Bom()
c = Component(
name='toml', version='0.10.2', bom_ref='pkg:pypi/[email protected]?extension=tar.gz',
purl=PackageURL(
type='pypi', name='toml', version='0.10.2', qualifiers='extension=tar.gz'
)
)
c.add_hash(
HashType.from_composite_str('sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b')
)
c.add_external_reference(
ExternalReference(
reference_type=ExternalReferenceType.DISTRIBUTION,
url='https://cyclonedx.org',
comment='No comment',
hashes=[
HashType.from_composite_str(
'sha256:806143ae5bfb6a3c6e736a764057db0e6a0e05e338b5630894a5f779cabb4f9b')
]
)
)
bom.add_component(c)
outputter: Json = get_instance(bom=bom, output_format=OutputFormat.JSON)
self.assertIsInstance(outputter, JsonV1Dot3)
with open(join(dirname(__file__),
'fixtures/bom_v1.3_toml_with_component_external_references.json')) as expected_json:
self.assertValidAgainstSchema(bom_json=outputter.output_as_string(), schema_version=SchemaVersion.V1_3)
self.assertEqualJsonBom(a=outputter.output_as_string(), b=expected_json.read())
expected_json.close()
def test_bom_v1_3_with_component_license(self) -> None:
bom = Bom()
c = Component(
name='toml', version='0.10.2', bom_ref='pkg:pypi/[email protected]?extension=tar.gz',
purl=PackageURL(
type='pypi', name='toml', version='0.10.2', qualifiers='extension=tar.gz'
), license_str='MIT License'
)
bom.add_component(c)
outputter: Json = get_instance(bom=bom, output_format=OutputFormat.JSON)
self.assertIsInstance(outputter, JsonV1Dot3)
with open(join(dirname(__file__),
'fixtures/bom_v1.3_toml_with_component_license.json')) as expected_json:
self.assertValidAgainstSchema(bom_json=outputter.output_as_string(), schema_version=SchemaVersion.V1_3)
self.assertEqualJsonBom(a=outputter.output_as_string(), b=expected_json.read())
expected_json.close()
def test_bom_v1_4_no_component_version(self) -> None:
bom = Bom()
c = Component(
name='setuptools', bom_ref='pkg:pypi/setuptools?extension=tar.gz',
purl=PackageURL(
type='pypi', name='setuptools', qualifiers='extension=tar.gz'
)
)
bom.add_component(c)
outputter = get_instance(bom=bom, output_format=OutputFormat.JSON, schema_version=SchemaVersion.V1_4)
self.assertIsInstance(outputter, JsonV1Dot4)
with open(join(dirname(__file__), 'fixtures/bom_v1.4_setuptools_no_version.json')) as expected_json:
self.assertValidAgainstSchema(bom_json=outputter.output_as_string(), schema_version=SchemaVersion.V1_4)
self.assertEqualJsonBom(expected_json.read(), outputter.output_as_string())
expected_json.close()
def test_with_component_release_notes_pre_1_4(self) -> None:
bom = Bom()
c = Component(
name='setuptools', version='50.3.2', bom_ref='pkg:pypi/[email protected]?extension=tar.gz',
purl=PackageURL(
type='pypi', name='setuptools', version='50.3.2', qualifiers='extension=tar.gz'
), release_notes=ReleaseNotes(type='major'), licenses=[LicenseChoice(license_expression='MIT License')]
)
bom.add_component(c)
outputter: Json = get_instance(bom=bom, output_format=OutputFormat.JSON, schema_version=SchemaVersion.V1_3)
self.assertIsInstance(outputter, JsonV1Dot3)
with open(join(dirname(__file__), 'fixtures/bom_v1.3_setuptools.json')) as expected_json:
self.assertValidAgainstSchema(bom_json=outputter.output_as_string(), schema_version=SchemaVersion.V1_3)
self.assertEqualJsonBom(expected_json.read(), outputter.output_as_string())
expected_json.close()
def test_with_component_release_notes_post_1_4(self) -> None:
bom = Bom()
timestamp: datetime = datetime(2021, 12, 31, 10, 0, 0, 0).replace(tzinfo=timezone.utc)
text_content: str = base64.b64encode(
bytes('Some simple plain text', encoding='UTF-8')
).decode(encoding='UTF-8')
c = Component(
name='setuptools', version='50.3.2', bom_ref='pkg:pypi/[email protected]?extension=tar.gz',
purl=PackageURL(
type='pypi', name='setuptools', version='50.3.2', qualifiers='extension=tar.gz'
),
release_notes=ReleaseNotes(
type='major', title="Release Notes Title",
featured_image=XsUri('https://cyclonedx.org/theme/assets/images/CycloneDX-Twitter-Card.png'),
social_image=XsUri('https://cyclonedx.org/cyclonedx-icon.png'),
description="This release is a test release", timestamp=timestamp,
aliases=[
"First Test Release"
],
tags=['test', 'alpha'],
resolves=[
IssueType(
classification=IssueClassification.SECURITY, id='CVE-2021-44228', name='Apache Log3Shell',
description='Apache Log4j2 2.0-beta9 through 2.12.1 and 2.13.0 through 2.15.0 JNDI features...',
source_name='NVD', source_url=XsUri('https://nvd.nist.gov/vuln/detail/CVE-2021-44228'),
references=[
XsUri('https://logging.apache.org/log4j/2.x/security.html'),
XsUri('https://central.sonatype.org/news/20211213_log4shell_help')
]
)
],
notes=[
Note(
text=NoteText(
content=text_content, content_type='text/plain; charset=UTF-8',
content_encoding=Encoding.BASE_64
), locale='en-GB'
),
Note(
text=NoteText(
content=text_content, content_type='text/plain; charset=UTF-8',
content_encoding=Encoding.BASE_64
), locale='en-US'
)
],
properties=[
Property(name='key1', value='val1'),
Property(name='key2', value='val2')
]
)
)
bom.add_component(c)
outputter: Json = get_instance(bom=bom, output_format=OutputFormat.JSON, schema_version=SchemaVersion.V1_4)
self.assertIsInstance(outputter, JsonV1Dot4)
with open(join(dirname(__file__),
'fixtures/bom_v1.4_setuptools_with_release_notes.json')) as expected_json:
self.assertValidAgainstSchema(bom_json=outputter.output_as_string(), schema_version=SchemaVersion.V1_3)
self.assertEqualJsonBom(expected_json.read(), outputter.output_as_string())
expected_json.close()
def test_simple_bom_v1_4_with_vulnerabilities(self) -> None:
bom = Bom()
nvd = VulnerabilitySource(name='NVD', url=XsUri('https://nvd.nist.gov/vuln/detail/CVE-2018-7489'))
owasp = VulnerabilitySource(name='OWASP', url=XsUri('https://owasp.org'))
c = Component(
name='setuptools', version='50.3.2', bom_ref='pkg:pypi/[email protected]?extension=tar.gz',
purl=PackageURL(
type='pypi', name='setuptools', version='50.3.2', qualifiers='extension=tar.gz'
)
)
c.add_vulnerability(Vulnerability(
bom_ref='my-vuln-ref-1', id='CVE-2018-7489', source=nvd,
references=[
VulnerabilityReference(id='SOME-OTHER-ID', source=VulnerabilitySource(
name='OSS Index', url=XsUri('https://ossindex.sonatype.org/component/pkg:pypi/setuptools')
))
],
ratings=[
VulnerabilityRating(
source=nvd, score=Decimal(9.8), severity=VulnerabilitySeverity.CRITICAL,
method=VulnerabilityScoreSource.CVSS_V3,
vector='AN/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H', justification='Some justification'
),
VulnerabilityRating(
source=owasp, score=Decimal(2.7), severity=VulnerabilitySeverity.LOW,
method=VulnerabilityScoreSource.CVSS_V3,
vector='AV:L/AC:H/PR:N/UI:R/S:C/C:L/I:N/A:N', justification='Some other justification'
)
],
cwes=[22, 33], description='A description here', detail='Some detail here',
recommendation='Upgrade',
advisories=[
VulnerabilityAdvisory(url=XsUri('https://nvd.nist.gov/vuln/detail/CVE-2018-7489')),
VulnerabilityAdvisory(url=XsUri('http://www.securitytracker.com/id/1040693'))
],
created=datetime(year=2021, month=9, day=1, hour=10, minute=50, second=42, microsecond=51979,
tzinfo=timezone.utc),
published=datetime(year=2021, month=9, day=2, hour=10, minute=50, second=42, microsecond=51979,
tzinfo=timezone.utc),
updated=datetime(year=2021, month=9, day=3, hour=10, minute=50, second=42, microsecond=51979,
tzinfo=timezone.utc),
credits=VulnerabilityCredits(
organizations=[
OrganizationalEntity(
name='CycloneDX', urls=[XsUri('https://cyclonedx.org')], contacts=[
OrganizationalContact(name='Paul Horton', email='[email protected]'),
OrganizationalContact(name='A N Other', email='[email protected]',
phone='+44 (0)1234 567890')
]
)
],
individuals=[
OrganizationalContact(name='A N Other', email='[email protected]', phone='+44 (0)1234 567890'),
]
),
tools=[
Tool(vendor='CycloneDX', name='cyclonedx-python-lib')
],
analysis=VulnerabilityAnalysis(
state=ImpactAnalysisState.EXPLOITABLE, justification=ImpactAnalysisJustification.REQUIRES_ENVIRONMENT,
responses=[ImpactAnalysisResponse.CAN_NOT_FIX], detail='Some extra detail'
),
affects_targets=[
BomTarget(ref=c.purl or c.to_package_url().to_string(), versions=[
BomTargetVersionRange(version_range='49.0.0 - 54.0.0', status=ImpactAnalysisAffectedStatus.AFFECTED)
])
]
))
bom.add_component(c)
outputter: Json = get_instance(bom=bom, output_format=OutputFormat.JSON, schema_version=SchemaVersion.V1_4)
self.assertIsInstance(outputter, JsonV1Dot4)
with open(join(dirname(__file__), 'fixtures/bom_v1.4_setuptools_with_vulnerabilities.json')) as expected_json:
self.assertValidAgainstSchema(bom_json=outputter.output_as_string(), schema_version=SchemaVersion.V1_4)
self.assertEqualJsonBom(expected_json.read(), outputter.output_as_string())
expected_json.close()
def test_bom_v1_3_with_metadata_component(self) -> None:
bom = Bom()
bom.metadata.component = Component(
name='cyclonedx-python-lib', version='1.0.0', component_type=ComponentType.LIBRARY)
outputter = get_instance(bom=bom, output_format=OutputFormat.JSON)
self.assertIsInstance(outputter, JsonV1Dot3)
with open(join(dirname(__file__), 'fixtures/bom_v1.3_with_metadata_component.json')) as expected_json:
self.assertEqualJsonBom(outputter.output_as_string(), expected_json.read())
maxDiff = None