Unintuitive behavior of the provenance expectation check
@behnazh-w is already working on this.
Since Jan 9, 2024.
- Dominant language
- Python
- Stars
- 210
- Forks
- 36
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 2
Description
Reproduction
We use the macaron analyze command under the use case of "user providing both a PackageURL to identify a software component and a repo URL explicitly".
macaron analyze \
--package-url pkg:maven/io.micronaut/micronaut-test@4.1.1 \
--repo-path https://github.com/micronaut-projects/micronaut-test \
--digest 0a43363f7562534063e06e3f2a328f09a066b547 \
--skip-deps \
Macaron then does not recognize the following expectation to correspond to the software component being analyzed:
{
target: "pkg:maven/io.micronaut/micronaut-test@4.1.1",
predicate: {
builder: {
id: =~"^https://github.com/slsa-framework/slsa-github-generator/.github/workflows/generator_generic_slsa3.yml.*"
}
}
}
However, after removing the version part from the PURL in the target field, Macaron now recognizes this expectation to correspond to the software component.
{
- target: "pkg:maven/io.micronaut/micronaut-test@4.1.1",
+ target: "pkg:maven/io.micronaut/micronaut-test",
This is undesirable from a user's perspective because it is not clear why the same PURL can be specified in the analyze command, but not in the expectation.
Cause
Macaron stores expectations for all analysis targets in a dictionary, in which each key is a PURL identifying a software component, and each value is the corresponding provenance expectation for that software component.
Before a pair of (PURL, expectation) is added to this dictionary, the version part of the PURL (starting from the @ character), is stripped away from the PURL.
Other unexpected details
- This function: while its docstring says it takes a repo_complete_name, it takes PURLs in reality.
- The
targetcolumn in theExpectationtable seems to store PURL, not "full repository name" as stated in the doc comment.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.