summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSam Roberts <vieuxtech@gmail.com>2019-06-03 11:48:25 -0700
committerAnna Henningsen <anna@addaleax.net>2019-12-03 23:28:38 +0100
commita025c5a8745637aa5f6e06acab0c15461a920d8e (patch)
tree7efb124ee33c61471cd7012e674f0266c89eff5c /doc
parentc0905b71adb55cbf98816dd993fec2d7c17ebbfe (diff)
downloadandroid-node-v8-a025c5a8745637aa5f6e06acab0c15461a920d8e.tar.gz
android-node-v8-a025c5a8745637aa5f6e06acab0c15461a920d8e.tar.bz2
android-node-v8-a025c5a8745637aa5f6e06acab0c15461a920d8e.zip
tls: expose IETF name for current cipher suite
OpenSSL has its own legacy names, but knowing the IETF name is useful when trouble-shooting, or looking for more information on the cipher. PR-URL: https://github.com/nodejs/node/pull/30637 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Yorkie Liu <yorkiefixer@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/tls.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md
index 8fa601096b..7473c11a68 100644
--- a/doc/api/tls.md
+++ b/doc/api/tls.md
@@ -827,16 +827,27 @@ changes:
pr-url: https://github.com/nodejs/node/pull/26625
description: Return the minimum cipher version, instead of a fixed string
(`'TLSv1/SSLv3'`).
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/30637
+ description: Return the IETF cipher name as `standardName`.
-->
* Returns: {Object}
- * `name` {string} The name of the cipher suite.
+ * `name` {string} OpenSSL name for the cipher suite.
+ * `standardName` {string} IETF name for the cipher suite.
* `version` {string} The minimum TLS protocol version supported by this cipher
suite.
Returns an object containing information on the negotiated cipher suite.
-For example: `{ name: 'AES256-SHA', version: 'TLSv1.2' }`.
+For example:
+```json
+{
+ "name": "AES128-SHA256",
+ "standardName": "TLS_RSA_WITH_AES_128_CBC_SHA256",
+ "version": "TLSv1.2"
+}
+```
See
[SSL_CIPHER_get_name](https://www.openssl.org/docs/man1.1.1/man3/SSL_CIPHER_get_name.html)