Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ankane/ip_anonymizer
IP address anonymizer for Ruby and Rails
https://github.com/ankane/ip_anonymizer
Last synced: 5 days ago
JSON representation
IP address anonymizer for Ruby and Rails
- Host: GitHub
- URL: https://github.com/ankane/ip_anonymizer
- Owner: ankane
- License: mit
- Created: 2018-05-06T01:34:40.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-27T04:01:50.000Z (3 months ago)
- Last Synced: 2024-10-23T11:12:57.652Z (11 days ago)
- Language: Ruby
- Homepage:
- Size: 27.3 KB
- Stars: 98
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# IP Anonymizer
:earth_americas: IP address anonymizer for Ruby and Rails
Works with IPv4 and IPv6
Designed to help with [GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation) compliance
[](https://github.com/ankane/ip_anonymizer/actions)
## 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, set the last octet to 0
- For IPv6, set the last 80 bits 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. 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
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"
```
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
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"
```
## 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)
## 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:
```sh
git clone https://github.com/ankane/ip_anonymizer.git
cd ip_anonymizer
bundle install
bundle exec rake test
```