ssrf_filter 1.0.8 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ad08c7683abaf9c1cce31358e91eebd54e2276911da99c3d7bdbc1481ec6a8f
-  data.tar.gz: 4993290726f69399264c18dfe8b4ef1c908b78c726f0cfb5dcbc5b9c09043ead
+  metadata.gz: f0230e20c7cd24b24dad277ee01042f3a4885fa68a8ea593fe0607de92023026
+  data.tar.gz: 6ce71a83907b1acfc382acc5d859a26fc1471dc3cd2dbc48d14b3e1dfca12051
 SHA512:
-  metadata.gz: 522368253a813feb3ac735f419b8d9fe6ac3b006debf3e3c003f6909d809b5b51af06ccc9c42b7cd8d18e90d54a298d3a39fee0514304a1c3a2a1ffd1d54580d
-  data.tar.gz: 21cd1fe841b77536db7e51e9cddc94b7ed96305bf766bb16df77e5b83029a6b6c44e042d1036ae52a135419e72ae70ec1155c471fdc6596eb9dab07809e54e36
+  metadata.gz: cb56468fb4bdcf10168efbc18f004d996363b9dcc8877a1fab1eff508ef1519b86c7eeb750fedd8b565a162804746f9a036b54e584520137c1c2b1a86d5c9421
+  data.tar.gz: 9d5e0ea62956d551caa2474a384fa90e827c6d133bbfe04831f77dd49cabe5bcb3abc7008eefc63bccedf1634a33bcc27f8178253ec26f7e051075dcfba7066e

data/lib/ssrf_filter/patch/resolv.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'resolv'
+
+class SsrfFilter
+  module Patch
+    module Resolv
+      # As described in ssl_socket.rb, we want to patch ruby's http connection code to allow us to make outbound network
+      # requests while ensuring that both:
+      # 1) we're connecting to a public / non-private ip address
+      # 2) https connections continue to work
+      #
+      # This used to work fine prior to this change in ruby's net/http library:
+      # https://github.com/ruby/net-http/pull/36
+      # After this changed was introduced our patch no longer works - we need to set the hostname to the correct
+      # value on the SSLSocket (`s.hostname = ssl_host_address`), but that code path no longer executes due to the
+      # modification in the linked pull request.
+      #
+      # To work around this we introduce the patch below, which forces our ip address string to not match against the
+      # Resolv IPv4/IPv6 regular expressions. This is ugly and cumbersome but I didn't see any better path.
+      class PatchedRegexp < Regexp
+        def ===(other)
+          if ::Thread.current.key?(::SsrfFilter::FIBER_ADDRESS_KEY) &&
+             other.object_id.equal?(::Thread.current[::SsrfFilter::FIBER_ADDRESS_KEY].object_id)
+            false
+          else
+            super(other)
+          end
+        end
+      end
+
+      def self.apply!
+        return if instance_variable_defined?(:@patched_resolv)
+
+        @patched_resolv = true
+
+        old_ipv4 = ::Resolv::IPv4.send(:remove_const, :Regex)
+        old_ipv6 = ::Resolv::IPv6.send(:remove_const, :Regex)
+        ::Resolv::IPv4.const_set(:Regex, PatchedRegexp.new(old_ipv4))
+        ::Resolv::IPv6.const_set(:Regex, PatchedRegexp.new(old_ipv6))
+      end
+    end
+  end
+end

data/lib/ssrf_filter/patch/ssl_socket.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SsrfFilter
   module Patch
     module SSLSocket
@@ -33,13 +35,14 @@ class SsrfFilter
         ::OpenSSL::SSL::SSLSocket.class_eval do
           original_post_connection_check = instance_method(:post_connection_check)
           define_method(:post_connection_check) do |hostname|
-            original_post_connection_check.bind(self).call(::Thread.current[::SsrfFilter::FIBER_LOCAL_KEY] || hostname)
+            original_post_connection_check.bind(self).call(::Thread.current[::SsrfFilter::FIBER_HOSTNAME_KEY] ||
+              hostname)
           end
 
           if method_defined?(:hostname=)
             original_hostname = instance_method(:hostname=)
             define_method(:hostname=) do |hostname|
-              original_hostname.bind(self).call(::Thread.current[::SsrfFilter::FIBER_LOCAL_KEY] || hostname)
+              original_hostname.bind(self).call(::Thread.current[::SsrfFilter::FIBER_HOSTNAME_KEY] || hostname)
             end
           end
         end

