ip_anonymizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dca65ff3aed9d29044a1e20925670a110aff00a527071991a5bfa9ba5cb9b269
+  data.tar.gz: ed6c97bd345eae2ac1ecabe9e1cb8db434d79a5df4dc99cdd2e561de91a42db7
+SHA512:
+  metadata.gz: 565e3cbbe4d119a859de314d7b658f810ba53e513bb1b92f54652ba2baa936b0dcba8ac83acc761b32b98a04ca62b3b52b192d7ba0a597027a18741c46207fa8
+  data.tar.gz: 9321631e81f1510de578f2b9298f5c1998270e0ee6c938c559ca2309cc8a61d9f55e997187dee36cc61c18c6a167dda9b2754332138e2e471da06ea8ad95b60e

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm: 2.5.1
+gemfile:
+  - Gemfile
+sudo: false
+before_install: gem install bundler
+script: bundle exec rake test
+notifications:
+  email:
+    on_success: never
+    on_failure: change

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ip_anonymizer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    ip_anonymizer (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    benchmark-ips (2.7.2)
+    minitest (5.11.3)
+    rake (12.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  benchmark-ips
+  bundler
+  ip_anonymizer!
+  minitest
+  rake
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Andrew
+
+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,84 @@
+# IP Anonymizer
+
+:earth_americas: IP address anonymizer for Ruby
+
+Works with IPv4 and IPv6, and includes middleware for Rails
+
+## Getting Started
+
+Add these lines to your application’s Gemfile:
+
+```ruby
+gem 'ip_anonymizer'
+```
+
+There are two strategies for anonymizing IPs.
+
+### Masking
+
+This is the approach [Google Analytics uses for IP anonymization](https://support.google.com/analytics/answer/2763052):
+
+- For IPv4, the last octet is set to 0
+- For IPv6, the last 80 bits are set to zeros
+
+```ruby
+IpAnonymizer.mask_ip("8.8.4.4")
+# => "8.8.4.0"
+
+IpAnonymizer.mask_ip("2001:4860:4860:0:0:0:0:8844")
+# => "2001:4860:4860::"
+```
+
+An advantange of this approach is geocoding will still work, only with slightly less accuracy.
+
+### Hashing
+
+Transform IP addresses with a keyed hash function (PBKDF2-HMAC-SHA256).
+
+```ruby
+IpAnonymizer.hash_ip("8.8.4.4", key: "secret")
+# => "6.128.151.207"
+
+IpAnonymizer.hash_ip("2001:4860:4860:0:0:0:0:8844", key: "secret")
+# => "f6e4:a4fe:32dc:2f39:3e47:84cc:e85e:865c"
+```
+
+Be sure to keep the key secret, or else a rainbow table can be constructed.
+
+## Rails
+
+Automatically anonymize `request.remote_ip` in Rails.
+
+For masking, add to `config/application.rb`:
+
+```ruby
+config.middleware.insert_after ActionDispatch::RemoteIp, IpAnonymizer::MaskIp
+```
+
+For hashing, use:
+
+```ruby
+config.middleware.insert_after ActionDispatch::RemoteIp, IpAnonymizer::HashIp, key: "secret"
+```
+
+## History
+
+View the [changelog](https://github.com/ankane/ip_anonymizer/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/ip_anonymizer/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/ip_anonymizer/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/ip_anonymizer.git
+cd ip_anonymizer
+bundle install
+rake test
+```

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "benchmark/ips"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test
+
+task :benchmark do
+  require "ip_anonymizer"
+  Benchmark.ips do |x|
+    x.report("mask_ip") { IpAnonymizer.mask_ip("8.8.4.4") }
+    x.report("hash_ip") { IpAnonymizer.hash_ip("8.8.4.4", key: "secret") }
+  end
+end

data/ip_anonymizer.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ip_anonymizer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ip_anonymizer"
+  spec.version       = IpAnonymizer::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+
+  spec.summary       = "IP address anonymizer for Ruby"
+  spec.homepage      = "https://github.com/ankane/ip_anonymizer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.2.0"
+
+  spec.add_development_dependency "benchmark-ips"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+end

data/lib/ip_anonymizer.rb

@@ -0,0 +1,28 @@
+require "ipaddr"
+require "openssl"
+
+require "ip_anonymizer/hash_ip"
+require "ip_anonymizer/mask_ip"
+require "ip_anonymizer/version"
+
+module IpAnonymizer
+  def self.mask_ip(ip)
+    addr = IPAddr.new(ip)
+    if addr.ipv4?
+      # set last octet to 0
+      addr.mask(24).to_s
+    else
+      # set last 80 bits to zeros
+      addr.mask(48).to_s
+    end
+  end
+
+  def self.hash_ip(ip, key:, iterations: 1)
+    addr = IPAddr.new(ip)
+    key_len = addr.ipv4? ? 4 : 16
+    family = addr.ipv4? ? Socket::AF_INET : Socket::AF_INET6
+
+    keyed_hash = OpenSSL::PKCS5.pbkdf2_hmac(addr.to_s, key, iterations, key_len, "sha256")
+    IPAddr.new(keyed_hash.bytes.inject {|a, b| (a << 8) + b }, family).to_s
+  end
+end

data/lib/ip_anonymizer/hash_ip.rb

@@ -0,0 +1,15 @@
+module IpAnonymizer
+  class HashIp
+    def initialize(app, key:)
+      @app = app
+      @key = key
+    end
+
+    def call(env)
+      req = ActionDispatch::Request.new(env)
+      # TODO lazy load, like ActionDispatch::RemoteIp
+      req.remote_ip = IpAnonymizer.hash_ip(req.remote_ip, key: @key)
+      @app.call(req.env)
+    end
+  end
+end

data/lib/ip_anonymizer/mask_ip.rb

@@ -0,0 +1,14 @@
+module IpAnonymizer
+  class MaskIp
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      req = ActionDispatch::Request.new(env)
+      # TODO lazy load, like ActionDispatch::RemoteIp
+      req.remote_ip = IpAnonymizer.mask_ip(req.remote_ip)
+      @app.call(req.env)
+    end
+  end
+end

data/lib/ip_anonymizer/version.rb

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

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: ip_anonymizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ip_anonymizer.gemspec
+- lib/ip_anonymizer.rb
+- lib/ip_anonymizer/hash_ip.rb
+- lib/ip_anonymizer/mask_ip.rb
+- lib/ip_anonymizer/version.rb
+homepage: https://github.com/ankane/ip_anonymizer
+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.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: IP address anonymizer for Ruby
+test_files: []