blob: 8766776fea9f73b5cc2d179379ef1df3ccda0287 [file] [log] [blame]
Richard Levitte933f32c2000-09-19 23:12:57 +00001=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
Dr. Stephen Hensond4a45bf2010-04-06 15:03:27 +000018SSL_library_init() registers the available SSL/TLS ciphers and digests.
Richard Levitte933f32c2000-09-19 23:12:57 +000019
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.
Nils Larschc2cd4222006-03-12 00:37:55 +000026SSL_library_init() is not reentrant.
Richard Levitte933f32c2000-09-19 23:12:57 +000027
Richard Levitte4aa4f332000-09-21 17:21:15 +000028=head1 WARNING
Richard Levitte933f32c2000-09-19 23:12:57 +000029
Dr. Stephen Hensonc0b8eb62010-04-07 13:18:07 +000030SSL_library_init() adds ciphers and digests used directly and indirectly by
31SSL/TLS.
Richard Levitte933f32c2000-09-19 23:12:57 +000032
33=head1 EXAMPLES
34
35A typical TLS/SSL application will start with the library initialization,
Dr. Stephen Hensonc0b8eb62010-04-07 13:18:07 +000036and provide readable error messages.
Richard Levitte933f32c2000-09-19 23:12:57 +000037
38 SSL_load_error_strings(); /* readable error messages */
39 SSL_library_init(); /* initialize library */
Richard Levitte933f32c2000-09-19 23:12:57 +000040
41=head1 RETURN VALUES
42
43SSL_library_init() always returns "1", so it is safe to discard the return
44value.
45
Dr. Stephen Hensonc0b8eb62010-04-07 13:18:07 +000046=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
Richard Levitte933f32c2000-09-19 23:12:57 +000052=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