You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It would be ideal if the output SBOM of syft included a description of what is in scope and out of scope as clearly as possible. This includes (but not limited to):
which catalogers were used during the SBOM generation process
what was the configuration of each cataloger (should be covered in the app config section already)
what paths were included in the search vs excluded from the search (as input)
what paths were attempted to be parsed/searched but could not be for various reasons (IO error, permissions error, parse error)
Why? A good SBOM describes the positive cases of "what" was actually found (X packages, Y files, etc). A great SBOM should describe negative conditions. This doesn't apply to the cases themselves, such as "list all of the packages you didn't find" (which makes no sense), but instead the runtime, configuration, and environmental factors that lead to "places not searched". This helps SBOM consumers better reproduce results and understand the boundaries of what was "in scope" vs "out of scope" during the analysis.
The text was updated successfully, but these errors were encountered:
^ This PR means we may enter a place where if a HASH cannot be generated for a package it won't be cataloged. This unknown should be surfaced in the SBOM output.
It would be ideal if the output SBOM of syft included a description of what is in scope and out of scope as clearly as possible. This includes (but not limited to):
Why? A good SBOM describes the positive cases of "what" was actually found (X packages, Y files, etc). A great SBOM should describe negative conditions. This doesn't apply to the cases themselves, such as "list all of the packages you didn't find" (which makes no sense), but instead the runtime, configuration, and environmental factors that lead to "places not searched". This helps SBOM consumers better reproduce results and understand the boundaries of what was "in scope" vs "out of scope" during the analysis.
The text was updated successfully, but these errors were encountered: