From: Gwyneth Morgan <gwymor@tilde.club>
To: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH v2] signature-format.txt: note SSH and X.509 signature delimiters
Date: Mon, 27 Feb 2023 20:26:06 +0000 [thread overview]
Message-ID: <Y/0R3lDyJrtd4gIZ@tilde.club> (raw)
In-Reply-To: <230210.86ilg9wzho.gmgdl@evledraar.gmail.com>
On 2023-02-10 11:52:42+0100, Ævar Arnfjörð Bjarmason wrote:
>
> On Fri, Feb 10 2023, Gwyneth Morgan wrote:
>
> > This document only explained PGP signatures, but Git now supports X.509
> > and SSH signatures.
>
> To elaborate a bit, in 1e7adb97566 (gpg-interface: introduce new
> signature format "x509" using gpgsm, 2018-07-17) we added X.509, and in
> 29b315778e9 (ssh signing: add ssh key format and signing code,
> 2021-09-10) we added "ssh", but our docs were never updated.
>
> Your commit message says as much in briefer terms, but maybe if you
> re-roll having those references would help put this change in context.>
I'll reference those commits in v3.
> > +Signatures begin with an ASCII Armor header line and end with a tail line,
> > +which differ depending on signature type.
>
> Does the "ASCII Armor header" really add something here, or just confuse
> the user with a reference that's not followed-up or explained here?
> Maybe we should point out OpenPGP's '--armor' option in passing, to note
> to the reader that this isn't some git-specific concept.
I think having a relevant term to search for online and in manpages is
helpful. Mentioning the specific command-line option seems unnecessary,
but I'll put the term "ASCII Armor" in quotes to make it clearer that
this is not a git-specific concept.
> I wonder if structuring it like this wouldn't help make this easier to
> read, and reduce the repetition, as well as making the circular
> references between this & 'gpg.format' more obvious:
>
> The signature start and end marker comes on its own line, and
> differs based on the signature type (as selected by
> 'gpg.format', see linkgit:git-config[1]).
>
> Those are, for values of 'gpg.format':
>
> gpg: `-----BEGIN PGP SIGNATURE-----` and `-----END PGP
> SIGNATURE-----`. Or, if GPG has been asked to produce
> RFC1991 signatures: `-----BEGIN PGP MESSAGE-----` and
> `-----END PGP MESSAGE-----`
>
> x509: `-----BEGIN SIGNED MESSAGE-----` `-----END SIGNED MESSAGE-----`
> ssh:`-----BEGIN SSH SIGNATURE-----` and `-----END SSH SIGNATURE-----`
Looks good. I'll do this in v3. I'll reference these by the gpg.format
value, as well as a parenthetical proper name, like "gpg (PGP)"; these
are basically the same the other two formats, but I want it to be clear
that `gpg` signatures don't have to be from the gpg program but could be
from any PGP-supporting program.
> Then for gpg.format in Documentation/config/gpg.txt we could add e.g.:
>
> See linkgit:gitformat-signature[5] for the signature format,
> which differs based on the selected 'gpg.format'.
OK.
Thanks.
next prev parent reply other threads:[~2023-02-27 20:26 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-20 5:32 [PATCH] signature-format.txt: Note SSH and X.509 signature delimiters Gwyneth Morgan
2022-01-20 19:30 ` Junio C Hamano
2022-01-20 19:49 ` Junio C Hamano
2023-02-10 6:16 ` Gwyneth Morgan
2023-02-10 16:58 ` Junio C Hamano
2023-02-10 6:16 ` [PATCH v2] signature-format.txt: note " Gwyneth Morgan
2023-02-10 10:52 ` Ævar Arnfjörð Bjarmason
2023-02-27 20:26 ` Gwyneth Morgan [this message]
2023-02-10 19:25 ` Junio C Hamano
2023-02-27 20:27 ` [PATCH v3] " Gwyneth Morgan
2023-02-27 21:44 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=Y/0R3lDyJrtd4gIZ@tilde.club \
--to=gwymor@tilde.club \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).