diff options
| author | schwarze <> | 2016-12-10 13:12:08 +0000 |
|---|---|---|
| committer | schwarze <> | 2016-12-10 13:12:08 +0000 |
| commit | 5c25f84f5f6a33946cfa19725ef930c22a1659c8 (patch) | |
| tree | 10a2e083559f9d5685376b336e407a57daa9b410 | |
| parent | b6948e1dc0f3d04b7a4215efbff64c78f9cdd408 (diff) | |
| download | openbsd-5c25f84f5f6a33946cfa19725ef930c22a1659c8.tar.gz openbsd-5c25f84f5f6a33946cfa19725ef930c22a1659c8.tar.bz2 openbsd-5c25f84f5f6a33946cfa19725ef930c22a1659c8.zip | |
Document SSL_version(3). It's listed in ssl(3) and <openssl/ssl.h>,
so it's clearly a public interface.
| -rw-r--r-- | src/lib/libssl/man/SSL_get_version.3 | 27 |
1 files changed, 20 insertions, 7 deletions
diff --git a/src/lib/libssl/man/SSL_get_version.3 b/src/lib/libssl/man/SSL_get_version.3 index 6157f24718..fe18fbf648 100644 --- a/src/lib/libssl/man/SSL_get_version.3 +++ b/src/lib/libssl/man/SSL_get_version.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: SSL_get_version.3,v 1.2 2016/12/03 09:14:28 schwarze Exp $ | 1 | .\" $OpenBSD: SSL_get_version.3,v 1.3 2016/12/10 13:12:08 schwarze Exp $ |
| 2 | .\" OpenSSL bb9ad09e Jun 6 00:43:05 2016 -0400 | 2 | .\" OpenSSL bb9ad09e Jun 6 00:43:05 2016 -0400 |
| 3 | .\" | 3 | .\" |
| 4 | .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>. | 4 | .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>. |
| @@ -48,31 +48,44 @@ | |||
| 48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
| 49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
| 50 | .\" | 50 | .\" |
| 51 | .Dd $Mdocdate: December 3 2016 $ | 51 | .Dd $Mdocdate: December 10 2016 $ |
| 52 | .Dt SSL_GET_VERSION 3 | 52 | .Dt SSL_GET_VERSION 3 |
| 53 | .Os | 53 | .Os |
| 54 | .Sh NAME | 54 | .Sh NAME |
| 55 | .Nm SSL_get_version | 55 | .Nm SSL_get_version , |
| 56 | .Nm SSL_version | ||
| 56 | .Nd get the protocol version of a connection | 57 | .Nd get the protocol version of a connection |
| 57 | .Sh SYNOPSIS | 58 | .Sh SYNOPSIS |
| 58 | .In openssl/ssl.h | 59 | .In openssl/ssl.h |
| 59 | .Ft const char * | 60 | .Ft const char * |
| 60 | .Fn SSL_get_version "const SSL *ssl" | 61 | .Fn SSL_get_version "const SSL *ssl" |
| 62 | .Ft int | ||
| 63 | .Fn SSL_version "const SSL *ssl" | ||
| 61 | .Sh DESCRIPTION | 64 | .Sh DESCRIPTION |
| 62 | .Fn SSL_get_version | 65 | .Fn SSL_get_version |
| 63 | returns the name of the protocol used for the connection | 66 | returns the name of the protocol used for the connection |
| 64 | .Fa ssl . | 67 | .Fa ssl . |
| 68 | .Pp | ||
| 69 | .Fn SSL_version | ||
| 70 | returns an integer constant representing that protocol. | ||
| 65 | .Sh RETURN VALUES | 71 | .Sh RETURN VALUES |
| 66 | The following strings can be returned: | 72 | The following strings or integers can be returned: |
| 67 | .Bl -tag -width Ds | 73 | .Bl -tag -width Ds |
| 68 | .It Qq TLSv1 | 74 | .It Qo TLSv1 Qc No or Dv TLS1_VERSION |
| 69 | The connection uses the TLSv1.0 protocol. | 75 | The connection uses the TLSv1.0 protocol. |
| 70 | .It Qq TLSv1.1 | 76 | .It Qo TLSv1.1 Qc No or Dv TLS1_1_VERSION |
| 71 | The connection uses the TLSv1.1 protocol. | 77 | The connection uses the TLSv1.1 protocol. |
| 72 | .It Qq TLSv1.2 | 78 | .It Qo TLSv1.2 Qc No or Dv TLS1_2_VERSION |
| 73 | The connection uses the TLSv1.2 protocol. | 79 | The connection uses the TLSv1.2 protocol. |
| 80 | .It Qo DTLSv1 Qc No or Dv DTLS1_VERSION | ||
| 81 | The connection uses the Datagram Transport Layer Security 1.0 protocol. | ||
| 74 | .It Qq unknown | 82 | .It Qq unknown |
| 75 | This indicates that no version has been set (no connection established). | 83 | This indicates that no version has been set (no connection established). |
| 76 | .El | 84 | .El |
| 77 | .Sh SEE ALSO | 85 | .Sh SEE ALSO |
| 78 | .Xr ssl 3 | 86 | .Xr ssl 3 |
| 87 | .Sh HISTORY | ||
| 88 | .Fn SSL_get_version | ||
| 89 | and | ||
| 90 | .Fn SSL_version | ||
| 91 | are available in all versions of OpenSSL. | ||