diff mbox series

[v3] http: document sslcert and sslkey types and extend to proxy

Message ID pull.1520.v3.git.1682021501245.gitgitgadget@gmail.com (mailing list archive)
State Superseded
Headers show
Series [v3] http: document sslcert and sslkey types and extend to proxy | expand

Commit Message

Ricky Davidson April 20, 2023, 8:11 p.m. UTC
From: Ricky Davidson <Ricky.Davidson@hii-tsd.com>

0a01d41ee4 (http: add support for different sslcert and sslkey
types., 2023-03-20) added http.sslCertType and http.sslKeyType, but:

1. it does not document the feature.
2. it does not apply to SSL proxy equivalents.

Documents http.sslCertType and http.sslKeyType. Implements
http.proxySSLCertType. Does the same for http.sslKeyType and
http.proxySSLKeyType equivalents and related environment
variables.

Signed-off-by: Ricky Davidson <Ricky.Davidson@hii-tsd.com>
---
    [PATCH] http: document sslcert and sslkey types and extend to proxy
    
    0a01d41ee4 (http: add support for different sslcert and sslkey types.,
    2023-03-20) added http.sslCertType and http.sslKeyType, but:
    
     1. it does not document the feature.
     2. it does not apply to SSL proxy equivalents.
    
    Documents http.sslCertType and http.sslKeyType. Implements
    http.proxySSLCertType. Does the same for http.sslKeyType and
    http.proxySSLKeyType equivalents and related environment variables.
    
    Signed-off-by: Ricky Davidson Ricky.Davidson@hii-tsd.com

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1520%2FRicky-Davidson-hii-tsd%2Fmaster-v3
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1520/Ricky-Davidson-hii-tsd/master-v3
Pull-Request: https://github.com/gitgitgadget/git/pull/1520

Range-diff vs v2:

 1:  78b96f60ec8 ! 1:  020c03104f4 http: document sslcert and sslkey types and extend to proxy
     @@ Metadata
       ## Commit message ##
          http: document sslcert and sslkey types and extend to proxy
      
     -    0a01d41 added http.sslCertType and http.sslKeyType, but:
     +    0a01d41ee4 (http: add support for different sslcert and sslkey
     +    types., 2023-03-20) added http.sslCertType and http.sslKeyType, but:
      
     -    1. does not document the feature.
     -    2. does not apply to SSL proxy equivalents.
     +    1. it does not document the feature.
     +    2. it does not apply to SSL proxy equivalents.
      
          Documents http.sslCertType and http.sslKeyType. Implements
     -    http.proxySSLCertType. Same for http.sslKeyType and
     +    http.proxySSLCertType. Does the same for http.sslKeyType and
          http.proxySSLKeyType equivalents and related environment
          variables.
      


 Documentation/config/http.txt | 24 ++++++++++++++++++++++++
 http.c                        | 12 ++++++++++++
 2 files changed, 36 insertions(+)


base-commit: 667fcf4e15379790f0b609d6a83d578e69f20301

Comments

Ricky Davidson April 20, 2023, 9:14 p.m. UTC | #1
> I think it is the first time we see your patches around here.
> Welcome to Git developer community.

First time, yes thank you. I am sorry about late replies: I have struggled
with all listed methods of replying not working.

> I wonder if we can add some tests for the feature, though.

I would love if there was a way to test it. But my historical
understanding of this issue is that it has been repeatedly not merged
in due to lack of anyone knowing how to test it, given the nature of
a hardware token (what this is especially focused at explicitly
enabling) generally being hardware. Technically, I am sure pkcs11 can
apply to software tokens, but I have never ventured the topic. I'm
also aware KVM+Qemu+Libvirt allows creating virtual smart cards, but
I also have not ventured that topic. I have been following this issue
since May of last year in private support tickets, and I do not feel
I am able to contribute anything that has not already been pondered
over this issue. I strongly welcome ideas, though.

0a01d41e (http: add support for different sslcert and sslkey types.,
2023-03-20) does solve our main issues (which is absolutely
wonderful), and this is only to finish it up with documentation, and
proxySSLCertType does not personally affect me, so I am not bothered
with the wait associated with consulting on proper testing.
Although, it would be a shame to see this fail to get pushed in again.

Thanks,
Ricky Davidson
Ramsay Jones April 21, 2023, 12:47 a.m. UTC | #2
On 20/04/2023 21:11, Ricky Davidson via GitGitGadget wrote:
> From: Ricky Davidson <Ricky.Davidson@hii-tsd.com>
> 
> 0a01d41ee4 (http: add support for different sslcert and sslkey
> types., 2023-03-20) added http.sslCertType and http.sslKeyType, but:
> 
> 1. it does not document the feature.
> 2. it does not apply to SSL proxy equivalents.
> 
> Documents http.sslCertType and http.sslKeyType. Implements
> http.proxySSLCertType. Does the same for http.sslKeyType and
> http.proxySSLKeyType equivalents and related environment
> variables.
> 
> Signed-off-by: Ricky Davidson <Ricky.Davidson@hii-tsd.com>
> ---
>     [PATCH] http: document sslcert and sslkey types and extend to proxy
>     
>     0a01d41ee4 (http: add support for different sslcert and sslkey types.,
>     2023-03-20) added http.sslCertType and http.sslKeyType, but:
>     
>      1. it does not document the feature.
>      2. it does not apply to SSL proxy equivalents.
>     
>     Documents http.sslCertType and http.sslKeyType. Implements
>     http.proxySSLCertType. Does the same for http.sslKeyType and
>     http.proxySSLKeyType equivalents and related environment variables.
>     
>     Signed-off-by: Ricky Davidson Ricky.Davidson@hii-tsd.com
> 
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1520%2FRicky-Davidson-hii-tsd%2Fmaster-v3
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1520/Ricky-Davidson-hii-tsd/master-v3
> Pull-Request: https://github.com/gitgitgadget/git/pull/1520
> 
> Range-diff vs v2:
> 
>  1:  78b96f60ec8 ! 1:  020c03104f4 http: document sslcert and sslkey types and extend to proxy
>      @@ Metadata
>        ## Commit message ##
>           http: document sslcert and sslkey types and extend to proxy
>       
>      -    0a01d41 added http.sslCertType and http.sslKeyType, but:
>      +    0a01d41ee4 (http: add support for different sslcert and sslkey
>      +    types., 2023-03-20) added http.sslCertType and http.sslKeyType, but:
>       
>      -    1. does not document the feature.
>      -    2. does not apply to SSL proxy equivalents.
>      +    1. it does not document the feature.
>      +    2. it does not apply to SSL proxy equivalents.
>       
>           Documents http.sslCertType and http.sslKeyType. Implements
>      -    http.proxySSLCertType. Same for http.sslKeyType and
>      +    http.proxySSLCertType. Does the same for http.sslKeyType and
>           http.proxySSLKeyType equivalents and related environment
>           variables.
>       
> 
> 
>  Documentation/config/http.txt | 24 ++++++++++++++++++++++++
>  http.c                        | 12 ++++++++++++
>  2 files changed, 36 insertions(+)
> 
> diff --git a/Documentation/config/http.txt b/Documentation/config/http.txt
> index afeeccfbfa7..53386b90185 100644
> --- a/Documentation/config/http.txt
> +++ b/Documentation/config/http.txt
> @@ -34,11 +34,23 @@ http.proxySSLCert::
>  	with an HTTPS proxy. Can be overridden by the `GIT_PROXY_SSL_CERT` environment
>  	variable.
>  
> +http.proxySSLCertType::
> +	Format of the client certificate used to authenticate with an HTTPS proxy.
> +	Supported formats are `PEM` and `ENG`. The format `ENG` enables loading from
> +	a crypto engine. Can be overridden by the `GIT_PROXY_SSL_CERT_TYPE` environment
> +	variable.
> +
>  http.proxySSLKey::
>  	The pathname of a file that stores a private key to use to authenticate with
>  	an HTTPS proxy. Can be overridden by the `GIT_PROXY_SSL_KEY` environment
>  	variable.
>  
> +http.proxySSLKeyType::
> +	Format of the client private key used to authenticate with an HTTPS proxy.
> +	Supported formats are `PEM` and `ENG`. The format `ENG` enables loading from
> +	a crypto engine. Can be overridden by the `GIT_PROXY_SSL_KEY_TYPE` environment
> +	variable.
> +
>  http.proxySSLCertPasswordProtected::
>  	Enable Git's password prompt for the proxy SSL certificate.  Otherwise OpenSSL
>  	will prompt the user, possibly many times, if the certificate or private key
> @@ -161,11 +173,23 @@ http.sslCert::
>  	over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
>  	variable.
>  
> +http.sslCertType::
> +	Format of the SSL certificate used to authenticate over HTTPS.
> +	Supported formats are `PEM` and `ENG`. The format `ENG` enables loading from
> +	a crypto engine. Can be overridden by the `GIT_SSL_CERT_TYPE` environment
> +	variable.
> +
>  http.sslKey::
>  	File containing the SSL private key when fetching or pushing
>  	over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
>  	variable.
>  
> +http.sslKeyType::
> +	Format of the SSL private key used to authenticate over HTTPS.
> +	Supported formats are `PEM` and `ENG`. The format `ENG` enables loading from
> +	a crypto engine. Can be overridden by the `GIT_SSL_CERT_TYPE` environment

s/GIT_SSL_CERT_TYPE/GIT_SSL_KEY_TYPE/ ?

ATB,
Ramsay Jones

