Re: [PATCH] send-email: clarify SMTP encryption settings
- From
brian m. carlson <sandals@crustytoothpaste.net>
- Date
- Apr 10, 2021, 01:39 UTC
- Message-ID
- <YHEB1ClofnD6nQWA@camp.crustytoothpaste.net>
- In-Reply-To
- <20210409211812.3869-1-sir@cmpwn.com>
On 2021-04-09 at 21:18:12, Drew DeVault wrote:
Show 31 quoted lines
> The present options are misleading; "ssl" enables generic, "modern" SSL > support, which could use either SSL or TLS; and "tls" enables the > SMTP-specific (and deprecated) STARTTLS protocol. > > This changes the canonical config options to "ssl/tls" and "starttls", > updates the docs to explain the options in more detail, and updates > git-send-email to accept either form. > --- > Documentation/git-send-email.txt | 11 ++++++++--- > git-send-email.perl | 4 ++-- > 2 files changed, 10 insertions(+), 5 deletions(-) > > diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt > index 93708aefea..3597935e41 100644 > --- a/Documentation/git-send-email.txt > +++ b/Documentation/git-send-email.txt > @@ -168,9 +168,14 @@ Sending > unspecified, choosing the envelope sender is left to your MTA. > > --smtp-encryption=<encryption>:: > - Specify the encryption to use, either 'ssl' or 'tls'. Any other > - value reverts to plain SMTP. Default is the value of > - `sendemail.smtpEncryption`. > + Specify the encryption to use, either 'ssl/tls' or 'starttls', whichever > + is recommended by your email service provider. SSL/TLS is typically > + used on port 465 and is preferred if available. STARTTLS is typically > + used on port 25 or 587. Any other value reverts to plain SMTP. The > + default is the value of `sendemail.smtpEncryption`. > ++ > +For legacy reasons, 'ssl' is accepted for 'ssl/tls' and 'tls' is accepted for > +'starttls'.
I definitely approve of describing the two options. Even just saying that one option is tunneled and one is actually STARTTLS would be an improvement here without the additional options. Apparently I managed to figure it out, but I'm not sure if that's because I use STARTTLS or because I would logically prefer the more modern TLS over SSL just by looking at the names.
Since I agree that "ssl/tls" may be a bit confusing, maybe we could call that option "wrapped" or "tunneled"? Other names are possible, of course.
-- brian m. carlson (he/him or they/them) Houston, Texas, US