diff options
| author | bentley <> | 2014-10-12 09:33:04 +0000 |
|---|---|---|
| committer | bentley <> | 2014-10-12 09:33:04 +0000 |
| commit | 78332233d01faa45e0bb0b1583d47cb5ad1ddc19 (patch) | |
| tree | a5087bf8d016a6041c2b6822fbecfd8f6c5e70b1 /src/lib/libssl/doc/SSL_get_ciphers.3 | |
| parent | 4e737c824fafe5f105e5f4849a9db2569b5d53d8 (diff) | |
| download | openbsd-78332233d01faa45e0bb0b1583d47cb5ad1ddc19.tar.gz openbsd-78332233d01faa45e0bb0b1583d47cb5ad1ddc19.tar.bz2 openbsd-78332233d01faa45e0bb0b1583d47cb5ad1ddc19.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.3 | 65 |
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 | ||
| 16 | returns the stack of available | ||
| 17 | .Vt SSL_CIPHER Ns s | ||
| 18 | for | ||
| 19 | .Fa ssl , | ||
| 20 | sorted by preference. | ||
| 21 | If | ||
| 22 | .Fa ssl | ||
| 23 | is | ||
| 24 | .Dv NULL | ||
| 25 | or no ciphers are available, | ||
| 26 | .Dv NULL | ||
| 27 | is returned. | ||
| 28 | .Pp | ||
| 29 | .Fn SSL_get_cipher_list | ||
| 30 | returns a pointer to the name of the | ||
| 31 | .Vt SSL_CIPHER | ||
| 32 | listed for | ||
| 33 | .Fa ssl | ||
| 34 | with | ||
| 35 | .Fa priority . | ||
| 36 | If | ||
| 37 | .Fa ssl | ||
| 38 | is | ||
| 39 | .Dv NULL , | ||
| 40 | no ciphers are available, or there are fewer ciphers than | ||
| 41 | .Fa priority | ||
| 42 | available, | ||
| 43 | .Dv NULL | ||
| 44 | is returned. | ||
| 45 | .Sh NOTES | ||
| 46 | The details of the ciphers obtained by | ||
| 47 | .Fn SSL_get_ciphers | ||
| 48 | can be obtained using the | ||
| 49 | .Xr SSL_CIPHER_get_name 3 | ||
| 50 | family of functions. | ||
| 51 | .Pp | ||
| 52 | Call | ||
| 53 | .Fn SSL_get_cipher_list | ||
| 54 | with | ||
| 55 | .Fa priority | ||
| 56 | starting from 0 to obtain the sorted list of available ciphers, until | ||
| 57 | .Dv NULL | ||
| 58 | is returned. | ||
| 59 | .Sh RETURN VALUES | ||
| 60 | See | ||
| 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 | ||
