git-imap-send.txt: remove the use of sslverify=false in GMail example
PATCH 1/1 git-imap-send.txt: remove the use of sslverify=false in GMail example
Since GMail is SSL capable there is no need to set sslverify to false, the example using it may confuse readers that it's needed since it's also used in the previous example configurations, too
--- Documentation/git-imap-send.txt | 1 - 1 file changed, 1 deletion(-)
Documentation/git-imap-send.txt +0 -2
@@ -123,7 +123,6 @@ to specify your account settings: host = imaps://imap.gmail.com user = [email protected] port = 993 - sslverify = false --------- You might need to instead use: folder = "[Google Mail]/Drafts" if you get an error --
Barbu Paul - Gheorghe
Common sense is not so common - Voltaire
Visit My GitHub profile to see my open-source projects - https://github.com/paullik
Quoted 6 lines · Barbu Paul - Gheorghe
Since GMail is SSL capable there is no need to set sslverify to false, the example using it may confuse readers that it's needed since it's also used in the previous example configurations, too
Signed-off-by Barbu Paul - Gheorghe <[email protected]>---
Thanks.
While removing that item from the configuration is a good thing to do in the post 1.8.2.1 era, the reason why it is does not have much to do with "GMail is SSL capable".
The configuration item is not about "Do we connect over SSL when talking to this host?", but is about "When we use SSL with this host, do we verify the certificate it gave us?".
The reason why we can run with sslverify=true against gmail is because we know imap.gmail.com gives a validly signed certificate that leads all the way to a root CA the user's OpenSSL installation is likely to trust (if your hand-rolled imap-over-ssl server uses a snakeoil certificate, even though the server may be "SSL capable", you may not be able to successfully connect to it without sslverify turned off).
Side note. Before 1.8.2 and/or 1.8.1.4, git-imap-send did not implement sslverify correctly; CVS-2013-0308 was inherited from its origin "isync", where it _did_ verify the certificate is valid, but did not make sure the certificate was for the host it thought it was talking with.
Also note that 1.8.2.1 and/or 1.8.1.6 were the first versions that support Server Name Identification (RFC4366). Connection with older versions of git-imap-send over SSL to hosts like googlemail.com that multi-home different SSL hosts can receive a valid certificate for another host that sits at the same IP address, which will lead to the sslverify check to fail.
Quoted 14 lines
Documentation/git-imap-send.txt | 1 - 1 file changed, 1 deletion(-)Documentation/git-imap-send.txt +0
-1@@ -123,7 +123,6 @@ to specify your account settings: host = imaps://imap.gmail.com user = [email protected] port = 993 - sslverify = false --------- You might need to instead use: folder = "[Google Mail]/Drafts" if you get an error
Quoted 7 lines · Junio C Hamano
The reason why we can run with sslverify=true against gmail is because we know imap.gmail.com gives a validly signed certificate that leads all the way to a root CA the user's OpenSSL installation is likely to trust (if your hand-rolled imap-over-ssl server uses a snakeoil certificate, even though the server may be "SSL capable", you may not be able to successfully connect to it without sslverify turned off).
Maybe imap-send should learn imap.sslCAInfo and imap.sslCAPath like http.* to handle custom certificates.
Quoted 11 lines
Documentation/git-imap-send.txt to specify your account settings: · line 127
Quoted 11 lines
Documentation/git-imap-send.txt +0
-1@@ -123,7 +123,6 @@ to specify your account settings: host = imaps://imap.gmail.com user = [email protected] port = 993 - sslverify = false --------- You might need to instead use: folder = "[Google Mail]/Drafts" if you get an error
I think we should remove sslverify = false from the other example as well. "Recommending" sslverify = false is IMHO a bad idea as SSL provides no protection without verification.
Regards
Simon
Signature · 3 lines
+ privacy is necessary + using gnupg http://gnupg.org + public key id: 0x92FEFDB7E44C32F9
Quoted 3 lines · Simon Ruderich
I think we should remove sslverify = false from the other example as well. "Recommending" sslverify = false is IMHO a bad idea as SSL provides no protection without verification.
Yep, that was why I thought there should be at least an example without it.
Should I create a new patch removing them all?
Signature · 3 lines
Barbu Paul - Gheorghe Common sense is not so common - Voltaire Visit My GitHub profile to see my open-source projects - https://github.com/paullik
Quoted 1 line · Barbu Paul - Gheorghe
Should I create a new patch removing them all?
Sounds like a good idea to me. And update the commit message with Junio's suggestions.
Regards
Simon
Signature · 3 lines
+ privacy is necessary + using gnupg http://gnupg.org + public key id: 0x92FEFDB7E44C32F9
PATCH 1/1 git-imap-send.txt: remove the use of sslverify=false
Since SSL provides no protection if the certificates aren't verified it's better not to include sslverify=false in the examples.
Also in the post 1.8.2.1 era git is able to properly verify the validity of a certificate as well it's origin.
--- Documentation/git-imap-send.txt | 2 -- 1 file changed, 2 deletions(-)
Documentation/git-imap-send.txt +0 -1
@@ -108,7 +108,6 @@ Using direct mode with SSL: user = bob pass = p4ssw0rd port = 123 - sslverify = false .......................... @@ -123,7 +122,6 @@ to specify your account settings: host = imaps://imap.gmail.com
user = [email protected]
port = 993
- sslverify = false
---------
You might need to instead use: folder = "[Google Mail]/Drafts" if you get an error
Signature · 3 lines
Barbu Paul - Gheorghe Common sense is not so common - Voltaire Visit My GitHub profile to see my open-source projects - https://github.com/paullik
Re: [PATCH] git-imap-send.txt: remove the use of sslverify=false
Quoted 17 lines · Barbu Paul - Gheorghe
Since SSL provides no protection if the certificates aren't verified it's better not to include sslverify=false in the examples.
Also in the post 1.8.2.1 era git is able to properly verify the validity of a certificate as well it's origin.Signed-off-by Barbu Paul - Gheorghe <[email protected]>--- Documentation/git-imap-send.txt | 2 -- 1 file changed, 2 deletions(-)Documentation/git-imap-send.txt +0
-0@@ -108,7 +108,6 @@ Using direct mode with SSL: user = bob pass = p4ssw0rd
Documentation/git-imap-send.txt Using direct mode with SSL:
Quoted 10 lines
Documentation/git-imap-send.txt +0
-2port = 123 - sslverify = false @@ -123,7 +122,6 @@ to specify your account settings: host = imaps://imap.gmail.com user = [email protected] port = 993 - sslverify = false --------- You might need to instead use: folder = "[Google Mail]/Drafts" if you get an error
It is amusing that an MTA can mangle such a short patch this badly.
Count the number of preimage lines in the first hunk and you see only 5 lines but you claim it has 7. Where did the other two go? The second hunk has the same problem. "@@" that introduces the second hunk is not at the leftmost column. Where did the leading SP come from?
The examples in the documentation are primarily to demonstrate how the supported configurations and options can be used and for what purpose. its secondary purpose is to nudge the readers into the best practice.
So I'd suggest a patch that does these things instead of just removing these two:
(0) Remove the duplication between the Examples header with ~~~~~~ underline and the EXAMPLE header with ------ underline.
(1) Use the second hunk of your patch to remove sslverify=false from that imap.gmail.com example. As a public service, it is unlikely that the server side is configured to throw a certificate that does not verify at you.
(2) Instead of removing sslverify=false in the imap.example.com example, comment it out like this:
- sslverify = false
+ ; sslverify = false
Then mention that the user may want to use sslverify=false while troubleshooting, if he suspects that the reason he is having trouble connecting is because the certificate he uses at the private server at example.com he is trying to set up (or has set up) may not be verified correctly.
Quoted 1 line · Junio C Hamano
Thanks.
My pleasure.
Quoted 3 lines
While removing that item from the configuration is a good thing to do in the post 1.8.2.1 era, the reason why it is does not have much to do with "GMail is SSL capable".
Should I change the commit message in order to avoid confusion among devs that read it?
Quoted 3 lines
The configuration item is not about "Do we connect over SSL when talking to this host?", but is about "When we use SSL with this host, do we verify the certificate it gave us?".
If I change it, how should it sound?
It could be:
Since GMail's certificates can be sslverify-ed there is no need to set sslverify to false, the example using it may confuse readers that it's needed since it's also used in the previous example configurations, too.
Have a nice day!
Signature · 3 lines
Barbu Paul - Gheorghe Common sense is not so common - Voltaire Visit My GitHub profile to see my open-source projects - https://github.com/paullik