Richard Levitte | 933f32c | 2000-09-19 23:12:57 +0000 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | SSL_library_init, OpenSSL_add_ssl_algorithms, SSLeay_add_ssl_algorithms |
| 6 | - initialize SSL library by registering algorithms |
| 7 | |
| 8 | =head1 SYNOPSIS |
| 9 | |
| 10 | #include <openssl/ssl.h> |
| 11 | |
| 12 | int SSL_library_init(void); |
| 13 | #define OpenSSL_add_ssl_algorithms() SSL_library_init() |
| 14 | #define SSLeay_add_ssl_algorithms() SSL_library_init() |
| 15 | |
| 16 | =head1 DESCRIPTION |
| 17 | |
Dr. Stephen Henson | d4a45bf | 2010-04-06 15:03:27 +0000 | [diff] [blame] | 18 | SSL_library_init() registers the available SSL/TLS ciphers and digests. |
Richard Levitte | 933f32c | 2000-09-19 23:12:57 +0000 | [diff] [blame] | 19 | |
| 20 | OpenSSL_add_ssl_algorithms() and SSLeay_add_ssl_algorithms() are synonyms |
| 21 | for SSL_library_init(). |
| 22 | |
| 23 | =head1 NOTES |
| 24 | |
| 25 | SSL_library_init() must be called before any other action takes place. |
Nils Larsch | c2cd422 | 2006-03-12 00:37:55 +0000 | [diff] [blame] | 26 | SSL_library_init() is not reentrant. |
Richard Levitte | 933f32c | 2000-09-19 23:12:57 +0000 | [diff] [blame] | 27 | |
Richard Levitte | 4aa4f33 | 2000-09-21 17:21:15 +0000 | [diff] [blame] | 28 | =head1 WARNING |
Richard Levitte | 933f32c | 2000-09-19 23:12:57 +0000 | [diff] [blame] | 29 | |
Dr. Stephen Henson | c0b8eb6 | 2010-04-07 13:18:07 +0000 | [diff] [blame] | 30 | SSL_library_init() adds ciphers and digests used directly and indirectly by |
| 31 | SSL/TLS. |
Richard Levitte | 933f32c | 2000-09-19 23:12:57 +0000 | [diff] [blame] | 32 | |
| 33 | =head1 EXAMPLES |
| 34 | |
| 35 | A typical TLS/SSL application will start with the library initialization, |
Dr. Stephen Henson | c0b8eb6 | 2010-04-07 13:18:07 +0000 | [diff] [blame] | 36 | and provide readable error messages. |
Richard Levitte | 933f32c | 2000-09-19 23:12:57 +0000 | [diff] [blame] | 37 | |
| 38 | SSL_load_error_strings(); /* readable error messages */ |
| 39 | SSL_library_init(); /* initialize library */ |
Richard Levitte | 933f32c | 2000-09-19 23:12:57 +0000 | [diff] [blame] | 40 | |
| 41 | =head1 RETURN VALUES |
| 42 | |
| 43 | SSL_library_init() always returns "1", so it is safe to discard the return |
| 44 | value. |
| 45 | |
Dr. Stephen Henson | c0b8eb6 | 2010-04-07 13:18:07 +0000 | [diff] [blame] | 46 | =head1 NOTES |
| 47 | |
| 48 | OpenSSL 0.9.8o and 1.0.0a and later added SHA2 algorithms to SSL_library_init(). |
| 49 | Applications which need to use SHA2 in earlier versions of OpenSSL should call |
| 50 | OpenSSL_add_all_algorithms() as well. |
| 51 | |
Richard Levitte | 933f32c | 2000-09-19 23:12:57 +0000 | [diff] [blame] | 52 | =head1 SEE ALSO |
| 53 | |
| 54 | L<ssl(3)|ssl(3)>, L<SSL_load_error_strings(3)|SSL_load_error_strings(3)>, |
| 55 | L<RAND_add(3)|RAND_add(3)> |
| 56 | |
| 57 | =cut |