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

Add instructions for creating signed releases/tags #1637

Merged
merged 5 commits into from
Feb 21, 2024

Conversation

cary-ilm
Copy link
Member

To satisfy OpenSSF requirement for signed releases and version tags.

@lgritz
Copy link
Contributor

lgritz commented Feb 12, 2024

This is great! Gonna steal these instructions for other projects.

Signed-off-by: Cary Phillips <[email protected]>
Signed-off-by: Cary Phillips <[email protected]>
cary-ilm added a commit to cary-ilm/Imath that referenced this pull request Feb 14, 2024
Signed-off-by: Cary Phillips <[email protected]>
cary-ilm added a commit to AcademySoftwareFoundation/Imath that referenced this pull request Feb 21, 2024
* Add workflow to sign release artifacts with Sigstore

Replicates the openexr workflow:
AcademySoftwareFoundation/openexr#1637

Signed-off-by: Cary Phillips <[email protected]>

* Use cosign and gh

Signed-off-by: Cary Phillips <[email protected]>

* Add comment reference to sigstore docs

Signed-off-by: Cary Phillips <[email protected]>

* Use gh-action-sigstore-python

Signed-off-by: Cary Phillips <[email protected]>

* Update security policy

Signed-off-by: Cary Phillips <[email protected]>

---------

Signed-off-by: Cary Phillips <[email protected]>
@cary-ilm
Copy link
Member Author

After a few more iterations, I'm going to go with this as is. The action creates and uploads a .tar.gz of the release source (not strictly necessary because it mirrors what the default GitHub release provides, but it has the advantage of being explicit). The action signs that .tar.gz with gh-action-sigstore-python, which produces a .tar.gz.sigstore credential file, which can be used to verify the download via:

% sigstore verify github --cert-identity https://github.com/AcademySoftwareFoundation/openexr/.github/workflows/release-sign.yml@refs/tags/<tag> openexr-<tag>.tar.gz

This means you can verify without needing the identity email (or just that sigstore determines the identity email from GitHub behind the scenes).

The workflow file and SECURITY.md have a note to this effect, which should satisfy the OpenSSF badge requirements that the project provide a way of "obtaining the public signing keys and verifying the signatures"

@cary-ilm cary-ilm merged commit 32de807 into AcademySoftwareFoundation:main Feb 21, 2024
27 checks passed
cary-ilm added a commit to cary-ilm/Imath that referenced this pull request Feb 21, 2024
…Foundation#369)

* Add workflow to sign release artifacts with Sigstore

Replicates the openexr workflow:
AcademySoftwareFoundation/openexr#1637

Signed-off-by: Cary Phillips <[email protected]>

* Use cosign and gh

Signed-off-by: Cary Phillips <[email protected]>

* Add comment reference to sigstore docs

Signed-off-by: Cary Phillips <[email protected]>

* Use gh-action-sigstore-python

Signed-off-by: Cary Phillips <[email protected]>

* Update security policy

Signed-off-by: Cary Phillips <[email protected]>

---------

Signed-off-by: Cary Phillips <[email protected]>
cary-ilm added a commit to cary-ilm/Imath that referenced this pull request Feb 27, 2024
…Foundation#369)

* Add workflow to sign release artifacts with Sigstore

Replicates the openexr workflow:
AcademySoftwareFoundation/openexr#1637

Signed-off-by: Cary Phillips <[email protected]>

* Use cosign and gh

Signed-off-by: Cary Phillips <[email protected]>

* Add comment reference to sigstore docs

Signed-off-by: Cary Phillips <[email protected]>

* Use gh-action-sigstore-python

Signed-off-by: Cary Phillips <[email protected]>

* Update security policy

Signed-off-by: Cary Phillips <[email protected]>

---------

Signed-off-by: Cary Phillips <[email protected]>
cary-ilm added a commit to AcademySoftwareFoundation/Imath that referenced this pull request Feb 27, 2024
* Add workflow to sign release artifacts with Sigstore

Replicates the openexr workflow:
AcademySoftwareFoundation/openexr#1637

Signed-off-by: Cary Phillips <[email protected]>

* Use cosign and gh

Signed-off-by: Cary Phillips <[email protected]>

* Add comment reference to sigstore docs

Signed-off-by: Cary Phillips <[email protected]>

* Use gh-action-sigstore-python

Signed-off-by: Cary Phillips <[email protected]>

* Update security policy

Signed-off-by: Cary Phillips <[email protected]>

---------

Signed-off-by: Cary Phillips <[email protected]>
cary-ilm added a commit to cary-ilm/openexr that referenced this pull request Mar 3, 2024
…undation#1637)

* Add instructions for creating signed releases/tags

Signed-off-by: Cary Phillips <[email protected]>

* Add openexr.keyring

Signed-off-by: Cary Phillips <[email protected]>

* Sign & upload release artifacts via sigstore

Signed-off-by: Cary Phillips <[email protected]>

* Add release-sign.yml

Signed-off-by: Cary Phillips <[email protected]>

* Use gh-action-sigstore-python

Signed-off-by: Cary Phillips <[email protected]>

---------

Signed-off-by: Cary Phillips <[email protected]>
cary-ilm added a commit that referenced this pull request Mar 4, 2024
* Add instructions for creating signed releases/tags

Signed-off-by: Cary Phillips <[email protected]>

* Add openexr.keyring

Signed-off-by: Cary Phillips <[email protected]>

* Sign & upload release artifacts via sigstore

Signed-off-by: Cary Phillips <[email protected]>

* Add release-sign.yml

Signed-off-by: Cary Phillips <[email protected]>

* Use gh-action-sigstore-python

Signed-off-by: Cary Phillips <[email protected]>

---------

Signed-off-by: Cary Phillips <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants