diff options
author | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2021-04-30 18:36:00 +0200 |
---|---|---|
committer | Dr. David von Oheimb <dev@ddvo.net> | 2021-05-04 18:27:57 +0200 |
commit | 79a2bccdb058683f6a43d9f2f5dbc1998f7518e9 (patch) | |
tree | 69beff8671eced67a907f5921dff6ce02eb2d53f /doc/man3/OSSL_HTTP_transfer.pod | |
parent | 9520fe5f4987f3bd1a568ac4cf73e1a5401d5f6f (diff) |
HTTP client: Correct the use of optional proxy URL and its documentation
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15104)
Diffstat (limited to 'doc/man3/OSSL_HTTP_transfer.pod')
-rw-r--r-- | doc/man3/OSSL_HTTP_transfer.pod | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/man3/OSSL_HTTP_transfer.pod b/doc/man3/OSSL_HTTP_transfer.pod index 7de213670d..d2ff8eeebc 100644 --- a/doc/man3/OSSL_HTTP_transfer.pod +++ b/doc/man3/OSSL_HTTP_transfer.pod @@ -104,14 +104,15 @@ I<bio> is used for writing the request, and I<rbio> for reading the response. As soon as the client has flushed I<bio> the server must be ready to provide a response or indicate a waiting condition via I<rbio>. -The optional I<proxy> parameter can be used to set the address of the an +If I<bio> is NULL the optional I<proxy> parameter can be used to set an HTTP(S) proxy to use (unless overridden by "no_proxy" settings). If TLS is not used this defaults to the environment variable C<http_proxy> if set, else C<HTTP_PROXY>. If I<use_ssl> != 0 it defaults to C<https_proxy> if set, else C<HTTPS_PROXY>. -An empty proxy string specifies not to use a proxy. -Else the format is C<[http[s]://]address[:port][/path]>, -where any path given is ignored. +An empty proxy string C<""> forbids using a proxy. +Else the format is +C<[http[s]://][userinfo@]host[:port][/path][?query][#fragment]>, +where any userinfo, path, query, and fragment given is ignored. The default proxy port number is 80, or 443 in case "https:" is given. The HTTP client functions connect via the given proxy unless the I<server> is found in the optional list I<no_proxy> of proxy hostnames (if not NULL; |