Commit c41c093
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 <thechargingvolcano@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent 2c357a7 commit c41c093
1 file changed
Lines changed: 4 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -435,14 +435,15 @@ Static boolean value, always `true`. May be used to distinguish TLS sockets | |||
| 435 | 435 | from regular ones. | |
| 436 | 436 | ||
| 437 | 437 | ### 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. | ||
| 440 | 441 | ||
| 441 | 442 | Example: | |
| 442 | 443 | { name: 'AES256-SHA', version: 'TLSv1/SSLv3' } | |
| 443 | 444 | ||
| 444 | 445 | 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 | ||
| 446 | 447 | information. | |
| 447 | 448 | ||
| 448 | 449 | ### tlsSocket.getEphemeralKeyInfo() | |
0 commit comments