SSL_library_init.pod 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. =pod
  2. =head1 NAME
  3. SSL_library_init, OpenSSL_add_ssl_algorithms, SSLeay_add_ssl_algorithms
  4. - initialize SSL library by registering algorithms
  5. =head1 SYNOPSIS
  6. #include <openssl/ssl.h>
  7. int SSL_library_init(void);
  8. #define OpenSSL_add_ssl_algorithms() SSL_library_init()
  9. #define SSLeay_add_ssl_algorithms() SSL_library_init()
  10. =head1 DESCRIPTION
  11. SSL_library_init() registers the available SSL/TLS ciphers and digests.
  12. OpenSSL_add_ssl_algorithms() and SSLeay_add_ssl_algorithms() are synonyms
  13. for SSL_library_init().
  14. =head1 NOTES
  15. SSL_library_init() must be called before any other action takes place.
  16. SSL_library_init() is not reentrant.
  17. =head1 WARNING
  18. SSL_library_init() adds ciphers and digests used directly and indirectly by
  19. SSL/TLS.
  20. =head1 EXAMPLES
  21. A typical TLS/SSL application will start with the library initialization,
  22. and provide readable error messages.
  23. SSL_load_error_strings(); /* readable error messages */
  24. SSL_library_init(); /* initialize library */
  25. =head1 RETURN VALUES
  26. SSL_library_init() always returns "1", so it is safe to discard the return
  27. value.
  28. =head1 NOTES
  29. OpenSSL 0.9.8o and 1.0.0a and later added SHA2 algorithms to SSL_library_init().
  30. Applications which need to use SHA2 in earlier versions of OpenSSL should call
  31. OpenSSL_add_all_algorithms() as well.
  32. =head1 SEE ALSO
  33. L<ssl(3)|ssl(3)>, L<SSL_load_error_strings(3)|SSL_load_error_strings(3)>,
  34. L<RAND_add(3)|RAND_add(3)>
  35. =cut