diff --git a/doc/api/tls.md b/doc/api/tls.md index d4c635963b34e7..fa34711fa81a12 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -717,18 +717,25 @@ socket has been destroyed, `null` will be returned. ### tlsSocket.getCipher() * Returns: {Object} + * `name` {string} The name of the cipher suite. + * `version` {string} The minimum TLS protocol version supported by this cipher + suite. -Returns an object representing the cipher name. The `version` key is a legacy -field which always contains the value `'TLSv1/SSLv3'`. +Returns an object containing information on the negotiated cipher suite. For example: `{ name: 'AES256-SHA', version: 'TLSv1/SSLv3' }`. -See `SSL_CIPHER_get_name()` in - for more -information. +See +[OpenSSL](https://www.openssl.org/docs/man1.1.1/man3/SSL_CIPHER_get_name.html) +for more information. ### tlsSocket.getEphemeralKeyInfo()