Permalink
Browse files

doc: improve checkServerIdentity docs

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 Nov 21, 2017
1 parent afd4d9e commit 0fa2f394577adb55f54747a512ea6ca694e68797
Showing with 3 additions and 2 deletions.
  1. +3 −2 doc/api/tls.md
View
@@ -808,8 +808,9 @@ added: v0.11.3
* `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

0 comments on commit 0fa2f39

Please sign in to comment.