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

Fix Cleaner#clean_url with mailto links #813

Merged
merged 2 commits into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 37 additions & 15 deletions lib/bugsnag/cleaner.rb
Original file line number Diff line number Diff line change
Expand Up @@ -30,25 +30,19 @@ def clean_url(url)

begin
uri = URI(url)
rescue URI::InvalidURIError
pre_query_string, _query_string = url.split('?', 2)

return "#{pre_query_string}?#{FILTERED}"
end

return url unless uri.query

query_params = uri.query.split('&').map { |pair| pair.split('=') }
query_params.map! do |key, val|
if filters_match?(key)
"#{key}=#{FILTERED}"
if uri.is_a?(URI::MailTo)
clean_mailto_url(url, uri)
else
"#{key}=#{val}"
clean_generic_url(url, uri)
end
end
rescue URI::InvalidURIError
pre_query_string, _query_string = url.split('?', 2)

uri.query = query_params.join('&')
uri.to_s
"#{pre_query_string}?#{FILTERED}"
rescue StandardError
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonderful! Thanks for this.

FILTERED
end
end

##
Expand Down Expand Up @@ -209,5 +203,33 @@ def scope_should_be_filtered?(scope)
scope.start_with?("#{scope_to_filter}.")
end
end

def clean_generic_url(original_url, uri)
return original_url unless uri.query

query_params = uri.query.split('&').map { |pair| pair.split('=') }

uri.query = filter_uri_parameter_array(query_params).join('&')
uri.to_s
end

def clean_mailto_url(original_url, uri)
return original_url unless uri.headers

# headers in mailto links can't contain square brackets so we replace
# filtered parameters with 'FILTERED' instead of '[FILTERED]'
uri.headers = filter_uri_parameter_array(uri.headers, 'FILTERED').join('&')
uri.to_s
end

def filter_uri_parameter_array(parameters, replacement = FILTERED)
parameters.map do |key, value|
if filters_match?(key)
"#{key}=#{replacement}"
else
"#{key}=#{value}"
end
end
end
end
end
24 changes: 24 additions & 0 deletions spec/cleaner_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -552,5 +552,29 @@ def to_s
let(:url) { "https://host.example/a b c d e f g" }
it { should eq "https://host.example/a b c d e f g" }
end

context "with a mailto URL" do
let(:filters) { [/token/] }
let(:url) { "mailto:[email protected]?token=secret&subject=Hello" }
it { should eq "mailto:[email protected]?token=FILTERED&subject=Hello" }
end

context "with a mailto URL without a to address" do
let(:filters) { [/token/] }
let(:url) { "mailto:?subject=Hello&token=password" }
it { should eq "mailto:?subject=Hello&token=FILTERED" }
end

context "with a websocket URL" do
let(:filters) { [/secret/] }
let(:url) { "ws://example.com?abc=xyz&secret=password" }
it { should eq "ws://example.com?abc=xyz&secret=[FILTERED]" }
end

context "with a websocket over TLS URL" do
let(:filters) { [/secret/] }
let(:url) { "wss://example.com?abc=xyz&secret=password" }
it { should eq "wss://example.com?abc=xyz&secret=[FILTERED]" }
end
end
end
Loading