Skip to content

doc: Improve checkServerIdentity docs #17203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Hannes-Magnusson-CK wants to merge 2 commits into from
Closed

doc: Improve checkServerIdentity docs #17203

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15a4b95
doc: Improve checkServerIdentity docs
Hannes-Magnusson-CK Nov 21, 2017
5bfa449
doc: Document tls.checkServerIdentity
Hannes-Magnusson-CK Nov 22, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
doc: Improve checkServerIdentity docs
  • Loading branch information
@Hannes-Magnusson-CK
Hannes-Magnusson-CK committed Nov 22, 2017
commit 15a4b955dfc475a5918a2db0ab3859e17f1f99ad
5 changes: 3 additions & 2 deletions doc/api/tls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -792,8 +792,9 @@ changes:
* `servername`: {string} Server name for the SNI (Server Name Indication) TLS
extension.
* `checkServerIdentity(servername, cert)` {Function} A callback function
to be used when checking the server's hostname against the certificate.
This should throw an error if verification fails. The method should return
   to be used (instead of the builtin `tls.checkServerIdentity()` function)
when checking the server's hostname against the certificate.
This should return an {Error} if verification fails. The method should return
`undefined` if the `servername` and `cert` are verified.
* `session` {Buffer} A `Buffer` instance, containing TLS session.
* `minDHSize` {number} Minimum size of the DH parameter in bits to accept a
Expand Down