Skip to content

Commit 9bc369f

Browse files
authored
doc: fix --inspect security warning section
PR-URL: #61675 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Tierney Cyren <hello@bnb.im> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
1 parent 9afa802 commit 9bc369f

File tree

1 file changed

+26
-20
lines changed

1 file changed

+26
-20
lines changed

doc/api/cli.md

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1684,26 +1684,6 @@ When enabled, the parser will accept the following:
16841684
All the above will expose your application to request smuggling
16851685
or poisoning attack. Avoid using this option.
16861686

1687-
<!-- Anchor to make sure old links find a target -->
1688-
1689-
<a id="inspector_security"></a>
1690-
1691-
#### Warning: binding inspector to a public IP:port combination is insecure
1692-
1693-
Binding the inspector to a public IP (including `0.0.0.0`) with an open port is
1694-
insecure, as it allows external hosts to connect to the inspector and perform
1695-
a [remote code execution][] attack.
1696-
1697-
If specifying a host, make sure that either:
1698-
1699-
* The host is not accessible from public networks.
1700-
* A firewall disallows unwanted connections on the port.
1701-
1702-
**More specifically, `--inspect=0.0.0.0` is insecure if the port (`9229` by
1703-
default) is not firewall-protected.**
1704-
1705-
See the [debugging security implications][] section for more information.
1706-
17071687
### `--inspect-brk[=[host:]port]`
17081688

17091689
<!-- YAML
@@ -1716,6 +1696,9 @@ a random available port will be used.
17161696

17171697
See [V8 Inspector integration for Node.js][] for further explanation on Node.js debugger.
17181698

1699+
See the [security warning][] below regarding the `host`
1700+
parameter usage.
1701+
17191702
### `--inspect-port=[host:]port`
17201703

17211704
<!-- YAML
@@ -1753,6 +1736,9 @@ a random available port will be used.
17531736

17541737
See [V8 Inspector integration for Node.js][] for further explanation on Node.js debugger.
17551738

1739+
See the [security warning][] below regarding the `host`
1740+
parameter usage.
1741+
17561742
### `--inspect[=[host:]port]`
17571743

17581744
<!-- YAML
@@ -1767,6 +1753,26 @@ and profile Node.js instances. The tools attach to Node.js instances via a
17671753
tcp port and communicate using the [Chrome DevTools Protocol][].
17681754
See [V8 Inspector integration for Node.js][] for further explanation on Node.js debugger.
17691755

1756+
<!-- Anchor to make sure old links find a target -->
1757+
1758+
<a id="inspector_security"></a>
1759+
1760+
#### Warning: binding inspector to a public IP:port combination is insecure
1761+
1762+
Binding the inspector to a public IP (including `0.0.0.0`) with an open port is
1763+
insecure, as it allows external hosts to connect to the inspector and perform
1764+
a [remote code execution][] attack.
1765+
1766+
If specifying a host, make sure that either:
1767+
1768+
* The host is not accessible from public networks.
1769+
* A firewall disallows unwanted connections on the port.
1770+
1771+
**More specifically, `--inspect=0.0.0.0` is insecure if the port (`9229` by
1772+
default) is not firewall-protected.**
1773+
1774+
See the [debugging security implications][] section for more information.
1775+
17701776
### `-i`, `--interactive`
17711777

17721778
<!-- YAML

0 commit comments

Comments
 (0)