data/lib/ssrf_filter/ssrf_filter.rb

@@ -10,7 +10,9 @@ class SsrfFilter
     mask_addr = ipaddr.instance_variable_get('@mask_addr')
     raise ArgumentError, 'Invalid mask' if mask_addr.zero?
 
-    mask_addr >>= 1 while (mask_addr & 0x1).zero?
+    while (mask_addr & 0x1).zero?
+      mask_addr >>= 1
+    end
 
     length = 0
     while mask_addr & 0x1 == 0x1
@@ -81,7 +83,8 @@ class SsrfFilter
     patch: ::Net::HTTP::Patch
   }.freeze
 
-  FIBER_LOCAL_KEY = :__ssrf_filter_hostname
+  FIBER_HOSTNAME_KEY = :__ssrf_filter_hostname
+  FIBER_ADDRESS_KEY = :__ssrf_filter_address
 
   class Error < ::StandardError
   end
@@ -104,7 +107,7 @@ class SsrfFilter
   %i[get put post delete head patch].each do |method|
     define_singleton_method(method) do |url, options = {}, &block|
       ::SsrfFilter::Patch::SSLSocket.apply!
-      ::SsrfFilter::Patch::HTTPGenericRequest.apply!
+      ::SsrfFilter::Patch::Resolv.apply!
 
       original_url = url
       scheme_whitelist = options[:scheme_whitelist] || DEFAULT_SCHEME_WHITELIST
@@ -126,16 +129,8 @@ class SsrfFilter
         public_addresses = ip_addresses.reject(&method(:unsafe_ip_address?))
         raise PrivateIPAddress, "Hostname '#{hostname}' has no public ip addresses" if public_addresses.empty?
 
-        response = fetch_once(uri, public_addresses.sample.to_s, method, options, &block)
-
-        case response
-        when ::Net::HTTPRedirection then
-          url = response['location']
-          # Handle relative redirects
-          url = "#{uri.scheme}://#{hostname}:#{uri.port}#{url}" if url.start_with?('/')
-        else
-          return response
-        end
+        response, url = fetch_once(uri, public_addresses.sample.to_s, method, options, &block)
+        return response if url.nil?
       end
 
       raise TooManyRedirects, "Got #{max_redirects} redirects fetching #{original_url}"
@@ -171,7 +166,7 @@ class SsrfFilter
 
   def self.fetch_once(uri, ip, verb, options, &block)
     if options[:params]
-      params = uri.query ? ::Hash[::URI.decode_www_form(uri.query)] : {}
+      params = uri.query ? ::URI.decode_www_form(uri.query).to_h : {}
       params.merge!(options[:params])
       uri.query = ::URI.encode_www_form(params)
     end
@@ -188,15 +183,26 @@ class SsrfFilter
 
     request.body = options[:body] if options[:body]
 
-    block.call(request) if block_given?
+    options[:request_proc].call(request) if options[:request_proc].respond_to?(:call)
     validate_request(request)
 
     http_options = options[:http_options] || {}
     http_options[:use_ssl] = (uri.scheme == 'https')
 
-    with_forced_hostname(hostname) do
-      ::Net::HTTP.start(uri.hostname, uri.port, http_options) do |http|
-        http.request(request)
+    with_forced_hostname(hostname, ip) do
+      ::Net::HTTP.start(uri.hostname, uri.port, **http_options) do |http|
+        http.request(request) do |response|
+          case response
+          when ::Net::HTTPRedirection
+            url = response['location']
+            # Handle relative redirects
+            url = "#{uri.scheme}://#{hostname}:#{uri.port}#{url}" if url.start_with?('/')
+            return nil, url
+          else
+            block&.call(response)
+            return response, nil
+          end
+        end
       end
     end
   end
@@ -215,11 +221,13 @@ class SsrfFilter
   end
   private_class_method :validate_request
 
-  def self.with_forced_hostname(hostname, &_block)
-    ::Thread.current[FIBER_LOCAL_KEY] = hostname
+  def self.with_forced_hostname(hostname, ip, &_block)
+    ::Thread.current[FIBER_HOSTNAME_KEY] = hostname
+    ::Thread.current[FIBER_ADDRESS_KEY] = ip
     yield
   ensure
-    ::Thread.current[FIBER_LOCAL_KEY] = nil
+    ::Thread.current[FIBER_HOSTNAME_KEY] = nil
+    ::Thread.current[FIBER_ADDRESS_KEY] = nil
   end
   private_class_method :with_forced_hostname
 end

