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

Do not normalize URL before fetching it #26219

Merged
merged 8 commits into from Jul 31, 2023
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 15 additions & 2 deletions app/lib/request.rb
Expand Up @@ -68,13 +68,26 @@ class Request
# about 15s in total
TIMEOUT = { connect_timeout: 5, read_timeout: 10, write_timeout: 10, read_deadline: 30 }.freeze

# Workaround for overly-eager decoding of percent-encoded characters in Addressable::URI#normalized_path
# https://github.com/sporkmonger/addressable/issues/366
URI_NORMALIZER = lambda do |uri|
uri = HTTP::URI.parse(uri)

HTTP::URI.new(
scheme: uri.normalized_scheme,
authority: uri.normalized_authority,
path: Addressable::URI.normalize_path(uri.path),
c960657 marked this conversation as resolved.
Show resolved Hide resolved
query: uri.query
)
end

include RoutingHelper

def initialize(verb, url, **options)
raise ArgumentError if url.blank?

@verb = verb
@url = Addressable::URI.parse(url).normalize
@url = URI_NORMALIZER.call(url)
@http_client = options.delete(:http_client)
@allow_local = options.delete(:allow_local)
@options = options.merge(socket_class: use_proxy? || @allow_local ? ProxySocket : Socket)
Expand Down Expand Up @@ -139,7 +152,7 @@ def valid_url?(url)
end

def http_client
HTTP.use(:auto_inflate).follow(max_hops: 3)
HTTP.use(:auto_inflate).use(normalize_uri: { normalizer: URI_NORMALIZER }).follow(max_hops: 3)
Copy link
Member

Choose a reason for hiding this comment

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

Question, if we know we pre-normalize the URI in this class, couldn't this just be a no-op?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The normalizer is also used for redirects, i.e. if the first request includes a Location: HTTP://EXAMPLE.COM header, we want to normalise that URL as well.

I have added a test for this.

BTW, a no-op normalizer would look like this:

->(x) { HTTP::URI.parse(x) }

i.e. a bit more complex than ->(x) { x } as mentioned in #24932 (comment).

Copy link
Member

Choose a reason for hiding this comment

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

Makes sense

end
end

Expand Down
33 changes: 32 additions & 1 deletion spec/controllers/concerns/signature_verification_spec.rb
Expand Up @@ -129,6 +129,37 @@ def signature_required
end
end

context 'with non-normalized URL' do
before do
get :success

fake_request = Request.new(:get, 'http://test.host/subdir/../success')
fake_request.on_behalf_of(author)

request.headers.merge!(fake_request.headers)

allow(controller).to receive(:actor_refresh_key!).and_return(author)
end

describe '#build_signed_string' do
it 'includes the normalized request path' do
expect(controller.send(:build_signed_string)).to start_with "(request-target): get /success\n"
end
end

describe '#signed_request?' do
it 'returns true' do
expect(controller.signed_request?).to be true
end
end

describe '#signed_request_actor' do
it 'returns an account' do
expect(controller.signed_request_account).to eq author
end
end
end

context 'with request with unparsable Date header' do
before do
get :success
Expand Down Expand Up @@ -202,7 +233,7 @@ def signature_required

request.headers.merge!(fake_request.headers)

stub_request(:get, 'http://localhost:5000/actor#main-key').to_raise(Mastodon::HostValidationError)
stub_request(:get, 'http://localhost:5000/actor').to_raise(Mastodon::HostValidationError)
end

describe '#signed_request?' do
Expand Down
62 changes: 61 additions & 1 deletion spec/lib/request_spec.rb
Expand Up @@ -4,7 +4,9 @@
require 'securerandom'

describe Request do
subject { described_class.new(:get, 'http://example.com') }
subject { described_class.new(:get, url) }

let(:url) { 'http://example.com' }

describe '#headers' do
it 'returns user agent' do
Expand Down Expand Up @@ -92,6 +94,64 @@
expect { subject.perform }.to raise_error Mastodon::ValidationError
end
end

context 'with unnormalized URL' do
let(:url) { 'HTTP://EXAMPLE.com:80/foo%41%3A?bar=%41%3A#baz' }

before do
stub_request(:get, 'http://example.com/foo%41%3A?bar=%41%3A')
end

it 'normalizes scheme' do
subject.perform do |response|
expect(response.request.uri.scheme).to eq 'http'
end
end

it 'normalizes host' do
subject.perform do |response|
expect(response.request.uri.authority).to eq 'example.com'
end
end

it 'does modify path' do
subject.perform do |response|
expect(response.request.uri.path).to eq '/foo%41%3A'
end
end

it 'does modify query string' do
subject.perform do |response|
expect(response.request.uri.query).to eq 'bar=%41%3A'
end
end

it 'strips fragment' do
subject.perform do |response|
expect(response.request.uri.fragment).to be_nil
end
end
end

context 'with non-ASCII URL' do
let(:url) { 'http://éxample:80/föo?bär=1' }

before do
stub_request(:get, 'http://xn--xample-9ua/f%C3%B6o?b%C3%A4r=1')
end

it 'IDN-encodes host' do
subject.perform do |response|
expect(response.request.uri.authority).to eq 'xn--xample-9ua'
end
end

it 'percent-escapes path and query string' do
subject.perform

expect(a_request(:get, 'http://xn--xample-9ua/f%C3%B6o?b%C3%A4r=1')).to have_been_made
end
end
end

describe "response's body_with_limit method" do
Expand Down