permission: add initial environment permission

benchmark/fs/readfile-permission-enabled.js

@@ -24,6 +24,7 @@ const bench = common.createBenchmark(main, {
     '--allow-fs-read=*',
     '--allow-fs-write=*',
     '--allow-child-process',
+    '--allow-env',
   ],
 });
 

benchmark/permission/permission-fs-read.js

@@ -13,6 +13,7 @@ const options = {
   flags: [
     '--experimental-permission',
     `--allow-fs-read=${rootPath}`,
+    '--allow-env',
   ],
 };
 

doc/api/cli.md

@@ -141,6 +141,61 @@ Error: Access to this API has been restricted
 }
 ```
 
+### `--allow-env`, `--allow-env-name`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+> Stability: 1 - Experimental
+
+When using the [Permission Model][], access to the environment variables via
+`process.env` is denied by default. Attempts to do so will throw an
+`ERR_ACCESS_DENIED`. Users can explicitly configure permissions by passing the
+`--allow-env` flag when starting Node.js.
+
+The valid arguments for the flag are:
+
+* Empty - Used to allow access to all environment variables. The empty argument
+  is only available on `--allow-env`.
+* Strings delimited by comma (`,`) - Used to allow access to specified
+  environment variables.
+
+Examples can be found in the [Environment Permissions][] documentation.
+
+Example:
+
+```js
+// Attempt to bypass the permission
+process.env.PORT;
+```
+
+```console
+$ node --experimental-permission --allow-fs-read=* index.js
+node:internal/modules/cjs/loader:162
+  const result = internalModuleStat(filename);
+                 ^
+
+Error: Access to this API has been restricted
+    at Object.<anonymous> (/home/index.js.js:1:13)
+    at Module._compile (node:internal/modules/cjs/loader:1256:14)
+    at Module._extensions..js (node:internal/modules/cjs/loader:1310:10)
+    at Module.load (node:internal/modules/cjs/loader:1114:32)
+    at Module._load (node:internal/modules/cjs/loader:961:12)
+    at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:83:12)
+    at node:internal/main/run_main_module:23:47 {
+  code: 'ERR_ACCESS_DENIED',
+  permission: 'Environment',
+  resource: 'PORT'
+}
+```
+
+The process needs to have access to the `PORT` in the environment variables:
+
+```console
+$ node --experimental-permission --allow-fs-read=* --allow-env=PORT index.js
+```
+
 ### `--allow-fs-read`
 
 <!-- YAML
@@ -2101,6 +2156,7 @@ Node.js options that are allowed are:
 <!-- node-options-node start -->
 
 * `--allow-child-process`
+* `--allow-env`, `--allow-env-name`
 * `--allow-fs-read`
 * `--allow-fs-write`
 * `--allow-worker`
@@ -2561,6 +2617,7 @@ done
 [CustomEvent Web API]: https://dom.spec.whatwg.org/#customevent
 [ECMAScript module]: esm.md#modules-ecmascript-modules
 [ECMAScript module loader]: esm.md#loaders
+[Environment Permissions]: permissions.md#environment-permissions
 [Fetch API]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
 [File System Permissions]: permissions.md#file-system-permissions
 [Modules loaders]: packages.md#modules-loaders

doc/api/permissions.md

@@ -464,9 +464,10 @@ will restrict access to all available permissions.
 The available permissions are documented by the [`--experimental-permission`][]
 flag.
 
-When starting Node.js with `--experimental-permission`,
-the ability to access the file system through the `fs` module, spawn processes,
-and use `node:worker_threads` will be restricted.
+When starting Node.js with `--experimental-permission`, the ability to access
+the file system through the `fs` module, access environment variables through
+`process.env`, spawn processes, and use `node:worker_threads` will be
+restricted.
 
 ```console
 $ node --experimental-permission index.js
@@ -488,6 +489,9 @@ Error: Access to this API has been restricted
 Allowing access to spawning a process and creating worker threads can be done
 using the [`--allow-child-process`][] and [`--allow-worker`][] respectively.
 
+Allowing access to environment variables through `process.env` can be done using
+the [`--allow-env`][].
+
 #### Runtime API
 
 When enabling the Permission Model through the [`--experimental-permission`][]
