diff options
| author | schwarze <> | 2016-11-05 15:32:20 +0000 |
|---|---|---|
| committer | schwarze <> | 2016-11-05 15:32:20 +0000 |
| commit | b3e8c428c609fc9c66690abb3d188c60b5d48bb1 (patch) | |
| tree | 1672f1234352c29443fcacb44e22f1b20f174d99 /src/lib/libssl/man/SSL_get_ciphers.3 | |
| parent | 19bc742a20d4c505bc890d49e01c44192e9dbeff (diff) | |
| download | openbsd-b3e8c428c609fc9c66690abb3d188c60b5d48bb1.tar.gz openbsd-b3e8c428c609fc9c66690abb3d188c60b5d48bb1.tar.bz2 openbsd-b3e8c428c609fc9c66690abb3d188c60b5d48bb1.zip | |
move manual pages from doc/ to man/ for consistency with other
libraries, in particular considering that there are unrelated
files in doc/; requested by jsing@ and beck@
Diffstat (limited to 'src/lib/libssl/man/SSL_get_ciphers.3')
| -rw-r--r-- | src/lib/libssl/man/SSL_get_ciphers.3 | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/src/lib/libssl/man/SSL_get_ciphers.3 b/src/lib/libssl/man/SSL_get_ciphers.3 new file mode 100644 index 0000000000..4469b73f92 --- /dev/null +++ b/src/lib/libssl/man/SSL_get_ciphers.3 | |||
| @@ -0,0 +1,68 @@ | |||
| 1 | .\" | ||
| 2 | .\" $OpenBSD: SSL_get_ciphers.3,v 1.1 2016/11/05 15:32:20 schwarze Exp $ | ||
| 3 | .\" | ||
| 4 | .Dd $Mdocdate: November 5 2016 $ | ||
| 5 | .Dt SSL_GET_CIPHERS 3 | ||
| 6 | .Os | ||
| 7 | .Sh NAME | ||
| 8 | .Nm SSL_get_ciphers , | ||
| 9 | .Nm SSL_get_cipher_list | ||
| 10 | .Nd get list of available SSL_CIPHERs | ||
| 11 | .Sh SYNOPSIS | ||
| 12 | .In openssl/ssl.h | ||
| 13 | .Ft STACK_OF(SSL_CIPHER) * | ||
| 14 | .Fn SSL_get_ciphers "const SSL *ssl" | ||
| 15 | .Ft const char * | ||
| 16 | .Fn SSL_get_cipher_list "const SSL *ssl" "int priority" | ||
| 17 | .Sh DESCRIPTION | ||
| 18 | .Fn SSL_get_ciphers | ||
| 19 | returns the stack of available | ||
| 20 | .Vt SSL_CIPHER Ns s | ||
| 21 | for | ||
| 22 | .Fa ssl , | ||
| 23 | sorted by preference. | ||
| 24 | If | ||
| 25 | .Fa ssl | ||
| 26 | is | ||
| 27 | .Dv NULL | ||
| 28 | or no ciphers are available, | ||
| 29 | .Dv NULL | ||
| 30 | is returned. | ||
| 31 | .Pp | ||
| 32 | .Fn SSL_get_cipher_list | ||
| 33 | returns a pointer to the name of the | ||
| 34 | .Vt SSL_CIPHER | ||
| 35 | listed for | ||
| 36 | .Fa ssl | ||
| 37 | with | ||
| 38 | .Fa priority . | ||
| 39 | If | ||
| 40 | .Fa ssl | ||
| 41 | is | ||
| 42 | .Dv NULL , | ||
| 43 | no ciphers are available, or there are fewer ciphers than | ||
| 44 | .Fa priority | ||
| 45 | available, | ||
| 46 | .Dv NULL | ||
| 47 | is returned. | ||
| 48 | .Sh NOTES | ||
| 49 | The details of the ciphers obtained by | ||
| 50 | .Fn SSL_get_ciphers | ||
| 51 | can be obtained using the | ||
| 52 | .Xr SSL_CIPHER_get_name 3 | ||
| 53 | family of functions. | ||
| 54 | .Pp | ||
| 55 | Call | ||
| 56 | .Fn SSL_get_cipher_list | ||
| 57 | with | ||
| 58 | .Fa priority | ||
| 59 | starting from 0 to obtain the sorted list of available ciphers, until | ||
| 60 | .Dv NULL | ||
| 61 | is returned. | ||
| 62 | .Sh RETURN VALUES | ||
| 63 | See | ||
| 64 | .Sx DESCRIPTION . | ||
| 65 | .Sh SEE ALSO | ||
| 66 | .Xr ssl 3 , | ||
| 67 | .Xr SSL_CIPHER_get_name 3 , | ||
| 68 | .Xr SSL_CTX_set_cipher_list 3 | ||
