Skip to content

Commit 1ef28f1

Browse files
tniessendanielleadams
authored andcommitted
crypto: remove checkIP options argument
None of the supported options have any effect on X509_check_ip_asc. Refs: openssl/openssl#17536 PR-URL: #41571 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 57dc595 commit 1ef28f1

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

doc/api/crypto.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -2509,24 +2509,26 @@ or it might contain wildcards (e.g., `*.example.com`). Because host name
25092509
comparisons are case-insensitive, the returned subject name might also differ
25102510
from the given `name` in capitalization.
25112511

2512-
### `x509.checkIP(ip[, options])`
2512+
### `x509.checkIP(ip)`
25132513

25142514
<!-- YAML
25152515
added: v15.6.0
2516+
changes:
2517+
- version: REPLACEME
2518+
pr-url: https://github.com/nodejs/node/pull/41571
2519+
description: The `options` argument has been removed since it had no effect.
25162520
-->
25172521

25182522
* `ip` {string}
2519-
* `options` {Object}
2520-
* `subject` {string} `'always'` or `'never'`. **Default:** `'always'`.
2521-
* `wildcards` {boolean} **Default:** `true`.
2522-
* `partialWildcards` {boolean} **Default:** `true`.
2523-
* `multiLabelWildcards` {boolean} **Default:** `false`.
2524-
* `singleLabelSubdomains` {boolean} **Default:** `false`.
25252523
* Returns: {string|undefined} Returns `ip` if the certificate matches,
25262524
`undefined` if it does not.
25272525

25282526
Checks whether the certificate matches the given IP address (IPv4 or IPv6).
25292527

2528+
Only [RFC 5280][] `iPAddress` subject alternative names are considered, and they
2529+
must match the given `ip` address exactly. Other subject alternative names as
2530+
well as the subject field of the certificate are ignored.
2531+
25302532
### `x509.checkIssued(otherCert)`
25312533

25322534
<!-- YAML
@@ -5911,6 +5913,7 @@ See the [list of SSL OP Flags][] for details.
59115913
[RFC 4055]: https://www.rfc-editor.org/rfc/rfc4055.txt
59125914
[RFC 4122]: https://www.rfc-editor.org/rfc/rfc4122.txt
59135915
[RFC 5208]: https://www.rfc-editor.org/rfc/rfc5208.txt
5916+
[RFC 5280]: https://www.rfc-editor.org/rfc/rfc5280.txt
59145917
[Web Crypto API documentation]: webcrypto.md
59155918
[`BN_is_prime_ex`]: https://www.openssl.org/docs/man1.1.1/man3/BN_is_prime_ex.html
59165919
[`Buffer`]: buffer.md

lib/internal/crypto/x509.js

+5
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,11 @@ class X509Certificate extends JSTransferable {
313313

314314
checkIP(ip, options) {
315315
validateString(ip, 'ip');
316+
// The options argument is currently undocumented since none of the options
317+
// have any effect on the behavior of this function. However, we still parse
318+
// the options argument in case OpenSSL adds flags in the future that do
319+
// affect the behavior of X509_check_ip. This ensures that no invalid values
320+
// are passed as the second argument in the meantime.
316321
return this[kHandle].checkIP(ip, getFlags(options));
317322
}
318323

0 commit comments

Comments
 (0)