diff options
Diffstat (limited to 'src/lib/libssl/doc/SSL_get_current_cipher.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_get_current_cipher.3 | 52 |
1 files changed, 0 insertions, 52 deletions
diff --git a/src/lib/libssl/doc/SSL_get_current_cipher.3 b/src/lib/libssl/doc/SSL_get_current_cipher.3 deleted file mode 100644 index d7140571b0..0000000000 --- a/src/lib/libssl/doc/SSL_get_current_cipher.3 +++ /dev/null | |||
@@ -1,52 +0,0 @@ | |||
1 | .\" | ||
2 | .\" $OpenBSD: SSL_get_current_cipher.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
3 | .\" | ||
4 | .Dd $Mdocdate: December 2 2014 $ | ||
5 | .Dt SSL_GET_CURRENT_CIPHER 3 | ||
6 | .Os | ||
7 | .Sh NAME | ||
8 | .Nm SSL_get_current_cipher , | ||
9 | .Nm SSL_get_cipher , | ||
10 | .Nm SSL_get_cipher_name , | ||
11 | .Nm SSL_get_cipher_bits , | ||
12 | .Nm SSL_get_cipher_version | ||
13 | .Nd get SSL_CIPHER of a connection | ||
14 | .Sh SYNOPSIS | ||
15 | .In openssl/ssl.h | ||
16 | .Ft SSL_CIPHER * | ||
17 | .Fn SSL_get_current_cipher "const SSL *ssl" | ||
18 | .Fd #define SSL_get_cipher(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s)) | ||
19 | .Fd #define SSL_get_cipher_name(s) \ | ||
20 | SSL_CIPHER_get_name(SSL_get_current_cipher(s)) | ||
21 | .Fd #define SSL_get_cipher_bits(s,np) \ | ||
22 | SSL_CIPHER_get_bits(SSL_get_current_cipher(s),np) | ||
23 | .Fd #define SSL_get_cipher_version(s) \ | ||
24 | SSL_CIPHER_get_version(SSL_get_current_cipher(s)) | ||
25 | .Sh DESCRIPTION | ||
26 | .Fn SSL_get_current_cipher | ||
27 | returns a pointer to an | ||
28 | .Vt SSL_CIPHER | ||
29 | object containing the description of the actually used cipher of a connection | ||
30 | established with the | ||
31 | .Fa ssl | ||
32 | object. | ||
33 | .Pp | ||
34 | .Fn SSL_get_cipher | ||
35 | and | ||
36 | .Fn SSL_get_cipher_name | ||
37 | are identical macros to obtain the name of the currently used cipher. | ||
38 | .Fn SSL_get_cipher_bits | ||
39 | is a macro to obtain the number of secret/algorithm bits used and | ||
40 | .Fn SSL_get_cipher_version | ||
41 | returns the protocol name. | ||
42 | See | ||
43 | .Xr SSL_CIPHER_get_name 3 | ||
44 | for more details. | ||
45 | .Sh RETURN VALUES | ||
46 | .Fn SSL_get_current_cipher | ||
47 | returns the cipher actually used or | ||
48 | .Dv NULL , | ||
49 | when no session has been established. | ||
50 | .Sh SEE ALSO | ||
51 | .Xr ssl 3 , | ||
52 | .Xr SSL_CIPHER_get_name 3 | ||