Skip to content

feat: add properties for licenses according to CycloneDX 1.5 #947

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

Merged
jkowalleck merged 1 commit into from
Mar 17, 2026
Merged

feat: add properties for licenses according to CycloneDX 1.5 #947

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
36 changes: 24 additions & 12 deletions cyclonedx/model/license.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
License related things
"""

from collections.abc import Iterable
from enum import Enum
from json import loads as json_loads
from typing import TYPE_CHECKING, Any, Optional, Union
Expand All @@ -34,7 +35,7 @@
from ..exception.model import MutuallyExclusivePropertiesException
from ..exception.serialization import CycloneDxDeserializationException
from ..schema.schema import SchemaVersion1Dot5, SchemaVersion1Dot6, SchemaVersion1Dot7
from . import AttachedText, XsUri
from . import AttachedText, Property, XsUri
from .bom_ref import BomRef


Expand Down Expand Up @@ -85,6 +86,7 @@ def __init__(
id: Optional[str] = None, name: Optional[str] = None,
text: Optional[AttachedText] = None, url: Optional[XsUri] = None,
acknowledgement: Optional[LicenseAcknowledgement] = None,
properties: Optional[Iterable[Property]] = None,
) -> None:
if not id and not name:
raise MutuallyExclusivePropertiesException('Either `id` or `name` MUST be supplied')
Expand All @@ -99,6 +101,7 @@ def __init__(
self._text = text
self._url = url
self._acknowledgement = acknowledgement
self._properties = SortedSet(properties or [])

@property
@serializable.view(SchemaVersion1Dot5)
Expand Down Expand Up @@ -200,17 +203,25 @@ def url(self, url: Optional[XsUri]) -> None:
# def licensing(self, ...) -> None:
# ... # TODO since CDX1.5

# @property
# ...
# @serializable.view(SchemaVersion1Dot5)
# @serializable.view(SchemaVersion1Dot6)
# @serializable.xml_sequence(6)
# def properties(self) -> ...:
# ... # TODO since CDX1.5
#
# @licensing.setter
# def properties(self, ...) -> None:
# ... # TODO since CDX1.5
@property
@serializable.view(SchemaVersion1Dot5)
@serializable.view(SchemaVersion1Dot6)
@serializable.view(SchemaVersion1Dot7)
@serializable.xml_array(serializable.XmlArraySerializationType.NESTED, 'property')
@serializable.xml_sequence(6)
def properties(self) -> 'SortedSet[Property]':
"""
Provides the ability to document properties in a key/value store. This provides flexibility to include data not
officially supported in the standard without having to use additional namespaces or create extensions.

