[FFmpeg-devel] [PATCH v2] doc/git-howto.texi: Document commit signing

[Michael Niedermayer]

On Tue, Aug 09, 2022 at 04:38:56PM -0300, James Almer wrote:
> On 8/9/2022 4:34 PM, Michael Niedermayer wrote:
> > From: Michael Niedermayer <michael-git at niedermayer.cc>
> > 
> > Signed-off-by: Michael Niedermayer <michael-git at niedermayer.cc>
> > ---
> >   doc/git-howto.texi | 22 +++++++++++++++++++++-
> >   1 file changed, 21 insertions(+), 1 deletion(-)
> > 
> > diff --git a/doc/git-howto.texi b/doc/git-howto.texi
> > index 874afabbbc..48389751a4 100644
> > --- a/doc/git-howto.texi
> > +++ b/doc/git-howto.texi
> > @@ -187,11 +187,18 @@ to make sure you don't have untracked files or deletions.
> >   git add [-i|-p|-A] <filenames/dirnames>
> >   @end example
> > -Make sure you have told Git your name and email address
> > +Make sure you have told Git your name, email address and GPG key
> >   @example
> >   git config --global user.name "My Name"
> >   git config --global user.email my@@email.invalid
> > +git config --global user.signingkey ABCDEF0123245
> > + at end example
> > +
> > +Enable signing all commits or use -S
> > +
> > + at example
> > +git config --global commit.gpgsign true
> >   @end example
> >   Use @option{--global} to set the global configuration for all your Git checkouts.
> > @@ -423,6 +430,19 @@ git checkout -b svn_23456 $SHA1
> >   where @var{$SHA1} is the commit hash from the @command{git log} output.
> > + at chapter gpg key generation
> > +
> > +If you have no gpg key yet, we recommand that you create a ed25519 based key as it
> 
> Recommend.
> 
> > +is small, fast and secure. Especially it results in small signatures in git.
> > +
> > + at example
> > +gpg --default-new-key-algo "ed25519/cert,sign+cv25519/encr" --quick-generate-key "human at server.com"
> > + at end example
> > +
> > +When genarting a key, make sure the email specified matches the email used in git as some sites like
> 
> Generating

ok


> 
> > +github consider mismatches a reason to declare such commits unverified. After generating a key you
> > +can add it to the MAINTAINER file and upload it to a keyserver.
> 
> Maybe link some external documentation about gpg keys, explaining the
> difference between public and private keys, 

what do you recommend ?


> how to encrypt the private one
> with a passphrase, etc.

Have you tried to generate a gpg key without a passphrase ?
I just tried, and failed, gpg keeps asking for a passphrase until you enter
one or kill it. It kept haunting me and asking for a passphrase even after
trying ctrl-c 


> Sites like gitlab tell you to not attempt to upload private keys, 

ok


> so i
> imagine quite a lot of people have mistakenly done so in the past.

imagine?

but what do you suggest? we can document how someone can create a key
upload it and so on. You can provide me with a url that describes a
working documentation for that, i surely do not have one. alot of
documentations are somewhat bad. Many keyservers have died recently
some existing keys like DSA seem to have some affinity to SHA1, and
SHA1 is rejected today while at the same time still default on many
setups, the one documentation i saw today to fix that DSA/SHA1 issue
requires you to have a backup as it breaks your keys and is wrong.


thx

[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Breaking DRM is a little like attempting to break through a door even
though the window is wide open and the only thing in the house is a bunch
of things you dont want and which you would get tomorrow for free anyway
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 195 bytes
Desc: not available
URL: <https://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20220810/e81ede8a/attachment.sig>