diff options
author | Dr. David von Oheimb <David.von.Oheimb@siemens.com> | 2021-05-11 15:45:22 +0200 |
---|---|---|
committer | Dr. David von Oheimb <dev@ddvo.net> | 2021-05-14 19:24:42 +0200 |
commit | 647a5dbf10227d65919b49d078da4eaca313f921 (patch) | |
tree | 308c8dfb9fbc850077796579e14b9476b6966b88 /doc | |
parent | e2c38c1a4e034f3fac817870902db6d8bc117119 (diff) | |
download | openssl-new-647a5dbf10227d65919b49d078da4eaca313f921.tar.gz |
Add OSSL_ prefix to HTTP_DEFAULT_MAX_{LINE_LENGTH,RESP_LEN}
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15053)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man3/OSSL_HTTP_REQ_CTX.pod | 6 | ||||
-rw-r--r-- | doc/man3/OSSL_HTTP_transfer.pod | 5 |
2 files changed, 5 insertions, 6 deletions
diff --git a/doc/man3/OSSL_HTTP_REQ_CTX.pod b/doc/man3/OSSL_HTTP_REQ_CTX.pod index 99396dfe7e..ec358d265f 100644 --- a/doc/man3/OSSL_HTTP_REQ_CTX.pod +++ b/doc/man3/OSSL_HTTP_REQ_CTX.pod @@ -64,8 +64,8 @@ which gets populated with the B<BIO> to write/send the request to (I<wbio>), the B<BIO> to read/receive the response from (I<rbio>, which may be equal to I<wbio>), and the maximum expected response header line length I<buf_size>. A value <= 0 indicates that -the B<HTTP_DEFAULT_MAX_LINE_LENGTH> of 4KiB should be used. -This length is also used as the number of content bytes that are read at a time. +the B<OSSL_HTTP_DEFAULT_MAX_LINE_LEN> of 4KiB should be used. +I<buf_size> is also used as the number of content bytes that are read at a time. The allocated context structure is also populated with an internal allocated memory B<BIO>, which collects the HTTP request and additional headers as text. @@ -154,7 +154,7 @@ in I<rctx> if provided by the server as <Content-Length> header field, else 0. OSSL_HTTP_REQ_CTX_set_max_response_length() sets the maximum allowed response content length for I<rctx> to I<len>. If not set or I<len> is 0 -then the B<HTTP_DEFAULT_MAX_RESP_LEN> is used, which currently is 100 KiB. +then the B<OSSL_HTTP_DEFAULT_MAX_RESP_LEN> is used, which currently is 100 KiB. If the C<Content-Length> header is present and exceeds this value or the content is an ASN.1 encoded structure with a length exceeding this value or both length indications are present but disagree then an error occurs. diff --git a/doc/man3/OSSL_HTTP_transfer.pod b/doc/man3/OSSL_HTTP_transfer.pod index 0133122558..d6eb39f652 100644 --- a/doc/man3/OSSL_HTTP_transfer.pod +++ b/doc/man3/OSSL_HTTP_transfer.pod @@ -123,9 +123,8 @@ Here is a simple example that supports TLS connections (but not via a proxy): After disconnect the modified BIO will be deallocated using BIO_free_all(). The I<buf_size> parameter specifies the response header maximum line length. -A value <= 0 indicates that -the B<HTTP_DEFAULT_MAX_LINE_LENGTH> of 4KiB should be used. -This length is also used as the number of content bytes that are read at a time. +A value <= 0 means that the B<OSSL_HTTP_DEFAULT_MAX_LINE_LEN> (4KiB) is used. +I<buf_size> is also used as the number of content bytes that are read at a time. If the I<overall_timeout> parameter is > 0 this indicates the maximum number of seconds the overall HTTP transfer (i.e., connection setup if needed, |