aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan Beglin <dbeglinuk@gmail.com>2019-05-17 23:17:19 +0100
committerDaniel Bevenius <daniel.bevenius@gmail.com>2019-05-21 05:28:24 +0200
commit0ca9297c3945f52325fcd08afe3fb9dfe3adf123 (patch)
treeb0adad89f2283cb05e5a3609a406bf45cafac7d7
parent2e5bc8047ea2b1fb143c24055c0aebcbf18894fb (diff)
downloadandroid-node-v8-0ca9297c3945f52325fcd08afe3fb9dfe3adf123.tar.gz
android-node-v8-0ca9297c3945f52325fcd08afe3fb9dfe3adf123.tar.bz2
android-node-v8-0ca9297c3945f52325fcd08afe3fb9dfe3adf123.zip
doc: corrected tlsSocket.getPeerCertificate response type
Within tls.md, the documentation for the response of tlsSocket.getPeerCertificate() included subjectaltname documented as an array of values. However these values are actually returned as a single string of concatenated values. The documentation has been updated to reflect this. PR-URL: https://github.com/nodejs/node/pull/27757 Fixes: https://github.com/nodejs/node/issues/27721 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
-rw-r--r--doc/api/tls.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/tls.md b/doc/api/tls.md
index d4c795bb3d..3edb604071 100644
--- a/doc/api/tls.md
+++ b/doc/api/tls.md
@@ -917,8 +917,8 @@ certificate.
It is returned as a `:` separated hexadecimal string. Example:
`'2A:7A:C2:DD:...'`.
* `ext_key_usage` {Array} (Optional) The extended key usage, a set of OIDs.
-* `subjectaltname` {Array} (Optional) An array of names for the subject, an
- alternative to the `subject` names.
+* `subjectaltname` {string} (Optional) A string containing concatenated names
+ for the subject, an alternative to the `subject` names.
* `infoAccess` {Array} (Optional) An array describing the AuthorityInfoAccess,
used with OCSP.
* `issuerCertificate` {Object} (Optional) The issuer certificate object. For