Skip to content
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

Rule Request: UnnecessaryShellCommand #3436

Open
mcandre opened this issue Nov 20, 2018 · 1 comment · May be fixed by #13597
Open

Rule Request: UnnecessaryShellCommand #3436

mcandre opened this issue Nov 20, 2018 · 1 comment · May be fixed by #13597
Assignees
Labels
A-lint Area: New lints L-perf Lint: Belongs in the perf lint group

Comments

@mcandre
Copy link

mcandre commented Nov 20, 2018

As an engineer, I want to be warned early when my application code is trying to shell out for things that libraries already provide, such as:

  • curl/wget (Can probably use a URL request)
  • sed/awk/gawk/nawk (Can just use a regular expression)
  • jq (Can use a JSON marshaller)

This rule would encourage more performant applications, remove dependencies on unnecessary software components, reduce attack surfaces, and increase cross-platform support, by avoiding relying on platform-specific shell command syntax.

Example triggers:

  • Supplying a process object with a launch path ending with curl, wget, sed, awk, jq, jq.exe, etc.

Example non-triggers:

  • Supplying a process object with an argument of curl, wget, sed, awk, jq, jq.exe, etc. While there are plenty of cases where these would constitute unnecessary shell commands, such as /usr/bin/env curl... or exec wget..., the false positives for such commands are unfortunately more numerous than the true positives.

This rule should contain a limited number of common shell commands, such as those listed above. We can add more over time. Configuration for this rule should be able to customize which of these command patterns is relevant to the user's application needs.

As a security concern, this rule can reasonably become a default rule, as shelling out introduces additional security risks, including shell injections, compared to sticking to pure library code.

I would be happy to see this rule be included in clippy's available suite of checks, and if we find we're happy to apply it in a lot of places, then we can always turn it on by default later.

@flip1995 flip1995 added A-lint Area: New lints L-perf Lint: Belongs in the perf lint group labels Nov 20, 2018
@GnomedDev
Copy link
Contributor

@rustbot claim

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-lint Area: New lints L-perf Lint: Belongs in the perf lint group
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants