X509_load_http.pod 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  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. The following macros have been deprecated since OpenSSL 3.0, and can be
  13. hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
  14. see L<openssl_user_macros(7)>:
  15. #define X509_http_nbio(rctx, pcert)
  16. #define X509_CRL_http_nbio(rctx, pcrl)
  17. =head1 DESCRIPTION
  18. X509_load_http() and X509_CRL_load_http() loads a certificate or a CRL,
  19. respectively, in ASN.1 format using HTTP from the given B<url>.
  20. Maximum size of the HTTP response is 100 kB for certificates and 32 MB for CRLs
  21. and hard coded in the functions.
  22. If B<bio> is given and B<rbio> is NULL then this BIO is used instead of an
  23. internal one for connecting, writing the request, and reading the response.
  24. If both B<bio> and B<rbio> are given (which may be memory BIOs, for instance)
  25. then no explicit connection is attempted,
  26. B<bio> is used for writing the request, and B<rbio> for reading the response.
  27. If the B<timeout> parameter is > 0 this indicates the maximum number of seconds
  28. to wait until the transfer is complete.
  29. A value of 0 enables waiting indefinitely,
  30. while a value < 0 immediately leads to a timeout condition.
  31. X509_http_nbio() and X509_CRL_http_nbio() are macros for backward compatibility
  32. that have the same effect as the functions above but with infinite timeout
  33. and without the possibility to specify custom BIOs.
  34. =head1 RETURN VALUES
  35. On success the function yield the loaded value, else NULL.
  36. Error conditions include connection/transfer timeout, parse errors, etc.
  37. =head1 SEE ALSO
  38. L<OSSL_HTTP_get(3)>
  39. =head1 HISTORY
  40. X509_load_http() and X509_CRL_load_http() were added in OpenSSL 3.0.
  41. X509_http_nbio() and X509_CRL_http_nbio() were deprecated in OpenSSL 3.0.
  42. =head1 COPYRIGHT
  43. Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
  44. Licensed under the Apache License 2.0 (the "License"). You may not use
  45. this file except in compliance with the License. You can obtain a copy
  46. in the file LICENSE in the source distribution or at
  47. L<https://www.openssl.org/source/license.html>.
  48. =cut