Provide documentation for auto-init/auto-deinit
[openssl.git] / doc / ssl / OPENSSL_INIT_ssl_library_start.pod
1 =pod
2
3 =head1 NAME
4
5 OPENSSL_INIT_ssl_library_start - OpenSSL (libssl and libcrypto) initialisation
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  void OPENSSL_INIT_ssl_library_start(uint64_t opts,
12                                      const OPENSSL_INIT_SETTINGS *settings);
13
14 =head1 DESCRIPTION
15
16 During normal operation OpenSSL (libssl and libcrypto) will allocate various
17 resources at start up that must, subsequently, be freed on close down of the
18 library. Additionally some resources are allocated on a per thread basis (if the
19 application is multi-threaded), and these resources must be freed prior to the
20 thread closing.
21
22 As of version 1.1.0 OpenSSL will automatically allocate all resources that it
23 needs so no explicit initialisation is required. Similarly it will also
24 automatically deinitialise as required.
25
26 However, there way be situations when explicit initialisation is desirable or
27 needed, for example when some non-default initialisation is required. The
28 function OPENSSL_INIT_ssl_library_start() can be used for this purpose. Calling
29 this function will explicitly initialise BOTH libcrypto and libssl. To
30 explicitly initialise ONLY libcrypto see the
31 L<OPENSSL_INIT_crypto_library_start(3)> function. In order to perform
32 non-default initialisation it MUST be called prior to any other calls of this
33 function. As numerous internal OpenSSL functions also call this, this usually
34 means you should call it prior to ANY other OpenSSL function calls.
35
36 The B<opts> parameter specifies which aspects of libssl and libcrypto should be
37 initialised. Valid options for libcrypto are described on the
38 L<OPENSSL_INIT_crypto_library_start(3)> page. In addition to any libcrypto
39 specific option the following libssl options can also be used:
40
41 =over 4
42
43 =item OPENSSL_INIT_NO_LOAD_SSL_STRINGS
44
45 Suppress automatic loading of the libssl error strings. With this option the
46 library will not automatically call ERR_load_SSL_strings(). This option is
47 not a default option. Once selected subsequent calls to
48 OPENSSL_INIT_ssl_library_start() with the option
49 B<OPENSSL_INIT_LOAD_SSL_STRINGS> will be ignored. Applications may call
50 ERR_load_SSL_strings() directly if they wish even if this option has been
51 selected. If they do so then they must also explicitly call ERR_free_strings()
52 on application close down.
53
54 =item OPENSSL_INIT_LOAD_SSL_STRINGS
55
56 Automatic loading of the libssl error strings. With this option the
57 library will automatically call ERR_load_SSL_strings(). This option is a
58 default option. Once selected subsequent calls to
59 OPENSSL_INIT_ssl_library_start() with the option
60 B<OPENSSL_INIT_LOAD_SSL_STRINGS> will be ignored.
61
62 =back
63
64 The B<settings> parameter specifies optional settings values to an option.
65 Currently no such settings are available for libssl specific options. However
66 these settings will also be passed internally to a call to
67 L<OPENSSL_INIT_crypto_library_start(3)>, so this parameter can also be used to
68 provide libcrypto settings values.
69
70 =head1 SEE ALSO
71
72 L<OPENSSL_INIT_crypto_library_start(3)>
73
74 =head1 HISTORY
75
76 The OPENSSL_INIT_ssl_library_start function was first added in OpenSSL 1.1.0.
77
78 =cut