xref: /openbsd/lib/libssl/man/OPENSSL_init_ssl.3 (revision 76d0caae)
1.\" $OpenBSD: OPENSSL_init_ssl.3,v 1.4 2019/06/14 13:41:31 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: June 14 2019 $
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
30This function is deprecated.
31It is never useful for any application program to call it explicitly.
32The library automatically calls it internally with an
33.Fa options
34argument of 0 whenever needed.
35It is safest to assume that any function may do so.
36.Pp
37To enable or disable the standard configuration file, instead use
38.Xr OPENSSL_config 3
39or
40.Xr OPENSSL_no_config 3 ,
41respectively.
42To load a non-standard configuration file, refer to
43.Xr CONF_modules_load_file 3 .
44.Pp
45.Fn OPENSSL_init_ssl
46calls
47.Xr OPENSSL_init_crypto 3 ,
48.Xr SSL_load_error_strings 3 ,
49and
50.Xr SSL_library_init 3 .
51.Pp
52The
53.Fa options
54argument is passed on to
55.Xr OPENSSL_init_crypto 3
56and the
57.Fa dummy
58argument is ignored.
59.Pp
60If this function is called more than once,
61none of the calls except the first one have any effect.
62.Sh RETURN VALUES
63.Fn OPENSSL_init_ssl
64is intended to return 1 on success or 0 on error.
65.Sh SEE ALSO
66.Xr CONF_modules_load_file 3 ,
67.Xr OPENSSL_config 3 ,
68.Xr ssl 3
69.Sh HISTORY
70.Fn OPENSSL_init_ssl
71first appeared in OpenSSL 1.1.0 and has been available since
72.Ox 6.3 .
73.Sh BUGS
74.Fn OPENSSL_init_ssl
75silently ignores even more configuration failures than
76.Xr OPENSSL_init_crypto 3 .
77