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

instructions to extend key expiry #157

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

samspills
Copy link
Contributor

No description provided.

@samspills samspills requested a review from rossabaker February 8, 2025 20:48
@samspills samspills self-assigned this Feb 8, 2025
Copy link
Member

@rossabaker rossabaker left a comment

Choose a reason for hiding this comment

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

Thanks for updating this. Most of my comments are nitpicky and we needn't mess with what works. You can ignore all my blathering except Step 7.

It is written from the perspective of updating the Typelevel keys, but might (hopefully!) be useful to affiliate maintainers as well.

1. If your keys are not in `gpg`, import them:
- `gpg --import public.asc`
Copy link
Member

Choose a reason for hiding this comment

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

This is not harmful, but probably not necessary. It should all be in private.asc.

Comment on lines +11 to +16
2. `gpg --edit-key $KEY_ID` will put you into the gpg command line
- type `expiry`, and follow the prompts to set the new expiry (we usually opt to extend the expiry by 1 year), and then type `save` to save the changes
- NOTE: the Typelevel key has a sub-key, and that expiry must also be extended:
- run `gpg --edit-key $KEY_ID` again
- type `key 1`, to edit the first sub-key
- follow the same steps as before to update the expiry, and `save`
Copy link
Member

Choose a reason for hiding this comment

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

gpg --quick-set-expire would make most of this go away, but I think you need the fingerprint and not just the KEY_ID.

- Update the GitHub secret variable with the copied value (For users of sbt-typelevel, this secret is named `PGP_SECRET` in GitHub)

5. Export the updated armored key files for safe keeping (e.g. in 1Password)
- `gpg --export --armor $KEY_ID > public.asc`
Copy link
Member

Choose a reason for hiding this comment

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

I guess this is better safe than sorry, but I'm pretty sure it's redundant with private.asc and definitely redundant with the key server and the website.


6. Update the public key in other locations.
- For example, the Typelevel site has a [Web Key Directory](https://wiki.gnupg.org/WKD) that needs to be updated
- in the Typelevel site repo, the key is at `.well-known/openpgpkey/hu/nwnwrk3rczw4ou5x56ibcrdatrgf1xag`
Copy link
Member

Choose a reason for hiding this comment

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

For posterity, hu is hardcoded, and the last segment comes from gpg-wks-client --print-wkd-hash [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