summaryrefslogtreecommitdiff
path: root/src/lib/libssl/doc/SSL_get_ciphers.3
diff options
context:
space:
mode:
authorbentley <>2014-10-12 09:33:04 +0000
committerbentley <>2014-10-12 09:33:04 +0000
commit82b7f378b6907ab315a6e50322d2a0a8794a0aa9 (patch)
treea5087bf8d016a6041c2b6822fbecfd8f6c5e70b1 /src/lib/libssl/doc/SSL_get_ciphers.3
parent0a63f0cf49369e1926567ab62e04e3355cedf0cd (diff)
downloadopenbsd-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_ciphers.3')
-rw-r--r--src/lib/libssl/doc/SSL_get_ciphers.365
1 files changed, 65 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_get_ciphers.3 b/src/lib/libssl/doc/SSL_get_ciphers.3
new file mode 100644
index 0000000000..f836988f39
--- /dev/null
+++ b/src/lib/libssl/doc/SSL_get_ciphers.3
@@ -0,0 +1,65 @@
1.Dd $Mdocdate: October 12 2014 $
2.Dt SSL_GET_CIPHERS 3
3.Os
4.Sh NAME
5.Nm SSL_get_ciphers ,
6.Nm SSL_get_cipher_list
7.Nd get list of available SSL_CIPHERs
8.Sh SYNOPSIS
9.In openssl/ssl.h
10.Ft STACK_OF(SSL_CIPHER) *
11.Fn SSL_get_ciphers "const SSL *ssl"
12.Ft const char *
13.Fn SSL_get_cipher_list "const SSL *ssl" "int priority"
14.Sh DESCRIPTION
15.Fn SSL_get_ciphers
16returns the stack of available
17.Vt SSL_CIPHER Ns s
18for
19.Fa ssl ,
20sorted by preference.
21If
22.Fa ssl
23is
24.Dv NULL
25or no ciphers are available,
26.Dv NULL
27is returned.
28.Pp
29.Fn SSL_get_cipher_list
30returns a pointer to the name of the
31.Vt SSL_CIPHER
32listed for
33.Fa ssl
34with
35.Fa priority .
36If
37.Fa ssl
38is
39.Dv NULL ,
40no ciphers are available, or there are fewer ciphers than
41.Fa priority
42available,
43.Dv NULL
44is returned.
45.Sh NOTES
46The details of the ciphers obtained by
47.Fn SSL_get_ciphers
48can be obtained using the
49.Xr SSL_CIPHER_get_name 3
50family of functions.
51.Pp
52Call
53.Fn SSL_get_cipher_list
54with
55.Fa priority
56starting from 0 to obtain the sorted list of available ciphers, until
57.Dv NULL
58is returned.
59.Sh RETURN VALUES
60See
61.Sx DESCRIPTION .
62.Sh SEE ALSO
63.Xr ssl 3 ,
64.Xr SSL_CIPHER_get_name 3 ,
65.Xr SSL_CTX_set_cipher_list 3