CryptoPAn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9678848491807457dd6e54cae840a125c0b74ff
+  data.tar.gz: 779499268696a5b96e04f9a64aabfc9246019ae4
+SHA512:
+  metadata.gz: 6cc78646ad88c3a60c6dc49c6c7800b88d2c9f92731b9e58bd1b3c287706d264375278e63672763e9f31970748b626a244938f5d4eb0d823de50e325680ceb2b
+  data.tar.gz: 17b23374d9f6664cd390023bcbd8a15d39c3fc7fffc6a1b24fd65ed6d0473cfa23f7fd231064f50d1a8313e4e897cdb4d77e5c8c9c604b222406cbd83ada3f77

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Peter Wood
+
+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 @@
+# Cryptopan
+
+[![Build Status](https://travis-ci.org/pwood/cryptopan.svg?branch=master)](https://travis-ci.org/pwood/cryptopan)
+
+This is a ruby implementation of the Crypto-PAn function providing prefix
+consistency while anonymising IP addresses. This program is based on the paper
+"Prefix-Preserving IP Address Anonymization: Measurement-based
+Security Evaluation and a New Cryptography-based Scheme" written by
+Jun Xu, Jinliang Fan, Mostafa H. Ammar, and Sue B. Moon.  The detailed
+explanation can be found in [Xu2002].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cryptopan'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cryptopan
+
+## Usage
+
+*Note* Currently only supports IPv4 addresses.
+
+```
+2.0.0-p598 :001 > key = SecureRandom.random_bytes(32).bytes
+ => [27, 8, 236, 31, 47, 181, 230, 41, 198, 24, 254, 3, 151, 151, 200, 75, 255, 197, 170, 3, 235, 236, 200, 41, 12, 10, 206, 127, 203, 162, 176, 206]
+2.0.0-p598 :002 > c = CryptoPAn.new(key)
+ => #<CryptoPAn:0x0000000349b350 @key="\e\b\xEC\x1F/\xB5\xE6)\xC6\x18\xFE\x03\x97\x97\xC8K", @pad=[214, 202, 47, 81, 14, 48, 182, 196, 30, 19, 88, 145, 215, 2, 249, 52]>
+2.0.0-p598 :003 > c.anonymise("8.8.8.8")
+ => "50.54.20.240"
+2.0.0-p598 :004 > c.anonymise("8.8.4.4")
+ => "50.54.28.11"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/pwood/cryptopan.
+
+
+## References
+
+[Xu2002] Jun Xu, Jinliang Fan, Mostafa H. Ammar, and Sue B. Moon,
+"Prefix-Preserving IP Address Anonymization: Measurement-based
+Security Evaluation and a New Cryptography-based Scheme", in
+Proceedings of the IEEE International Conference on Network Protocols,
+Paris, 2002.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Contributors
+
+- Keiichi SHIMA, (https://github.com/keiichishima) - README.md and some test data shamelessly appropriated.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cryptopan"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cryptopan.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cryptopan/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "CryptoPAn"
+  spec.version       = CRYPTOPAN_VERSION
+  spec.authors       = ["Peter Wood"]
+  spec.email         = ["peter@alastria.net"]
+
+  spec.summary       = 'Ruby implementation of Crypto-PAn IP Anonymisation.'
+  spec.description   = 'Ruby implementation of Crypto-PAn IP Anonymisation, providing consistency accross prefixes.'
+  spec.homepage      = 'http://github.com/pwood/crypto-pan'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "netaddr", "~> 1.5"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/cryptopan.rb

@@ -0,0 +1,70 @@
+require 'netaddr'
+
+class CryptoPAn
+  def initialize(key)
+    if key.is_a? Array
+      material = key.pack("c*")
+    else
+      material = key
+    end
+
+    raise "Key material is not 32 bytes." if material.length != 32
+
+    @key = material[0..15]
+    unencrypted_pad = material[16..31]
+
+    @pad = encrypt(unencrypted_pad)
+  end
+
+  def anonymise(ip)
+    long_ip = NetAddr.ip_to_i ip
+
+    encrypt_input = @pad.dup
+
+    long_pad = @pad[0].to_i << 24
+    long_pad += @pad[1].to_i << 16
+    long_pad += @pad[2].to_i << 8
+    long_pad += @pad[3].to_i
+
+    result = 0
+
+    32.times do |i|
+      first4bytes_input = long_pad
+
+      if i > 0
+        first4bytes_input = (long_ip >> (32-i)) << (32-i) | ((long_pad << i) & 0xffffffff) >> i
+      end
+
+      encrypt_input[0] = first4bytes_input >> 24
+      encrypt_input[1] = (first4bytes_input << 8) >> 24
+      encrypt_input[2] = (first4bytes_input << 16) >> 24
+      encrypt_input[3] = (first4bytes_input << 24) >> 24
+
+      encrypt_output = encrypt(encrypt_input.pack("c*"))[0]
+
+      result |= (((encrypt_output & 0xff) >> 7) << (31-i))
+    end
+
+    value = result ^ long_ip
+
+    output_value = []
+    output_value[0] = value >> 24 & 0xff
+    output_value[1] = value >> 16 & 0xff
+    output_value[2] = value >> 8 & 0xff
+    output_value[3] = value & 0xff
+
+    output_value.join(".")
+  end
+
+  private
+
+  def encrypt(value)
+    cipher = OpenSSL::Cipher.new('AES-128-ECB')
+    cipher.padding = 0
+    cipher.encrypt
+
+    cipher.key = @key
+
+    (cipher.update(value) + cipher.final).bytes
+  end
+end

data/lib/cryptopan/version.rb

@@ -0,0 +1 @@
+CRYPTOPAN_VERSION = "0.1.0"

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: CryptoPAn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Wood
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: netaddr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: 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: Ruby implementation of Crypto-PAn IP Anonymisation, providing consistency
+  accross prefixes.
+email:
+- peter@alastria.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cryptopan.gemspec
+- lib/cryptopan.rb
+- lib/cryptopan/version.rb
+homepage: http://github.com/pwood/crypto-pan
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby implementation of Crypto-PAn IP Anonymisation.
+test_files: []