doc: clarify proxy threat model · nodejs/node@004238d · GitHub
Skip to content

Commit 004238d

Browse files
mcollinaaduh95
authored andcommitted
doc: clarify proxy threat model
Signed-off-by: Matteo Collina <hello@matteocollina.com> PR-URL: #64366 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Gürgün Dayıoğlu <hey@gurgun.day>
1 parent 241ece0 commit 004238d

3 files changed

Lines changed: 52 additions & 2 deletions

File tree

SECURITY.md

Lines changed: 23 additions & 0 deletions

doc/api/cli.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3188,9 +3188,14 @@ added: v24.5.0
31883188
> Stability: 1.1 - Active Development
31893189
31903190
When enabled, Node.js parses the `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY`
3191-
environment variables during startup, and tunnels requests over the
3191+
environment variables during startup, and routes requests through the
31923192
specified proxy.
31933193

3194+
Use this only with proxies that are trusted and authorized for the deployment.
3195+
Proxy support is intended for reaching external networks through authorized
3196+
proxy servers, for example when a firewall requires one. It is not for hiding
3197+
traffic or evading network policy. See [Built-in Proxy Support][].
3198+
31943199
This is equivalent to setting the [`NODE_USE_ENV_PROXY=1`][] environment variable.
31953200
When both are set, `--use-env-proxy` takes precedence.
31963201

@@ -3864,9 +3869,14 @@ added: v24.0.0
38643869
> Stability: 1.1 - Active Development
38653870
38663871
When enabled, Node.js parses the `HTTP_PROXY`, `HTTPS_PROXY` and `NO_PROXY`
3867-
environment variables during startup, and tunnels requests over the
3872+
environment variables during startup, and routes requests through the
38683873
specified proxy.
38693874

3875+
Use this only with proxies that are trusted and authorized for the deployment.
3876+
Proxy support is intended for reaching external networks through authorized
3877+
proxy servers, for example when a firewall requires one. It is not for hiding
3878+
traffic or evading network policy. See [Built-in Proxy Support][].
3879+
38703880
This can also be enabled using the [`--use-env-proxy`][] command-line flag.
38713881
When both are set, `--use-env-proxy` takes precedence.
38723882

@@ -4170,6 +4180,7 @@ node --stack-trace-limit=12 -p -e "Error.stackTraceLimit" # prints 12
41704180
<!-- v8-options end -->
41714181

41724182
[#42511]: https://github.com/nodejs/node/issues/42511
4183+
[Built-in Proxy Support]: http.md#built-in-proxy-support
41734184
[Chrome DevTools Protocol]: https://chromedevtools.github.io/devtools-protocol/
41744185
[Chromium's policy for locally trusted certificates]: https://chromium.googlesource.com/chromium/src/+/main/net/data/ssl/chrome_root_store/faq.md#does-the-chrome-certificate-verifier-consider-local-trust-decisions
41754186
[CommonJS module]: modules.md

doc/api/http.md

Lines changed: 16 additions & 0 deletions

0 commit comments

Comments
 (0)