> +	variable.
> +
>  http.sslCertPasswordProtected::
>  	Enable Git's password prompt for the SSL certificate.  Otherwise
>  	OpenSSL will prompt the user, possibly many times, if the
> diff --git a/http.c b/http.c
> index d5d82c5230f..bee4ea64115 100644
> --- a/http.c
> +++ b/http.c
> @@ -74,7 +74,9 @@ static const char *curl_http_proxy;
>  static const char *http_proxy_authmethod;
>  
>  static const char *http_proxy_ssl_cert;
> +static const char *http_proxy_ssl_cert_type;
>  static const char *http_proxy_ssl_key;
> +static const char *http_proxy_ssl_key_type;
>  static const char *http_proxy_ssl_ca_info;
>  static struct credential proxy_cert_auth = CREDENTIAL_INIT;
>  static int proxy_ssl_cert_password_required;
> @@ -441,9 +443,13 @@ static int http_options(const char *var, const char *value, void *cb)
>  
>  	if (!strcmp("http.proxysslcert", var))
>  		return git_config_string(&http_proxy_ssl_cert, var, value);
> +	if (!strcmp("http.proxysslcerttype", var))
> +		return git_config_string(&http_proxy_ssl_cert_type, var, value);
>  
>  	if (!strcmp("http.proxysslkey", var))
>  		return git_config_string(&http_proxy_ssl_key, var, value);
> +	if (!strcmp("http.proxysslkeytype", var))
> +		return git_config_string(&http_proxy_ssl_key_type, var, value);
>  
>  	if (!strcmp("http.proxysslcainfo", var))
>  		return git_config_string(&http_proxy_ssl_ca_info, var, value);
> @@ -1146,9 +1152,13 @@ static CURL *get_curl_handle(void)
>  
>  			if (http_proxy_ssl_cert)
>  				curl_easy_setopt(result, CURLOPT_PROXY_SSLCERT, http_proxy_ssl_cert);
> +			if (http_proxy_ssl_cert_type)
> +				curl_easy_setopt(result, CURLOPT_PROXY_SSLCERTTYPE, http_proxy_ssl_cert_type);
>  
>  			if (http_proxy_ssl_key)
>  				curl_easy_setopt(result, CURLOPT_PROXY_SSLKEY, http_proxy_ssl_key);
> +			if (http_proxy_ssl_key_type)
> +				curl_easy_setopt(result, CURLOPT_PROXY_SSLKEYTYPE, http_proxy_ssl_key_type);
>  
>  			if (has_proxy_cert_password())
>  				curl_easy_setopt(result, CURLOPT_PROXY_KEYPASSWD, proxy_cert_auth.password);
> @@ -1285,7 +1295,9 @@ void http_init(struct remote *remote, const char *url, int proactive_auth)
>  		max_requests = DEFAULT_MAX_REQUESTS;
>  
>  	set_from_env(&http_proxy_ssl_cert, "GIT_PROXY_SSL_CERT");
> +	set_from_env(&http_proxy_ssl_cert_type, "GIT_PROXY_SSL_CERT_TYPE");
>  	set_from_env(&http_proxy_ssl_key, "GIT_PROXY_SSL_KEY");
> +	set_from_env(&http_proxy_ssl_key_type, "GIT_PROXY_SSL_KEY_TYPE");
>  	set_from_env(&http_proxy_ssl_ca_info, "GIT_PROXY_SSL_CAINFO");
>  
>  	if (getenv("GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED"))
> 
> base-commit: 667fcf4e15379790f0b609d6a83d578e69f20301
Ricky Davidson April 21, 2023, 3:18 a.m. UTC | #3
> s/GIT_SSL_CERT_TYPE/GIT_SSL_KEY_TYPE/ ?

Ah, yes, thank you. Another patch will be inbound. Also, I am a little concerned about the language in "Supported formats are `PEM` and `ENG`.", so I will change that too.
diff mbox series

Patch

diff --git a/Documentation/config/http.txt b/Documentation/config/http.txt
index afeeccfbfa7..53386b90185 100644
--- a/Documentation/config/http.txt
+++ b/Documentation/config/http.txt
@@ -34,11 +34,23 @@  http.proxySSLCert::
 	with an HTTPS proxy. Can be overridden by the `GIT_PROXY_SSL_CERT` environment
 	variable.
 
+http.proxySSLCertType::
+	Format of the client certificate used to authenticate with an HTTPS proxy.
+	Supported formats are `PEM` and `ENG`. The format `ENG` enables loading from
+	a crypto engine. Can be overridden by the `GIT_PROXY_SSL_CERT_TYPE` environment
+	variable.
+
 http.proxySSLKey::
 	The pathname of a file that stores a private key to use to authenticate with
 	an HTTPS proxy. Can be overridden by the `GIT_PROXY_SSL_KEY` environment
 	variable.
 
