From 0ca9297c3945f52325fcd08afe3fb9dfe3adf123 Mon Sep 17 00:00:00 2001 From: Dan Beglin Date: Fri, 17 May 2019 23:17:19 +0100 Subject: [PATCH] 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 Reviewed-By: Rich Trott Reviewed-By: Luigi Pinca Reviewed-By: Colin Ihrig Reviewed-By: James M Snell Reviewed-By: Ruben Bridgewater --- doc/api/tls.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/tls.md b/doc/api/tls.md index d4c795bb3da4e1..3edb604071e787 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