slsa-github-generator
slsa-github-generator copied to clipboard
slsa-framework
`id-token: write` not available on pull_requests
Adding id-token: write to workflows triggered by pull_request events doesn't seem to be allowed.
This seems a bit problematic that we would expect that folks only run our workflow when a tagged. I can imagine folks would run into issues if they only exercise the workflows when releasing new versions as there would be significant time and changes to their repo in between releases. If the builders don't run on pull_request it will be hard to ensure that new code works with the reusable workflows.
For comparison, go-releaser's example workflow runs on pull_request.
https://github.com/goreleaser/goreleaser-action#workflow
Goreleaser works on PR but they cannot sign with keys, because the keys need to be stored in secrets that are not available on PRs.
To have access to the secrets or OIDC tokens, we could support pull_request_target instead.
@ianlewis are you suggesting we support PRs and not output provenance in this case (to be on par with Goreleaser)?
@laurentsimon I'm not actually sure what's best right now. I just think we probably need to support PRs in some capacity even if we don't sign provenance because it would introduce differences between how building in PR pre-submits work and how it works on releases. I think it may be a future point of user friction.
Like for example, maybe just running the builder on PRs is the right way to go?
I think that's fine, yes. I considered this to be low priority for v1, and wanted to see if we get push back from people. We can tackle this in the next iteration. Wdut?
I think that's fine, yes. I considered this to be low priority for v1, and wanted to see if we get push back from people. We can tackle this in the next iteration. Wdut?
I agree. I haven't included it in the v1 milestone.
As an aside, we currently use the NilClientProvider for pull requests which returns nil for both the OIDC and GitHub clients, but we should still be able to use the GitHub API in pull requests as it uses github.token for auth.
https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token
That should allow us to set the invocation entry point properly and not have special code for that.
We can also look into supporting the pull_request_target event which may allow us to get the right permissions because it runs using workflow code at the base ref of the PR.
thinking more about this, it may be more complicated than it seems. The OIDC token will contain information from the repo at HEAD: repo name, commit hash, etc, not the PR's repo's information.