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
Add new Security/Open
cop
#5319
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module Security | ||
# This cop checks for the use of `Kernel#open`. | ||
# `Kernel#open` enables not only file access but also process invocation | ||
# by prefixing a pipe symbol (e.g., `open("| ls")`). So, it may lead to | ||
# a serious security risk by using variable input to the argument of | ||
# `Kernel#open`. It would be better to use `File.open` or `IO.popen` | ||
# explicitly. | ||
# | ||
# @example | ||
# # bad | ||
# open(something) | ||
# | ||
# # good | ||
# File.open(something) | ||
# IO.popen(something) | ||
class Open < Cop | ||
MSG = 'The use of `Kernel#open` is a serious security risk.'.freeze | ||
|
||
def_node_matcher :open?, <<-PATTERN | ||
(send nil? :open $!str ...) | ||
PATTERN | ||
|
||
def safe?(node) | ||
if node.str_type? | ||
!node.str_content.empty? && !node.str_content.start_with?('|') | ||
elsif node.dstr_type? | ||
safe?(node.child_nodes.first) | ||
elsif node.send_type? && node.method_name == :+ | ||
safe?(node.child_nodes.first) | ||
else | ||
false | ||
end | ||
end | ||
|
||
def on_send(node) | ||
open?(node) do |code| | ||
return if safe?(code) | ||
add_offense(node, location: :selector) | ||
end | ||
end | ||
end | ||
end | ||
end | ||
end |
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
# frozen_string_literal: true | ||
|
||
RSpec.describe RuboCop::Cop::Security::Open do | ||
subject(:cop) { described_class.new } | ||
|
||
it 'registers an offense for open' do | ||
expect_offense(<<-RUBY.strip_indent) | ||
open(something) | ||
^^^^ The use of `Kernel#open` is a serious security risk. | ||
RUBY | ||
end | ||
|
||
it 'registers an offense for open with mode argument' do | ||
expect_offense(<<-RUBY.strip_indent) | ||
open(something, "r") | ||
^^^^ The use of `Kernel#open` is a serious security risk. | ||
RUBY | ||
end | ||
|
||
it 'registers an offense for open with dynamic string that is not prefixed' do | ||
expect_offense(<<-'RUBY'.strip_indent) | ||
open("#{foo}.txt") | ||
^^^^ The use of `Kernel#open` is a serious security risk. | ||
RUBY | ||
end | ||
|
||
it 'registers an offense for open with string that starts with a pipe' do | ||
expect_offense(<<-'RUBY'.strip_indent) | ||
open("| #{foo}") | ||
^^^^ The use of `Kernel#open` is a serious security risk. | ||
RUBY | ||
end | ||
|
||
it 'accepts open as variable' do | ||
expect_no_offenses('open = something') | ||
end | ||
|
||
it 'accepts File.open as method' do | ||
expect_no_offenses('File.open(something)') | ||
end | ||
|
||
it 'accepts open on a literal string' do | ||
expect_no_offenses('open("foo.txt")') | ||
end | ||
|
||
it 'accepts open with no arguments' do | ||
expect_no_offenses('open') | ||
end | ||
|
||
it 'accepts open with string that has a prefixed interpolation' do | ||
expect_no_offenses('open "prefix_#{foo}"') | ||
end | ||
|
||
it 'accepts open with prefix string literal plus something' do | ||
expect_no_offenses('open "prefix" + foo') | ||
end | ||
|
||
it 'accepts open with a string that interpolates a literal' do | ||
expect_no_offenses('open "foo#{2}.txt"') | ||
end | ||
end |
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.
I'd add more explanations here, as to why this is a security risk. After all this comment is going to become the cop's description in the manual.