From 275f6dbcbbcaa80ba9bc30bf8c513110bff67dab Mon Sep 17 00:00:00 2001 From: Brian White Date: Sun, 31 Jan 2016 01:28:41 -0500 Subject: [PATCH] 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: https://github.com/nodejs/node/pull/4995 Reviewed-By: Sakthipriyan Vairamani Reviewed-By: Ben Noordhuis Reviewed-By: James M Snell --- doc/api/tls.markdown | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/api/tls.markdown b/doc/api/tls.markdown index fb4c9555a6af8d..364d82634f513f 100644 --- a/doc/api/tls.markdown +++ b/doc/api/tls.markdown @@ -435,14 +435,15 @@ Static boolean value, always `true`. May be used to distinguish TLS sockets from regular ones. ### tlsSocket.getCipher() -Returns an object representing the cipher name and the SSL/TLS -protocol version of the current connection. + +Returns an object representing the cipher name and the SSL/TLS protocol version +that first defined the cipher. Example: { name: 'AES256-SHA', version: 'TLSv1/SSLv3' } See SSL_CIPHER_get_name() and SSL_CIPHER_get_version() in -https://www.openssl.org/docs/ssl/ssl.html#DEALING_WITH_CIPHERS for more +https://www.openssl.org/docs/manmaster/ssl/SSL_CIPHER_get_name.html for more information. ### tlsSocket.getEphemeralKeyInfo()