summaryrefslogtreecommitdiffstats
path: root/doc/ssl
diff options
context:
space:
mode:
authorRich Salz <rsalz@akamai.com>2016-02-09 11:52:40 -0500
committerRich Salz <rsalz@openssl.org>2016-02-10 09:37:03 -0500
commitf672aee49450e03e7b1a26c8701d0be720e9ae0e (patch)
tree3f0eacb640d461102a8962d3a663a6e17df70fd6 /doc/ssl
parentea7736a0930d8c9dd3d4d1a3b3e001ff56364bd6 (diff)
Rename INIT funtions, deprecate old ones.
Man, there were a lot of renamings :) Reviewed-by: Richard Levitte <levitte@openssl.org>
Diffstat (limited to 'doc/ssl')
-rw-r--r--doc/ssl/OPENSSL_init_ssl.pod (renamed from doc/ssl/OPENSSL_INIT_ssl_library_start.pod)36
-rw-r--r--doc/ssl/SSL_library_init.pod15
-rw-r--r--doc/ssl/ssl.pod6
3 files changed, 21 insertions, 36 deletions
diff --git a/doc/ssl/OPENSSL_INIT_ssl_library_start.pod b/doc/ssl/OPENSSL_init_ssl.pod
index c0f598df30..d9246a53c1 100644
--- a/doc/ssl/OPENSSL_INIT_ssl_library_start.pod
+++ b/doc/ssl/OPENSSL_init_ssl.pod
@@ -2,14 +2,13 @@
=head1 NAME
-OPENSSL_INIT_ssl_library_start - OpenSSL (libssl and libcrypto) initialisation
+OPENSSL_init_ssl - OpenSSL (libssl and libcrypto) initialisation
=head1 SYNOPSIS
#include <openssl/ssl.h>
- void OPENSSL_INIT_ssl_library_start(uint64_t opts,
- const OPENSSL_INIT_SETTINGS *settings);
+ void OPENSSL_init_ssl(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);
=head1 DESCRIPTION
@@ -25,40 +24,35 @@ automatically deinitialise as required.
However, there way be situations when explicit initialisation is desirable or
needed, for example when some non-default initialisation is required. The
-function OPENSSL_INIT_ssl_library_start() can be used for this purpose. Calling
+function OPENSSL_init_ssl() can be used for this purpose. Calling
this function will explicitly initialise BOTH libcrypto and libssl. To
explicitly initialise ONLY libcrypto see the
-L<OPENSSL_INIT_crypto_library_start(3)> function.
+L<OPENSSL_init_crypto(3)> function.
-Numerous internal OpenSSL functions call OPENSSL_INIT_ssl_library_start().
+Numerous internal OpenSSL functions call OPENSSL_init_ssl().
Therefore, in order to perform non-default initialisation,
-OPENSSL_INIT_ssl_library_start() MUST be called by application code prior to
+OPENSSL_init_ssl() MUST be called by application code prior to
any other OpenSSL function calls.
The B<opts> parameter specifies which aspects of libssl and libcrypto should be
initialised. Valid options for libcrypto are described on the
-L<OPENSSL_INIT_crypto_library_start(3)> page. In addition to any libcrypto
+L<OPENSSL_init_crypto(3)> page. In addition to any libcrypto
specific option the following libssl options can also be used:
=over 4
=item OPENSSL_INIT_NO_LOAD_SSL_STRINGS
-Suppress automatic loading of the libssl error strings. With this option the
-library will not automatically call ERR_load_SSL_strings(). This option is
+Suppress automatic loading of the libssl error strings. This option is
not a default option. Once selected subsequent calls to
-OPENSSL_INIT_ssl_library_start() with the option
-B<OPENSSL_INIT_LOAD_SSL_STRINGS> will be ignored. Applications may call
-ERR_load_SSL_strings() directly if they wish even if this option has been
-selected. If they do so then they must also explicitly call ERR_free_strings()
-on application close down.
+OPENSSL_init_ssl() with the option
+B<OPENSSL_INIT_LOAD_SSL_STRINGS> will be ignored.
=item OPENSSL_INIT_LOAD_SSL_STRINGS
-Automatic loading of the libssl error strings. With this option the
-library will automatically call ERR_load_SSL_strings(). This option is a
+Automatic loading of the libssl error strings. This option is a
default option. Once selected subsequent calls to
-OPENSSL_INIT_ssl_library_start() with the option
+OPENSSL_init_ssl() with the option
B<OPENSSL_INIT_LOAD_SSL_STRINGS> will be ignored.
=back
@@ -66,15 +60,15 @@ B<OPENSSL_INIT_LOAD_SSL_STRINGS> will be ignored.
The B<settings> parameter specifies optional settings values to an option.
Currently no such settings are available for libssl specific options. However
these settings will also be passed internally to a call to
-L<OPENSSL_INIT_crypto_library_start(3)>, so this parameter can also be used to
+L<OPENSSL_init_crypto(3)>, so this parameter can also be used to
provide libcrypto settings values.
=head1 SEE ALSO
-L<OPENSSL_INIT_crypto_library_start(3)>
+L<OPENSSL_init_crypto(3)>
=head1 HISTORY
-The OPENSSL_INIT_ssl_library_start function was added in OpenSSL 1.1.0.
+The OPENSSL_init_ssl() function was added in OpenSSL 1.1.0.
=cut
diff --git a/doc/ssl/SSL_library_init.pod b/doc/ssl/SSL_library_init.pod
index d96d3f0613..c872858ca3 100644
--- a/doc/ssl/SSL_library_init.pod
+++ b/doc/ssl/SSL_library_init.pod
@@ -28,14 +28,6 @@ SSL_library_init() is not reentrant.
SSL_library_init() adds ciphers and digests used directly and indirectly by
SSL/TLS.
-=head1 EXAMPLES
-
-A typical TLS/SSL application will start with the library initialization,
-and provide readable error messages.
-
- SSL_load_error_strings(); /* readable error messages */
- SSL_library_init(); /* initialize library */
-
=head1 RETURN VALUES
SSL_library_init() always returns "1", so it is safe to discard the return
@@ -43,7 +35,12 @@ value.
=head1 SEE ALSO
-L<ssl(3)>, L<SSL_load_error_strings(3)>,
+L<ssl(3)>,
L<RAND_add(3)>
+=head1 HISTORY
+
+The SSL_library_init() and OpenSSL_add_ssl_algorithms() functions were
+deprecated in OpenSSL 1.1.0 by OPENSSL_init_ssl().
+
=cut
diff --git a/doc/ssl/ssl.pod b/doc/ssl/ssl.pod
index 597b88e5f7..e350c3e14f 100644
--- a/doc/ssl/ssl.pod
+++ b/doc/ssl/ssl.pod
@@ -13,9 +13,6 @@ The OpenSSL B<ssl> library implements the Secure Sockets Layer (SSL v2/v3) and
Transport Layer Security (TLS v1) protocols. It provides a rich API which is
documented here.
-At first the library must be initialized; see
-L<SSL_library_init(3)>.
-
Then an B<SSL_CTX> object is created as a framework to establish
TLS/SSL enabled connections (see L<SSL_CTX_new(3)>).
Various options regarding certificates, algorithms etc. can be set
@@ -560,8 +557,6 @@ fresh handle for each connection.
=item STACK *B<SSL_load_client_CA_file>(char *file);
-=item void B<SSL_load_error_strings>(void);
-
=item SSL *B<SSL_new>(SSL_CTX *ctx);
=item void SSL_up_ref(SSL *s);
@@ -742,7 +737,6 @@ L<SSL_get_rbio(3)>,
L<SSL_get_session(3)>,
L<SSL_get_verify_result(3)>,
L<SSL_get_version(3)>,
-L<SSL_library_init(3)>,
L<SSL_load_client_CA_file(3)>,
L<SSL_new(3)>,
L<SSL_pending(3)>,