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

fix(sbom): move licenses to name field in Cyclonedx format #4941

Merged

Conversation

DmitriyLewen
Copy link
Contributor

@DmitriyLewen DmitriyLewen commented Aug 4, 2023

Description

Expression field is string including all licenses separated by AND or OR (https://cyclonedx.org/docs/1.4/json/#tab-pane_components_items_licenses_items_oneOf_i1).
We can't determine correct separator in all cases.

But we can use license.name field(https://cyclonedx.org/docs/1.4/json/#components_items_licenses_items_license_name).

As new feature, we can use id, but we need to compare found licenses with license enums and remove licenses not from this list.

Related issues

Checklist

  • I've read the guidelines for contributing to this repository.
  • I've followed the conventions in the PR title.
  • I've added tests that prove my fix is effective or that my feature works.
  • I've updated the documentation with the relevant information (if needed).
  • I've added usage information (if the PR introduces new options)
  • I've included a "before" and "after" example to the description (if the PR is a user interface change).

@DmitriyLewen DmitriyLewen marked this pull request as ready for review August 4, 2023 06:31
@DmitriyLewen DmitriyLewen changed the title fix(sbom): move licenses to name field fix(sbom): move licenses to name field in Cyclonedx format Aug 4, 2023
@knqyf263 knqyf263 added this pull request to the merge queue Aug 6, 2023
Merged via the queue into aquasecurity:main with commit f18b0db Aug 6, 2023
14 checks passed
@DmitriyLewen DmitriyLewen deleted the fix/cyclonexd-use-name-for-licenses branch August 7, 2023 04:28
knqyf263 pushed a commit to knqyf263/trivy that referenced this pull request Aug 8, 2023
…urity#4941)

* use license.Name instead of Expression

* update tests
github-merge-queue bot pushed a commit that referenced this pull request Aug 8, 2023
* test: validate CycloneDX with the JSON schema

* fix(sbom): move licenses to `name` field in Cyclonedx format (#4941)

* use license.Name instead of Expression

* update tests

* test: add uuid package

* test: compare UUID

---------

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>
AnaisUrlichs pushed a commit to AnaisUrlichs/trivy that referenced this pull request Aug 10, 2023
…urity#4941)

* use license.Name instead of Expression

* update tests
AnaisUrlichs pushed a commit to AnaisUrlichs/trivy that referenced this pull request Aug 10, 2023
* test: validate CycloneDX with the JSON schema

* fix(sbom): move licenses to `name` field in Cyclonedx format (aquasecurity#4941)

* use license.Name instead of Expression

* update tests

* test: add uuid package

* test: compare UUID

---------

Co-authored-by: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>
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

Successfully merging this pull request may close these issues.

CycloneDX SBOM files generated by trivy are not compliant with corresponding CycloneDX schema
2 participants