ssrf_filter 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82909e9f3a32689d3a678e5474d09fbcfb8eae84308dd1ae13d622c8d1e6f6cd
-  data.tar.gz: 6c349dc635f346cb0204d1a238ab02e4f6adcc6e9d9cd4268404195dfa9a66b2
+  metadata.gz: d68f597eb7885a7c9941fc8f134f7a6b87eec03fc0c92b6b6684a00d1be00069
+  data.tar.gz: 2c934e958e0542c2ae1606b0657cb2096d54647969f291aa41579fd3f0363c67
 SHA512:
-  metadata.gz: 602e11a98e4da6eaa0f869dc5f64aea715038b3a705b9354e25b7378dd96a893070bf4eb31d5c26c642b474d7891320c2749f7d9fc600e015c0e200cb04c3575
-  data.tar.gz: 4cd5d4382850e12b23784e807dc4728c8e67a7c214fa1aa8637fb10d49a570a1ca94ecacf9a2ef41d3c7ed983e2569545eacacdc80030dabbb99a6ef033e0e8c
+  metadata.gz: 231e5f001e5540067710bc8894364592707fde79adafcbed2d4ea019646eb4b71fe60fae76caa562e8161090cffcb49390521045f57d153d8569eeeeaef85e79
+  data.tar.gz: 6854c8b312de12da5ea27bf842533eb48719ed98668d83838b4e07c1408ccacb302cfa7830b23c810e27d8f46e0f95cfcabd9919c29c86b351b8f285dac25934

data/lib/ssrf_filter/ssrf_filter.rb

@@ -6,7 +6,7 @@ require 'resolv'
 require 'uri'
 
 class SsrfFilter
-  def self.prefixlen_from_ipaddr(ipaddr)
+  private_class_method def self.prefixlen_from_ipaddr(ipaddr)
     mask_addr = ipaddr.instance_variable_get('@mask_addr')
     raise ArgumentError, 'Invalid mask' if mask_addr.zero?
 
@@ -22,7 +22,19 @@ class SsrfFilter
 
     length
   end
-  private_class_method :prefixlen_from_ipaddr
+
+  private_class_method def self.ipv4_from_rfc6052(ipv6_addr, prefix_len)
+    n = ipv6_addr.to_i
+    ipv4_int = case prefix_len
+    when 32 then (n >> 64) & 0xFFFF_FFFF
+    when 40 then (((n >> 64) & 0xFFFFFF) << 8)  | ((n >> 48) & 0xFF)
+    when 48 then (((n >> 64) & 0xFFFF)   << 16) | ((n >> 40) & 0xFFFF)
+    when 56 then (((n >> 64) & 0xFF)     << 24) | ((n >> 32) & 0xFFFFFF)
+    when 64 then (n >> 24) & 0xFFFF_FFFF
+    when 96 then n & 0xFFFF_FFFF
+    end
+    ::IPAddr.new(ipv4_int, Socket::AF_INET) if ipv4_int
+  end
 
   # https://en.wikipedia.org/wiki/Reserved_IP_addresses
   IPV4_BLACKLIST = [
@@ -34,7 +46,6 @@ class SsrfFilter
     ::IPAddr.new('172.16.0.0/12'), # Private network
     ::IPAddr.new('192.0.0.0/24'), # IETF Protocol Assignments
     ::IPAddr.new('192.0.2.0/24'), # TEST-NET-1, documentation and examples
-    ::IPAddr.new('192.88.99.0/24'), # IPv6 to IPv4 relay (includes 2002::/16)
     ::IPAddr.new('192.168.0.0/16'), # Private network
     ::IPAddr.new('198.18.0.0/15'), # Network benchmark tests
     ::IPAddr.new('198.51.100.0/24'), # TEST-NET-2, documentation and examples
@@ -44,9 +55,11 @@ class SsrfFilter
     ::IPAddr.new('255.255.255.255') # Broadcast
   ].freeze
 
