diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 4d9493ac5dee5c..e51148d85a7321 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -2542,24 +2542,26 @@ does not contain any DNS names. This behavior is consistent with [RFC 2818][] If the `'subject'` option is set to `'never'`, the certificate subject is never considered, even if the certificate contains no subject alternative names. -### `x509.checkIP(ip[, options])` +### `x509.checkIP(ip)` * `ip` {string} -* `options` {Object} - * `subject` {string} `'always'` or `'never'`. **Default:** `'always'`. - * `wildcards` {boolean} **Default:** `true`. - * `partialWildcards` {boolean} **Default:** `true`. - * `multiLabelWildcards` {boolean} **Default:** `false`. - * `singleLabelSubdomains` {boolean} **Default:** `false`. * Returns: {string|undefined} Returns `ip` if the certificate matches, `undefined` if it does not. Checks whether the certificate matches the given IP address (IPv4 or IPv6). +Only [RFC 5280][] `iPAddress` subject alternative names are considered, and they +must match the given `ip` address exactly. Other subject alternative names as +well as the subject field of the certificate are ignored. + ### `x509.checkIssued(otherCert)`