Skip to content

Commit

Permalink
doc: minor cleanup of tls.getProtocol()
Browse files Browse the repository at this point in the history
Improve markup and return value description.

PR-URL: #24533
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
  • Loading branch information
sam-github authored and codebytere committed Jan 29, 2019
1 parent c16b932 commit 40c9ee0
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions doc/api/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -669,19 +669,19 @@ to implement the `tls-unique` channel binding from [RFC 5929][].
added: v5.7.0
-->

* Returns: {string}
* Returns: {string|null}

Returns a string containing the negotiated SSL/TLS protocol version of the
current connection. The value `'unknown'` will be returned for connected
sockets that have not completed the handshaking process. The value `null` will
be returned for server sockets or disconnected client sockets.

Example responses include:
Protocol versions are:

* `TLSv1`
* `TLSv1.1`
* `TLSv1.2`
* `unknown`
* `'TLSv1'`
* `'TLSv1.1'`
* `'TLSv1.2'`
* `'SSLv3'`

See <https://www.openssl.org/docs/man1.1.0/ssl/SSL_get_version.html> for more
information.
Expand Down

0 comments on commit 40c9ee0

Please sign in to comment.