Commit 29bbabd
doc: clarify tls.tlsSocket.getCipher().version
The getCipher() returns a tuple that includes protocol version string.
This string refers to the minimum protocol version string, as per
documentation. What is missing is a reference to the documentation
where to get the negotiated cipher for the socket connection and
a clearer example.
Fixes: #43406
PR-URL: #44086
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>1 parent 5adf039 commit 29bbabd
1 file changed
Lines changed: 6 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1098,17 +1098,17 @@ changes: | |||
| 1098 | 1098 | * `name` {string} OpenSSL name for the cipher suite. | |
| 1099 | 1099 | * `standardName` {string} IETF name for the cipher suite. | |
| 1100 | 1100 | * `version` {string} The minimum TLS protocol version supported by this cipher | |
| 1101 | - suite. | ||
| 1101 | + suite. For the actual negotiated protocol, see [`tls.TLSSocket.getProtocol()`][]. | ||
| 1102 | 1102 | ||
| 1103 | 1103 | Returns an object containing information on the negotiated cipher suite. | |
| 1104 | 1104 | ||
| 1105 | - For example: | ||
| 1105 | + For example, a TLSv1.2 protocol with AES256-SHA cipher: | ||
| 1106 | 1106 | ||
| 1107 | 1107 | ```json | |
| 1108 | 1108 | { | |
| 1109 | - "name": "AES128-SHA256", | ||
| 1110 | - "standardName": "TLS_RSA_WITH_AES_128_CBC_SHA256", | ||
| 1111 | - "version": "TLSv1.2" | ||
| 1109 | + "name": "AES256-SHA", | ||
| 1110 | + "standardName": "TLS_RSA_WITH_AES_256_CBC_SHA", | ||
| 1111 | + "version": "SSLv3" | ||
| 1112 | 1112 | } | |
| 1113 | 1113 | ``` | |
| 1114 | 1114 | ||
@@ -2258,6 +2258,7 @@ added: v11.4.0 | |||
| 2258 | 2258 | [`tls.Server`]: #class-tlsserver | |
| 2259 | 2259 | [`tls.TLSSocket.enableTrace()`]: #tlssocketenabletrace | |
| 2260 | 2260 | [`tls.TLSSocket.getPeerCertificate()`]: #tlssocketgetpeercertificatedetailed | |
| 2261 | + [`tls.TLSSocket.getProtocol()`]: #tlssocketgetprotocol | ||
| 2261 | 2262 | [`tls.TLSSocket.getSession()`]: #tlssocketgetsession | |
| 2262 | 2263 | [`tls.TLSSocket.getTLSTicket()`]: #tlssocketgettlsticket | |
| 2263 | 2264 | [`tls.TLSSocket`]: #class-tlstlssocket | |
0 commit comments