private_address_check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69dffe5d95058be5d6d131dd7e27843b02e736ac
+  data.tar.gz: 12043ad0e982f7bfc4e95050151b69a8fb3575f9
+SHA512:
+  metadata.gz: 230e58a7c57213f83ee7975b05329aaa17b0a5c2f99d55325ff50fc1b9d76faeb616e4ce4ce24aa4b722bf819743e2ec75b36d2c113a91e1d89a929d63d58192
+  data.tar.gz: f93358263bdd8fd37a62495a33402dc149a51d67c0a00928f54f1aaf0073e748654a36ba37f8b3b5f49ba1c04ee5bf7b233a35e633ff37a1bde9e834040e1935

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jdowney@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in private_address_check.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 John Downey
+
+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,68 @@
+# PrivateAddressCheck
+
+[![Build Status](https://travis-ci.org/jtdowney/private_address_check.svg?branch=master)](https://travis-ci.org/jtdowney/private_address_check)
+[![Code Climate](https://codeclimate.com/github/jtdowney/private_address_check/badges/gpa.svg)](https://codeclimate.com/github/jtdowney/private_address_check)
+
+Checks if a URL or hostname would cause a request to a private network (RFC 1918). This is useful in preventing attacks like [Server Side Request Forgery](https://cwe.mitre.org/data/definitions/918.html).
+
+## Requirements
+
+* Ruby >= 2.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'private_address_check'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install private_address_check
+
+## Usage
+
+```ruby
+require "private_address_check"
+
+PrivateAddressCheck.private_address?("8.8.8.8") # => false
+PrivateAddressCheck.private_address?("10.10.10.2") # => true
+PrivateAddressCheck.private_address?("127.0.0.1") # => true
+PrivateAddressCheck.private_address?("172.16.2.10") # => true
+PrivateAddressCheck.private_address?("192.168.1.10") # => true
+PrivateAddressCheck.private_address?("fd00::2") # => true
+PrivateAddressCheck.resolves_to_private_address?("github.com") # => false
+PrivateAddressCheck.resolves_to_private_address?("localhost") # => true
+
+require "private_address_check/tcpsocket_ext"
+require "net/http"
+require "require "uri""
+
+Net::HTTP.get_response(URI.parse("http://192.168.1.1")) # => attempts connection like normal
+
+PrivateAddressCheck.only_public_connections do
+  Net::HTTP.get_response(URI.parse("http://192.168.1.1"))
+end
+# => raises PrivateAddressCheck::PrivateConnectionAttemptedError
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jtdowney/private_address_check. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/private_address_check.rb

@@ -0,0 +1,38 @@
+require "ipaddr"
+require "resolv"
+
+require "private_address_check/version"
+
+module PrivateAddressCheck
+  module_function
+
+  CIDR_LIST = [
+    # Loopback
+    IPAddr.new("127.0.0.0/8"),
+    IPAddr.new("::1/64"),
+
+    # Link Local,
+    IPAddr.new("169.254.0.0/16"),
+
+    # RFC 1918
+    IPAddr.new("10.0.0.0/8"),
+    IPAddr.new("172.16.0.0/12"),
+    IPAddr.new("192.168.0.0/16"),
+
+    # RFC 4193
+    IPAddr.new("fc00::/7"),
+  ]
+
+  def private_address?(address)
+    CIDR_LIST.any? do |cidr| 
+      cidr.include?(address)
+    end
+  end
+
+  def resolves_to_private_address?(hostname)
+    ips = Resolv.getaddresses(hostname)
+    ips.any? do |ip| 
+      private_address?(ip)
+    end
+  end
+end

data/lib/private_address_check/tcpsocket_ext.rb

@@ -0,0 +1,29 @@
+module PrivateAddressCheck
+  PrivateConnectionAttemptedError = Class.new(StandardError)
+
+  module_function
+
+  def only_public_connections
+    Thread.current[:private_address_check] = true
+    yield
+  ensure
+    Thread.current[:private_address_check] = false
+  end
+
+  module TCPSocketExt
+    def initialize(remote_host, remote_port, local_host = nil, local_port = nil)
+      if Thread.current[:private_address_check]
+        ip = Resolv.getaddress(remote_host)
+        if PrivateAddressCheck.private_address?(ip)
+          raise PrivateAddressCheck::PrivateConnectionAttemptedError
+        end
+
+        super(ip, remote_port, local_host, local_port)
+      else
+        super
+      end
+    end
+  end
+end
+
+TCPSocket.send(:prepend, PrivateAddressCheck::TCPSocketExt)

data/lib/private_address_check/version.rb

@@ -0,0 +1,3 @@
+module PrivateAddressCheck
+  VERSION = "0.1.0"
+end

data/test/private_address_check_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class PrivateAddressCheckTest < Minitest::Test
+  def test_private_address_for_public_addresses
+    refute PrivateAddressCheck.private_address?("192.30.253.113")
+    refute PrivateAddressCheck.private_address?("8.8.8.8")
+  end
+
+  def test_private_address_for_rfc1918_addresses
+    assert PrivateAddressCheck.private_address?("10.10.10.2")
+    assert PrivateAddressCheck.private_address?("172.16.2.10")
+    assert PrivateAddressCheck.private_address?("192.168.1.10")
+  end
+
+  def test_private_address_for_rfc4193_addresses
+    assert PrivateAddressCheck.private_address?("fc00::a")
+    assert PrivateAddressCheck.private_address?("fd00::2")
+  end
+
+  def test_private_address_for_loopback_addresses
+    assert PrivateAddressCheck.private_address?("127.0.0.1")
+    assert PrivateAddressCheck.private_address?("127.2.2.2")
+    assert PrivateAddressCheck.private_address?("::1")
+  end
+
+  def test_private_address_for_link_local_addresses
+    assert PrivateAddressCheck.private_address?("169.254.2.5")
+  end
+
+  def test_private_hostname_for_public_addresses
+    refute PrivateAddressCheck.resolves_to_private_address?("github.com")
+    refute PrivateAddressCheck.resolves_to_private_address?("example.com")
+  end
+
+  def test_private_hostname_for_private_addresses
+    assert PrivateAddressCheck.resolves_to_private_address?("localhost")
+  end
+end

data/test/tcpsocket_ext_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+require 'private_address_check/tcpsocket_ext'
+
+class TCPSocketExtTest < Minitest::Test
+  def test_private_address
+    assert_raises PrivateAddressCheck::PrivateConnectionAttemptedError do
+      PrivateAddressCheck.only_public_connections do
+        TCPSocket.new("localhost", 80)
+      end
+    end
+  end
+
+  def test_public_address
+    connected = false
+    PrivateAddressCheck.only_public_connections do
+      TCPSocket.new("example.com", 80)
+      connected = true
+    end
+
+    assert connected
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'private_address_check'
+
+require 'minitest/autorun'

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: private_address_check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Downey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Checks if a IP or hostname would cause a request to a private network
+  (RFC 1918)
+email:
+- jdowney@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/private_address_check.rb
+- lib/private_address_check/tcpsocket_ext.rb
+- lib/private_address_check/version.rb
+- test/private_address_check_test.rb
+- test/tcpsocket_ext_test.rb
+- test/test_helper.rb
+homepage: https://github.com/jtdowney/private_address_check
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Prevent Server Side Request Forgery attacks by checking the destination
+test_files: []