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

Update documentation around generating GPG keys to sign releases #77

Merged
merged 2 commits into from
Dec 8, 2020

Conversation

carnage
Copy link
Contributor

@carnage carnage commented Oct 4, 2020

Q A
Documentation yes
Bugfix no
BC Break no
New Feature no
RFC no
QA no

Description

Adding more detail to documentation to cover areas I didn't find clear/had to lookup elsewhere while attempting to use this in a project. Adding to this as I progress through the setup process.

@Ocramius
Copy link
Member

Ocramius commented Oct 4, 2020

Check also #32 - that's the process I went through, at least :D

@carnage
Copy link
Contributor Author

carnage commented Oct 6, 2020

I decided to go with a brand new GPG key as:

a) My master key is stored on an encrypted flash drive, in a safe, no where near my Laptop; so effort+++
b) I perceive GPG to be a very fragile thing so any change could break my current setup
c) Was "testing" the setup so didn't feel the need to use a "real" key
d) Using a per project release key seemed like a good idea anyway.

Given your comments on #32 I'll perhaps split this into it's own document and add the details on creating a new subkey as well.

I suspect that it would be possible to make it passwordless without deleting your key; simply set the password on the master key to empty; export the sub key and restore the password to it's previous value.

@Ocramius
Copy link
Member

Ocramius commented Oct 7, 2020

a) My master key is stored on an encrypted flash drive, in a safe, no where near my Laptop; so effort+++

My master key is not even at my home, so the effort is kinda normal, FWIW.

I guess multiple GPG keys are viable in github config (https://github.com/settings/keys)

c) Was "testing" the setup so didn't feel the need to use a "real" key

Yeah, but docs should be about the "real" key - the actual setup workflow is indeed in #32

I suspect that it would be possible to make it passwordless without deleting your key; simply set the password on the master key to empty; export the sub key and restore the password to it's previous value.

Probably feasible: didn't want to change any other pre-existing subkeys on my system

carnage and others added 2 commits December 5, 2020 15:45
Signed-off-by: Carnage <[email protected]>
…ection for using a subkey of an existing key as per laminas#32

Signed-off-by: Carnage <[email protected]>
@carnage carnage marked this pull request as ready for review December 5, 2020 15:47
@carnage
Copy link
Contributor Author

carnage commented Dec 5, 2020

Made a few changes to this;

Pulled the GPG stuff into it's own section with sub sections for using a new key or an existing one. I used your steps from #32 as a basis for this but found a better way to remove a password from a subkey using a temp home dir so not to mess with the users current gpg setup.

Think it's ready for merge now.

Copy link
Member

@Ocramius Ocramius left a comment

Choose a reason for hiding this comment

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

Excellent, thanks!

@Ocramius Ocramius self-assigned this Dec 8, 2020
@Ocramius Ocramius added this to the 1.9.0 milestone Dec 8, 2020
@Ocramius Ocramius changed the title Documentation update Update documentation around generating GPG keys to sign releases Dec 8, 2020
@Ocramius Ocramius merged commit 7c4dfd3 into laminas:1.9.x Dec 8, 2020
@glensc
Copy link
Contributor

glensc commented Jan 24, 2021

@carnage what was your gpg version when you created these docs?

Asking as such choices are not available for me:

@Ocramius
Copy link
Member

gpg (GnuPG) 2.2.4
libgcrypt 1.8.1

No idea if GnuPG is semver-compliant there.

@glensc
Copy link
Contributor

glensc commented Jan 25, 2021

Some 3 year time delta:

Version Date Announce
2.2.4 Wed Dec 20 16:36:34 CET 2017 https://lists.gnupg.org/pipermail/gnupg-announce/2017q4/000419.html
2.2.25 Mon Nov 23 19:00:22 CET 2020 https://lists.gnupg.org/pipermail/gnupg-announce/2020q4/000450.html

@Ocramius
Copy link
Member

Yeah, I'm on Ubuntu 18.04 LTS, so it probably stuck to something ancient :-\

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants