diff options
Diffstat (limited to 'src/lib')
-rw-r--r-- | src/lib/libssl/man/SSL_SESSION_get0_cipher.3 | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/src/lib/libssl/man/SSL_SESSION_get0_cipher.3 b/src/lib/libssl/man/SSL_SESSION_get0_cipher.3 new file mode 100644 index 0000000000..239a426dbd --- /dev/null +++ b/src/lib/libssl/man/SSL_SESSION_get0_cipher.3 | |||
@@ -0,0 +1,94 @@ | |||
1 | .\" $OpenBSD: SSL_SESSION_get0_cipher.3,v 1.1 2021/05/12 14:16:25 tb Exp $ | ||
2 | .\" full merge up to: OpenSSL d42e7759f Mar 30 19:40:04 2017 +0200 | ||
3 | .\" selective merge up to: OpenSSL df75c2bf Dec 9 01:02:36 2018 +0100 | ||
4 | .\" | ||
5 | .\" This file was written by Rich Salz <rsalz@openssl.org>. | ||
6 | .\" Copyright (c) 2016, 2017 The OpenSSL Project. All rights reserved. | ||
7 | .\" | ||
8 | .\" Redistribution and use in source and binary forms, with or without | ||
9 | .\" modification, are permitted provided that the following conditions | ||
10 | .\" are met: | ||
11 | .\" | ||
12 | .\" 1. Redistributions of source code must retain the above copyright | ||
13 | .\" notice, this list of conditions and the following disclaimer. | ||
14 | .\" | ||
15 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
16 | .\" notice, this list of conditions and the following disclaimer in | ||
17 | .\" the documentation and/or other materials provided with the | ||
18 | .\" distribution. | ||
19 | .\" | ||
20 | .\" 3. All advertising materials mentioning features or use of this | ||
21 | .\" software must display the following acknowledgment: | ||
22 | .\" "This product includes software developed by the OpenSSL Project | ||
23 | .\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" | ||
24 | .\" | ||
25 | .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to | ||
26 | .\" endorse or promote products derived from this software without | ||
27 | .\" prior written permission. For written permission, please contact | ||
28 | .\" openssl-core@openssl.org. | ||
29 | .\" | ||
30 | .\" 5. Products derived from this software may not be called "OpenSSL" | ||
31 | .\" nor may "OpenSSL" appear in their names without prior written | ||
32 | .\" permission of the OpenSSL Project. | ||
33 | .\" | ||
34 | .\" 6. Redistributions of any form whatsoever must retain the following | ||
35 | .\" acknowledgment: | ||
36 | .\" "This product includes software developed by the OpenSSL Project | ||
37 | .\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" | ||
38 | .\" | ||
39 | .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY | ||
40 | .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
41 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR | ||
42 | .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR | ||
43 | .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
44 | .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | ||
45 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
46 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
47 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | ||
48 | .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | ||
49 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | ||
50 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | ||
51 | .\" | ||
52 | .Dd $Mdocdate: May 12 2021 $ | ||
53 | .Dt SSL_SESSION_GET0_CIPHER 3 | ||
54 | .Os | ||
55 | .Sh NAME | ||
56 | .Nm SSL_SESSION_get0_cipher | ||
57 | .Nd retrieve the SSL cipher associated with a session | ||
58 | .Sh SYNOPSIS | ||
59 | .In openssl/ssl.h | ||
60 | .Ft const SSL_CIPHER * | ||
61 | .Fo SSL_SESSION_get0_cipher | ||
62 | .Fa "const SSL_SESSION *session" | ||
63 | .Fc | ||
64 | .Sh DESCRIPTION | ||
65 | .Fn SSL_SESSION_get0_cipher | ||
66 | retrieves the cipher that was used by the connection when the session | ||
67 | was created, or | ||
68 | .Dv NULL | ||
69 | if it cannot be determined. | ||
70 | .Pp | ||
71 | The value returned is a pointer to an object maintained within | ||
72 | .Fa session | ||
73 | and should not be released. | ||
74 | .Sh RETURN VALUES | ||
75 | .Fn SSL_SESSION_get0_cipher | ||
76 | returns the | ||
77 | .Vt SSL_CIPHER | ||
78 | associated with | ||
79 | .Fa session | ||
80 | or | ||
81 | .Dv NULL | ||
82 | if it cannot be determined. | ||
83 | .Sh SEE ALSO | ||
84 | .Xr ssl 3 , | ||
85 | .Xr SSL_CIPHER_get_name 3 , | ||
86 | .Xr SSL_get_current_cipher 3 , | ||
87 | .Xr SSL_get_session 3 , | ||
88 | .Xr SSL_SESSION_new 3 | ||
89 | .Sh HISTORY | ||
90 | The | ||
91 | .Fn SSL_SESSION_get0_cipher | ||
92 | function first appeared in OpenSSL 1.1.0 | ||
93 | and has been available since | ||
94 | .Ox 7.0 . | ||