-
-
Notifications
You must be signed in to change notification settings - Fork 2
Detect usage of npx in yaml & JS code #11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| rules: | ||
| - id: npx-usage-js | ||
| languages: | ||
| - javascript | ||
| - typescript | ||
| severity: WARNING | ||
| metadata: | ||
| tags: [security] | ||
| shortDescription: "npx usage introduces supply chain security risks" | ||
| confidence: HIGH | ||
| help: | | ||
| Using npx to install and run packages introduces significant supply chain security risks for the following reasons: | ||
|
|
||
| 1. **Unpinned by default**: Running `npx <package>` fetches the latest release outside of your lockfile. If a malicious version of a package is published ([example])(https://socket.dev/blog/npm-author-qix-compromised-in-major-supply-chain-attack), `npx` will install and execute it the next time it is run. | ||
|
|
||
| 2. **Bypasses lockfile guarantees**: Packages executed with npx are not added to your project's package.json or lockfile. As a result, their versions and lockfile integrity hashes are not captured for reproducibility, making builds non-deterministic and harder to audit | ||
|
|
||
| ### Recommended practice | ||
| - Add packages as dependencies or devDependencies in `package.json`. | ||
| - Use your package manager to install and execute them (e.g., `yarn add <package> [--dev]` followed by `yarn <package> <command>`). | ||
|
|
||
| **Bad example (using npx):** | ||
| ```javascript | ||
| const cmd = `npx jest --coverage`; | ||
| execSync(cmd); | ||
| ``` | ||
|
|
||
| **Good example (proper dependency):** | ||
| ```javascript | ||
| // Add jest as a dependency /devDependency in package.json | ||
| const cmd = `yarn jest --coverage`; | ||
| execSync(cmd); | ||
| ``` | ||
|
|
||
| message: >- | ||
| Avoid using 'npx' to run packages due to supply chain security risks. Instead, install the package | ||
| as a dependency / devDependency and invoke it using your package manager to ensure version pinning | ||
| and reproducibility. | ||
| patterns: | ||
| - pattern: "$STRING" | ||
| - metavariable-regex: | ||
| metavariable: $STRING | ||
| regex: '.*\bnpx\s' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| rules: | ||
| - id: npx-usage-yml | ||
| languages: | ||
| - yaml | ||
| severity: WARNING | ||
| metadata: | ||
| tags: [security] | ||
| shortDescription: "npx usage introduces supply chain security risks" | ||
| confidence: HIGH | ||
| help: | | ||
| Using npx to install and run packages introduces significant supply chain security risks for the following reasons: | ||
|
|
||
| 1. **Unpinned by default**: Running `npx <package>` fetches the latest release outside of your lockfile. If a malicious version of a package is published ([example])(https://socket.dev/blog/npm-author-qix-compromised-in-major-supply-chain-attack), `npx` will install and execute it the next time it is run. | ||
|
|
||
| 2. **Bypasses lockfile guarantees**: Packages executed with npx are not added to your project's package.json or lockfile. As a result, their versions and lockfile integrity hashes are not captured for reproducibility, making builds non-deterministic and harder to audit | ||
|
|
||
| ### Recommended practice | ||
| - Add packages as dependencies or devDependencies in `package.json`. | ||
| - Use your package manager to install and execute them (e.g., `yarn add <package> --dev` followed by `yarn <package> <command>`). | ||
|
|
||
| **Bad example (using npx):** | ||
| ```yaml | ||
| - name: Run tests | ||
| run: npx jest --coverage | ||
| ``` | ||
|
|
||
| **Good example (proper dependency):** | ||
| ```yaml | ||
| - name: Run tests | ||
| run: yarn jest --coverage | ||
| ``` | ||
|
|
||
| message: >- | ||
| Avoid using 'npx' to run packages due to supply chain security risks. Instead, install the package | ||
| as a dependency / devDependency and invoke it using your package manager to ensure version pinning | ||
| and reproducibility. | ||
| patterns: | ||
| - pattern: | | ||
| run: $CMD | ||
| - metavariable-pattern: | ||
| metavariable: $CMD | ||
| language: sh | ||
| pattern: npx ... |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| const { execSync, exec, spawn, spawnSync } = require('child_process'); | ||
|
|
||
| // Test cases that should be flagged | ||
|
|
||
| // Template literal with interpolation (like coverage-analysis.js:234) | ||
| function runTests() { | ||
| const testArgs = 'test/*.js'; | ||
| // ruleid: npx-usage-js | ||
| const cmd = `npx jest ${testArgs} --coverage --coverageReporters=lcov`; | ||
| execSync(cmd); | ||
| } | ||
|
|
||
| // Template literal passed directly to exec | ||
| function lintCode() { | ||
| // ruleid: npx-usage-js | ||
| execSync(`npx eslint src/`); | ||
| } | ||
|
|
||
| // String literal in error message (like global.setup.ts:72) | ||
| // Now caught with regex - flags npx usage anywhere in strings including docs/examples | ||
| function throwError() { | ||
| throw new Error( | ||
| // ruleid: npx-usage-js | ||
| 'Please specify a project name with --project flag. Example: npx playwright test --project dummy-test-local' | ||
| ); | ||
| } | ||
|
|
||
| // String literal with scoped package | ||
| function formatCode() { | ||
| // ruleid: npx-usage-js | ||
| const command = "npx @typescript-eslint/parser --version"; | ||
| exec(command); | ||
| } | ||
|
|
||
| // Template literal with output redirection | ||
| function generateFingerprint() { | ||
| // ruleid: npx-usage-js | ||
| exec(`npx @expo/fingerprint ./ > fingerprint.json`); | ||
| } | ||
|
|
||
| // Template literal with flags | ||
| function setupTool() { | ||
| // ruleid: npx-usage-js | ||
| const setupCmd = `npx --yes create-react-app my-app`; | ||
| execSync(setupCmd); | ||
| } | ||
|
|
||
| // Template literal with environment variables | ||
| function runWithEnv() { | ||
| const workspace = process.env.GITHUB_WORKSPACE; | ||
| // ruleid: npx-usage-js | ||
| spawn(`npx jest ${workspace} --coverage`); | ||
| } | ||
|
|
||
| // Template literal in command chain | ||
| function buildAndTest() { | ||
| // ruleid: npx-usage-js | ||
| execSync(`yarn build && npx jest --coverage`); | ||
| } | ||
|
|
||
| // String literal assigned to variable | ||
| function assignCommand() { | ||
| // ruleid: npx-usage-js | ||
| let cmd = "npx prettier --write ."; | ||
| return cmd; | ||
| } | ||
|
|
||
| // Test cases that should NOT be flagged | ||
|
|
||
| // Using yarn instead | ||
| function goodYarnUsage() { | ||
| // ok: npx-usage-js | ||
| execSync(`yarn jest --coverage`); | ||
| } | ||
|
|
||
| // Using npm scripts | ||
| function goodNpmUsage() { | ||
| // ok: npx-usage-js | ||
| execSync('npm run test'); | ||
| } | ||
|
|
||
| // Using yarn dlx | ||
| function goodYarnDlx() { | ||
| // ok: npx-usage-js | ||
| const cmd = `yarn dlx create-react-app my-app`; | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe worth considering adding a warning about But we can consider that in a separate PR |
||
| execSync(cmd); | ||
| } | ||
|
|
||
| // Direct node execution | ||
| function goodNodeUsage() { | ||
| // ok: npx-usage-js | ||
| exec('node scripts/build.js'); | ||
| } | ||
|
|
||
| // Comment mentioning npx - should be ignored automatically | ||
| // This comment talks about npx but isn't code execution | ||
| function withComment() { | ||
| // ok: npx-usage-js | ||
| execSync('yarn test'); | ||
| } | ||
|
|
||
| // Variable name contains "npx" but not executing it | ||
| function variableName() { | ||
| // ok: npx-usage-js | ||
| const shouldUseNpx = false; | ||
| const npxWarning = "Dont use npx!"; | ||
| console.log(npxWarning); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| import { execSync, exec, spawn } from 'child_process'; | ||
|
|
||
| // Test cases that should be flagged in TypeScript | ||
|
|
||
| // Template literal with type annotation (like global.setup.ts scenario) | ||
| function runPlaywrightTests(): void { | ||
| const project: string = 'test-project'; | ||
| // ruleid: npx-usage-js | ||
| const command: string = `npx playwright test --project ${project}`; | ||
| execSync(command); | ||
| } | ||
|
|
||
| // Error message with npx example | ||
| function throwConfigError(): never { | ||
| throw new Error( | ||
| // ruleid: npx-usage-js | ||
| 'Please specify a project name with --project flag. Example: npx playwright test --project dummy-test-local' | ||
| ); | ||
| } | ||
|
|
||
| // Arrow function with template literal | ||
| const buildApp = (): void => { | ||
| // ruleid: npx-usage-js | ||
| execSync(`npx tsc --build`); | ||
| }; | ||
|
|
||
| // Async function | ||
| async function deployApp(): Promise<void> { | ||
| // ruleid: npx-usage-js | ||
| await exec(`npx vercel deploy`); | ||
| } | ||
|
|
||
| // String literal with type assertion | ||
| function formatFiles(): void { | ||
| // ruleid: npx-usage-js | ||
| const cmd = "npx prettier --write ." as const; | ||
| execSync(cmd); | ||
| } | ||
|
|
||
| // Template literal in class method | ||
| class TestRunner { | ||
| runTests(): void { | ||
| const coverage: boolean = true; | ||
| // ruleid: npx-usage-js | ||
| execSync(`npx jest ${coverage ? '--coverage' : ''}`); | ||
| } | ||
| } | ||
|
|
||
| // Good examples that should NOT be flagged | ||
|
|
||
| function useYarnProperly(): void { | ||
| // ok: npx-usage-js | ||
| execSync('yarn test --coverage'); | ||
| } | ||
|
|
||
| function useNpmScript(): void { | ||
| // ok: npx-usage-js | ||
| exec('npm run build'); | ||
| } | ||
|
|
||
| function useYarnDlx(): void { | ||
| // ok: npx-usage-js | ||
| const cmd: string = `yarn dlx create-next-app my-app`; | ||
| execSync(cmd); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| name: Test Workflow | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
|
|
||
| jobs: | ||
| test: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| # Test basic npx usage in GitHub Actions - should be flagged | ||
| - name: Run tests | ||
| # ruleid: npx-usage-yml | ||
| run: npx jest --coverage | ||
|
|
||
| - name: Lint code | ||
| # ruleid: npx-usage-yml | ||
| run: npx eslint src/ | ||
|
|
||
| - name: Format code | ||
| # ruleid: npx-usage-yml | ||
| run: npx prettier --write . | ||
|
|
||
| - name: Create app | ||
| # ruleid: npx-usage-yml | ||
| run: npx create-react-app my-app | ||
|
|
||
| - name: Setup tool with flag | ||
| # ruleid: npx-usage-yml | ||
| run: npx --yes setup-tool --config config.json | ||
|
|
||
| - name: Run with env vars | ||
| # ruleid: npx-usage-yml | ||
| run: npx jest ${GITHUB_WORKSPACE} --coverage | ||
|
|
||
| # Test scoped package with output redirection - should be flagged | ||
| - name: Generate fingerprint | ||
| # ruleid: npx-usage-yml | ||
| run: npx @expo/fingerprint ./ > fingerprint-pr.json | ||
|
|
||
| - name: Another scoped package | ||
| # ruleid: npx-usage-yml | ||
| run: npx @typescript-eslint/parser --version | ||
|
|
||
| # Test npx in middle of command strings - should be flagged | ||
| - name: Install and test | ||
| # ruleid: npx-usage-yml | ||
| run: yarn install && npx jest --coverage | ||
|
|
||
| - name: Setup and lint | ||
| # ruleid: npx-usage-yml | ||
| run: echo "Setting up" && npx eslint src/ | ||
|
|
||
| - name: Build and format | ||
| # ruleid: npx-usage-yml | ||
| run: npm run build && npx prettier --write . | ||
|
|
||
| # Test good alternatives - should not be flagged | ||
| - name: Run tests with yarn | ||
| # ok: npx-usage-yml | ||
| run: yarn jest --coverage | ||
|
|
||
| - name: Lint code with yarn | ||
| # ok: npx-usage-yml | ||
| run: yarn eslint src/ | ||
|
|
||
| - name: Format code with yarn | ||
| # ok: npx-usage-yml | ||
| run: yarn prettier --write . | ||
|
|
||
| - name: Create app with yarn dlx | ||
| # ok: npx-usage-yml | ||
| run: yarn dlx create-react-app my-app | ||
|
|
||
| - name: Build with npm script | ||
| # ok: npx-usage-yml | ||
| run: npm run build | ||
|
|
||
| - name: Description mentions npx but doesn't use it | ||
| # ok: npx-usage-yml | ||
| run: echo "This workflow mentions npx but doesn't execute it" | ||
|
|
||
| - name: Just npm (not npx) | ||
| # ok: npx-usage-yml | ||
| run: npm install |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there an easy way to ignore this warning for vendored code? We have some third-party minified code in mobile and extension that would contain the string
npx(e.g. a fixture of a snap bundle used by e2e tests)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Gudahtt yes this would be configured in the
security-code-scanner.ymlin the paths-ignored section (Example)