Skip to content

Commit

Permalink
doc: improve checkServerIdentity docs
Browse files Browse the repository at this point in the history
PR-URL: #17203
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information
Hannes-Magnusson-CK authored and gibfahn committed Dec 19, 2017
1 parent 9f73ce0 commit 88ae46d
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/api/tls.md
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

0 comments on commit 88ae46d

Please sign in to comment.