Add new Security/IoMethods cop
#10102
Merged
Conversation
This file contains 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
koic
force-pushed
the
add_new_security_io_read_cop
branch
from
211382c
to
6112012
Compare
koic
force-pushed
the
add_new_security_io_read_cop
branch
from
6112012
to
9ac620a
Compare
|
The cop name is a bit misleading, as it checks for some writes as well. I'm not sure if |
bbatsov
reviewed
Sep 22, 2021
lib/rubocop/cop/security/io_read.rb
Outdated
| # Checks for the first argument to `IO.read`, `IO.binread`, `IO.write`, `IO.binwrite`, | ||
| # `IO.foreach`, and `IO.readlines`. | ||
| # | ||
| # If argument starts with a pipe character (`'|'`) and the receiver is the `IO` class, |
There was a problem hiding this comment.
Probably you should mention somewhere that Kernel#open may allow unintentional command injection, which is the reason IO methods are a security risk.
|
@koic ping :-) |
koic
force-pushed
the
add_new_security_io_read_cop
branch
2 times, most recently
from
eb1f041
to
de050bd
Compare
## Summary Follow up to rubocop#9695 (comment). This PR adds new `Security/IoMethods` cop. It checks for the first argument to `IO.read`, `IO.binread`, `IO.write`, `IO.binwrite`, `IO.foreach`, and `IO.readlines`. If argument starts with a pipe character (`'|'`) and the receiver is the `IO` class, a subprocess is created in the same way as `Kernel#open`, and its output is returned. Consider to use `File.read` to disable the behavior of subprocess invocation. This cop is unsafe because false positive will occur if the variable passed as the first argument is a command that is not a file path. ```ruby # bad IO.read(path) IO.read('path') # good File.read(path) File.read('path') IO.read('| command') # Allow intentional command invocation. ``` ## Other Information Below are links related to this cop. - rubygems/rubygems#4530 - ruby/ruby#4579
koic
force-pushed
the
add_new_security_io_read_cop
branch
from
de050bd
to
a88c43c
Compare
|
Thanks! |
|
Thank you too! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Follow up to #9695 (comment).
This PR adds new
Security/IoMethodscop.It checks for the first argument to
IO.read,IO.binread,IO.write,IO.binwrite,IO.foreach, andIO.readlines.If argument starts with a pipe character (
'|') and the receiver is theIOclass, a subprocess is created in the same way asKernel#open, and its output is returned.Consider to use
File.readto disable the behavior of subprocess invocation.This cop is unsafe because false positive will occur if the variable passed as the first argument is a command that is not a file path.
Other Information
Below are links related to this cop.
File.readsingleton method ruby/ruby#4579Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).bundle exec rake default. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.