obfuscated_identifier 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 847b96d3bdffdbc0780009f69509ca5ed1ed39f3
+  data.tar.gz: 89706dcf8cb664cf5dee90fb62ac5a9a32b185c1
+SHA512:
+  metadata.gz: 26d146b0f8d593250e3fc19772f985bde82fbcee77fb60c9f24cfbbb27f6e07db2ceac71ad58f57e7d3a0f84f70f5a66fc32077062b0f1a3058096083d070cd5
+  data.tar.gz: 808e0a3ee1b77547bbb2611db90b8c40cb491e744b222c1d60c71c4a342f617417321fdf281c6bf334193af61c02c1b98748bd6676c0c929f55ea3234c58217b

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rspec
+vendor/bundle

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steve Smith
+
+MIT License
+
+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,54 @@
+# Obfuscated Identifier
+
+Hide your Rails primary key without the need for token generation and additional index space.
+
+Obfuscate Identifier uses an obfuscation algorithm to generate a unique identifier for your
+existing primary key. As long as you have the key that was used to create the identifier then you
+can get back to the original primary key.
+
+This removes the need for tricks like generating a random number and storing indexing it as the
+primary key is still used to retrieve the object.
+
+There are a huge number of options when creating a system like this here are some of the
+considerations whilst creating this gem:
+
+  * Identifiers must be unique
+  * Identifiers must be reversible
+  * Identifiers should be consistent, repeat generation should create the same output
+  * Patterns within identifiers should not be 'obvious' (sequences should be avoided)
+  * The algorithm should not be overly complex
+  * The algorithm should 'relatively' computationally inexpensive
+
+### Notes:
+
+Obfuscation is not encryption. It's important to note that this isn't really hiding anything,
+if someone really wants to work out your primary key they probably can. This favors simplicity over
+the quality of the identifier generated.
+
+This was a very quick stab at an implementation. Pull requests and comments are hugely appreciated!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'obfusicated_identifier'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install obfusicated_identifier
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/obfuscated_identifier/version.rb

@@ -0,0 +1,3 @@
+module ObfuscatedIdentifier
+  VERSION = "0.0.1"
+end

data/lib/obfuscated_identifier.rb

@@ -0,0 +1,57 @@
+require "active_support/concern"
+require "obfuscated_identifier/version"
+
+module ObfuscatedIdentifier
+  extend ActiveSupport::Concern
+
+  def to_param
+    self.class.to_identifier(id)
+  end
+
+  module ClassMethods
+    attr_reader :identifier_length
+
+    def obfusicate_identifier(pattern, offset, length = 16)
+      @identifier_pattern = pattern
+      @identifier_offset = offset
+      @identifier_length = 16
+    end
+
+    def generate_identifier_pattern
+      %w{0 1 2 3 4 5 6 7 8 9 a b c d e}.shuffle
+    end
+
+    def from_param(value)
+      id = from_identifier(value)
+      find_by_id!(id)
+    end
+
+    def from_identifier(value)
+      counts = value.each_char.map { |c| @identifier_pattern.index(c.to_s) }.reverse
+
+      numbers = counts[0..-2].each_with_index.map do |count, index|
+        ((count - counts[index + 1]) - @identifier_offset) % @identifier_pattern.length
+      end + [(counts[-1] - @identifier_offset) % @identifier_pattern.length]
+
+      numbers.join('').to_i
+    end
+
+    def to_identifier(value)
+      padded_string = pad_number(value)
+
+      count = 0
+      counts = padded_string.reverse.each_char.map do |c|
+        count += (c.to_i + @identifier_offset)
+        count = count % @identifier_pattern.length
+      end
+
+      counts.map { |c| @identifier_pattern[c] }.join('')
+    end
+
+    protected
+
+    def pad_number(value)
+      sprintf("%0#{@identifier_length}d", value)
+    end
+  end
+end

data/obfuscated_identifier.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'obfuscated_identifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "obfuscated_identifier"
+  spec.version       = ObfuscatedIdentifier::VERSION
+  spec.authors       = ["Steve Smith"]
+  spec.email         = ["github@scsworld.co.uk"]
+  spec.description   = %q{Obfuscate your Rails primary key}
+  spec.summary       = %q{Hide your Rails primary key without the need for token generation and additional index space.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "activesupport", "~> 4.0.0"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/obfuscated_identifier_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+require 'obfuscated_identifier'
+
+class ObfuscatedIdentifierClass
+  include ObfuscatedIdentifier
+
+  obfusicate_identifier(
+    %w{2 7 3 e 6 9 1 8 b c 5 a 4 d 0},
+    7,
+    16
+  )
+end
+
+describe ObfuscatedIdentifier do
+  let(:klass) { ObfuscatedIdentifierClass }
+  let(:postgres_max_identifier) { (2**(4 * 8 - 1) - 1) }
+  let(:example_identifier) { 'b2801d946ae53c7b' }
+  let(:example_number) { 1 }
+
+  describe '#pad_number' do
+    it 'returns a string' do
+      expect(klass.send(:pad_number, 1)).to be_instance_of(String)
+    end
+
+    context 'when number is 1' do
+      it 'returns the number padded with 0s' do
+        expect(klass.send(:pad_number, 1)).to eq('0000000000000001')
+      end
+    end
+
+    context 'when number is greater than the padding' do
+      it 'returns the number as a string' do
+        expect(klass.send(:pad_number, 999_999_999_999_999_999)).to eq('999999999999999999')
+      end
+    end
+
+    context 'when number is the max identifier postgres int type allows' do
+      it 'returns the number as a string' do
+        expect(klass.send(:pad_number, postgres_max_identifier)).to eq('0000002147483647')
+      end
+    end
+  end
+
+  describe '#to_identifier' do
+    it 'returns a string' do
+      expect(klass.to_identifier(1)).to be_instance_of(String)
+    end
+
+    it 'returns a value with length LENGTH' do
+      expect(klass.to_identifier(1).length).to eq(klass.identifier_length)
+    end
+
+    it 'returns the expect identifier' do
+      expect(klass.to_identifier(1)).to eq(example_identifier)
+    end
+
+    it 'creates a reversable identifier' do
+      100.times do
+        number = rand(0..postgres_max_identifier)
+        identifier = klass.to_identifier(number)
+        expect(klass.from_identifier(identifier)).to eq(number)
+      end
+    end
+  end
+
+  describe '#from_identifier' do
+    it 'returns a number' do
+      expect(klass.from_identifier(example_identifier)).to be_instance_of(Fixnum)
+    end
+
+    it 'returns the expected integer' do
+      expect(klass.from_identifier(example_identifier)).to eq(example_number)
+    end
+  end
+
+  describe 'generate_identifier_pattern' do
+    it 'returns 0-9a-f' do
+      klass.generate_identifier_pattern.each do |item|
+        expect(item).to match(/[a-f 0-9]/)
+      end
+    end
+
+    it 'returns each item only once' do
+      output = klass.generate_identifier_pattern
+      expect(output.uniq).to eq(output)
+    end
+
+    it 'generates a different pattern each time' do
+      output = klass.generate_identifier_pattern
+      expect(klass.generate_identifier_pattern).not_to eq(output)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: obfuscated_identifier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steve Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Obfuscate your Rails primary key
+email:
+- github@scsworld.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/obfuscated_identifier.rb
+- lib/obfuscated_identifier/version.rb
+- obfuscated_identifier.gemspec
+- spec/obfuscated_identifier_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Hide your Rails primary key without the need for token generation and additional
+  index space.
+test_files:
+- spec/obfuscated_identifier_spec.rb
+- spec/spec_helper.rb