summaryrefslogtreecommitdiff
path: root/src/lib
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib')
-rw-r--r--src/lib/libssl/man/SSL_get_current_cipher.397
1 files changed, 77 insertions, 20 deletions
diff --git a/src/lib/libssl/man/SSL_get_current_cipher.3 b/src/lib/libssl/man/SSL_get_current_cipher.3
index de46f3d21c..e61ea2280c 100644
--- a/src/lib/libssl/man/SSL_get_current_cipher.3
+++ b/src/lib/libssl/man/SSL_get_current_cipher.3
@@ -1,7 +1,54 @@
1.\" $OpenBSD: SSL_get_current_cipher.3,v 1.2 2016/12/03 09:07:56 schwarze Exp $
2.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
1.\" 3.\"
2.\" $OpenBSD: SSL_get_current_cipher.3,v 1.1 2016/11/05 15:32:20 schwarze Exp $ 4.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>.
5.\" Copyright (c) 2000, 2005, 2016 The OpenSSL Project. All rights reserved.
3.\" 6.\"
4.Dd $Mdocdate: November 5 2016 $ 7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\"
11.\" 1. Redistributions of source code must retain the above copyright
12.\" notice, this list of conditions and the following disclaimer.
13.\"
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\" notice, this list of conditions and the following disclaimer in
16.\" the documentation and/or other materials provided with the
17.\" distribution.
18.\"
19.\" 3. All advertising materials mentioning features or use of this
20.\" software must display the following acknowledgment:
21.\" "This product includes software developed by the OpenSSL Project
22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
23.\"
24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25.\" endorse or promote products derived from this software without
26.\" prior written permission. For written permission, please contact
27.\" openssl-core@openssl.org.
28.\"
29.\" 5. Products derived from this software may not be called "OpenSSL"
30.\" nor may "OpenSSL" appear in their names without prior written
31.\" permission of the OpenSSL Project.
32.\"
33.\" 6. Redistributions of any form whatsoever must retain the following
34.\" acknowledgment:
35.\" "This product includes software developed by the OpenSSL Project
36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)"
37.\"
38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49.\" OF THE POSSIBILITY OF SUCH DAMAGE.
50.\"
51.Dd $Mdocdate: December 3 2016 $
5.Dt SSL_GET_CURRENT_CIPHER 3 52.Dt SSL_GET_CURRENT_CIPHER 3
6.Os 53.Os
7.Sh NAME 54.Sh NAME
@@ -13,15 +60,16 @@
13.Nd get SSL_CIPHER of a connection 60.Nd get SSL_CIPHER of a connection
14.Sh SYNOPSIS 61.Sh SYNOPSIS
15.In openssl/ssl.h 62.In openssl/ssl.h
16.Ft SSL_CIPHER * 63.Ft const SSL_CIPHER *
17.Fn SSL_get_current_cipher "const SSL *ssl" 64.Fn SSL_get_current_cipher "const SSL *ssl"
18.Fd #define SSL_get_cipher(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s)) 65.Ft const char *
19.Fd #define SSL_get_cipher_name(s) \ 66.Fn SSL_get_cipher "const SSL *ssl"
20SSL_CIPHER_get_name(SSL_get_current_cipher(s)) 67.Ft const char *
21.Fd #define SSL_get_cipher_bits(s,np) \ 68.Fn SSL_get_cipher_name "const SSL *ssl"
22SSL_CIPHER_get_bits(SSL_get_current_cipher(s),np) 69.Ft int
23.Fd #define SSL_get_cipher_version(s) \ 70.Fn SSL_get_cipher_bits "const SSL *ssl" "int *np"
24SSL_CIPHER_get_version(SSL_get_current_cipher(s)) 71.Ft char *
72.Fn SSL_get_cipher_version "const SSL *ssl"
25.Sh DESCRIPTION 73.Sh DESCRIPTION
26.Fn SSL_get_current_cipher 74.Fn SSL_get_current_cipher
27returns a pointer to an 75returns a pointer to an
@@ -30,23 +78,32 @@ object containing the description of the actually used cipher of a connection
30established with the 78established with the
31.Fa ssl 79.Fa ssl
32object. 80object.
81See
82.Xr SSL_CIPHER_get_name 3
83for more details.
33.Pp 84.Pp
34.Fn SSL_get_cipher
35and
36.Fn SSL_get_cipher_name 85.Fn SSL_get_cipher_name
37are identical macros to obtain the name of the currently used cipher. 86obtains the name of the currently used cipher.
87.Fn SSL_get_cipher
88is identical to
89.Fn SSL_get_cipher_name .
90.Pp
38.Fn SSL_get_cipher_bits 91.Fn SSL_get_cipher_bits
39is a macro to obtain the number of secret/algorithm bits used and 92obtains the number of secret/algorithm bits used and
40.Fn SSL_get_cipher_version 93.Fn SSL_get_cipher_version
41returns the protocol name. 94returns the protocol name.
42See 95.Pp
43.Xr SSL_CIPHER_get_name 3 96.Fn SSL_get_cipher ,
44for more details. 97.Fn SSL_get_cipher_name ,
98.Fn SSL_get_cipher_bits ,
99and
100.Fn SSL_get_cipher_version
101are implemented as macros.
45.Sh RETURN VALUES 102.Sh RETURN VALUES
46.Fn SSL_get_current_cipher 103.Fn SSL_get_current_cipher
47returns the cipher actually used or 104returns the cipher actually used, or
48.Dv NULL , 105.Dv NULL
49when no session has been established. 106if no session has been established.
50.Sh SEE ALSO 107.Sh SEE ALSO
51.Xr ssl 3 , 108.Xr ssl 3 ,
52.Xr SSL_CIPHER_get_name 3 109.Xr SSL_CIPHER_get_name 3