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

Include or Exclude Projects From BOM Validation Using Tags #3891

Open
2 tasks done
msymons opened this issue Jun 27, 2024 · 0 comments
Open
2 tasks done

Include or Exclude Projects From BOM Validation Using Tags #3891

msymons opened this issue Jun 27, 2024 · 0 comments
Labels
enhancement New feature or request p2 Non-critical bugs, and features that help organizations to identify and reduce risk size/S Small effort
Milestone

Comments

@msymons
Copy link
Member

msymons commented Jun 27, 2024

Current Behavior

BOM Validation against the CycloneDX schema was a feature introduced in v4.11.0 and can be enabled or disabled by an administrator.

It is "all or nothing". Either every BOM upload gets validated or nothing gets validated.

It was known before v4.11.0 release that this could cause problems if users' tooling was producing invalid BOMs.

However, real-world experience has shown that more tools are generating invalid BOMs than might have been hoped for. Thus, we need to improve functionality:

  • Cautious roll-out: User X does not trust their tools (or Dependency-Track) and wants to try BOM Validation on a small subset of projects
  • User Y really values BOM Validation but has problems with a small subset of projects and wants to to exclude these from Validation.
  • User X and User Y do not want to continually have to tweak configuration at an admin level

Proposed Behavior

Implement the ability to filter Validation based on tag. Configuration based on tag means that the administrator can set things up once and then users with lower privileges can easily control behavior at the project level.

Once BOM Validation is enabled then select whether to run in one of two modes (suggest using a radio button here)

  • Include: specify a tag to only apply BOM Validation to projects with this tag.
  • Exclude: specify a tag that will be used to exclude projects with the tag from BOM validation

If the admin does not provide any tag then behavior should be as in v4.11.0 (everything gets validated)

If the admin switches from "Include" mode to "Exclude" mode (or vice versa) then the system should still remember the tag that was used in the option that is now inactive.... they might want to switch back again later.

I suggest that the default should be "Exclude" This would allow the admin to configure it with a tag and have BOMs upload before the tag is added to any project and behavior would still be "everything gets validated".

Checklist

@msymons msymons added the enhancement New feature or request label Jun 27, 2024
@msymons msymons added this to the 4.12 milestone Jun 27, 2024
@nscuro nscuro added p2 Non-critical bugs, and features that help organizations to identify and reduce risk size/S Small effort labels Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request p2 Non-critical bugs, and features that help organizations to identify and reduce risk size/S Small effort
Projects
None yet
Development

No branches or pull requests

2 participants