Node.js

- About these Docs
- Usage & Example

- Assertion Testing
- Async Hooks
- Buffer
- C++ Addons
- C/C++ Addons with N-API
- Child Processes
- Cluster
- Command Line Options
- Console
- Crypto
- Debugger
- Deprecated APIs
- DNS
- Domain
- ECMAScript Modules
- Errors
- Events
- File System
- Globals
- HTTP
- HTTP/2
- HTTPS
- Inspector
- Internationalization
- Modules
- Net
- OS
- Path
- Performance Hooks
- Policies
- Process
- Punycode
- Query Strings
- Readline
- REPL
- Report
- Stream
- String Decoder
- Timers
- TLS/SSL
- Trace Events
- TTY
- UDP/Datagram
- URL
- Utilities
- V8
- VM
- Worker Threads
- Zlib

- GitHub Repo & Issue Tracker

# Policies#

Stability: 1 - Experimental

Node.js contains experimental support for creating policies on loading code.

Policies are a security feature intended to allow guarantees about what code Node.js is able to load. The use of policies assumes safe practices for the policy files such as ensuring that policy files cannot be overwritten by the Node.js application by using file permissions.

A best practice would be to ensure that the policy manifest is read only for the running Node.js application, and that the file cannot be changed by the running Node.js application in any way. A typical setup would be to create the policy file as a different user id than the one running Node.js and granting read permissions to the user id running Node.js.

## Enabling#

The `--experimental-policy` flag can be used to enable features for policies when loading modules.

Once this has been set, all modules must conform to a policy manifest file passed to the flag:

    node --experimental-policy=policy.json app.js

The policy manifest will be used to enforce constraints on code loaded by Node.js.

To mitigate tampering with policy files on disk, an integrity for the policy file itself may be provided via `--policy-integrity`. This allows running `node` and asserting the policy file contents even if the file is changed on disk.

    node --experimental-policy=policy.json --policy-integrity="sha384-SggXRQHwCG8g+DktYYzxkXRIkTiEYWBHqev0xnpCxYlqMBufKZHAHQM3/boDaI/0" app.js

## Features#

### Error Behavior#

When a policy check fails, Node.js by default will throw an error. It is possible to change the error behavior to one of a few possibilities by defining an "onerror" field in a policy manifest. The following values are available to change the behavior:

- `"exit"`: will exit the process immediately. No cleanup code will be allowed to run.
- `"log"`: will log the error at the site of the failure.
- `"throw"`: will throw a JS error at the site of the failure. This is the default.

    {
      "onerror": "log",
      "resources": {
        "./app/checked.js": {
          "integrity": "sha384-SggXRQHwCG8g+DktYYzxkXRIkTiEYWBHqev0xnpCxYlqMBufKZHAHQM3/boDaI/0"
        }
      }
    }

### Integrity Checks#

Policy files must use integrity checks with Subresource Integrity strings compatible with the browser integrity attribute associated with absolute URLs.

When using `require()` all resources involved in loading are checked for integrity if a policy manifest has been specified. If a resource does not match the integrity listed in the manifest, an error will be thrown.

An example policy file that would allow loading a file `checked.js`:

    {
      "resources": {
        "./app/checked.js": {
          "integrity": "sha384-SggXRQHwCG8g+DktYYzxkXRIkTiEYWBHqev0xnpCxYlqMBufKZHAHQM3/boDaI/0"
        }
      }
    }

Each resource listed in the policy manifest can be of one the following formats to determine its location:

1. A relative url string to a resource from the manifest such as `./resource.js`, `../resource.js`, or `/resource.js`.
2. A complete url string to a resource such as `file:///resource.js`.

When loading resources the entire URL must match including search parameters and hash fragment. `./a.js?b` will not be used when attempting to load `./a.js` and vice versa.

To generate integrity strings, a script such as `printf "sha384-$(cat checked.js | openssl dgst -sha384 -binary | base64)"` can be used.

Integrity can be specified as the boolean value `true` to accept any body for the resource which can be useful for local development. It is not recommended in production since it would allow unexpected alteration of resources to be considered valid.

### Dependency Redirection#

An application may need to ship patched versions of modules or to prevent modules from allowing all modules access to all other modules. Redirection can be used by intercepting attempts to load the modules wishing to be replaced.

    {
      "builtins": [],
      "resources": {
        "./app/checked.js": {
          "dependencies": {
            "fs": true,
            "os": "./app/node_modules/alt-os"
          }
        }
      }
    }

The dependencies are keyed by the requested string specifier and have values of either `true` or a string pointing to a module that will be resolved.

The specifier string does not perform any searching and must match exactly what is provided to the `require()`. Therefore, multiple specifiers may be needed in the policy if `require()` uses multiple different strings to point to the same module (such as excluding the extension).

If the value of the redirection is `true` the default searching algorithms will be used to find the module.

If the value of the redirection is a string, it will be resolved relative to the manifest and then immediately be used without searching.

Any specifier string that is `require()`ed and not listed in the dependencies will result in an error according to the policy.

Redirection will not prevent access to APIs through means such as direct access to `require.cache` and/or through `module.constructor` which allow access to loading modules. Policy redirection only affect specifiers to `require()`. Other means such as to prevent undesired access to APIs through variables are necessary to lock down that path of loading modules.

A boolean value of `true` for the dependencies map can be specified to allow a module to load any specifier without redirection. This can be useful for local development and may have some valid usage in production, but should be used only with care after auditing a module to ensure its behavior is valid.

#### Example: Patched Dependency#

Since a dependency can be redirected, you can provide attenuated or modified forms of dependencies as fits your application. For example, you could log data about timing of function durations by wrapping the original:

    const original = require('fn');
    module.exports = function fn(...args) {
      console.time();
      try {
        return new.target ?
          Reflect.construct(original, args) :
          Reflect.apply(original, this, args);
      } finally {
        console.timeEnd();
      }
    };