Add licenses and properties to CDX.Models.Metadata. CycloneDX#1019

Signed-off-by: Augustus Kling <[email protected]>

Author: AugustusKling

src/models/metadata.ts

@@ -18,9 +18,11 @@ Copyright (c) OWASP Foundation. All Rights Reserved.
 */
 
 import type { Component } from './component'
+import { LicenseRepository } from './license'
 import { LifecycleRepository } from './lifecycle'
 import { OrganizationalContactRepository } from './organizationalContact'
 import type { OrganizationalEntity } from './organizationalEntity'
+import { PropertyRepository } from './property'
 import { ToolRepository } from './tool'
 
 export interface OptionalMetadataProperties {
@@ -31,6 +33,8 @@ export interface OptionalMetadataProperties {
   component?: Metadata['component']
   manufacture?: Metadata['manufacture']
   supplier?: Metadata['supplier']
+  licenses?: Metadata['licenses']
+  properties?: Metadata['properties']
 }
 
 export class Metadata {
@@ -41,6 +45,8 @@ export class Metadata {
   component?: Component
   manufacture?: OrganizationalEntity
   supplier?: OrganizationalEntity
+  licenses: LicenseRepository
+  properties: PropertyRepository
 
   constructor (op: OptionalMetadataProperties = {}) {
     this.timestamp = op.timestamp
@@ -50,5 +56,7 @@ export class Metadata {
     this.component = op.component
     this.manufacture = op.manufacture
     this.supplier = op.supplier
+    this.licenses = op.licenses ?? new LicenseRepository()
+    this.properties = op.properties ?? new PropertyRepository()
   }
 }

src/serialize/json/normalize.ts

@@ -223,7 +223,13 @@ export class MetadataNormalizer extends BaseJsonNormalizer<Models.Metadata> {
         : orgEntityNormalizer.normalize(data.manufacture, options),
       supplier: data.supplier === undefined
         ? undefined
-        : orgEntityNormalizer.normalize(data.supplier, options)
+        : orgEntityNormalizer.normalize(data.supplier, options),
+      licenses: data.licenses.size > 0
+        ? this._factory.makeForLicense().normalizeIterable(data.licenses, options)
+        : undefined,
+      properties: this._factory.spec.supportsProperties(data) && data.properties.size > 0
+        ? this._factory.makeForProperty().normalizeIterable(data.properties, options)
+        : undefined,
     }
   }
 }

src/serialize/json/types.ts

@@ -94,6 +94,7 @@ export namespace Normalized {
     manufacture?: OrganizationalEntity
     supplier?: OrganizationalEntity
     licenses?: License[]
+    properties?: Property[]
   }
 
   export interface LifecyclePhase {

src/serialize/xml/normalize.ts

@@ -246,6 +246,20 @@ export class MetadataNormalizer extends BaseXmlNormalizer<Models.Metadata> {
           children: this._factory.makeForOrganizationalContact().normalizeIterable(data.authors, options, 'author')
         }
       : undefined
+    const licenses: SimpleXml.Element | undefined = data.licenses.size > 0
+      ? {
+          type: 'element',
+          name: 'licenses',
+          children: this._factory.makeForLicense().normalizeIterable(data.licenses, options)
+        }
+      : undefined
+    const properties: SimpleXml.Element | undefined = this._factory.spec.supportsProperties(data) && data.properties.size > 0
+      ? {
+          type: 'element',
+          name: 'properties',
+          children: this._factory.makeForProperty().normalizeIterable(data.properties, options, 'property')
+        }
+      : undefined
     return {
       type: 'element',
       name: elementName,
@@ -262,7 +276,9 @@ export class MetadataNormalizer extends BaseXmlNormalizer<Models.Metadata> {
           : orgEntityNormalizer.normalize(data.manufacture, options, 'manufacture'),
         data.supplier === undefined
           ? undefined
-          : orgEntityNormalizer.normalize(data.supplier, options, 'supplier')
+          : orgEntityNormalizer.normalize(data.supplier, options, 'supplier'),
+        licenses,
+        properties
       ].filter(isNotUndefined)
     }
   }