+  # NAT64 local-use prefix (RFC 8215), uses RFC 6052 /48 encoding (checked at runtime).
+  NAT64_LOCAL_PREFIX = ::IPAddr.new('64:ff9b:1::/48').freeze
+
   IPV6_BLACKLIST = ([
     ::IPAddr.new('::1/128'), # Loopback
-    ::IPAddr.new('64:ff9b::/96'), # IPv4/IPv6 translation (RFC 6052)
     ::IPAddr.new('100::/64'), # Discard prefix (RFC 6666)
     ::IPAddr.new('2001::/32'), # Teredo tunneling
     ::IPAddr.new('2001:10::/28'), # Deprecated (previously ORCHID)
@@ -60,10 +73,14 @@ class SsrfFilter
     prefixlen = prefixlen_from_ipaddr(ipaddr)
 
     # Don't call ipaddr.ipv4_compat because it prints out a deprecation warning on ruby 2.5+
-    ipv4_compatible = IPAddr.new(ipaddr.to_i, Socket::AF_INET6).mask(96 + prefixlen)
-    ipv4_mapped = ipaddr.ipv4_mapped.mask(80 + prefixlen)
-
-    [ipv4_compatible, ipv4_mapped]
+    ipv4_compatible  = IPAddr.new(ipaddr.to_i, Socket::AF_INET6).mask(96 + prefixlen)
+    ipv4_mapped      = ipaddr.ipv4_mapped.mask(80 + prefixlen)
+    # IPv4-translated (RFC 2765): ::ffff:0:x.x.x.x/96+n
+    ipv4_translated  = IPAddr.new("::ffff:0:#{ipaddr}").mask(96 + prefixlen)
+    # NAT64 well-known prefix (RFC 6052): 64:ff9b::x.x.x.x/96+n
+    nat64_well_known = IPAddr.new("64:ff9b::#{ipaddr}").mask(96 + prefixlen)
+
+    [ipv4_compatible, ipv4_mapped, ipv4_translated, nat64_well_known]
   end).freeze
 
   DEFAULT_SCHEME_WHITELIST = %w[http https].freeze
@@ -74,6 +91,8 @@ class SsrfFilter
 
   DEFAULT_ALLOW_UNFOLLOWED_REDIRECTS = false
   DEFAULT_MAX_REDIRECTS = 10
+  DEFAULT_SENSITIVE_HEADERS = %w[authorization cookie].freeze
+  DEFAULT_ON_CROSS_ORIGIN_REDIRECT = :strip
 
   VERB_MAP = {
     get: ::Net::HTTP::Get,
@@ -102,14 +121,19 @@ class SsrfFilter
   class CRLFInjection < Error
   end
 
-  %i[get put post delete head patch].each do |method|
+  class CredentialLeakage < Error
+  end
+
+  VERB_MAP.each_key do |method|
     define_singleton_method(method) do |url, options = {}, &block|
+      url = url.to_s
       original_url = url
+      original_uri = URI(url)
       scheme_whitelist = options.fetch(:scheme_whitelist, DEFAULT_SCHEME_WHITELIST)
       resolver = options.fetch(:resolver, DEFAULT_RESOLVER)
       allow_unfollowed_redirects = options.fetch(:allow_unfollowed_redirects, DEFAULT_ALLOW_UNFOLLOWED_REDIRECTS)
       max_redirects = options.fetch(:max_redirects, DEFAULT_MAX_REDIRECTS)
-      url = url.to_s
+      sensitive_headers = options.fetch(:sensitive_headers, DEFAULT_SENSITIVE_HEADERS)
 
       response = nil
       (max_redirects + 1).times do
@@ -126,7 +150,14 @@ 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, url = fetch_once(uri, public_addresses.sample.to_s, method, options, &block)
+        headers_to_strip = if !sensitive_headers.empty? && different_origin?(original_uri, uri)
+          sensitive_headers
+        else
+          []
+        end
+
+        response, url = fetch_once(uri, public_addresses.sample.to_s, method,
+          options.merge(headers_to_strip: headers_to_strip), &block)
         return response if url.nil?
       end
 
@@ -136,23 +167,36 @@ class SsrfFilter
     end
   end
 
-  def self.unsafe_ip_address?(ip_address)
+  private_class_method def self.unsafe_ip_address?(ip_address)
     return true if ipaddr_has_mask?(ip_address)
 
     return IPV4_BLACKLIST.any? { |range| range.include?(ip_address) } if ip_address.ipv4?
-    return IPV6_BLACKLIST.any? { |range| range.include?(ip_address) } if ip_address.ipv6?
+
+    if ip_address.ipv6?
+      return true if IPV6_BLACKLIST.any? { |range| range.include?(ip_address) }
+
+      # RFC 6052 /48 encoding for NAT64 local-use prefix (RFC 8215): 64:ff9b:1::/48
+      # IPv4 is split around u-bits at positions 64-71, so must be decoded at runtime
+      if NAT64_LOCAL_PREFIX.dup.include?(ip_address)
+        ipv4 = ipv4_from_rfc6052(ip_address, 48)
+        return unsafe_ip_address?(ipv4)
+      end
+      return false
+    end
 
     true
   end
-  private_class_method :unsafe_ip_address?
 
-  def self.ipaddr_has_mask?(ipaddr)
+  private_class_method def self.ipaddr_has_mask?(ipaddr)
     range = ipaddr.to_range
     range.first != range.last
   end
-  private_class_method :ipaddr_has_mask?
 
-  def self.normalized_hostname(uri)
+  private_class_method def self.different_origin?(uri1, uri2)
+    uri1.scheme != uri2.scheme || uri1.hostname != uri2.hostname || uri1.port != uri2.port
+  end
+
+  private_class_method def self.normalized_hostname(uri)
     # Attach port for non-default as per RFC2616
     if (uri.port == 80 && uri.scheme == 'http') ||
        (uri.port == 443 && uri.scheme == 'https')
@@ -161,9 +205,8 @@ class SsrfFilter
       "#{uri.hostname}:#{uri.port}"
     end
   end
-  private_class_method :normalized_hostname
 
-  def self.fetch_once(uri, ip, verb, options, &block)
+  private_class_method def self.fetch_once(uri, ip, verb, options, &block)
     if options[:params]
       params = uri.query ? ::URI.decode_www_form(uri.query).to_h : {}
       params.merge!(options[:params])
@@ -180,6 +223,20 @@ class SsrfFilter
     request.body = options[:body] if options[:body]
 
     options[:request_proc].call(request) if options[:request_proc].respond_to?(:call)
+
+    headers_to_strip = Array(options[:headers_to_strip])
+    unless headers_to_strip.empty?
+      if options[:on_cross_origin_redirect] == :raise
+        leaking = headers_to_strip.select { |h| request[h] }
+        unless leaking.empty?
+          raise CredentialLeakage,
+            "Cross-origin redirect would leak sensitive headers: #{leaking.join(', ')}"
+        end
+      else
+        headers_to_strip.each { |h| request.delete(h) }
+      end
+    end
+
     validate_request(request)
 
     http_options = (options[:http_options] || {}).merge(
@@ -202,9 +259,8 @@ class SsrfFilter
       return response, url
     end
   end
-  private_class_method :fetch_once
 
-  def self.validate_request(request)
+  private_class_method def self.validate_request(request)
     # RFC822 allows multiline "folded" headers:
     # https://tools.ietf.org/html/rfc822#section-3.1
     # In practice if any user input is ever supplied as a header key/value, they'll get
@@ -215,5 +271,4 @@ class SsrfFilter
       end
     end
   end
-  private_class_method :validate_request
 end

data/lib/ssrf_filter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class SsrfFilter
-  VERSION = '1.3.0'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssrf_filter
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Arkadiy Tetelman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-10 00:00:00.000000000 Z
+date: 2026-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: tsort
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -167,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: A gem that makes it easy to prevent server side request forgery (SSRF) attacks