diff options
author | bentley <> | 2014-10-12 09:33:04 +0000 |
---|---|---|
committer | bentley <> | 2014-10-12 09:33:04 +0000 |
commit | 82b7f378b6907ab315a6e50322d2a0a8794a0aa9 (patch) | |
tree | a5087bf8d016a6041c2b6822fbecfd8f6c5e70b1 /src/lib/libssl/doc/SSL_get_current_cipher.3 | |
parent | 0a63f0cf49369e1926567ab62e04e3355cedf0cd (diff) | |
download | openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.tar.gz openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.tar.bz2 openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.zip |
Convert libssl manpages from pod to mdoc(7).
libcrypto has not been started yet.
ok schwarze@ miod@
Diffstat (limited to 'src/lib/libssl/doc/SSL_get_current_cipher.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_get_current_cipher.3 | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_get_current_cipher.3 b/src/lib/libssl/doc/SSL_get_current_cipher.3 new file mode 100644 index 0000000000..ec1f2bb7df --- /dev/null +++ b/src/lib/libssl/doc/SSL_get_current_cipher.3 | |||
@@ -0,0 +1,49 @@ | |||
1 | .Dd $Mdocdate: October 12 2014 $ | ||
2 | .Dt SSL_GET_CURRENT_CIPHER 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm SSL_get_current_cipher , | ||
6 | .Nm SSL_get_cipher , | ||
7 | .Nm SSL_get_cipher_name , | ||
8 | .Nm SSL_get_cipher_bits , | ||
9 | .Nm SSL_get_cipher_version | ||
10 | .Nd get SSL_CIPHER of a connection | ||
11 | .Sh SYNOPSIS | ||
12 | .In openssl/ssl.h | ||
13 | .Ft SSL_CIPHER * | ||
14 | .Fn SSL_get_current_cipher "const SSL *ssl" | ||
15 | .Fd #define SSL_get_cipher(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s)) | ||
16 | .Fd #define SSL_get_cipher_name(s) \ | ||
17 | SSL_CIPHER_get_name(SSL_get_current_cipher(s)) | ||
18 | .Fd #define SSL_get_cipher_bits(s,np) \ | ||
19 | SSL_CIPHER_get_bits(SSL_get_current_cipher(s),np) | ||
20 | .Fd #define SSL_get_cipher_version(s) \ | ||
21 | SSL_CIPHER_get_version(SSL_get_current_cipher(s)) | ||
22 | .Sh DESCRIPTION | ||
23 | .Fn SSL_get_current_cipher | ||
24 | returns a pointer to an | ||
25 | .Vt SSL_CIPHER | ||
26 | object containing the description of the actually used cipher of a connection | ||
27 | established with the | ||
28 | .Fa ssl | ||
29 | object. | ||
30 | .Pp | ||
31 | .Fn SSL_get_cipher | ||
32 | and | ||
33 | .Fn SSL_get_cipher_name | ||
34 | are identical macros to obtain the name of the currently used cipher. | ||
35 | .Fn SSL_get_cipher_bits | ||
36 | is a macro to obtain the number of secret/algorithm bits used and | ||
37 | .Fn SSL_get_cipher_version | ||
38 | returns the protocol name. | ||
39 | See | ||
40 | .Xr SSL_CIPHER_get_name 3 | ||
41 | for more details. | ||
42 | .Sh RETURN VALUES | ||
43 | .Fn SSL_get_current_cipher | ||
44 | returns the cipher actually used or | ||
45 | .Dv NULL , | ||
46 | when no session has been established. | ||
47 | .Sh SEE ALSO | ||
48 | .Xr ssl 3 , | ||
49 | .Xr SSL_CIPHER_get_name 3 | ||