xref: /openbsd-src/lib/libssl/man/OPENSSL_init_ssl.3 (revision 9f11ffb7133c203312a01e4b986886bc88c7d74b)
1.\" $OpenBSD: OPENSSL_init_ssl.3,v 1.2 2018/03/24 00:55:37 schwarze Exp $
2.\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org>
3.\"
4.\" Permission to use, copy, modify, and distribute this software for any
5.\" purpose with or without fee is hereby granted, provided that the above
6.\" copyright notice and this permission notice appear in all copies.
7.\"
8.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15.\"
16.Dd $Mdocdate: March 24 2018 $
17.Dt OPENSSL_INIT_SSL 3
18.Os
19.Sh NAME
20.Nm OPENSSL_init_ssl
21.Nd initialise the crypto and ssl libraries
22.Sh SYNOPSIS
23.In openssl/ssl.h
24.Ft int
25.Fo OPENSSL_init_ssl
26.Fa "uint64_t options"
27.Fa "const void *dummy"
28.Fc
29.Sh DESCRIPTION
30.Fn OPENSSL_init_ssl
31calls
32.Xr OPENSSL_init_crypto 3
33and also allocates various resources used internally by the ssl library.
34.Pp
35Calling it is never useful because it is automatically called
36internally when needed.
37.Pp
38The
39.Fa options
40argument is passed on to
41.Xr OPENSSL_init_crypto 3
42and the
43.Fa dummy
44argument is ignored.
45.Pp
46If this function is called more than once,
47none of the calls except the first one have any effect.
48.Sh RETURN VALUES
49.Fn OPENSSL_init_ssl
50is intended to return 1 on success or 0 on error.
51.Sh SEE ALSO
52.Xr CONF_modules_load_file 3 ,
53.Xr OPENSSL_init_crypto 3
54.Sh HISTORY
55.Fn OPENSSL_init_ssl
56first appeared in OpenSSL 1.1.0 and has been available since
57.Ox 6.3 .
58.Sh BUGS
59.Fn OPENSSL_init_ssl
60silently ignores even more configuration failures than
61.Xr OPENSSL_init_crypto 3 .
62