Skip to content
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.

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

Component.copyright should be escaped when serializing to XML #538

Open
nnobelis opened this issue Oct 18, 2024 · 0 comments
Open

Component.copyright should be escaped when serializing to XML #538

nnobelis opened this issue Oct 18, 2024 · 0 comments

Comments

@nnobelis
Copy link

We are running in an exception with cyclonedx-core-java version 9.1.0

org.cyclonedx.exception.GeneratorException: com.fasterxml.jackson.databind.JsonMappingException: Invalid white space character (0x1) in text to 
output (in xml 1.1, could output as a character entity) (through reference chain: org.cyclonedx.model.Bom["component"]->java.util.ArrayList[164]-
>org.cyclonedx.model.Component["copyright"]) at 
org.ossreviewtoolkit.plugins.reporters.cyclonedx.CycloneDxReporter.writeBom(CycloneDxReporter.kt:369) at 
org.ossreviewtoolkit.plugins.reporters.cyclonedx.CycloneDxReporterKt.access$generateBom(CycloneDxReporter.kt:1) at 
org.ossreviewtoolkit.plugins.reporters.cyclonedx.CycloneDxReporterKt.generateBom(CycloneDxReporter.kt:394) at 
org.cyclonedx.generators.xml.BomXmlGenerator.toXmlString(BomXmlGenerator.java:131) at 
org.cyclonedx.generators.xml.BomXmlGenerator.toXML(BomXmlGenerator.java:116)

When we try to generate a CycloneDXBOM in XML. This is the BOM in JSON:

{
  "bomFormat": "CycloneDX",
  "specVersion": "1.5",
  "serialNumber": "urn:uuid:92ccb333-391c-4224-877f-cba7ba8c372e",
  "version": 1,
  "metadata": {
    "timestamp": "2024-10-18T12:29:38Z",
    "tools": {
      "components": [
        {
          "type": "application",
          "name": "OSS Review Toolkit",
          "version": "IDE-SNAPSHOT"
        }
      ]
    },
    "licenses": [
      {
        "expression": "CC0-1.0"
      }
    ]
  },
  "components": [
    
    {
      "type": "library",
      "bom-ref": "NPM:@ort:no-license-file:1.0",
      "group": "@ort",
      "name": "no-license-file",
      "version": "1.0",
      "description": "",
      "scope": "required",
      "licenses": [
        {
          "license": {
            "id": "MIT",
            "text": {
              "contentType": "plain/text",
              "content": "Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."
            }
          }
        }
      ],
      "copyright": "Portions created by the Initial Developer are Copyright (c) 2002 the Initial Developer, holder is Tim Hudson ([email protected]), Objc, (c) Objv, \u0002 \u0002 \u0001A\u0002\u0002\u0001o\u0002\u0012 AB, Copyright (c)",
      "purl": "pkg:npm/%40ort/[email protected]",
      "modified": false,
      "externalReferences": [
        {
          "type": "website",
          "url": "https://github.com/oss-review-toolkit/ort"
        }
      ]
    }
  ]
}

The problem are the special characters in component.copyright.

It seems the component.evidence.copyright is handled by a special serializer EvidenceSerializer that wraps the copyright in CDATA e.g.

<text><![CDATA[Copyright 2012 Google Inc. All Rights Reserved.]]></text>

Would it be possible to have the same handling for component.copyright ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant