gitlabhq/spec/initializers/trusted_proxies_spec.rb

# frozen_string_literal: true

require 'spec_helper'

RSpec.describe 'trusted_proxies' do
  context 'with default config' do
    before do
      set_trusted_proxies([])
    end

    it 'preserves private IPs' do
      request = stub_request('HTTP_X_FORWARDED_FOR' => '10.1.5.89')
      expect(request.remote_ip).to eq('10.1.5.89')
      expect(request.ip).to eq('10.1.5.89')
    end

    it 'filters out localhost' do
      request = stub_request('HTTP_X_FORWARDED_FOR' => '1.1.1.1, 11.1.5.89, 127.0.0.1')
      expect(request.remote_ip).to eq('11.1.5.89')
      expect(request.ip).to eq('11.1.5.89')
    end

    it 'filters out bad values' do
      request = stub_request('HTTP_X_FORWARDED_FOR' => '(null), 11.1.5.89')
      expect(request.remote_ip).to eq('11.1.5.89')
      expect(request.ip).to eq('11.1.5.89')
    end

    it 'filters out private and local IPs' do
      request = stub_request('HTTP_X_FORWARDED_FOR' => '1.2.3.6, 1.1.1.1, 10.1.5.89, 127.0.0.1')
      expect(request.remote_ip).to eq('1.1.1.1')
      expect(request.ip).to eq('1.1.1.1')
    end

    it 'filters out private and local IPv6 addresses' do
      request = stub_request(
        'HTTP_X_FORWARDED_FOR' => '::ffff:1.2.3.6, ::ffff:1.1.1.1, ::ffff:10.1.5.89, ::ffff:127.0.0.1'
      )
      expect(request.remote_ip).to eq('::ffff:1.1.1.1')
      expect(request.ip).to eq('::ffff:1.1.1.1')
    end
  end

  context 'with proxy IP added' do
    before do
      set_trusted_proxies(["60.98.25.47"])
    end

    it 'filters out proxy IP' do
      request = stub_request('HTTP_X_FORWARDED_FOR' => '1.2.3.6, 1.1.1.1, 60.98.25.47, 127.0.0.1')
      expect(request.remote_ip).to eq('1.1.1.1')
      expect(request.ip).to eq('1.1.1.1')
    end

    it 'handles mapped IPv6 addresses' do
      request = stub_request(
        'HTTP_X_FORWARDED_FOR' => '::ffff:1.2.3.6, ::ffff:1.1.1.1, ::ffff:60.98.25.47, ::ffff::127.0.0.1'
      )
      expect(request.remote_ip).to eq('::ffff:1.1.1.1')
      expect(request.ip).to eq('::ffff:1.1.1.1')
    end

    it 'handles invalid IP addresses' do
      request = stub_request('HTTP_X_FORWARDED_FOR' => '(null), 1.1.1.1:12345, 1.1.1.1')
      expect(request.remote_ip).to eq('1.1.1.1')
      expect(request.ip).to eq('1.1.1.1')
    end

    it 'does not trust private IPs' do
      request = stub_request('HTTP_X_FORWARDED_FOR' => '1.2.3.6, 10.1.1.1, 60.98.25.47, 127.0.0.1')
      expect(request.remote_ip).to eq('10.1.1.1')
      expect(request.ip).to eq('10.1.1.1')
    end
  end

  def stub_request(headers = {})
    ActionDispatch::RemoteIp.new(proc {}, false, Rails.application.config.action_dispatch.trusted_proxies).call(headers)
    ActionDispatch::Request.new(headers)
  end

  def set_trusted_proxies(proxies = [])
    stub_config_setting('trusted_proxies' => proxies)
    load File.join(__dir__, '../../config/initializers/trusted_proxies.rb')
  end
end