Skip to content

doc: corrected tlsSocket.getPeerCertificate response type - #27757

Closed
danbeglin wants to merge 1 commit into
nodejs:masterfrom
danbeglin:master
Closed

doc: corrected tlsSocket.getPeerCertificate response type#27757
danbeglin wants to merge 1 commit into
nodejs:masterfrom
danbeglin:master

Conversation

@danbeglin

@danbeglindanbeglin commented May 17, 2019

Copy link
Copy Markdown
Contributor

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: #27721

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. tls Issues and PRs related to the tls subsystem. labels May 17, 2019
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
@danbeglin

Copy link
Copy Markdown
ContributorAuthor

Recreation of https://github.com/nodejs/node/pull/27734 due to misunderstanding of commit rules

@danbevdanbev added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 21, 2019
@danbev

Copy link
Copy Markdown
Contributor

Landed in 0ca9297. 🎉

@danbevdanbev closed this May 21, 2019
danbev pushed a commit that referenced this pull request May 21, 2019
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: #27757Fixes: #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>
BridgeAR pushed a commit that referenced this pull request May 21, 2019
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: #27757Fixes: #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>
@BridgeARBridgeAR mentioned this pull request May 21, 2019
4 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.tlsIssues and PRs related to the tls subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

API docs: type for TLS Certificate's subjectaltname field is wrong.

10 participants

@danbeglin@danbev@jasnell@Trott@addaleax@lpinca@cjihrig@JoelBradley@BridgeAR@nodejs-github-bot