doc/man3/X509_load_http.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 X509_load_http,
   6 X509_http_nbio,
   7 X509_CRL_load_http,
   8 X509_CRL_http_nbio
   9 - certificate and CRL loading functions
  10
  11 =head1 SYNOPSIS
  12
  13  #include <openssl/x509.h>
  14
  15  X509 *X509_load_http(const char *url, BIO *bio, BIO *rbio, int timeout);
  16  X509_CRL *X509_CRL_load_http(const char *url, BIO *bio, BIO *rbio, int timeout);
  17
  18 The following macros have been deprecated since OpenSSL 3.0, and can be
  19 hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
  20 see L<openssl_user_macros(7)>:
  21
  22  #define X509_http_nbio(rctx, pcert)
  23  #define X509_CRL_http_nbio(rctx, pcrl)
  24
  25 =head1 DESCRIPTION
  26
  27 X509_load_http() and X509_CRL_load_http() loads a certificate or a CRL,
  28 respectively, in ASN.1 format using HTTP from the given B<url>.
  29
  30 If B<bio> is given and B<rbio> is NULL then this BIO is used instead of an
  31 internal one for connecting, writing the request, and reading the response.
  32 If both B<bio> and B<rbio> are given (which may be memory BIOs, for instance)
  33 then no explicit connection is attempted,
  34 B<bio> is used for writing the request, and B<rbio> for reading the response.
  35
  36 If the B<timeout> parameter is > 0 this indicates the maximum number of seconds
  37 to wait until the transfer is complete.
  38 A value of 0 enables waiting indefinitely,
  39 while a value < 0 immediately leads to a timeout condition.
  40
  41 X509_http_nbio() and X509_CRL_http_nbio() are macros for backward compatibility
  42 that have the same effect as the functions above but with infinite timeout
  43 and without the possibility to specify custom BIOs.
  44
  45 =head1 RETURN VALUES
  46
  47 On success the function yield the loaded value, else NULL.
  48 Error conditions include connection/transfer timeout, parse errors, etc.
  49
  50 =head1 SEE ALSO
  51
  52 L<OSSL_HTTP_get(3)>
  53
  54 =head1 HISTORY
  55
  56 X509_load_http() and X509_CRL_load_http() were added in OpenSSL 3.0.
  57 X509_http_nbio() and X509_CRL_http_nbio() were deprecated in OpenSSL 3.0.
  58
  59 =head1 COPYRIGHT
  60
  61 Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
  62
  63 Licensed under the Apache License 2.0 (the "License").  You may not use
  64 this file except in compliance with the License.  You can obtain a copy
  65 in the file LICENSE in the source distribution or at
  66 L<https://www.openssl.org/source/license.html>.
  67
  68 =cut