├── .editorconfig ├── .gitattributes ├── .github ├── security.md └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── index.js ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/security.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. 4 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 20 14 | - 18 15 | steps: 16 | - uses: actions/checkout@v3 17 | - uses: actions/setup-node@v3 18 | with: 19 | node-version: ${{ matrix.node-version }} 20 | - run: npm install 21 | - run: sudo npm test 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | import process from 'node:process'; 2 | import isRoot from 'is-root'; 3 | import defaultUid from 'default-uid'; 4 | 5 | export default function downgradeRoot() { 6 | if (!isRoot()) { 7 | return; 8 | } 9 | 10 | // `setgid` needs to happen before setuid to avoid EPERM. 11 | if (process.setgid) { 12 | const gid = Number.parseInt(process.env.SUDO_GID, 10); 13 | if (gid && gid > 0) { 14 | process.setgid(gid); 15 | } 16 | } 17 | 18 | if (process.setuid) { 19 | const uid = Number.parseInt(process.env.SUDO_UID, 10) ?? defaultUid(); 20 | if (uid && uid > 0) { 21 | process.setuid(uid); 22 | } 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "downgrade-root", 3 | "version": "2.0.0", 4 | "description": "Try to downgrade the permissions of a process with root privileges", 5 | "license": "MIT", 6 | "repository": "sindresorhus/downgrade-root", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "exports": "./index.js", 15 | "engines": { 16 | "node": ">=18" 17 | }, 18 | "scripts": { 19 | "test": "xo && ava" 20 | }, 21 | "files": [ 22 | "index.js" 23 | ], 24 | "keywords": [ 25 | "sudo", 26 | "root", 27 | "user", 28 | "permissions", 29 | "uid", 30 | "block", 31 | "prevent", 32 | "stop", 33 | "downgrade", 34 | "drop", 35 | "privileges" 36 | ], 37 | "dependencies": { 38 | "default-uid": "^2.0.0", 39 | "is-root": "^3.0.0" 40 | }, 41 | "devDependencies": { 42 | "ava": "^5.3.1", 43 | "xo": "^0.56.0" 44 | }, 45 | "ava": { 46 | "workerThreads": false 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # downgrade-root 2 | 3 | > Try to downgrade the permissions of a process with root privileges 4 | 5 | Usually applies to a process started with `sudo`. 6 | 7 | Windows is gracefully ignored as it lacks a way to [set UID](http://nodejs.org/api/process.html#process_process_setuid_id). 8 | 9 | ## Install 10 | 11 | ```sh 12 | npm install downgrade-root 13 | ``` 14 | 15 | ## Usage 16 | 17 | ```js 18 | import downgradeRoot from 'downgrade-root'; 19 | 20 | try { 21 | downgradeRoot(); 22 | } catch { 23 | console.error('Couldn\'t downgrade permissions'); 24 | } 25 | ``` 26 | 27 | ## Tip 28 | 29 | Useful for [trying to downgrade permission](https://github.com/sindresorhus/root-check) before [blocking](https://github.com/sindresorhus/sudo-block) using your app as root. 30 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import process from 'node:process'; 2 | import test from 'ava'; 3 | import defaultUid from 'default-uid'; 4 | import downgradeRoot from './index.js'; 5 | 6 | test('main', t => { 7 | const _ = process.getuid; 8 | process.getuid = () => 0; 9 | downgradeRoot(); 10 | process.getuid = _; 11 | 12 | if ('CI' in process.env || 'GITHUB_ACTIONS' in process.env) { 13 | t.pass(); 14 | } else { 15 | t.is(process.getuid(), defaultUid()); 16 | } 17 | }); 18 | --------------------------------------------------------------------------------