@@ -506,6 +510,27 @@ process.permission.has('fs.read'); // true
 process.permission.has('fs.read', '/home/rafaelgss/protected-folder'); // false
 ```
 
+#### Environment Permissions
+
+To configure permission to access the environment variables via `process.env`,
+use the [`--allow-env`][] flag:
+
+```console
+$ node --experimental-permission --allow-fs-read=* --allow-env index.js
+```
+
+The valid arguments for the flag are:
+
+* Empty - Used to allow access to all environment variables.
+* Strings delimited by comma (`,`) - Used to allow access to specified
+  environment variable names.
+
+Example:
+
+* `--allow-env` - It will allow accees to all environment variables.
+* `--allow-env=HOME` - It will allow accees to `HOME`.
+* `--allow-env=HOME,PORT` - It will allow accees to both `HOME` and `PORT`.
+
 #### File System Permissions
 
 To allow access to the file system, use the [`--allow-fs-read`][] and
@@ -554,6 +579,7 @@ There are constraints you need to know before using this system:
 [Import maps]: https://url.spec.whatwg.org/#relative-url-with-fragment-string
 [Security Policy]: https://github.com/nodejs/node/blob/main/SECURITY.md
 [`--allow-child-process`]: cli.md#--allow-child-process
+[`--allow-env`]: cli.md#--allow-env---allow-env-name
 [`--allow-fs-read`]: cli.md#--allow-fs-read
 [`--allow-fs-write`]: cli.md#--allow-fs-write
 [`--allow-worker`]: cli.md#--allow-worker

doc/api/process.md

@@ -2659,12 +2659,18 @@ The available scopes are:
 * `fs.write` - File System write operations
 * `child` - Child process spawning operations
 * `worker` - Worker thread spawning operation
+* `env` - Environment variable access operations
 
 ```js
 // Check if the process has permission to read the README file
 process.permission.has('fs.read', './README.md');
 // Check if the process has read permission operations
 process.permission.has('fs.read');
