SSL_library_init.pod 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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 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. =head1 WARNING
  17. SSL_library_init() only registers ciphers. Another important initialization
  18. is the seeding of the PRNG (Pseudo Random Number Generator), which has to
  19. be performed separately.
  20. =head1 EXAMPLES
  21. A typical TLS/SSL application will start with the library initialization,
  22. will provide readable error messages and will seed the PRNG.
  23. SSL_load_error_strings(); /* readable error messages */
  24. SSL_library_init(); /* initialize library */
  25. actions_to_seed_PRNG();
  26. =head1 RETURN VALUES
  27. SSL_library_init() always returns "1", so it is safe to discard the return
  28. value.
  29. =head1 SEE ALSO
  30. L<ssl(3)|ssl(3)>, L<SSL_load_error_strings(3)|SSL_load_error_strings(3)>,
  31. L<RAND_add(3)|RAND_add(3)>
  32. =cut