Skip to content

Commit c41c093

Browse files
committed
doc: correct tlsSocket.getCipher() description
getCipher() actually includes the protocol version that the cipher was first supported and *not* the negotiated protocol of the current connection. PR-URL: #4995 Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 2c357a7 commit c41c093

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

doc/api/tls.markdown

+4-3
Original file line numberDiff line numberDiff line change
@@ -435,14 +435,15 @@ Static boolean value, always `true`. May be used to distinguish TLS sockets
435435
from regular ones.
436436

437437
### tlsSocket.getCipher()
438-
Returns an object representing the cipher name and the SSL/TLS
439-
protocol version of the current connection.
438+
439+
Returns an object representing the cipher name and the SSL/TLS protocol version
440+
that first defined the cipher.
440441

441442
Example:
442443
{ name: 'AES256-SHA', version: 'TLSv1/SSLv3' }
443444

444445
See SSL_CIPHER_get_name() and SSL_CIPHER_get_version() in
445-
https://www.openssl.org/docs/ssl/ssl.html#DEALING_WITH_CIPHERS for more
446+
https://www.openssl.org/docs/manmaster/ssl/SSL_CIPHER_get_name.html for more
446447
information.
447448

448449
### tlsSocket.getEphemeralKeyInfo()

0 commit comments

Comments
 (0)