diff options
author | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2018-03-17 18:52:43 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@cvs.openbsd.org> | 2018-03-17 18:52:43 +0000 |
commit | 4fd987871a162f58fab135a761e39a1da607c0a6 (patch) | |
tree | 557d5fbb42e76bee110179ca7a1e742baf8724bf /lib/libssl | |
parent | 2be94c88da4256baf101bc41a11889b806b2f5d4 (diff) |
In crypto.h rev. 1.43 and ssl.h rev. 1.153 2018/03/17 16:20:01, beck@
provided OPENSSL_init_crypto(3) and OPENSSL_init_ssl(3).
Write the documentation from scratch
because the text OpenSSL provides is full of bloat.
Diffstat (limited to 'lib/libssl')
-rw-r--r-- | lib/libssl/man/Makefile | 3 | ||||
-rw-r--r-- | lib/libssl/man/OPENSSL_init_ssl.3 | 60 |
2 files changed, 62 insertions, 1 deletions
diff --git a/lib/libssl/man/Makefile b/lib/libssl/man/Makefile index d5141811e78..375e5fba2bf 100644 --- a/lib/libssl/man/Makefile +++ b/lib/libssl/man/Makefile @@ -1,9 +1,10 @@ -# $OpenBSD: Makefile,v 1.64 2018/03/17 18:19:49 schwarze Exp $ +# $OpenBSD: Makefile,v 1.65 2018/03/17 18:52:42 schwarze Exp $ .include <bsd.own.mk> MAN = BIO_f_ssl.3 \ DTLSv1_listen.3 \ + OPENSSL_init_ssl.3 \ PEM_read_SSL_SESSION.3 \ SSL_CIPHER_get_name.3 \ SSL_COMP_add_compression_method.3 \ diff --git a/lib/libssl/man/OPENSSL_init_ssl.3 b/lib/libssl/man/OPENSSL_init_ssl.3 new file mode 100644 index 00000000000..ae356c9bf54 --- /dev/null +++ b/lib/libssl/man/OPENSSL_init_ssl.3 @@ -0,0 +1,60 @@ +.\" $OpenBSD: OPENSSL_init_ssl.3,v 1.1 2018/03/17 18:52:42 schwarze Exp $ +.\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org> +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: March 17 2018 $ +.Dt OPENSSL_INIT_SSL 3 +.Os +.Sh NAME +.Nm OPENSSL_init_ssl +.Nd initialise the crypto and ssl libraries +.Sh SYNOPSIS +.In openssl/ssl.h +.Ft int +.Fo OPENSSL_init_ssl +.Fa "uint64_t options" +.Fa "const void *dummy" +.Fc +.Sh DESCRIPTION +.Fn OPENSSL_init_ssl +calls +.Xr OPENSSL_init_crypto 3 +and also allocates various resources used internally by the ssl library. +.Pp +Calling it is never useful because it is automatically called +internally when needed. +.Pp +The +.Fa options +argument is passed on to +.Xr OPENSSL_init_crypto 3 +and the +.Fa dummy +argument is ignored. +.Pp +If this function is called more than once, +none of the calls except the first one have any effect. +.Sh RETURN VALUES +.Fn OPENSSL_init_ssl +is intended to return 1 on success or 0 on error. +.Sh SEE ALSO +.Xr CONF_modules_load_file 3 , +.Xr OPENSSL_init_crypto 3 +.Sh HISTORY +.Fn OPENSSL_init_ssl +first appeared in OpenSSL 1.1.0. +.Sh BUGS +.Fn OPENSSL_init_ssl +silently ignores even more configuration failures than +.Xr OPENSSL_init_crypto 3 . |