Add DSN#local?

Author: solnic

sentry-ruby/lib/sentry/dsn.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
 require "uri"
+require "ipaddr"
+require "resolv"
 
 module Sentry
   class DSN
     PORT_MAP = { "http" => 80, "https" => 443 }.freeze
     REQUIRED_ATTRIBUTES = %w[host path public_key project_id].freeze
+    LOCALHOST_NAMES = %w[localhost 127.0.0.1 ::1 [::1]].freeze
+    LOCALHOST_PATTERN = /\.local(host|domain)?$/i
 
     attr_reader :scheme, :secret_key, :port, *REQUIRED_ATTRIBUTES
 
@@ -49,5 +53,33 @@ def csp_report_uri
     def envelope_endpoint
       "#{path}/api/#{project_id}/envelope/"
     end
+
+    def local?
+      @local ||= (localhost? || private_ip? || resolved_ips_private?)
+    end
+
+    def localhost?
+      LOCALHOST_NAMES.include?(host.downcase) || LOCALHOST_PATTERN.match?(host)
+    end
+
+    def private_ip?
+      @private_ip ||= begin
+        begin
+          IPAddr.new(host).private?
+        rescue IPAddr::InvalidAddressError
+          false
+        end
+      end
+    end
+
+    def resolved_ips_private?
+      @resolved_ips_private ||= begin
+        begin
+          Resolv.getaddresses(host).any? { |ip| IPAddr.new(ip).private? }
+        rescue Resolv::ResolvError, IPAddr::InvalidAddressError
+          false
+        end
+      end
+    end
   end
 end

sentry-ruby/spec/sentry/dsn_spec.rb

@@ -37,4 +37,29 @@
       expect(subject.csp_report_uri).to eq("http://sentry.localdomain:3000/api/42/security/?sentry_key=12345")
     end
   end
+
+  describe "#local?" do
+    it "returns true for localhost" do
+      expect(described_class.new("http://12345:67890@localhost/sentry/42").local?).to eq(true)
+    end
+
+    it "returns true for 127.0.0.1" do
+      expect(described_class.new("http://12345:67890@127.0.0.1/sentry/42").local?).to eq(true)
+    end
+    it "returns true for ::1" do
+      expect(described_class.new("http://12345:67890@[::1]/sentry/42").local?).to eq(true)
+    end
+
+    it "returns true for private IP" do
+      expect(described_class.new("http://12345:67890@192.168.0.1/sentry/42").local?).to eq(true)
+    end
+
+    it "returns true for private IP with port" do
+      expect(described_class.new("http://12345:67890@192.168.0.1:3000/sentry/42").local?).to eq(true)
+    end
+
+    it "returns false for non-local domain" do
+      expect(described_class.new("http://12345:67890@sentry.io/sentry/42").local?).to eq(false)
+    end
+  end
 end