Skip to content

feat(policy): allow generic material kinds #2305

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.

Sign up for GitHub

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

Merged
Piskoo merged 3 commits into from
Aug 5, 2025
Merged

feat(policy): allow generic material kinds #2305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c7bcb17
feat(policy): allow generic material kinds
Piskoo Aug 5, 2025
0d39269
exclude artifact kind
Piskoo Aug 5, 2025
b66726b
fix linter error
Piskoo Aug 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions app/controlplane/api/gen/frontend/workflowcontract/v1/crafting_schema.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion app/controlplane/api/gen/jsonschema/workflowcontract.v1.PolicySpecV2.jsonschema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion app/controlplane/api/gen/jsonschema/workflowcontract.v1.PolicySpecV2.schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

164 changes: 81 additions & 83 deletions app/controlplane/api/workflowcontract/v1/crafting_schema.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 1 addition & 7 deletions app/controlplane/api/workflowcontract/v1/crafting_schema.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,14 +280,8 @@ message PolicySpecV2 {
}

// if set, it will match any material supported by Chainloop
// except those not having a direct schema (STRING, ARTIFACT, EVIDENCE), since their format cannot be guessed by the crafter.

@migmartri migmartri Aug 5, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if ARTIFACT should be also permitted since ARTIFACT is at the same level but opposite than EVIDENCE.

@Piskoo Piskoo Aug 5, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We want to shift responsibility of handling EVIDENCE to the user because there's no way to verify schema at this point, but at the same time there's no way to validate what the ARTIFACT is, in that way they are similar.

@migmartri migmartri Aug 5, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jiparis just give it a review, I am ok either way, thanks

@jiparis jiparis Aug 5, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be a long discussion. I think that we are giving Evidence and Artifact a semantic that is orthogonal to material kinds. For example, following that convention, a CycloneDX material can be and Evidence at the same time.

Since we are not yet in that stage of the discussion (but I think we will soon), I would just allow EVIDENCE at this point (and maybe STRING), clearly stating in the docs that Artifact is not supported because it's usually an arbitrary format (a binary, a tar.gz ...), whereas Evidences are only supported if they have a JSON format.

// CONTAINER, HELM_CHART are also excluded, but we might implement custom policies for them in the future.
CraftingSchema.Material.MaterialType kind = 3 [(buf.validate.field).enum = {
not_in: [
1,
3,
11
]
not_in: [3]
}];
}

Expand Down
Loading