SSL_library_init.pod revision 238405
1=pod
2
3=head1 NAME
4
5SSL_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
18SSL_library_init() registers the available SSL/TLS ciphers and digests.
19
20OpenSSL_add_ssl_algorithms() and SSLeay_add_ssl_algorithms() are synonyms
21for SSL_library_init().
22
23=head1 NOTES
24
25SSL_library_init() must be called before any other action takes place.
26SSL_library_init() is not reentrant. 
27
28=head1 WARNING
29
30SSL_library_init() adds ciphers and digests used directly and indirectly by
31SSL/TLS.
32
33=head1 EXAMPLES
34
35A typical TLS/SSL application will start with the library initialization,
36and provide readable error messages.
37
38 SSL_load_error_strings();                /* readable error messages */
39 SSL_library_init();                      /* initialize library */
40
41=head1 RETURN VALUES
42
43SSL_library_init() always returns "1", so it is safe to discard the return
44value.
45
46=head1 NOTES
47
48OpenSSL 0.9.8o and 1.0.0a and later added SHA2 algorithms to SSL_library_init().
49Applications which need to use SHA2 in earlier versions of OpenSSL should call
50OpenSSL_add_all_algorithms() as well.
51
52=head1 SEE ALSO
53
54L<ssl(3)|ssl(3)>, L<SSL_load_error_strings(3)|SSL_load_error_strings(3)>,
55L<RAND_add(3)|RAND_add(3)>
56
57=cut
58