Make error messages even more descriptive

This commit is contained in:
Douwe Maan 2018-04-02 17:13:23 +02:00
parent 7143bb8852
commit b95918dda8
No known key found for this signature in database
GPG key ID: 5976703F65143D36
3 changed files with 53 additions and 39 deletions

View file

@ -10,28 +10,27 @@ module Gitlab
begin begin
uri = Addressable::URI.parse(url) uri = Addressable::URI.parse(url)
# Allow imports from the GitLab instance itself but only from the configured ports
return true if internal?(uri)
raise BlockedUrlError, "Port is blocked" if blocked_port?(uri.port, valid_ports)
raise BlockedUrlError, "User is blocked" if blocked_user_or_hostname?(uri.user)
raise BlockedUrlError, "Hostname is blocked" if blocked_user_or_hostname?(uri.hostname)
addrs_info = Addrinfo.getaddrinfo(uri.hostname, 80, nil, :STREAM)
if !allow_localhost && localhost?(addrs_info)
raise BlockedUrlError, "Requests to localhost are blocked"
end
if !allow_private_networks && private_network?(addrs_info)
raise BlockedUrlError, "Requests to the private local network are blocked"
end
rescue Addressable::URI::InvalidURIError rescue Addressable::URI::InvalidURIError
raise BlockedUrlError, "URI is invalid" raise BlockedUrlError, "URI is invalid"
rescue SocketError
return
end end
# Allow imports from the GitLab instance itself but only from the configured ports
return true if internal?(uri)
port = uri.port || uri.default_port
validate_port!(port, valid_ports) if valid_ports.any?
validate_user!(uri.user)
validate_hostname!(uri.hostname)
begin
addrs_info = Addrinfo.getaddrinfo(uri.hostname, port, nil, :STREAM)
rescue SocketError
return true
end
validate_localhost!(addrs_info) unless allow_localhost
validate_local_network!(addrs_info) unless allow_private_networks
true true
end end
@ -45,16 +44,42 @@ module Gitlab
private private
def blocked_port?(port, valid_ports) def validate_port!(port, valid_ports)
return false if port.blank? || valid_ports.blank? return if port.blank?
# Only ports under 1024 are restricted
return if port >= 1024
return if valid_ports.include?(port)
port < 1024 && !valid_ports.include?(port) raise BlockedUrlError, "Only allowed ports are #{valid_ports.join(', ')}, and any over 1024"
end end
def blocked_user_or_hostname?(value) def validate_user!(value)
return false if value.blank? return if value.blank?
return if value =~ /\A\p{Alnum}/
value !~ /\A\p{Alnum}/ raise BlockedUrlError, "Username needs to start with an alphanumeric character"
end
def validate_hostname!(value)
return if value.blank?
return if value =~ /\A\p{Alnum}/
raise BlockedUrlError, "Hostname needs to start with an alphanumeric character"
end
def validate_localhost!(addrs_info)
local_ips = ["127.0.0.1", "::1", "0.0.0.0"]
local_ips.concat(Socket.ip_address_list.map(&:ip_address))
return if (local_ips & addrs_info.map(&:ip_address)).empty?
raise BlockedUrlError, "Requests to localhost are not allowed"
end
def validate_local_network!(addrs_info)
return unless addrs_info.any? { |addr| addr.ipv4_private? || addr.ipv6_sitelocal? }
raise BlockedUrlError, "Requests to the local network are not allowed"
end end
def internal?(uri) def internal?(uri)
@ -71,17 +96,6 @@ module Gitlab
(uri.port.blank? || uri.port == config.gitlab_shell.ssh_port) (uri.port.blank? || uri.port == config.gitlab_shell.ssh_port)
end end
def localhost?(addrs_info)
blocked_ips = ["127.0.0.1", "::1", "0.0.0.0"]
blocked_ips.concat(Socket.ip_address_list.map(&:ip_address))
(blocked_ips & addrs_info.map(&:ip_address)).any?
end
def private_network?(addrs_info)
addrs_info.any? { |addr| addr.ipv4_private? || addr.ipv6_sitelocal? }
end
def config def config
Gitlab.config Gitlab.config
end end

View file

@ -224,14 +224,14 @@ describe Project do
project2 = build(:project, import_url: 'http://localhost:9000/t.git') project2 = build(:project, import_url: 'http://localhost:9000/t.git')
expect(project2).to be_invalid expect(project2).to be_invalid
expect(project2.errors[:import_url]).to include('imports are not allowed from that URL') expect(project2.errors[:import_url].first).to include('Requests to localhost are not allowed')
end end
it "does not allow blocked import_url port" do it "does not allow blocked import_url port" do
project2 = build(:project, import_url: 'http://github.com:25/t.git') project2 = build(:project, import_url: 'http://github.com:25/t.git')
expect(project2).to be_invalid expect(project2).to be_invalid
expect(project2.errors[:import_url]).to include('imports are not allowed from that URL') expect(project2.errors[:import_url].first).to include('Only allowed ports are 22, 80, 443')
end end
describe 'project pending deletion' do describe 'project pending deletion' do

View file

@ -156,7 +156,7 @@ describe Projects::ImportService do
result = described_class.new(project, user).execute result = described_class.new(project, user).execute
expect(result[:status]).to eq :error expect(result[:status]).to eq :error
expect(result[:message]).to end_with 'Blocked import URL.' expect(result[:message]).to include('Requests to localhost are not allowed')
end end
it 'fails with port 25' do it 'fails with port 25' do
@ -165,7 +165,7 @@ describe Projects::ImportService do
result = described_class.new(project, user).execute result = described_class.new(project, user).execute
expect(result[:status]).to eq :error expect(result[:status]).to eq :error
expect(result[:message]).to end_with 'Blocked import URL.' expect(result[:message]).to include('Only allowed ports are 22, 80, 443')
end end
end end