tokenify 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e27be55e1d8b752d55d097c6f1fab24d6aeb855
+  data.tar.gz: 9d5a0d29e5d9e7f80bca5bd10e120f0e18e2a775
+SHA512:
+  metadata.gz: 320f748936b0078dd88740b9dfd252889c466cc8ee347b6d3df3e0e1919b3d45a07981a3d7a0e4ef2e0a75812a38a9768d81113ea054112ab5700aa8e1e7989f
+  data.tar.gz: f0a41cfa058ece9b4bb5226039b0cba5af8278e2130db46c30f78fdd13bdc045f9004e3a353cd4c42d038b037513e6f2701605081659c5cb7bd9ff7faaa08e45

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Florent Monbillard
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 EppO
+
+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,50 @@
+# Tokenify
+
+tokenify is a utility class to generate and decrypt tokens using AES-256 encryption.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tokenify'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tokenify
+
+## Usage
+
+### Generate the token
+
+    # token = Token.new(secret, salt, data_to_encrypt).generate
+    => token object including encrypted token
+    # token.encrypted
+    => encrypted token string 
+    # token.encoded
+    => encrypted token string encoded in URL friendly base64
+
+### Decrypt the token
+
+    # data_to_decrypt = token = Token.new(secret, salt, token.encoded).decrypt
+    => original data in plain text
+    # data_to_decrypt == data_to_encrypt
+    => true
+
+if you don't want to encode your token in base64, you can still decrypt the encrypted version:
+  
+    # data_to_decrypt = token = Token.new(secret, salt, token.encrypted).decrypt(false)
+    => original data in plain text
+    # data_to_decrypt == data_to_encrypt
+    => true
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/tokenify.rb

@@ -0,0 +1,2 @@
+require "tokenify/version"
+require "tokenify/token"

data/lib/tokenify/token.rb

@@ -0,0 +1,41 @@
+require 'openssl'
+require 'base64'
+
+module Tokenify
+  class Token
+    attr_reader :encrypted, :plain
+  
+    def initialize(secret, salt, data)
+      @secret = secret
+      @salt = salt
+      @data = data
+    end
+  
+    def self.cipher(mode, key, data, iv = nil)
+      cipher = OpenSSL::Cipher::Cipher.new('aes-256-cbc').send(mode)
+      cipher.key = Digest::SHA256.hexdigest(key)
+      if iv 
+        cipher.iv = iv
+        cipher.update(data) << cipher.final
+      else
+        cipher.iv = iv = cipher.random_iv
+        iv + cipher.update(data) + cipher.final
+      end
+    end
+
+    def generate
+      @encrypted = Token.cipher(:encrypt, "#{@secret}:#{@salt}", @data)
+      self
+    end
+  
+    def encoded
+      Base64.urlsafe_encode64(@encrypted)
+    end
+
+    def decrypt(is_encoded = true)
+      decoded = is_encoded ? Base64.urlsafe_decode64(@data) : @data
+      iv = decoded.slice!(0,16)
+      @plain = Token.cipher(:decrypt, "#{@secret}:#{@salt}", decoded, iv)
+    end
+  end
+end

data/lib/tokenify/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'openssl'
+require 'base64'
+require 'securerandom'
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'tokenify'

data/spec/tokenify/token_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+module Tokenify
+  describe Token do
+    subject { token_instance }
+    
+    let(:secret) { SecureRandom.hex }
+    let(:salt) { SecureRandom.hex }
+    let(:data) { "this is secret data. Don't let the NSA see this." }
+    
+    let(:token_instance) { Token.new(secret, salt, data) }
+    let(:encrypted_token) { token_instance.generate }
+    
+    describe "#new" do
+      it "creates a new token instance" do
+        expect(subject).to be_kind_of(Token)
+      end
+      
+      it "sets secret instance variable" do
+        expect(subject.instance_variable_get(:@secret)).to eq(secret)
+      end
+      
+      it "sets salt instance variable" do
+        expect(subject.instance_variable_get(:@salt)).to eq(salt)
+      end
+      
+      it "sets data instance variable" do
+        expect(subject.instance_variable_get(:@data)).to eq(data)
+      end
+    end
+    
+    describe "#generate" do
+      let(:another_token) { Token.new(secret, salt, data).generate }
+      
+      it "creates a unique encrypted token" do
+        expect(subject.generate).to_not eq(another_token)
+      end
+    end
+    
+    describe "#encoded" do
+      let(:encoded_token) { encrypted_token.encoded }
+      
+      it "creates a unique encrypted token" do
+        expect(encoded_token).to eq(Base64.urlsafe_encode64(encrypted_token.encrypted))
+      end
+    end
+    
+    describe "#decrypt" do
+      context "with a good key and a good salt" do
+        subject { Token.new(secret, salt, encrypted_token.encoded) }
+      
+        it "decrypts successfully the token" do
+          expect(subject.decrypt).to eq(data)
+        end
+      end
+      
+      context "with a good key and a good salt and a token not encoded" do
+        subject { Token.new(secret, salt, encrypted_token.encrypted) }
+      
+        it "decrypts successfully the token" do
+          expect(subject.decrypt(false)).to eq(data)
+        end
+      end
+      
+      context "with a bad secret key" do
+        subject { Token.new(bad_secret, salt, encrypted_token.encoded) }
+      
+        let(:bad_secret) { SecureRandom.hex }
+        
+        it "raises a decryption error" do
+          expect { subject.decrypt }.to raise_error(OpenSSL::Cipher::CipherError)
+        end
+      end
+      
+      context "with a bad secret salt" do
+        subject { Token.new(secret, bad_salt, encrypted_token.encoded) }
+        
+        let(:bad_salt) { SecureRandom.hex }
+        
+        it "raises a decryption error" do
+          expect { subject.decrypt }.to raise_error(OpenSSL::Cipher::CipherError)
+        end
+      end
+    end
+  end
+end

data/spec/tokenify_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Tokenify do
+  it 'should have a version number' do
+    Tokenify::VERSION.should_not be_nil
+  end
+end

data/tokenify.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tokenify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tokenify"
+  spec.version       = Tokenify::VERSION
+  spec.authors       = [ "Florent Monbillard" ]
+  spec.email         = [ "f.monbillard@gmail.com" ]
+  spec.description   = %q{tokenify is a utility class to generate and decrypt tokens using AES-256 encryption}
+  spec.summary       = %q{Utility class to generate and decrypt tokens}
+  spec.homepage      = "https://github.com/EppO/tokenify"
+  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 "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: tokenify
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Florent Monbillard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-04 00:00:00.000000000 Z
+dependencies:
+- !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: tokenify is a utility class to generate and decrypt tokens using AES-256
+  encryption
+email:
+- f.monbillard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tokenify.rb
+- lib/tokenify/token.rb
+- lib/tokenify/version.rb
+- spec/spec_helper.rb
+- spec/tokenify/token_spec.rb
+- spec/tokenify_spec.rb
+- tokenify.gemspec
+homepage: https://github.com/EppO/tokenify
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Utility class to generate and decrypt tokens
+test_files:
+- spec/spec_helper.rb
+- spec/tokenify/token_spec.rb
+- spec/tokenify_spec.rb