Skip to content

Commit 94f9b2c

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.
1 parent 0c6e523 commit 94f9b2c

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
@@ -434,14 +434,15 @@ Static boolean value, always `true`. May be used to distinguish TLS sockets
434434
from regular ones.
435435

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

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

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

447448
### tlsSocket.getEphemeralKeyInfo()

0 commit comments

Comments
 (0)