sudo-block

What is sudo-block?

The sudo-block npm package is designed to prevent users from running your Node.js application with superuser (sudo) privileges. This can be useful for security reasons, ensuring that your application does not inadvertently gain elevated permissions.

What are sudo-block's main functionalities?

Preventing sudo execution

This feature prevents the execution of your Node.js application with sudo privileges. By calling `sudoBlock()`, the application will exit with an error message if it detects that it is being run with superuser privileges.

const sudoBlock = require('sudo-block');
sudoBlock();

Other packages similar to sudo-block

is-root

The is-root package checks if the current process is running as the root user. Unlike sudo-block, it does not prevent execution but simply provides a boolean value indicating whether the process has root privileges. This can be useful for conditional logic based on user permissions.

README

sudo-block

Block users from running your tool with root permissions.

Install

Install with npm: npm install --save sudo-block

Example

var sudoBlock = require('sudo-block');
sudoBlock('my-module');

When the above file is ran with root permissions it will exit and show an error message telling the user how to fix the problem so they don't have to run it with sudo.

API

sudoBlock(options)

Options is either a string specifying the package name or an object with these keys:

• packageName: name of the package the error message is printed for
• message: a custom error message

sudoBlock.isRoot

Boolean indicating whether the current user is root.

License

MIT License • © Sindre Sorhus