ip_anonymizer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dca65ff3aed9d29044a1e20925670a110aff00a527071991a5bfa9ba5cb9b269
-  data.tar.gz: ed6c97bd345eae2ac1ecabe9e1cb8db434d79a5df4dc99cdd2e561de91a42db7
+  metadata.gz: f454e201a3d9c2f4289e2b0c6e367bffbed093f74dbcc6feeb1325ca39aa7a84
+  data.tar.gz: 312f1dcaf7e753febe323c9aed56b5847d1c1bfba84a2231fa79b73e34d8ec5a
 SHA512:
-  metadata.gz: 565e3cbbe4d119a859de314d7b658f810ba53e513bb1b92f54652ba2baa936b0dcba8ac83acc761b32b98a04ca62b3b52b192d7ba0a597027a18741c46207fa8
-  data.tar.gz: 9321631e81f1510de578f2b9298f5c1998270e0ee6c938c559ca2309cc8a61d9f55e997187dee36cc61c18c6a167dda9b2754332138e2e471da06ea8ad95b60e
+  metadata.gz: 8e5ad0bba1c72b3753e4b9218af6139df2cc0833cb3334e7b508740771ae6d3e3201773674ee2442d242807bf943cd46d93e75ce85271fb8a13fb7e499245ea0
+  data.tar.gz: e800b290819f4854464d21bd73451a2a5c39ea5598155267323c34a59552f3efb1139eb4881b2a2e952f08b4435c07e2113ababf85061da9e399d9d89365fa38

data/CHANGELOG.md

@@ -1,3 +1,11 @@
-## 0.1.0
+## 0.2.0 (2022-10-09)
+
+- Dropped support for Ruby < 2.7
+
+## 0.1.1 (2018-05-11)
+
+- Better performance when IP not needed
+
+## 0.1.0 (2018-05-05)
 
 - First release

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Andrew
+Copyright (c) 2018-2022 Andrew Kane
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,15 +1,19 @@
 # IP Anonymizer
 
-:earth_americas: IP address anonymizer for Ruby
+:earth_americas: IP address anonymizer for Ruby and Rails
 
-Works with IPv4 and IPv6, and includes middleware for Rails
+Works with IPv4 and IPv6
+
+Designed to help with [GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation) compliance
+
+[![Build Status](https://github.com/ankane/ip_anonymizer/workflows/build/badge.svg?branch=master)](https://github.com/ankane/ip_anonymizer/actions)
 
 ## Getting Started
 
 Add these lines to your application’s Gemfile:
 
 ```ruby
-gem 'ip_anonymizer'
+gem "ip_anonymizer"
 ```
 
 There are two strategies for anonymizing IPs.
@@ -18,8 +22,8 @@ There are two strategies for anonymizing IPs.
 
 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
+- For IPv4, set the last octet to 0
+- For IPv6, set the last 80 bits to zeros
 
 ```ruby
 IpAnonymizer.mask_ip("8.8.4.4")
@@ -29,7 +33,7 @@ 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.
+An advantange of this approach is geocoding will still work, only with slightly less accuracy. A potential disadvantage is different IPs will have the same mask (`8.8.4.4` and `8.8.4.5` both become `8.8.4.0`).
 
 ### Hashing
 
@@ -43,7 +47,13 @@ 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.
+An advantage of this approach is different IPs will have different hashes (with the exception of collisions).
+
+Make sure the key is kept secret and at least 30 random characters. Otherwise, a rainbow table can be constructed. You can generate a good key with:
+
+```ruby
+SecureRandom.hex(32)
+```
 
 ## Rails
 
@@ -61,6 +71,10 @@ For hashing, use:
 config.middleware.insert_after ActionDispatch::RemoteIp, IpAnonymizer::HashIp, key: "secret"
 ```
 
+## Related Projects
+
+- [Logstop](https://github.com/ankane/logstop) - Keep personally identifiable information (PII) out of your logs
+
 ## History
 
 View the [changelog](https://github.com/ankane/ip_anonymizer/blob/master/CHANGELOG.md)
@@ -74,11 +88,11 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Write, clarify, or fix documentation
 - Suggest or add new features
 
-To get started with development and testing:
+To get started with development:
 
 ```sh
 git clone https://github.com/ankane/ip_anonymizer.git
 cd ip_anonymizer
 bundle install
-rake test
+bundle exec rake test
 ```

data/lib/ip_anonymizer/hash_ip.rb

@@ -7,9 +7,20 @@ module IpAnonymizer
 
     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)
+      # get header directly to preserve ActionDispatch::RemoteIp lazy loading
+      req.remote_ip = GetIp.new(req.get_header("action_dispatch.remote_ip".freeze), @key)
       @app.call(req.env)
     end
+
+    class GetIp
+      def initialize(remote_ip, key)
+        @remote_ip = remote_ip
+        @key = key
+      end
+
+      def to_s
+        @ip ||= IpAnonymizer.hash_ip(@remote_ip, key: @key)
+      end
+    end
   end
 end

data/lib/ip_anonymizer/mask_ip.rb

@@ -6,9 +6,19 @@ module IpAnonymizer
 
     def call(env)
       req = ActionDispatch::Request.new(env)
-      # TODO lazy load, like ActionDispatch::RemoteIp
-      req.remote_ip = IpAnonymizer.mask_ip(req.remote_ip)
+      # get header directly to preserve ActionDispatch::RemoteIp lazy loading
+      req.remote_ip = GetIp.new(req.get_header("action_dispatch.remote_ip".freeze))
       @app.call(req.env)
     end
+
+    class GetIp
+      def initialize(remote_ip)
+        @remote_ip = remote_ip
+      end
+
+      def to_s
+        @ip ||= IpAnonymizer.mask_ip(@remote_ip)
+      end
+    end
   end
 end

data/lib/ip_anonymizer/version.rb

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

data/lib/ip_anonymizer.rb

@@ -1,13 +1,15 @@
+# stdlib
 require "ipaddr"
 require "openssl"
 
+# modules
 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)
+    addr = IPAddr.new(ip.to_s)
     if addr.ipv4?
       # set last octet to 0
       addr.mask(24).to_s
@@ -18,7 +20,7 @@ module IpAnonymizer
   end
 
   def self.hash_ip(ip, key:, iterations: 1)
-    addr = IPAddr.new(ip)
+    addr = IPAddr.new(ip.to_s)
     key_len = addr.ipv4? ? 4 : 16
     family = addr.ipv4? ? Socket::AF_INET : Socket::AF_INET6
 

metadata

@@ -1,87 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: ip_anonymizer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 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
+date: 2022-10-10 00:00:00.000000000 Z
+dependencies: []
+description:
+email: andrew@ankane.org
 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
@@ -90,7 +27,7 @@ homepage: https://github.com/ankane/ip_anonymizer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,16 +35,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
-summary: IP address anonymizer for Ruby
+summary: IP address anonymizer for Ruby and Rails
 test_files: []

data/.gitignore

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

data/.travis.yml

@@ -1,11 +0,0 @@
-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/Gemfile

@@ -1,6 +0,0 @@
-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

@@ -1,24 +0,0 @@
-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/Rakefile

@@ -1,19 +0,0 @@
-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

@@ -1,29 +0,0 @@
-
-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