1.\" $OpenBSD: SSL_get_current_cipher.3,v 1.4 2018/03/27 17:35:50 schwarze Exp $ 2.\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 3.\" 4.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>. 5.\" Copyright (c) 2000, 2005, 2016 The OpenSSL Project. All rights reserved. 6.\" 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: March 27 2018 $ 52.Dt SSL_GET_CURRENT_CIPHER 3 53.Os 54.Sh NAME 55.Nm SSL_get_current_cipher , 56.Nm SSL_get_cipher , 57.Nm SSL_get_cipher_name , 58.Nm SSL_get_cipher_bits , 59.Nm SSL_get_cipher_version 60.Nd get SSL_CIPHER of a connection 61.Sh SYNOPSIS 62.In openssl/ssl.h 63.Ft const SSL_CIPHER * 64.Fn SSL_get_current_cipher "const SSL *ssl" 65.Ft const char * 66.Fn SSL_get_cipher "const SSL *ssl" 67.Ft const char * 68.Fn SSL_get_cipher_name "const SSL *ssl" 69.Ft int 70.Fn SSL_get_cipher_bits "const SSL *ssl" "int *np" 71.Ft char * 72.Fn SSL_get_cipher_version "const SSL *ssl" 73.Sh DESCRIPTION 74.Fn SSL_get_current_cipher 75returns a pointer to an 76.Vt SSL_CIPHER 77object containing the description of the actually used cipher of a connection 78established with the 79.Fa ssl 80object. 81See 82.Xr SSL_CIPHER_get_name 3 83for more details. 84.Pp 85.Fn SSL_get_cipher_name 86obtains the name of the currently used cipher. 87.Fn SSL_get_cipher 88is identical to 89.Fn SSL_get_cipher_name . 90.Pp 91.Fn SSL_get_cipher_bits 92obtains the number of secret/algorithm bits used and 93.Fn SSL_get_cipher_version 94returns the protocol name. 95.Pp 96.Fn SSL_get_cipher , 97.Fn SSL_get_cipher_name , 98.Fn SSL_get_cipher_bits , 99and 100.Fn SSL_get_cipher_version 101are implemented as macros. 102.Sh RETURN VALUES 103.Fn SSL_get_current_cipher 104returns the cipher actually used, or 105.Dv NULL 106if no session has been established. 107.Sh SEE ALSO 108.Xr ssl 3 , 109.Xr SSL_CIPHER_get_name 3 110.Sh HISTORY 111.Fn SSL_get_cipher 112appeared in SSLeay 0.4 or earlier. 113.Fn SSL_get_cipher_bits 114first appeared in SSLeay 0.6.4. 115.Fn SSL_get_cipher_name 116and 117.Fn SSL_get_cipher_version 118first appeared in SSLeay 0.8.0. 119.Fn SSL_get_current_cipher 120first appeared in SSLeay 0.8.1. 121These functions have been available since 122.Ox 2.4 . 123