diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/OSSL_HTTP_transfer.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/OSSL_HTTP_transfer.3 | 23 |
1 files changed, 13 insertions, 10 deletions
diff --git a/secure/lib/libcrypto/man/man3/OSSL_HTTP_transfer.3 b/secure/lib/libcrypto/man/man3/OSSL_HTTP_transfer.3 index 4863e639a8b6..4c325861d7fc 100644 --- a/secure/lib/libcrypto/man/man3/OSSL_HTTP_transfer.3 +++ b/secure/lib/libcrypto/man/man3/OSSL_HTTP_transfer.3 @@ -1,5 +1,5 @@ .\" -*- mode: troff; coding: utf-8 -*- -.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -52,10 +52,13 @@ . \} .\} .rr rF +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l .\" ======================================================================== .\" .IX Title "OSSL_HTTP_TRANSFER 3ossl" -.TH OSSL_HTTP_TRANSFER 3ossl 2025-09-30 3.5.4 OpenSSL +.TH OSSL_HTTP_TRANSFER 3ossl 2026-04-07 3.5.6 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -115,7 +118,7 @@ OSSL_HTTP_close NULL, else by connecting to a given \fIserver\fR optionally via a \fIproxy\fR. .PP Typically the OpenSSL build supports sockets and the \fIbio\fR parameter is NULL. -In this case \fIrbio\fR must be NULL as well and the \fIserver\fR must be non-NULL. +In this case \fIrbio\fR must be NULL as well and the \fIserver\fR must be non\-NULL. The function creates a network BIO internally using \fBBIO_new_connect\fR\|(3) for connecting to the given server and the optionally given \fIport\fR, defaulting to 80 for HTTP or 443 for HTTPS. @@ -130,7 +133,7 @@ As soon as the client has flushed \fIbio\fR the server must be ready to provide a response or indicate a waiting condition via \fIrbio\fR. .PP If \fIbio\fR is given, -it is an error to provide non-NULL \fIproxy\fR or \fIno_proxy\fR arguments, +it is an error to provide non\-NULL \fIproxy\fR or \fIno_proxy\fR arguments, while \fIserver\fR and \fIport\fR arguments may be given to support diagnostic output. If \fIbio\fR is NULL the optional \fIproxy\fR parameter can be used to set an HTTP(S) proxy to use (unless overridden by "no_proxy" settings). @@ -217,7 +220,7 @@ A value <= 0 enables waiting indefinitely, i.e., no timeout. \&\fBOSSL_HTTP_proxy_connect()\fR may be used by an above BIO connect callback function to set up an SSL/TLS connection via an HTTPS proxy. It promotes the given BIO \fIbio\fR representing a connection -pre-established with a TLS proxy using the HTTP CONNECT method, +pre\-established with a TLS proxy using the HTTP CONNECT method, optionally using proxy client credentials \fIproxyuser\fR and \fIproxypass\fR, to connect with TLS protection ultimately to \fIserver\fR and \fIport\fR. If the \fIport\fR argument is NULL or the empty string it defaults to "443". @@ -226,7 +229,7 @@ seconds the connection setup is allowed to take. A value <= 0 enables waiting indefinitely, i.e., no timeout. Since this function is typically called by applications such as \&\fBopenssl\-s_client\fR\|(1) it uses the \fIbio_err\fR and \fIprog\fR parameters (unless -NULL) to print additional diagnostic information in a user-oriented way. +NULL) to print additional diagnostic information in a user\-oriented way. .PP \&\fBOSSL_HTTP_set1_request()\fR sets up in \fIrctx\fR the request header and content data and expectations on the response using the following parameters. @@ -239,7 +242,7 @@ If \fIpath\fR is NULL it defaults to "/". If \fIreq\fR is NULL the HTTP GET method will be used to send the request else HTTP POST with the contents of \fIreq\fR and optional \fIcontent_type\fR, where the length of the data in \fIreq\fR does not need to be determined in advance: the -BIO will be read on-the-fly while sending the request, which supports streaming. +BIO will be read on\-the\-fly while sending the request, which supports streaming. The optional list \fIheaders\fR may contain additional custom HTTP header lines. The \fImax_resp_len\fR parameter specifies the maximum allowed response content length, where the value 0 indicates no limit. @@ -265,11 +268,11 @@ Otherwise it returns directly the read BIO that holds the response contents, which allows a response of indefinite length and may support streaming. The caller is responsible for freeing the BIO pointer obtained. .PP -\&\fBOSSL_HTTP_get()\fR uses HTTP GET to obtain data from \fIbio\fR if non-NULL, +\&\fBOSSL_HTTP_get()\fR uses HTTP GET to obtain data from \fIbio\fR if non\-NULL, else from the server contained in the \fIurl\fR, and returns it as a BIO. It supports redirection via HTTP status code 301 or 302. It is meant for transfers with a single round trip, so does not support persistent connections. -If \fIbio\fR is non-NULL, any host and port components in the \fIurl\fR are not used +If \fIbio\fR is non\-NULL, any host and port components in the \fIurl\fR are not used for connecting but the hostname is used, as usual, for the \f(CW\*(C`Host\*(C'\fR header. Any userinfo and fragment components in the \fIurl\fR are ignored. Any query component is handled as part of the path component. @@ -283,7 +286,7 @@ The caller is responsible for freeing the BIO pointer obtained. over a connection managed via \fIprctx\fR without supporting redirection. It combines \fBOSSL_HTTP_open()\fR, \fBOSSL_HTTP_set1_request()\fR, \fBOSSL_HTTP_exchange()\fR, and \fBOSSL_HTTP_close()\fR. -If \fIprctx\fR is not NULL it reuses any open connection represented by a non-NULL +If \fIprctx\fR is not NULL it reuses any open connection represented by a non\-NULL \&\fI*prctx\fR. It keeps the connection open if a persistent connection is requested or required and this was granted by the server, else it closes the connection and assigns NULL to \fI*prctx\fR. |