local_ip_checker 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6729080644e1a9f257475491abec3785326bd3d4228e779693abeab4070c3ac3
+  data.tar.gz: 8fd0de18050aefde74ba780f6173388bbd09964d2896f2b3470a87a53396106b
+SHA512:
+  metadata.gz: 6abbe04fdcf406b01658673d1bed8ce0ecbe5893283e4deffd936933b91daea9b9cd8272e4551ba60f25cf12cea7fe53f959d72eae960ceffb5ca8898f82b70c
+  data.tar.gz: 318c4cc84a46379d29a7eb4755f58be591243ece1990224ec58e70ebcaddca8239eca53e392fd0379134679657a88304b404772323467248e2bbbb3ba5880f79

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0
+
+Initial version.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 yaroslav2k
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+# Local IP Checker
+
+Simple ruby gem that provides checking if given URL resolves to local IP address.
+
+## Abstract
+
+If your system makes HTTP requests to 3rd-party provided URL it's required to check if this URL maps to some kind of local IP address. This gem performs checks against following types of local IP addresses:
+
+1. IPv4 and IPv6 localhost addresses.
+2. IPv4 `0.0.0.0` and IPv6 `::` addresses.
+3. IPv4 private address ranges (e. g. `10.0.0.0/8`).
+4. IPv6 unique local addresses (`fc00::/7`).
+5. IPv6 site-local address (`fec0::/10`)
+6. IPv4 and IPv6 link-local addresses.
+
+## Usage
+
+Example:
+```
+require "local_ip_checker"
+
+LocalIPChecker.local?("google.com") # => false
+LocalIPChecker.nonlocal?("google.com") => true
+LocalIPChecker.local?("localhost") => true
+LocalIPChecker.local?("::") # => true
+```

data/lib/local_ip_checker/adapters.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "resolv"
+
+require "local_ip_checker/adapters/base"
+require "local_ip_checker/adapters/domain"
+require "local_ip_checker/adapters/ip_address"
+
+module LocalIPChecker
+  module Adapters
+    DOMAIN_REGEX = /(\w+\.?)+/.freeze
+
+    module_function
+
+    def build(value)
+      if value.match?(Resolv::IPv4::Regex) || value.match?(Resolv::IPv6::Regex)
+        LocalIPChecker::Adapters::IPAddress
+      elsif value.match?(DOMAIN_REGEX)
+        LocalIPChecker::Adapters::Domain
+      else
+        raise "ValueError #{value}"
+      end.new(value)
+    end
+  end
+end

data/lib/local_ip_checker/executor.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "socket"
+
+module LocalIPChecker
+  class Executor
+    HOST_IP_ADDRESSES = (%w[0.0.0.0 ::] + Socket.ip_address_list.map(&:ip_address)).freeze
+    IPV6_LINKLOCAL_ADDRESSES = IPAddr.new("169.254.0.0/16").freeze
+
+    class << self
+      def local?(value)
+        new(value).local?
+      end
+
+      def nonlocal?(value)
+        !local?(value)
+      end
+    end
+
+    def initialize(value)
+      @value = value
+    end
+
+    def local?
+      Enumerator.new do |enum|
+        enum << localhost?
+        enum << loopback?
+        enum << local_network?
+        enum << link_local?
+      end.any?(&:itself)
+    end
+
+    private
+
+    attr_reader :value
+
+    def localhost?
+      (HOST_IP_ADDRESSES & resolved_ips.map(&:ip_address)).any?
+    end
+
+    def loopback?
+      check_ips { |ip| ip.ipv4_loopback? || ip.ipv6_loopback? }
+    end
+
+    def local_network?
+      check_ips { |ip| ip.ipv4_private? || ip.ipv6_sitelocal? || ip.ipv6_unique_local? }
+    end
+
+    def link_local?
+      check_ips { |ip| ip.ipv6_linklocal? || IPV6_LINKLOCAL_ADDRESSES.include?(ip.ip_address) }
+    end
+
+    def check_ips(&block)
+      resolved_ips.any?(&block)
+    end
+
+    def resolved_ips
+      @resolved_ips ||=
+        Addrinfo.getaddrinfo(value, 80, nil, :STREAM).map do |ip|
+          ip.ipv6_v4mapped? ? ip.ipv6_to_ipv4 : ip
+        end
+    end
+  end
+end

data/lib/local_ip_checker/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LocalIPChecker
+  VERSION = "1.0.0"
+end

data/lib/local_ip_checker.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+require "local_ip_checker/version"
+require "local_ip_checker/executor"
+
+module LocalIPChecker
+  extend SingleForwardable
+
+  def_delegators "LocalIPChecker::Executor", *%i[local? nonlocal?]
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: local_ip_checker
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yaroslav Kurbatov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email: yaroslav2kleet@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/local_ip_checker.rb
+- lib/local_ip_checker/adapters.rb
+- lib/local_ip_checker/executor.rb
+- lib/local_ip_checker/version.rb
+homepage: https://github.com/yaroslav2k/local_ip_checker
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Simple gem to check if provided URL is mapped to local IP address
+test_files: []