diff options
author | Richard Levitte <levitte@openssl.org> | 2000-09-19 23:12:57 +0000 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2000-09-19 23:12:57 +0000 |
commit | 933f32cc4d183b9f154316a55d77a95efb571282 (patch) | |
tree | 75860210b954a5d607236c7fbe4d8dc4bf3e5eb9 /doc | |
parent | c6def253b45b50a0d87ae7768db523c4a32e8517 (diff) |
Document SSL_library_init() and it's aliases. Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ssl/SSL_library_init.pod | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/ssl/SSL_library_init.pod b/doc/ssl/SSL_library_init.pod new file mode 100644 index 0000000000..e982a5f01d --- /dev/null +++ b/doc/ssl/SSL_library_init.pod @@ -0,0 +1,52 @@ +=pod + +=head1 NAME + +SSL_library_init, OpenSSL_add_ssl_algorithms, SSLeay_add_ssl_algorithms +- initialize SSL library by registering algorithms + +=head1 SYNOPSIS + + #include <openssl/ssl.h> + + int SSL_library_init(void); + #define OpenSSL_add_ssl_algorithms() SSL_library_init() + #define SSLeay_add_ssl_algorithms() SSL_library_init() + +=head1 DESCRIPTION + +SSL_library_init() registers the available ciphers and digests. + +OpenSSL_add_ssl_algorithms() and SSLeay_add_ssl_algorithms() are synonyms +for SSL_library_init(). + +=head1 NOTES + +SSL_library_init() must be called before any other action takes place. + +=head1 IMPORTANT + +SSL_library_init() only registers ciphers. Another important initialization +is the seeding of the PRNG (Pseude Random Number Generator), which has to +be performed seperately. + +=head1 EXAMPLES + +A typical TLS/SSL application will start with the library initialization, +will provide readable error messages and will seed the PRNG. + + SSL_load_error_strings(); /* readable error messages */ + SSL_library_init(); /* initialize library */ + actions_to_seed_PRNG(); + +=head1 RETURN VALUES + +SSL_library_init() always returns "1", so it is safe to discard the return +value. + +=head1 SEE ALSO + +L<ssl(3)|ssl(3)>, L<SSL_load_error_strings(3)|SSL_load_error_strings(3)>, +L<RAND_add(3)|RAND_add(3)> + +=cut |