Skip to content

Commit

Permalink
doc: corrected tlsSocket.getPeerCertificate response type
Browse files Browse the repository at this point in the history
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.

Fixes: nodejs#27721
  • Loading branch information
dannyb648 committed May 17, 2019
1 parent 2a24aa2 commit 004baf8
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/api/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

1 comment on commit 004baf8

@JoelBradley
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dannyb648 Nice spot mate

Please sign in to comment.