3732c57d31b640b9fb90984a29359ac4ccb6e821
[openssl.git] / doc / man3 / SSL_SESSION_get0_cipher.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_SESSION_get0_cipher - retrieve the SSL cipher associated with a session
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  const SSL_CIPHER *SSL_SESSION_get0_cipher(const SSL_SESSION *s);
12
13 =head1 DESCRIPTION
14
15 SSL_SESSION_get0_cipher() retrieves the cipher that was used by the
16 connection when the session was created, or NULL if it cannot be determined.
17
18 The value returned is a pointer to an object maintained within B<s> and
19 should not be released.
20
21 =head1 SEE ALSO
22
23 L<ssl(7)>,
24 L<d2i_SSL_SESSION(3)>,
25 L<SSL_SESSION_get_time(3)>,
26 L<SSL_SESSION_get0_hostname(3)>,
27 L<SSL_SESSION_free(3)>
28
29 =head1 HISTORY
30
31 SSL_SESSION_get0_cipher() was first added to OpenSSL 1.1.0
32
33 =head1 COPYRIGHT
34
35 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
36
37 Licensed under the OpenSSL license (the "License").  You may not use
38 this file except in compliance with the License.  You can obtain a copy
39 in the file LICENSE in the source distribution or at
40 L<https://www.openssl.org/source/license.html>.
41
42 =cut