Return:
Set of `Property`
"""
return self._properties

@properties.setter
def properties(self, properties: Iterable[Property]) -> None:
self._properties = SortedSet(properties)

@property
@serializable.view(SchemaVersion1Dot6)
Expand Down Expand Up @@ -245,6 +256,7 @@ def __comparable_tuple(self) -> _ComparableTuple:
self._url,
self._text,
self._bom_ref.value,
_ComparableTuple(self._properties),
))

def __eq__(self, other: object) -> bool:
Expand Down
8 changes: 8 additions & 0 deletions tests/_data/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1082,6 +1082,14 @@ def get_bom_with_licenses() -> Bom:
DisjunctiveLicense(name='some additional',
text=AttachedText(content='this is additional license text')),
]),
Component(name='c-with-license-properties', type=ComponentType.LIBRARY, bom_ref='C4',
licenses=[
DisjunctiveLicense(id='Apache-2.0',
properties=[Property(name='key1', value='val1'),
Property(name='key2', value='val2')]),
DisjunctiveLicense(name='some other license',
properties=[Property(name='myname', value='proprietary')]),
]),
],
services=[
Service(name='s-with-expression', bom_ref='S1',
Expand Down
5 changes: 5 additions & 0 deletions tests/_data/snapshots/get_bom_with_licenses-1.0.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@
<version/>
<modified>false</modified>
</component>
<component type="library">
<name>c-with-license-properties</name>
<version/>
<modified>false</modified>
</component>
<component type="library">
<name>c-with-name</name>
<version/>
Expand Down
12 changes: 12 additions & 0 deletions tests/_data/snapshots/get_bom_with_licenses-1.1.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,18 @@
<expression>Apache-2.0 OR MIT</expression>
</licenses>
</component>
<component type="library" bom-ref="C4">
<name>c-with-license-properties</name>
<version/>
<licenses>
<license>
<id>Apache-2.0</id>
</license>
<license>
<name>some other license</name>
</license>
</licenses>
</component>
<component type="library" bom-ref="C3">
<name>c-with-name</name>
<version/>
Expand Down
21 changes: 21 additions & 0 deletions tests/_data/snapshots/get_bom_with_licenses-1.2.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,24 @@
"type": "library",
"version": ""
},
{
"bom-ref": "C4",
"licenses": [
{
"license": {
"id": "Apache-2.0"
}
},
{
"license": {
"name": "some other license"
}
}
],
"name": "c-with-license-properties",
"type": "library",
"version": ""
},
{
"bom-ref": "C3",
"licenses": [
Expand Down Expand Up @@ -62,6 +80,9 @@
{
"ref": "C3"
},
{
"ref": "C4"
},
{
"ref": "S1"
},
Expand Down
13 changes: 13 additions & 0 deletions tests/_data/snapshots/get_bom_with_licenses-1.2.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,18 @@
<expression>Apache-2.0 OR MIT</expression>
</licenses>
</component>
<component type="library" bom-ref="C4">
<name>c-with-license-properties</name>
<version/>
<licenses>
<license>
<id>Apache-2.0</id>
</license>
<license>
<name>some other license</name>
</license>
</licenses>
</component>
<component type="library" bom-ref="C3">
<name>c-with-name</name>
<version/>
Expand Down Expand Up @@ -79,6 +91,7 @@
<dependency ref="C1"/>
<dependency ref="C2"/>
<dependency ref="C3"/>
<dependency ref="C4"/>
<dependency ref="S1"/>
<dependency ref="S2"/>
<dependency ref="S3"/>
Expand Down
21 changes: 21 additions & 0 deletions tests/_data/snapshots/get_bom_with_licenses-1.3.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,24 @@
"type": "library",
"version": ""
},
{
"bom-ref": "C4",
"licenses": [
{
"license": {
"id": "Apache-2.0"
}
},
{
"license": {
"name": "some other license"
}
}
],
"name": "c-with-license-properties",
"type": "library",
"version": ""
},
{
"bom-ref": "C3",
"licenses": [
Expand Down Expand Up @@ -62,6 +80,9 @@
{
"ref": "C3"
},
{
"ref": "C4"
},
{
"ref": "S1"
},
Expand Down
13 changes: 13 additions & 0 deletions tests/_data/snapshots/get_bom_with_licenses-1.3.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,18 @@
<expression>Apache-2.0 OR MIT</expression>
</licenses>
</component>
<component type="library" bom-ref="C4">
<name>c-with-license-properties</name>
<version/>
<licenses>
<license>
<id>Apache-2.0</id>
</license>
<license>
<name>some other license</name>
</license>
</licenses>
</component>
<component type="library" bom-ref="C3">
<name>c-with-name</name>
<version/>
Expand Down Expand Up @@ -84,6 +96,7 @@
<dependency ref="C1"/>
<dependency ref="C2"/>
<dependency ref="C3"/>
<dependency ref="C4"/>
<dependency ref="S1"/>
<dependency ref="S2"/>
<dependency ref="S3"/>
Expand Down
20 changes: 20 additions & 0 deletions tests/_data/snapshots/get_bom_with_licenses-1.4.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,23 @@
"name": "c-with-expression",
"type": "library"
},
{
"bom-ref": "C4",
"licenses": [
{
"license": {
"id": "Apache-2.0"
}
},
{
"license": {
"name": "some other license"
}
}
],
"name": "c-with-license-properties",
"type": "library"
},
{
"bom-ref": "C3",
"licenses": [
Expand Down Expand Up @@ -59,6 +76,9 @@
{
"ref": "C3"
},
{
"ref": "C4"
},
{
"ref": "S1"
},
Expand Down
12 changes: 12 additions & 0 deletions tests/_data/snapshots/get_bom_with_licenses-1.4.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,17 @@
<expression>Apache-2.0 OR MIT</expression>
</licenses>
</component>
<component type="library" bom-ref="C4">
<name>c-with-license-properties</name>
<licenses>
<license>
<id>Apache-2.0</id>
</license>
<license>
<name>some other license</name>
</license>
</licenses>
</component>
<component type="library" bom-ref="C3">
<name>c-with-name</name>
<licenses>
Expand Down Expand Up @@ -80,6 +91,7 @@
<dependency ref="C1"/>
<dependency ref="C2"/>
<dependency ref="C3"/>
<dependency ref="C4"/>
<dependency ref="S1"/>
<dependency ref="S2"/>
<dependency ref="S3"/>
Expand Down
36 changes: 36 additions & 0 deletions tests/_data/snapshots/get_bom_with_licenses-1.5.json.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,39 @@
"name": "c-with-expression",
"type": "library"
},
{
"bom-ref": "C4",
"licenses": [
{
"license": {
"id": "Apache-2.0",
"properties": [
{
"name": "key1",
"value": "val1"
},
{
"name": "key2",
"value": "val2"
}
]
}
},
{
"license": {
"name": "some other license",
"properties": [
{
"name": "myname",
"value": "proprietary"
}
]
}
}
],
"name": "c-with-license-properties",
"type": "library"
},
{
"bom-ref": "C3",
"licenses": [
Expand Down Expand Up @@ -59,6 +92,9 @@
{
"ref": "C3"
},
{
"ref": "C4"
},
{
"ref": "S1"
},
Expand Down
19 changes: 19 additions & 0 deletions tests/_data/snapshots/get_bom_with_licenses-1.5.xml.bin
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,24 @@
<expression>Apache-2.0 OR MIT</expression>
</licenses>
</component>
<component type="library" bom-ref="C4">
<name>c-with-license-properties</name>
<licenses>
<license>
<id>Apache-2.0</id>
<properties>
<property name="key1">val1</property>
<property name="key2">val2</property>
</properties>
</license>
<license>
<name>some other license</name>
<properties>
<property name="myname">proprietary</property>
</properties>
</license>
</licenses>
</component>
<component type="library" bom-ref="C3">
<name>c-with-name</name>
<licenses>
Expand Down Expand Up @@ -80,6 +98,7 @@
<dependency ref="C1"/>
<dependency ref="C2"/>
<dependency ref="C3"/>
<dependency ref="C4"/>
<dependency ref="S1"/>
<dependency ref="S2"/>
<dependency ref="S3"/>
Expand Down
Loading
Loading