Debian Codegraph @

upstream/debian-unstable/man3/X509_load_http.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "X509_LOAD_HTTP 3SSL"
58 .TH X509_LOAD_HTTP 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 X509_load_http,
65 X509_http_nbio,
66 X509_CRL_load_http,
67 X509_CRL_http_nbio
68 \&\- certificate and CRL loading functions
69 .SH SYNOPSIS
70 .IX Header "SYNOPSIS"
71 .Vb 1
72 \& #include <openssl/x509.h>
73 \&
74 \& X509 *X509_load_http(const char *url, BIO *bio, BIO *rbio, int timeout);
75 \& X509_CRL *X509_CRL_load_http(const char *url, BIO *bio, BIO *rbio, int timeout);
76 .Ve
77 .PP
78 The following macros have been deprecated since OpenSSL 3.0, and can be
79 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
80 see \fBopenssl_user_macros\fR\|(7):
81 .PP
82 .Vb 2
83 \& #define X509_http_nbio(rctx, pcert)
84 \& #define X509_CRL_http_nbio(rctx, pcrl)
85 .Ve
86 .SH DESCRIPTION
87 .IX Header "DESCRIPTION"
88 \&\fBX509_load_http()\fR and \fBX509_CRL_load_http()\fR loads a certificate or a CRL,
89 respectively, in ASN.1 format using HTTP from the given \fBurl\fR.
90 .PP
91 Maximum size of the HTTP response is 100 kB for certificates and 32 MB for CRLs
92 and hard coded in the functions.
93 .PP
94 If \fBbio\fR is given and \fBrbio\fR is NULL then this BIO is used instead of an
95 internal one for connecting, writing the request, and reading the response.
96 If both \fBbio\fR and \fBrbio\fR are given (which may be memory BIOs, for instance)
97 then no explicit connection is attempted,
98 \&\fBbio\fR is used for writing the request, and \fBrbio\fR for reading the response.
99 .PP
100 If the \fBtimeout\fR parameter is > 0 this indicates the maximum number of seconds
101 to wait until the transfer is complete.
102 A value of 0 enables waiting indefinitely,
103 while a value < 0 immediately leads to a timeout condition.
104 .PP
105 \&\fBX509_http_nbio()\fR and \fBX509_CRL_http_nbio()\fR are macros for backward compatibility
106 that have the same effect as the functions above but with infinite timeout
107 and without the possibility to specify custom BIOs.
108 .SH "RETURN VALUES"
109 .IX Header "RETURN VALUES"
110 On success the function yield the loaded value, else NULL.
111 Error conditions include connection/transfer timeout, parse errors, etc.
112 .SH "SEE ALSO"
113 .IX Header "SEE ALSO"
114 \&\fBOSSL_HTTP_get\fR\|(3)
115 .SH HISTORY
116 .IX Header "HISTORY"
117 \&\fBX509_load_http()\fR and \fBX509_CRL_load_http()\fR were added in OpenSSL 3.0.
118 \&\fBX509_http_nbio()\fR and \fBX509_CRL_http_nbio()\fR were deprecated in OpenSSL 3.0.
119 .SH COPYRIGHT
120 .IX Header "COPYRIGHT"
121 Copyright 2019\-2021 The OpenSSL Project Authors. All Rights Reserved.
122 .PP
123 Licensed under the Apache License 2.0 (the "License"). You may not use
124 this file except in compliance with the License. You can obtain a copy
125 in the file LICENSE in the source distribution or at
126 <https://www.openssl.org/source/license.html>.