xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/X509_load_http.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: X509_load_http.3,v 1.5 2024/09/08 13:08:37 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "X509_load_http 3"
X509_load_http 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
X509_load_http, X509_http_nbio, X509_CRL_load_http, X509_CRL_http_nbio \- certificate and CRL loading functions
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/x509.h> \& X509 *X509_load_http(const char *url, BIO *bio, BIO *rbio, int timeout); X509_CRL *X509_CRL_load_http(const char *url, BIO *bio, BIO *rbio, int timeout); .Ve

The following macros have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining OPENSSL_API_COMPAT with a suitable version value, see openssl_user_macros\|(7):

.Vb 2 #define X509_http_nbio(rctx, pcert) #define X509_CRL_http_nbio(rctx, pcrl) .Ve

DESCRIPTION
Header "DESCRIPTION" \fBX509_load_http() and X509_CRL_load_http() loads a certificate or a CRL, respectively, in ASN.1 format using HTTP from the given url.

If bio is given and rbio is NULL then this BIO is used instead of an internal one for connecting, writing the request, and reading the response. If both bio and rbio are given (which may be memory BIOs, for instance) then no explicit connection is attempted, \fBbio is used for writing the request, and rbio for reading the response.

If the timeout parameter is > 0 this indicates the maximum number of seconds to wait until the transfer is complete. A value of 0 enables waiting indefinitely, while a value < 0 immediately leads to a timeout condition.

\fBX509_http_nbio() and X509_CRL_http_nbio() are macros for backward compatibility that have the same effect as the functions above but with infinite timeout and without the possibility to specify custom BIOs.

"RETURN VALUES"
Header "RETURN VALUES" On success the function yield the loaded value, else NULL. Error conditions include connection/transfer timeout, parse errors, etc.
"SEE ALSO"
Header "SEE ALSO" \fBOSSL_HTTP_get\|(3)
HISTORY
Header "HISTORY" \fBX509_load_http() and X509_CRL_load_http() were added in OpenSSL 3.0. \fBX509_http_nbio() and X509_CRL_http_nbio() were deprecated in OpenSSL 3.0.
COPYRIGHT
Header "COPYRIGHT" Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.