+
+// Check if the process has permission to access SECRET in environment variables
+process.permission.has('env', 'SECRET');
+// Check if the process has permission to access all environment variables
+process.permission.has('env');
 ```
 
 ## `process.pid`

doc/node.1

@@ -88,6 +88,9 @@ Allow spawning process when using the permission model.
 .It Fl -allow-worker
 Allow creating worker threads when using the permission model.
 .
+.It Fl -allow-env
+Allow environment variables access when using the permission model.
+.
 .It Fl -completion-bash
 Print source-able bash completion script for Node.js.
 .

lib/child_process.js

@@ -43,6 +43,11 @@ const {
   StringPrototypeSlice,
   StringPrototypeToUpperCase,
 } = primordials;
+const {
+  privateSymbols: {
+    env_private_symbol,
+  },
+} = internalBinding('util');
 
 const {
   convertToValidSignal,
@@ -534,10 +539,10 @@ ObjectDefineProperty(execFile, promisify.custom, {
 });
 
 function copyProcessEnvToEnv(env, name, optionEnv) {
-  if (process.env[name] &&
+  if (process[env_private_symbol][name] &&
       (!optionEnv ||
        !ObjectPrototypeHasOwnProperty(optionEnv, name))) {
-    env[name] = process.env[name];
+    env[name] = process[env_private_symbol][name];
   }
 }
 
@@ -622,7 +627,7 @@ function normalizeSpawnArguments(file, args, options) {
       if (typeof options.shell === 'string')
         file = options.shell;
       else
-        file = process.env.comspec || 'cmd.exe';
+        file = process[env_private_symbol].comspec || 'cmd.exe';
       // '/d /s /c' is used only for cmd.exe.
       if (RegExpPrototypeExec(/^(?:.*\\)?cmd(?:\.exe)?$/i, file) !== null) {
         args = ['/d', '/s', '/c', `"${command}"`];
@@ -647,7 +652,7 @@ function normalizeSpawnArguments(file, args, options) {
     ArrayPrototypeUnshift(args, file);
   }
 
-  const env = options.env || process.env;
+  const env = options.env || process[env_private_symbol];
   const envPairs = [];
 
   // process.env.NODE_V8_COVERAGE always propagates, making it possible to

lib/cluster.js

@@ -21,5 +21,11 @@
 
 'use strict';
 
-const childOrPrimary = 'NODE_UNIQUE_ID' in process.env ? 'child' : 'primary';
+const {
+  privateSymbols: {
+    env_private_symbol,
+  },
+} = internalBinding('util');
+
+const childOrPrimary = 'NODE_UNIQUE_ID' in process[env_private_symbol] ? 'child' : 'primary';
 module.exports = require(`internal/cluster/${childOrPrimary}`);

lib/internal/cluster/child.js

@@ -8,6 +8,11 @@ const {
   SafeMap,
   SafeSet,
 } = primordials;
+const {
+  privateSymbols: {
+    env_private_symbol,
+  },
+} = internalBinding('util');
 
 const assert = require('internal/assert');
 const path = require('path');
@@ -34,7 +39,7 @@ cluster.Worker = Worker;
 
 cluster._setupWorker = function() {
   const worker = new Worker({
-    id: +process.env.NODE_UNIQUE_ID | 0,
+    id: +process[env_private_symbol].NODE_UNIQUE_ID | 0,
     process: process,
     state: 'online',
   });

lib/internal/cluster/primary.js

@@ -14,6 +14,11 @@ const {
     ERR_SOCKET_BAD_PORT,
   },
 } = require('internal/errors');
+const {
+  privateSymbols: {
+    env_private_symbol,
+  },
+} = internalBinding('util');
 
 const assert = require('internal/assert');
 const { fork } = require('child_process');
@@ -45,7 +50,7 @@ let ids = 0;
 let initialized = false;
 
 // XXX(bnoordhuis) Fold cluster.schedulingPolicy into cluster.settings?
-let schedulingPolicy = process.env.NODE_CLUSTER_SCHED_POLICY;
+let schedulingPolicy = process[env_private_symbol].NODE_CLUSTER_SCHED_POLICY;
 if (schedulingPolicy === 'rr')
   schedulingPolicy = SCHED_RR;
 else if (schedulingPolicy === 'none')
@@ -116,7 +121,7 @@ function setupSettingsNT(settings) {
 }
 
 function createWorkerProcess(id, env) {
-  const workerEnv = { ...process.env, ...env, NODE_UNIQUE_ID: `${id}` };
+  const workerEnv = { ...process[env_private_symbol], ...env, NODE_UNIQUE_ID: `${id}` };
   const execArgv = [...cluster.settings.execArgv];
 
   if (cluster.settings.inspectPort === null) {

lib/internal/console/constructor.js

@@ -52,7 +52,12 @@ const {
   validateInteger,
   validateObject,
 } = require('internal/validators');
-const { previewEntries } = internalBinding('util');
+const {
+  previewEntries,
+  privateSymbols: {
+    env_private_symbol,
+  },
+} = internalBinding('util');
 const { Buffer: { isBuffer } } = require('buffer');
 const {
   inspect,
@@ -442,7 +447,7 @@ const consoleMethods = {
   clear() {
     // It only makes sense to clear if _stdout is a TTY.
     // Otherwise, do nothing.
-    if (this._stdout.isTTY && process.env.TERM !== 'dumb') {
+    if (this._stdout.isTTY && process[env_private_symbol].TERM !== 'dumb') {
       // The require is here intentionally to avoid readline being
       // required too early when console is first loaded.
       const {

lib/internal/debugger/inspect_repl.js

@@ -43,6 +43,11 @@ const {
   StringPrototypeToUpperCase,
   StringPrototypeTrim,
 } = primordials;
+const {
+  privateSymbols: {
+    env_private_symbol,
+  },
+} = internalBinding('util');
 
 const { ERR_DEBUGGER_ERROR } = require('internal/errors').codes;
 
@@ -887,7 +892,7 @@ function createRepl(inspector) {
   }
 
   Debugger.on('paused', ({ callFrames, reason /* , hitBreakpoints */ }) => {
-    if (process.env.NODE_INSPECT_RESUME_ON_START === '1' &&
+    if (process[env_private_symbol].NODE_INSPECT_RESUME_ON_START === '1' &&
         reason === 'Break on start') {
       debuglog('Paused on start, but NODE_INSPECT_RESUME_ON_START' +
               ' environment variable is set to 1, resuming');

lib/internal/main/repl.js

@@ -18,14 +18,20 @@ const { getOptionValue } = require('internal/options');
 
 const { exitCodes: { kInvalidCommandLineArgument } } = internalBinding('errors');
 
+const {
+  privateSymbols: {
+    env_private_symbol,
+  },
+} = internalBinding('util');
+
 prepareMainThreadExecution();
 
 markBootstrapComplete();
 
-if (process.env.NODE_REPL_EXTERNAL_MODULE) {
+if (process[env_private_symbol].NODE_REPL_EXTERNAL_MODULE) {
   require('internal/modules/cjs/loader')
     .Module
-    ._load(process.env.NODE_REPL_EXTERNAL_MODULE, undefined, true);
+    ._load(process[env_private_symbol].NODE_REPL_EXTERNAL_MODULE, undefined, true);
 } else {
   // --input-type flag not supported in REPL
   if (getOptionValue('--input-type')) {
@@ -41,7 +47,7 @@ if (process.env.NODE_REPL_EXTERNAL_MODULE) {
       'Type ".help" for more information.');
 
     const cliRepl = require('internal/repl');
-    cliRepl.createInternalRepl(process.env, (err, repl) => {
+    cliRepl.createInternalRepl(process[env_private_symbol], (err, repl) => {
       if (err) {
         throw err;
       }

lib/internal/main/watch_mode.js

@@ -8,6 +8,11 @@ const {
   ArrayPrototypeSlice,
   StringPrototypeStartsWith,
 } = primordials;
+const {
+  privateSymbols: {
+    env_private_symbol,
+  },
+} = internalBinding('util');
 
 const {
   prepareMainThreadExecution,
@@ -54,7 +59,10 @@ let exited;
 function start() {
   exited = false;
   const stdio = kShouldFilterModules ? ['inherit', 'inherit', 'inherit', 'ipc'] : 'inherit';
-  child = spawn(process.execPath, args, { stdio, env: { ...process.env, WATCH_REPORT_DEPENDENCIES: '1' } });
+  child = spawn(process.execPath, args, {
+    stdio,
+    env: { ...process[env_private_symbol], WATCH_REPORT_DEPENDENCIES: '1' },
+  });
   watcher.watchChildProcessModules(child);
   child.once('exit', (code) => {
     exited = true;