xref: /minix3/crypto/external/bsd/openssl/dist/doc/ssl/SSL_library_init.pod (revision ebfedea0ce5bbe81e252ddf32d732e40fb633fae)
1*ebfedea0SLionel Sambuc=pod
2*ebfedea0SLionel Sambuc
3*ebfedea0SLionel Sambuc=head1 NAME
4*ebfedea0SLionel Sambuc
5*ebfedea0SLionel SambucSSL_library_init, OpenSSL_add_ssl_algorithms, SSLeay_add_ssl_algorithms
6*ebfedea0SLionel Sambuc- initialize SSL library by registering algorithms
7*ebfedea0SLionel Sambuc
8*ebfedea0SLionel Sambuc=head1 SYNOPSIS
9*ebfedea0SLionel Sambuc
10*ebfedea0SLionel Sambuc #include <openssl/ssl.h>
11*ebfedea0SLionel Sambuc
12*ebfedea0SLionel Sambuc int SSL_library_init(void);
13*ebfedea0SLionel Sambuc #define OpenSSL_add_ssl_algorithms()    SSL_library_init()
14*ebfedea0SLionel Sambuc #define SSLeay_add_ssl_algorithms()     SSL_library_init()
15*ebfedea0SLionel Sambuc
16*ebfedea0SLionel Sambuc=head1 DESCRIPTION
17*ebfedea0SLionel Sambuc
18*ebfedea0SLionel SambucSSL_library_init() registers the available SSL/TLS ciphers and digests.
19*ebfedea0SLionel Sambuc
20*ebfedea0SLionel SambucOpenSSL_add_ssl_algorithms() and SSLeay_add_ssl_algorithms() are synonyms
21*ebfedea0SLionel Sambucfor SSL_library_init().
22*ebfedea0SLionel Sambuc
23*ebfedea0SLionel Sambuc=head1 NOTES
24*ebfedea0SLionel Sambuc
25*ebfedea0SLionel SambucSSL_library_init() must be called before any other action takes place.
26*ebfedea0SLionel SambucSSL_library_init() is not reentrant.
27*ebfedea0SLionel Sambuc
28*ebfedea0SLionel Sambuc=head1 WARNING
29*ebfedea0SLionel Sambuc
30*ebfedea0SLionel SambucSSL_library_init() adds ciphers and digests used directly and indirectly by
31*ebfedea0SLionel SambucSSL/TLS.
32*ebfedea0SLionel Sambuc
33*ebfedea0SLionel Sambuc=head1 EXAMPLES
34*ebfedea0SLionel Sambuc
35*ebfedea0SLionel SambucA typical TLS/SSL application will start with the library initialization,
36*ebfedea0SLionel Sambucand provide readable error messages.
37*ebfedea0SLionel Sambuc
38*ebfedea0SLionel Sambuc SSL_load_error_strings();                /* readable error messages */
39*ebfedea0SLionel Sambuc SSL_library_init();                      /* initialize library */
40*ebfedea0SLionel Sambuc
41*ebfedea0SLionel Sambuc=head1 RETURN VALUES
42*ebfedea0SLionel Sambuc
43*ebfedea0SLionel SambucSSL_library_init() always returns "1", so it is safe to discard the return
44*ebfedea0SLionel Sambucvalue.
45*ebfedea0SLionel Sambuc
46*ebfedea0SLionel Sambuc=head1 NOTES
47*ebfedea0SLionel Sambuc
48*ebfedea0SLionel SambucOpenSSL 0.9.8o and 1.0.0a and later added SHA2 algorithms to SSL_library_init().
49*ebfedea0SLionel SambucApplications which need to use SHA2 in earlier versions of OpenSSL should call
50*ebfedea0SLionel SambucOpenSSL_add_all_algorithms() as well.
51*ebfedea0SLionel Sambuc
52*ebfedea0SLionel Sambuc=head1 SEE ALSO
53*ebfedea0SLionel Sambuc
54*ebfedea0SLionel SambucL<ssl(3)|ssl(3)>, L<SSL_load_error_strings(3)|SSL_load_error_strings(3)>,
55*ebfedea0SLionel SambucL<RAND_add(3)|RAND_add(3)>
56*ebfedea0SLionel Sambuc
57*ebfedea0SLionel Sambuc=cut
58