Skip to content

feat: add support for Data object for Service properties #1034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
saquibsaifee wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add support for Data object for Service properties #1034

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
468 changes: 458 additions & 10 deletions cyclonedx/model/service.py
View file
Open in desktop

Large diffs are not rendered by default.

19 changes: 15 additions & 4 deletions tests/_data/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
from cyclonedx.model import (
AttachedText,
Copyright,
DataClassification,
DataFlow,
Encoding,
ExternalReference,
Expand Down Expand Up @@ -106,7 +105,7 @@
)
from cyclonedx.model.lifecycle import LifecyclePhase, NamedLifecycle, PredefinedLifecycle
from cyclonedx.model.release_note import ReleaseNotes
from cyclonedx.model.service import Service
from cyclonedx.model.service import Data, DataGovernance, OrganizationOrIndividualType, Service
from cyclonedx.model.tool import Tool, ToolRepository
from cyclonedx.model.vulnerability import (
BomTarget,
Expand Down Expand Up @@ -626,7 +625,19 @@ def get_bom_with_services_complex() -> Bom:
XsUri('/api/thing/2')
],
authenticated=False, x_trust_boundary=True, data=[
DataClassification(flow=DataFlow.OUTBOUND, classification='public')
Data(
flow=DataFlow.OUTBOUND,
classification='public',
name='Credit card reporting',
description='Credit card information exchanged between the web app and the database',
governance=DataGovernance(
custodians=[OrganizationOrIndividualType(organization=get_org_entity_1())],
stewards=[OrganizationOrIndividualType(individual=get_org_contact_1())],
owners=[OrganizationOrIndividualType(organization=get_org_entity_1())],
),
source=[XsUri('https://0.0.0.0/source')],
destination=[XsUri('https://0.0.0.0/destination')],
)
],
licenses=[DisjunctiveLicense(name='Commercial')],
external_references=[
Expand Down Expand Up @@ -654,7 +665,7 @@ def get_bom_with_nested_services() -> Bom:
XsUri('/api/thing/2')
],
authenticated=False, x_trust_boundary=True, data=[
DataClassification(flow=DataFlow.OUTBOUND, classification='public')
Data(flow=DataFlow.OUTBOUND, classification='public')
],
licenses=[DisjunctiveLicense(name='Commercial')],
external_references=[
Expand Down
16 changes: 8 additions & 8 deletions tests/_data/snapshots/enum_DataFlow-1.2.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,20 @@
"bom-ref": "dummy",
"data": [
{
"classification": "BI_DIRECTIONAL",
"flow": "bi-directional"
"flow": "bi-directional",
"classification": "BI_DIRECTIONAL"
},
{
"classification": "INBOUND",
"flow": "inbound"
"flow": "inbound",
"classification": "INBOUND"
},
{
"classification": "OUTBOUND",
"flow": "outbound"
"flow": "outbound",
"classification": "OUTBOUND"
},
{
"classification": "UNKNOWN",
"flow": "unknown"
"flow": "unknown",
"classification": "UNKNOWN"
}
],
"name": "dummy"
Expand Down
16 changes: 8 additions & 8 deletions tests/_data/snapshots/enum_DataFlow-1.3.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,20 @@
"bom-ref": "dummy",
"data": [
{
"classification": "BI_DIRECTIONAL",
"flow": "bi-directional"
"flow": "bi-directional",
"classification": "BI_DIRECTIONAL"
},
{
"classification": "INBOUND",
"flow": "inbound"
"flow": "inbound",
"classification": "INBOUND"
},
{
"classification": "OUTBOUND",
"flow": "outbound"
"flow": "outbound",
"classification": "OUTBOUND"
},
{
"classification": "UNKNOWN",
"flow": "unknown"
"flow": "unknown",
"classification": "UNKNOWN"
}
],
"name": "dummy"
Expand Down
16 changes: 8 additions & 8 deletions tests/_data/snapshots/enum_DataFlow-1.4.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,20 @@
"bom-ref": "dummy",
"data": [
{
"classification": "BI_DIRECTIONAL",
"flow": "bi-directional"
"flow": "bi-directional",
"classification": "BI_DIRECTIONAL"
},
{
"classification": "INBOUND",
"flow": "inbound"
"flow": "inbound",
"classification": "INBOUND"
},
{
"classification": "OUTBOUND",
"flow": "outbound"
"flow": "outbound",
"classification": "OUTBOUND"
},
{
"classification": "UNKNOWN",
"flow": "unknown"
"flow": "unknown",
"classification": "UNKNOWN"
}
],
"name": "dummy"
Expand Down
16 changes: 8 additions & 8 deletions tests/_data/snapshots/enum_DataFlow-1.5.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,20 @@
"bom-ref": "dummy",
"data": [
{
"classification": "BI_DIRECTIONAL",
"flow": "bi-directional"
"flow": "bi-directional",
"classification": "BI_DIRECTIONAL"
},
{
"classification": "INBOUND",
"flow": "inbound"
"flow": "inbound",
"classification": "INBOUND"
},
{
"classification": "OUTBOUND",
"flow": "outbound"
"flow": "outbound",
"classification": "OUTBOUND"
},
{
"classification": "UNKNOWN",
"flow": "unknown"
"flow": "unknown",
"classification": "UNKNOWN"
}
],
"name": "dummy"
Expand Down
16 changes: 12 additions & 4 deletions tests/_data/snapshots/enum_DataFlow-1.5.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,18 @@
<service bom-ref="dummy">
<name>dummy</name>
<data>
<classification flow="bi-directional">BI_DIRECTIONAL</classification>
<classification flow="inbound">INBOUND</classification>
<classification flow="outbound">OUTBOUND</classification>
<classification flow="unknown">UNKNOWN</classification>
<dataflow>
<classification flow="bi-directional">BI_DIRECTIONAL</classification>
</dataflow>
<dataflow>
<classification flow="inbound">INBOUND</classification>
</dataflow>
<dataflow>
<classification flow="outbound">OUTBOUND</classification>
</dataflow>
<dataflow>
<classification flow="unknown">UNKNOWN</classification>
</dataflow>
</data>
</service>
</services>
Expand Down
16 changes: 8 additions & 8 deletions tests/_data/snapshots/enum_DataFlow-1.6.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,20 @@
"bom-ref": "dummy",
"data": [
{
"classification": "BI_DIRECTIONAL",
"flow": "bi-directional"
"flow": "bi-directional",
"classification": "BI_DIRECTIONAL"
},
{
"classification": "INBOUND",
"flow": "inbound"
"flow": "inbound",
"classification": "INBOUND"
},
{
"classification": "OUTBOUND",
"flow": "outbound"
"flow": "outbound",
"classification": "OUTBOUND"
},
{
"classification": "UNKNOWN",
"flow": "unknown"
"flow": "unknown",
"classification": "UNKNOWN"
}
],
"name": "dummy"
Expand Down
16 changes: 12 additions & 4 deletions tests/_data/snapshots/enum_DataFlow-1.6.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,18 @@
<service bom-ref="dummy">
<name>dummy</name>
<data>
<classification flow="bi-directional">BI_DIRECTIONAL</classification>
<classification flow="inbound">INBOUND</classification>
<classification flow="outbound">OUTBOUND</classification>
<classification flow="unknown">UNKNOWN</classification>
<dataflow>
<classification flow="bi-directional">BI_DIRECTIONAL</classification>
</dataflow>
<dataflow>
<classification flow="inbound">INBOUND</classification>
</dataflow>
<dataflow>
<classification flow="outbound">OUTBOUND</classification>
</dataflow>
<dataflow>
<classification flow="unknown">UNKNOWN</classification>
</dataflow>
</data>
</service>
</services>
Expand Down
16 changes: 8 additions & 8 deletions tests/_data/snapshots/enum_DataFlow-1.7.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,20 @@
"bom-ref": "dummy",
"data": [
{
"classification": "BI_DIRECTIONAL",
"flow": "bi-directional"
"flow": "bi-directional",
"classification": "BI_DIRECTIONAL"
},
{
"classification": "INBOUND",
"flow": "inbound"
"flow": "inbound",
"classification": "INBOUND"
},
{
"classification": "OUTBOUND",
"flow": "outbound"
"flow": "outbound",
"classification": "OUTBOUND"
},
{
"classification": "UNKNOWN",
"flow": "unknown"
"flow": "unknown",
"classification": "UNKNOWN"
}
],
"name": "dummy"
Expand Down
16 changes: 12 additions & 4 deletions tests/_data/snapshots/enum_DataFlow-1.7.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,18 @@
<service bom-ref="dummy">
<name>dummy</name>
<data>
<classification flow="bi-directional">BI_DIRECTIONAL</classification>
<classification flow="inbound">INBOUND</classification>
<classification flow="outbound">OUTBOUND</classification>
<classification flow="unknown">UNKNOWN</classification>
<dataflow>
<classification flow="bi-directional">BI_DIRECTIONAL</classification>
</dataflow>
<dataflow>
<classification flow="inbound">INBOUND</classification>
</dataflow>
<dataflow>
<classification flow="outbound">OUTBOUND</classification>
</dataflow>
<dataflow>
<classification flow="unknown">UNKNOWN</classification>
</dataflow>
</data>
</service>
</services>
Expand Down
4 changes: 2 additions & 2 deletions tests/_data/snapshots/get_bom_with_nested_services-1.2.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
"bom-ref": "my-specific-bom-ref-for-my-first-service",
"data": [
{
"classification": "public",
"flow": "outbound"
"flow": "outbound",
"classification": "public"
}
],
"description": "Description goes here",
Expand Down
4 changes: 2 additions & 2 deletions tests/_data/snapshots/get_bom_with_nested_services-1.3.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
"bom-ref": "my-specific-bom-ref-for-my-first-service",
"data": [
{
"classification": "public",
"flow": "outbound"
"flow": "outbound",
"classification": "public"
}
],
"description": "Description goes here",
Expand Down
4 changes: 2 additions & 2 deletions tests/_data/snapshots/get_bom_with_nested_services-1.4.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
"bom-ref": "my-specific-bom-ref-for-my-first-service",
"data": [
{
"classification": "public",
"flow": "outbound"
"flow": "outbound",
"classification": "public"
}
],
"description": "Description goes here",
Expand Down
4 changes: 2 additions & 2 deletions tests/_data/snapshots/get_bom_with_nested_services-1.5.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@
"bom-ref": "my-specific-bom-ref-for-my-first-service",
"data": [
{
"classification": "public",
"flow": "outbound"
"flow": "outbound",
"classification": "public"
}
],
"description": "Description goes here",
Expand Down
4 changes: 3 additions & 1 deletion tests/_data/snapshots/get_bom_with_nested_services-1.5.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,9 @@
<authenticated>false</authenticated>
<x-trust-boundary>true</x-trust-boundary>
<data>
<classification flow="outbound">public</classification>
<dataflow>
<classification flow="outbound">public</classification>
</dataflow>
</data>
<licenses>
<license>
Expand Down
4 changes: 2 additions & 2 deletions tests/_data/snapshots/get_bom_with_nested_services-1.6.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@
"bom-ref": "my-specific-bom-ref-for-my-first-service",
"data": [
{
"classification": "public",
"flow": "outbound"
"flow": "outbound",
"classification": "public"
}
],
"description": "Description goes here",
Expand Down
4 changes: 3 additions & 1 deletion tests/_data/snapshots/get_bom_with_nested_services-1.6.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@
<authenticated>false</authenticated>
<x-trust-boundary>true</x-trust-boundary>
<data>
<classification flow="outbound">public</classification>
<dataflow>
<classification flow="outbound">public</classification>
</dataflow>
</data>
<licenses>
<license>
Expand Down
4 changes: 2 additions & 2 deletions tests/_data/snapshots/get_bom_with_nested_services-1.7.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@
"bom-ref": "my-specific-bom-ref-for-my-first-service",
"data": [
{
"classification": "public",
"flow": "outbound"
"flow": "outbound",
"classification": "public"
}
],
"description": "Description goes here",
Expand Down
4 changes: 3 additions & 1 deletion tests/_data/snapshots/get_bom_with_nested_services-1.7.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,9 @@
<authenticated>false</authenticated>
<x-trust-boundary>true</x-trust-boundary>
<data>
<classification flow="outbound">public</classification>
<dataflow>
<classification flow="outbound">public</classification>
</dataflow>
</data>
<licenses>
<license>
Expand Down
4 changes: 2 additions & 2 deletions tests/_data/snapshots/get_bom_with_services_complex-1.2.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
"bom-ref": "my-specific-bom-ref-for-my-first-service",
"data": [
{
"classification": "public",
"flow": "outbound"
"flow": "outbound",
"classification": "public"
}
],
"description": "Description goes here",
Expand Down
Loading