+http.proxySSLKeyType::
+	Format of the client private key used to authenticate with an HTTPS proxy.
+	Supported formats are `PEM` and `ENG`. The format `ENG` enables loading from
+	a crypto engine. Can be overridden by the `GIT_PROXY_SSL_KEY_TYPE` environment
+	variable.
+
 http.proxySSLCertPasswordProtected::
 	Enable Git's password prompt for the proxy SSL certificate.  Otherwise OpenSSL
 	will prompt the user, possibly many times, if the certificate or private key
@@ -161,11 +173,23 @@  http.sslCert::
 	over HTTPS. Can be overridden by the `GIT_SSL_CERT` environment
 	variable.
 
+http.sslCertType::
+	Format of the SSL certificate used to authenticate over HTTPS.
+	Supported formats are `PEM` and `ENG`. The format `ENG` enables loading from
+	a crypto engine. Can be overridden by the `GIT_SSL_CERT_TYPE` environment
+	variable.
+
 http.sslKey::
 	File containing the SSL private key when fetching or pushing
 	over HTTPS. Can be overridden by the `GIT_SSL_KEY` environment
 	variable.
 
+http.sslKeyType::
+	Format of the SSL private key used to authenticate over HTTPS.
+	Supported formats are `PEM` and `ENG`. The format `ENG` enables loading from
+	a crypto engine. Can be overridden by the `GIT_SSL_CERT_TYPE` environment
+	variable.
+
 http.sslCertPasswordProtected::
 	Enable Git's password prompt for the SSL certificate.  Otherwise
 	OpenSSL will prompt the user, possibly many times, if the
diff --git a/http.c b/http.c
index d5d82c5230f..bee4ea64115 100644
--- a/http.c
+++ b/http.c
@@ -74,7 +74,9 @@  static const char *curl_http_proxy;
 static const char *http_proxy_authmethod;
 
 static const char *http_proxy_ssl_cert;
+static const char *http_proxy_ssl_cert_type;
 static const char *http_proxy_ssl_key;
+static const char *http_proxy_ssl_key_type;
 static const char *http_proxy_ssl_ca_info;
 static struct credential proxy_cert_auth = CREDENTIAL_INIT;
 static int proxy_ssl_cert_password_required;
@@ -441,9 +443,13 @@  static int http_options(const char *var, const char *value, void *cb)
 
 	if (!strcmp("http.proxysslcert", var))
 		return git_config_string(&http_proxy_ssl_cert, var, value);
+	if (!strcmp("http.proxysslcerttype", var))
+		return git_config_string(&http_proxy_ssl_cert_type, var, value);
 
 	if (!strcmp("http.proxysslkey", var))
 		return git_config_string(&http_proxy_ssl_key, var, value);
+	if (!strcmp("http.proxysslkeytype", var))
+		return git_config_string(&http_proxy_ssl_key_type, var, value);
 
 	if (!strcmp("http.proxysslcainfo", var))
 		return git_config_string(&http_proxy_ssl_ca_info, var, value);
@@ -1146,9 +1152,13 @@  static CURL *get_curl_handle(void)
 
 			if (http_proxy_ssl_cert)
 				curl_easy_setopt(result, CURLOPT_PROXY_SSLCERT, http_proxy_ssl_cert);
+			if (http_proxy_ssl_cert_type)
+				curl_easy_setopt(result, CURLOPT_PROXY_SSLCERTTYPE, http_proxy_ssl_cert_type);
 
 			if (http_proxy_ssl_key)
 				curl_easy_setopt(result, CURLOPT_PROXY_SSLKEY, http_proxy_ssl_key);
+			if (http_proxy_ssl_key_type)
+				curl_easy_setopt(result, CURLOPT_PROXY_SSLKEYTYPE, http_proxy_ssl_key_type);
 
 			if (has_proxy_cert_password())
 				curl_easy_setopt(result, CURLOPT_PROXY_KEYPASSWD, proxy_cert_auth.password);
@@ -1285,7 +1295,9 @@  void http_init(struct remote *remote, const char *url, int proactive_auth)
 		max_requests = DEFAULT_MAX_REQUESTS;
 
 	set_from_env(&http_proxy_ssl_cert, "GIT_PROXY_SSL_CERT");
+	set_from_env(&http_proxy_ssl_cert_type, "GIT_PROXY_SSL_CERT_TYPE");
 	set_from_env(&http_proxy_ssl_key, "GIT_PROXY_SSL_KEY");
+	set_from_env(&http_proxy_ssl_key_type, "GIT_PROXY_SSL_KEY_TYPE");
 	set_from_env(&http_proxy_ssl_ca_info, "GIT_PROXY_SSL_CAINFO");
 
 	if (getenv("GIT_PROXY_SSL_CERT_PASSWORD_PROTECTED"))