summaryrefslogtreecommitdiff
path: root/lib/libssl
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2016-12-03 09:00:47 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2016-12-03 09:00:47 +0000
commit4bd037a38e783595edb770c71e8fa39052b5abe3 (patch)
tree8c43627e003365156e0e5799f08221b0ab4e4fe1 /lib/libssl
parent21d3c3372ed0b57cafa33929469df80a160c8c02 (diff)
Add Copyright and license.
Some additional explanations from OpenSSL. Delete empty RETURN VALUES section.
Diffstat (limited to 'lib/libssl')
-rw-r--r--lib/libssl/man/SSL_get_ciphers.373
1 files changed, 62 insertions, 11 deletions
diff --git a/lib/libssl/man/SSL_get_ciphers.3 b/lib/libssl/man/SSL_get_ciphers.3
index 4469b73f92e..4c3bbc45ced 100644
--- a/lib/libssl/man/SSL_get_ciphers.3
+++ b/lib/libssl/man/SSL_get_ciphers.3
@@ -1,7 +1,54 @@
+.\" $OpenBSD: SSL_get_ciphers.3,v 1.2 2016/12/03 09:00:46 schwarze Exp $
+.\" OpenSSL c3e64028 Mar 30 11:50:14 2005 +0000
.\"
-.\" $OpenBSD: SSL_get_ciphers.3,v 1.1 2016/11/05 15:32:20 schwarze Exp $
+.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
+.\" Copyright (c) 2000, 2005, 2015 The OpenSSL Project. All rights reserved.
.\"
-.Dd $Mdocdate: November 5 2016 $
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\"
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\"
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in
+.\" the documentation and/or other materials provided with the
+.\" distribution.
+.\"
+.\" 3. All advertising materials mentioning features or use of this
+.\" software must display the following acknowledgment:
+.\" "This product includes software developed by the OpenSSL Project
+.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
+.\"
+.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
+.\" endorse or promote products derived from this software without
+.\" prior written permission. For written permission, please contact
+.\" openssl-core@openssl.org.
+.\"
+.\" 5. Products derived from this software may not be called "OpenSSL"
+.\" nor may "OpenSSL" appear in their names without prior written
+.\" permission of the OpenSSL Project.
+.\"
+.\" 6. Redistributions of any form whatsoever must retain the following
+.\" acknowledgment:
+.\" "This product includes software developed by the OpenSSL Project
+.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
+.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
+.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+.\" OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd $Mdocdate: December 3 2016 $
.Dt SSL_GET_CIPHERS 3
.Os
.Sh NAME
@@ -29,6 +76,19 @@ or no ciphers are available,
.Dv NULL
is returned.
.Pp
+.Fn SSL_get_ciphers
+returns a pointer to an internal cipher stack, which will be freed
+later on when the
+.Vt SSL
+object is freed.
+Therefore, the calling code must not free the return value itself.
+.Pp
+The details of the ciphers obtained by
+.Fn SSL_get_ciphers
+can be obtained using the
+.Xr SSL_CIPHER_get_name 3
+family of functions.
+.Pp
.Fn SSL_get_cipher_list
returns a pointer to the name of the
.Vt SSL_CIPHER
@@ -45,12 +105,6 @@ no ciphers are available, or there are fewer ciphers than
available,
.Dv NULL
is returned.
-.Sh NOTES
-The details of the ciphers obtained by
-.Fn SSL_get_ciphers
-can be obtained using the
-.Xr SSL_CIPHER_get_name 3
-family of functions.
.Pp
Call
.Fn SSL_get_cipher_list
@@ -59,9 +113,6 @@ with
starting from 0 to obtain the sorted list of available ciphers, until
.Dv NULL
is returned.
-.Sh RETURN VALUES
-See
-.Sx DESCRIPTION .
.Sh SEE ALSO
.Xr ssl 3 ,
.Xr SSL_CIPHER_get_name 3 ,