https://github.com/derhuerst/generate-node-policy-file

Generate a Node.js policy file for your code.
https://github.com/derhuerst/generate-node-policy-file

json nodejs security

Last synced: 6 days ago
JSON representation

Generate a Node.js policy file for your code.

• Host: GitHub
• URL: https://github.com/derhuerst/generate-node-policy-file
• Owner: derhuerst
• License: isc
• Created: 2019-05-01T11:29:36.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-03-17T12:21:00.000Z (over 3 years ago)
• Last Synced: 2024-11-07T14:29:53.637Z (7 days ago)
• Topics: json, nodejs, security
• Language: JavaScript
• Homepage: https://github.com/derhuerst/generate-node-policy-file#generate-node-policy-file
• Size: 29.3 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# generate-node-policy-file

**Generate a [Node.js policy file](https://nodejs.org/api/policy.html) for your 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.

*Note:* In Node.js `12` and `13`, the [policy feature](https://nodejs.org/api/policy.html) is marked as **experimental**:

> This feature is still under active development and subject to non-backward compatible changes or removal in any future version. Use of the feature is not recommended in production environments. Experimental features are not subject to the Node.js Semantic Versioning model.

[![npm version](https://img.shields.io/npm/v/generate-node-policy-file.svg)](https://www.npmjs.com/package/generate-node-policy-file)

[![build status](https://api.travis-ci.org/derhuerst/generate-node-policy-file.svg?branch=master)](https://travis-ci.org/derhuerst/generate-node-policy-file)

![ISC-licensed](https://img.shields.io/github/license/derhuerst/generate-node-policy-file.svg)

[![support me via GitHub Sponsors](https://img.shields.io/badge/support%20me-donate-fa7664.svg)](https://github.com/sponsors/derhuerst)

[![chat with me on Twitter](https://img.shields.io/badge/chat%20with%20me-on%20Twitter-1da1f2.svg)](https://twitter.com/derhuerst)

## Installation

```shell

npm install generate-node-policy-file

```

## Usage

Generate a list of required files by your app:

```shell

env REQUIRED_FILES=required-files.json node -r generate-node-policy-file/track my-app.js

```

Generate a [Node.js policy file](https://nodejs.org/api/policy.html) from the list:

```shell

generate-node-policy-file policy.json

```

Make it read-only for the user the app will be running with:

```shell

sudo chown root:admin policy.json

sudo chmod 755 policy.json

```

Let Node.js use it:

```shell

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

```

## Options

option | description | default

-------|-------------|--------

`--base-dir`, `-d` | Directory the file paths are relative to. | `$CWD`

`--on-error` | [Error behavior](https://nodejs.org/api/policy.html#policy_error_behavior). | `exit`

`--pretty`, `-p` | Pretty-print the generated JSON. | –

## Contributing

If you have a question or need support using `generate-node-policy-file`, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to [the issues page](https://github.com/derhuerst/generate-node-policy-file/issues).