feat: add cyclonedx.model.crypto.ProtocolProperties.crypto_ref_array

applied the fix recommended in the thread, to add crypto_ref_array
as an argument to ProtocolProperties class
Also updated bom1.6.SNAPSHOT.xsd from cryptoRef -> cryptoRefArray
added testcase and BOM json from the mentioned issue.

Signed-off-by: Indivar Mishra <[email protected]>

Author: indiVar0508

cyclonedx/model/crypto.py

@@ -1309,11 +1309,13 @@ def __init__(
         version: Optional[str] = None,
         cipher_suites: Optional[Iterable[ProtocolPropertiesCipherSuite]] = None,
         ikev2_transform_types: Optional[Ikev2TransformTypes] = None,
+        crypto_ref_array: Optional[Iterable[BomRef]] = None,
     ) -> None:
         self.type = type
         self.version = version
         self.cipher_suites = cipher_suites or []  # type:ignore[assignment]
         self.ikev2_transform_types = ikev2_transform_types
+        self.crypto_ref_array = crypto_ref_array or []  # type:ignore[assignment]
 
     @property
     @serializable.xml_sequence(10)
@@ -1376,13 +1378,37 @@ def ikev2_transform_types(self) -> Optional[Ikev2TransformTypes]:
     def ikev2_transform_types(self, ikev2_transform_types: Optional[Ikev2TransformTypes]) -> None:
         self._ikev2_transform_types = ikev2_transform_types
 
+    @property
+    @serializable.xml_array(serializable.XmlArraySerializationType.FLAT, 'cryptoRefArray')
+    @serializable.xml_sequence(40)
+    def crypto_ref_array(self) -> 'SortedSet[BomRef]':
+        """
+        A list of protocol-related cryptographic assets.
+
+        Returns:
+            `Iterable[BomRef]`
+        """
+        return self._crypto_ref_array
+
+    @crypto_ref_array.setter
+    def crypto_ref_array(self, crypto_ref_array: Iterable[BomRef]) -> None:
+        self._crypto_ref_array = SortedSet(crypto_ref_array)
+
     def __eq__(self, other: object) -> bool:
         if isinstance(other, ProtocolProperties):
             return hash(other) == hash(self)
         return False
 
     def __hash__(self) -> int:
-        return hash((self.type, self.version, tuple(self.cipher_suites), self.ikev2_transform_types))
+        return hash(
+            (
+                self.type,
+                self.version,
+                tuple(self.cipher_suites),
+                self.ikev2_transform_types,
+                tuple(self.crypto_ref_array)
+            )
+        )
 
     def __repr__(self) -> str:
         return f'<ProtocolProperties type={self.type}, version={self.version}>'

cyclonedx/schema/_res/bom-1.6.SNAPSHOT.xsd

@@ -7429,7 +7429,7 @@ limitations under the License.
                                 </xs:sequence>
                             </xs:complexType>
                         </xs:element>
-                        <xs:element name="cryptoRef" type="bom:refType" minOccurs="0" maxOccurs="unbounded">
+                        <xs:element name="cryptoRefArray" type="bom:refType" minOccurs="0" maxOccurs="unbounded">
                             <xs:annotation>
                                 <xs:documentation>A protocol-related cryptographic assets</xs:documentation>
                             </xs:annotation>

tests/_data/models.py

@@ -708,6 +708,33 @@ def get_bom_for_issue_328_components() -> Bom:
     return bom
 
 
+def get_bom_for_issue_692_components() -> Bom:
+    """regression test for issue #692
+    see https://github.com/CycloneDX/cyclonedx-python-lib/issues/692
+    """
+    bom = _make_bom()
+
+    comp_root = Component(type=ComponentType.APPLICATION,
+                          name='my application', version='1')
+    comp_test = Component(
+        name='comp_test',
+        type=ComponentType.CRYPTOGRAPHIC_ASSET,
+        bom_ref='crypto/protocol/test',
+        crypto_properties=CryptoProperties(
+            asset_type=CryptoAssetType.PROTOCOL,
+            protocol_properties=ProtocolProperties(
+                type=ProtocolPropertiesType.TLS,
+                version='1.2',
+                crypto_ref_array=[BomRef(value='for-test')]
+            ),
+            oid='1.3.18.0.2.32.104',
+        ))
+    bom.metadata.component = comp_root
+    bom.register_dependency(comp_root, [comp_test])
+    bom.components = [comp_test]
+    return bom
+
+
 def get_component_setuptools_complete(include_pedigree: bool = True) -> Component:
     component = get_component_setuptools_simple(bom_ref='my-specific-bom-ref-for-dings')
     component.supplier = get_org_entity_1()
@@ -1357,4 +1384,5 @@ def get_bom_with_definitions_standards() -> Bom:
     get_bom_for_issue_630_empty_property,
     get_bom_with_lifecycles,
     get_bom_with_definitions_standards,
+    get_bom_for_issue_692_components,
 }

tests/test_deserialize_json.py

@@ -90,7 +90,7 @@ def test(ls: LicenseRepository) -> None:
 
     def test_regression_issue690(self) -> None:
         """
-        regressio test for issue#690.
+        regression test for issue#690.
         see https://github.com/CycloneDX/cyclonedx-python-lib/issues/690
         """
         json_file = join(OWN_DATA_DIRECTORY, 'json',