X509_load_http.pod 1.9 KB

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