diff options
| author | Dan Beglin <dbeglinuk@gmail.com> | 2019-05-17 23:17:19 +0100 |
|---|---|---|
| committer | Ruben Bridgewater <ruben@bridgewater.de> | 2019-05-21 13:13:29 +0200 |
| commit | 9f5b6900e788afce29d27b71d167f188064e4ede (patch) | |
| tree | 8b448424f38fbb1e541b5b2a577c555cf2a5173a /doc/api/tls.md | |
| parent | d1da11765d886c764b93f25c1b95fe14472c2946 (diff) | |
| download | node-new-9f5b6900e788afce29d27b71d167f188064e4ede.tar.gz | |
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>
Diffstat (limited to 'doc/api/tls.md')
| -rw-r--r-- | doc/api/tls.md | 4 |
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 |