2018-10-22 07:00:50 +00:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2017-03-15 20:09:08 +00:00
|
|
|
require 'resolv'
|
2018-11-26 08:45:38 +00:00
|
|
|
require 'ipaddress'
|
2017-03-15 20:09:08 +00:00
|
|
|
|
|
|
|
module Gitlab
|
|
|
|
class UrlBlocker
|
2018-03-28 17:27:16 +00:00
|
|
|
BlockedUrlError = Class.new(StandardError)
|
2017-03-18 17:56:05 +00:00
|
|
|
|
2018-03-28 17:27:16 +00:00
|
|
|
class << self
|
2018-12-05 20:14:09 +00:00
|
|
|
def validate!(url, ports: [], protocols: [], allow_localhost: false, allow_local_network: true, ascii_only: false, enforce_user: false)
|
2018-03-28 17:27:16 +00:00
|
|
|
return true if url.nil?
|
2017-03-15 20:09:08 +00:00
|
|
|
|
2018-11-28 19:06:44 +00:00
|
|
|
# Param url can be a string, URI or Addressable::URI
|
|
|
|
uri = parse_url(url)
|
2017-03-15 20:09:08 +00:00
|
|
|
|
2018-04-02 15:13:23 +00:00
|
|
|
# Allow imports from the GitLab instance itself but only from the configured ports
|
|
|
|
return true if internal?(uri)
|
2018-03-13 22:38:25 +00:00
|
|
|
|
2018-04-02 15:13:23 +00:00
|
|
|
port = uri.port || uri.default_port
|
2018-06-01 11:43:53 +00:00
|
|
|
validate_protocol!(uri.scheme, protocols)
|
|
|
|
validate_port!(port, ports) if ports.any?
|
2018-06-11 13:29:37 +00:00
|
|
|
validate_user!(uri.user) if enforce_user
|
2018-04-02 15:13:23 +00:00
|
|
|
validate_hostname!(uri.hostname)
|
2018-12-05 20:14:09 +00:00
|
|
|
validate_unicode_restriction!(uri) if ascii_only
|
2018-03-28 17:27:16 +00:00
|
|
|
|
2018-04-02 15:13:23 +00:00
|
|
|
begin
|
2018-11-26 08:45:38 +00:00
|
|
|
addrs_info = Addrinfo.getaddrinfo(uri.hostname, port, nil, :STREAM).map do |addr|
|
|
|
|
addr.ipv6_v4mapped? ? addr.ipv6_to_ipv4 : addr
|
|
|
|
end
|
2017-11-07 08:30:38 +00:00
|
|
|
rescue SocketError
|
2018-04-02 15:13:23 +00:00
|
|
|
return true
|
2017-03-15 20:09:08 +00:00
|
|
|
end
|
|
|
|
|
2018-04-02 15:13:23 +00:00
|
|
|
validate_localhost!(addrs_info) unless allow_localhost
|
2018-09-06 04:41:59 +00:00
|
|
|
validate_loopback!(addrs_info) unless allow_localhost
|
2018-04-02 15:13:47 +00:00
|
|
|
validate_local_network!(addrs_info) unless allow_local_network
|
2018-08-11 10:38:21 +00:00
|
|
|
validate_link_local!(addrs_info) unless allow_local_network
|
2018-04-02 15:13:23 +00:00
|
|
|
|
2018-03-28 17:27:16 +00:00
|
|
|
true
|
|
|
|
end
|
|
|
|
|
|
|
|
def blocked_url?(*args)
|
|
|
|
validate!(*args)
|
|
|
|
|
2017-03-15 20:09:08 +00:00
|
|
|
false
|
2018-03-28 17:27:16 +00:00
|
|
|
rescue BlockedUrlError
|
|
|
|
true
|
2017-03-15 20:09:08 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
private
|
|
|
|
|
2018-11-28 19:06:44 +00:00
|
|
|
def parse_url(url)
|
|
|
|
raise Addressable::URI::InvalidURIError if multiline?(url)
|
|
|
|
|
|
|
|
Addressable::URI.parse(url)
|
|
|
|
rescue Addressable::URI::InvalidURIError, URI::InvalidURIError
|
|
|
|
raise BlockedUrlError, 'URI is invalid'
|
|
|
|
end
|
|
|
|
|
|
|
|
def multiline?(url)
|
|
|
|
CGI.unescape(url.to_s) =~ /\n|\r/
|
|
|
|
end
|
|
|
|
|
2018-06-01 11:43:53 +00:00
|
|
|
def validate_port!(port, ports)
|
2018-04-02 15:13:23 +00:00
|
|
|
return if port.blank?
|
|
|
|
# Only ports under 1024 are restricted
|
|
|
|
return if port >= 1024
|
2018-06-01 11:43:53 +00:00
|
|
|
return if ports.include?(port)
|
2018-04-02 15:13:23 +00:00
|
|
|
|
2018-06-01 11:43:53 +00:00
|
|
|
raise BlockedUrlError, "Only allowed ports are #{ports.join(', ')}, and any over 1024"
|
|
|
|
end
|
|
|
|
|
|
|
|
def validate_protocol!(protocol, protocols)
|
|
|
|
if protocol.blank? || (protocols.any? && !protocols.include?(protocol))
|
|
|
|
raise BlockedUrlError, "Only allowed protocols are #{protocols.join(', ')}"
|
|
|
|
end
|
2018-04-02 15:13:23 +00:00
|
|
|
end
|
|
|
|
|
|
|
|
def validate_user!(value)
|
|
|
|
return if value.blank?
|
|
|
|
return if value =~ /\A\p{Alnum}/
|
2017-03-15 20:09:08 +00:00
|
|
|
|
2018-04-02 15:13:23 +00:00
|
|
|
raise BlockedUrlError, "Username needs to start with an alphanumeric character"
|
2017-03-15 20:09:08 +00:00
|
|
|
end
|
|
|
|
|
2018-04-02 15:13:23 +00:00
|
|
|
def validate_hostname!(value)
|
|
|
|
return if value.blank?
|
2018-11-26 08:45:38 +00:00
|
|
|
return if IPAddress.valid?(value)
|
2018-04-02 15:13:23 +00:00
|
|
|
return if value =~ /\A\p{Alnum}/
|
2017-08-08 17:36:24 +00:00
|
|
|
|
2018-11-26 08:45:38 +00:00
|
|
|
raise BlockedUrlError, "Hostname or IP address invalid"
|
2018-04-02 15:13:23 +00:00
|
|
|
end
|
|
|
|
|
2018-12-05 20:14:09 +00:00
|
|
|
def validate_unicode_restriction!(uri)
|
|
|
|
return if uri.to_s.ascii_only?
|
|
|
|
|
|
|
|
raise BlockedUrlError, "URI must be ascii only #{uri.to_s.dump}"
|
|
|
|
end
|
|
|
|
|
2018-04-02 15:13:23 +00:00
|
|
|
def validate_localhost!(addrs_info)
|
2018-11-26 08:45:38 +00:00
|
|
|
local_ips = ["::", "0.0.0.0"]
|
2018-04-02 15:13:23 +00:00
|
|
|
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
|
|
|
|
|
2018-09-06 04:41:59 +00:00
|
|
|
def validate_loopback!(addrs_info)
|
|
|
|
return unless addrs_info.any? { |addr| addr.ipv4_loopback? || addr.ipv6_loopback? }
|
|
|
|
|
|
|
|
raise BlockedUrlError, "Requests to loopback addresses are not allowed"
|
|
|
|
end
|
|
|
|
|
2018-04-02 15:13:23 +00:00
|
|
|
def validate_local_network!(addrs_info)
|
2018-11-26 08:45:38 +00:00
|
|
|
return unless addrs_info.any? { |addr| addr.ipv4_private? || addr.ipv6_sitelocal? || addr.ipv6_unique_local? }
|
2018-04-02 15:13:23 +00:00
|
|
|
|
|
|
|
raise BlockedUrlError, "Requests to the local network are not allowed"
|
2017-08-08 17:36:24 +00:00
|
|
|
end
|
|
|
|
|
2018-08-11 10:38:21 +00:00
|
|
|
def validate_link_local!(addrs_info)
|
|
|
|
netmask = IPAddr.new('169.254.0.0/16')
|
|
|
|
return unless addrs_info.any? { |addr| addr.ipv6_linklocal? || netmask.include?(addr.ip_address) }
|
|
|
|
|
|
|
|
raise BlockedUrlError, "Requests to the link local network are not allowed"
|
|
|
|
end
|
|
|
|
|
2017-03-15 20:09:08 +00:00
|
|
|
def internal?(uri)
|
|
|
|
internal_web?(uri) || internal_shell?(uri)
|
|
|
|
end
|
|
|
|
|
|
|
|
def internal_web?(uri)
|
2018-11-28 18:37:12 +00:00
|
|
|
uri.scheme == config.gitlab.protocol &&
|
|
|
|
uri.hostname == config.gitlab.host &&
|
2017-03-15 20:09:08 +00:00
|
|
|
(uri.port.blank? || uri.port == config.gitlab.port)
|
|
|
|
end
|
|
|
|
|
|
|
|
def internal_shell?(uri)
|
2018-11-28 18:37:12 +00:00
|
|
|
uri.scheme == 'ssh' &&
|
|
|
|
uri.hostname == config.gitlab_shell.ssh_host &&
|
2017-03-15 20:09:08 +00:00
|
|
|
(uri.port.blank? || uri.port == config.gitlab_shell.ssh_port)
|
|
|
|
end
|
|
|
|
|
|
|
|
def config
|
|
|
|
Gitlab.config
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|