data/lib/ssrf_filter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class SsrfFilter
-  VERSION = '1.0.8'.freeze
+  VERSION = '1.1.1'
 end

data/lib/ssrf_filter.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'ssrf_filter/patch/http_generic_request'
+require 'ssrf_filter/patch/resolv'
 require 'ssrf_filter/patch/ssl_socket'
 require 'ssrf_filter/ssrf_filter'
 require 'ssrf_filter/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssrf_filter
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.1.1
 platform: ruby
 authors:
 - Arkadiy Tetelman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-04 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -16,126 +16,126 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.22
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.22
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: psych
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 1.35.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 1.35.0
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: 2.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.1
+        version: 2.12.1
 - !ruby/object:Gem::Dependency
-  name: webrick
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
-  name: public_suffix
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.5
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
-  name: rexml
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.4
+        version: 3.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.4
+        version: 3.18.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: webrick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '0'
 description: A gem that makes it easy to prevent server side request forgery (SSRF)
   attacks
 email:
@@ -144,14 +144,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/ssrf_filter.rb
-- lib/ssrf_filter/patch/http_generic_request.rb
+- lib/ssrf_filter/patch/resolv.rb
 - lib/ssrf_filter/patch/ssl_socket.rb
 - lib/ssrf_filter/ssrf_filter.rb
 - lib/ssrf_filter/version.rb
 homepage: https://github.com/arkadiyt/ssrf_filter
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -160,14 +161,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: A gem that makes it easy to prevent server side request forgery (SSRF) attacks

data/lib/ssrf_filter/patch/http_generic_request.rb

@@ -1,83 +0,0 @@
-require 'stringio'
-
-class SsrfFilter
-  module Patch
-    module HTTPGenericRequest
-      # Ruby had a bug in its Http library where if you set a custom `Host` header on a request it would get
-      # overwritten. This was tracked in:
-      # https://bugs.ruby-lang.org/issues/10054
-      # and resolved with the commit:
-      # https://github.com/ruby/ruby/commit/70a2eb63999265ff7e8d46d1f5b410c8ee3d30d7#diff-5c08b4ae27d2294a8294a27ff9af4a85
-      # Versions of Ruby that don't have this fix applied will fail to connect to certain hosts via SsrfFilter. The
-      # patch below backports the fix from the linked commit.
-
-      def self.should_apply?
-        # Check if the patch needs to be applied:
-        # The Ruby bug was that HTTPGenericRequest#exec overwrote the Host header, so this snippet checks
-        # if we can reproduce that behavior. It does not actually open any network connections.
-
-        uri = URI('https://www.example.com')
-        request = ::Net::HTTPGenericRequest.new('HEAD', false, false, uri)
-        request['host'] = '127.0.0.1'
-        request.exec(StringIO.new, '1.1', '/')
-        request['host'] == uri.hostname
-      end
-
-      # Apply the patch from the linked commit onto ::Net::HTTPGenericRequest. Since this is 3rd party code,
-      # disable code coverage and rubocop linting for this section.
-      # :nocov:
-      # rubocop:disable all
-      def self.apply!
-        return if instance_variable_defined?(:@checked_http_generic_request)
-        @checked_http_generic_request = true
-        return unless should_apply?
-
-        ::Net::HTTPGenericRequest.class_eval do
-          def exec(sock, ver, path)
-            if @body
-              send_request_with_body sock, ver, path, @body
-            elsif @body_stream
-              send_request_with_body_stream sock, ver, path, @body_stream
-            elsif @body_data
-              send_request_with_body_data sock, ver, path, @body_data
-            else
-              write_header sock, ver, path
-            end
-          end
-
-          def update_uri(addr, port, ssl)
-            # reflect the connection and @path to @uri
-            return unless @uri
-
-            if ssl
-              scheme = 'https'.freeze
-              klass = URI::HTTPS
-            else
-              scheme = 'http'.freeze
-              klass = URI::HTTP
-            end
-
-            if host = self['host']
-              host.sub!(/:.*/s, ''.freeze)
-            elsif host = @uri.host
-            else
-             host = addr
-            end
-            # convert the class of the URI
-            if @uri.is_a?(klass)
-              @uri.host = host
-              @uri.port = port
-            else
-              @uri = klass.new(
-                scheme, @uri.userinfo,
-                host, port, nil,
-                @uri.path, nil, @uri.query, nil)
-            end
-          end
-        end
-      end
-      # rubocop:enable all
-      # :nocov:
-    end
-  end
-end