fernet 0.0.1

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Harold Giménez
+
+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,34 @@
+# Fernet
+
+Fernet allows you to easily generate and verify HMAC based authentication tokens for issuing API requests between remote servers.
+
+![Fernet](http://f.cl.ly/items/2d0P3d26271O3p2v253u/photo.JPG)
+
+Fernet is usually served as a *digestif* after a meal but may also be served with coffee and espresso or mixed into coffee and espresso drinks.
+
+Fernet about it!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fernet'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fernet
+
+## Usage
+
+For now, see [spec/fernet_spec.rb](https://github.com/hgimenez/fernet/blob/master/spec/fernet_spec.rb).
+
+I'll flesh this out further soon. Sorry.
+
+## License
+
+Valcro is copyright (c) Harold Giménez and is released under the terms of the
+MIT License found in the LICENSE file.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/fernet.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/fernet/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Harold Giménez"]
+  gem.email         = ["harold.gimenez@gmail.com"]
+  gem.description   = %q{Delicious HMAC Digest[if] authentication}
+  gem.summary       = %q{Easily generate and verify HMAC based authentication tokens}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "fernet"
+  gem.require_paths = ["lib"]
+  gem.version       = Fernet::VERSION
+
+  gem.add_development_dependency "rspec"
+end

data/lib/fernet.rb

@@ -0,0 +1,13 @@
+require 'fernet/version'
+require 'fernet/generator'
+require 'fernet/verifier'
+
+module Fernet
+  def self.generate(secret, &block)
+    Generator.new(secret).generate(&block)
+  end
+
+  def self.verify(secret, token, &block)
+    Verifier.new(secret).verify_token(token, &block)
+  end
+end

data/lib/fernet/generator.rb

@@ -0,0 +1,24 @@
+require 'base64'
+require 'json'
+require 'openssl'
+require 'date'
+
+module Fernet
+  class Generator
+    attr_reader :secret
+    attr_accessor :data
+
+    def initialize(secret)
+      @secret = secret
+    end
+
+    def generate
+      yield self
+      data.merge!(issued_at: DateTime.now)
+
+      mac = OpenSSL::HMAC.hexdigest('sha256', JSON.dump(data), secret)
+      Base64.urlsafe_encode64(JSON.dump(data.merge(signature: mac)))
+    end
+
+  end
+end

data/lib/fernet/verifier.rb

@@ -0,0 +1,41 @@
+require 'base64'
+require 'json'
+require 'openssl'
+require 'date'
+
+module Fernet
+  class Verifier
+
+    attr_reader :secret, :token, :data
+    attr_writer :seconds_valid
+
+    def initialize(secret)
+      @secret        = secret
+    end
+
+    def verify_token(token)
+      @token = token
+      deconstruct
+
+      custom_verification = yield self
+
+      signatures_match? && token_recent_enough? && custom_verification
+    end
+
+    private
+
+    def deconstruct
+      @data               = JSON.parse(Base64.decode64(token))
+      @received_signature = @data.delete('signature')
+      @regenerated_mac    = OpenSSL::HMAC.hexdigest('sha256', JSON.dump(@data), secret)
+    end
+
+    def token_recent_enough?
+      DateTime.parse(data['issued_at']) > (DateTime.now - 60)
+    end
+
+    def signatures_match?
+      @regenerated_mac == @received_signature
+    end
+  end
+end

data/lib/fernet/version.rb

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

data/spec/fernet_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'fernet'
+
+describe Fernet do
+  let(:token_data) do
+    { email: 'harold@heroku.com', id: '123', arbitrary: 'data' }
+  end
+
+  let(:secret) { 'sekrit123' }
+
+  it 'can verify tokens it generates' do
+    token = Fernet.generate(secret) do |generator|
+      generator.data = token_data
+    end
+
+    Fernet.verify(secret, token) do |verifier|
+      verifier.data['email'] == 'harold@heroku.com'
+    end.should be_true
+  end
+
+  it 'fails with a bad secret' do
+    token = Fernet.generate(secret) do |generator|
+      generator.data = token_data
+    end
+
+    Fernet.verify('bad', token) do |verifier|
+      verifier.data['email'] == 'harold@heroku.com'
+    end.should be_false
+  end
+
+  it 'fails with a bad custom verification' do
+    token = Fernet.generate(secret) do |generator|
+      generator.data = token_data
+    end
+
+    Fernet.verify('bad', token) do |verifier|
+      verifier.data['email'] == 'harold@gmail.com'
+    end.should be_false
+  end
+
+  it 'fails if the token is too old' do
+    token = Fernet.generate(secret) do |generator|
+      generator.data = token_data
+    end
+
+    Fernet.verify('bad', token) do |verifier|
+      verifier.seconds_valid = 0
+    end.should be_false
+  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,71 @@
+--- !ruby/object:Gem::Specification
+name: fernet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Harold Giménez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70116561753260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70116561753260
+description: Delicious HMAC Digest[if] authentication
+email:
+- harold.gimenez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fernet.gemspec
+- lib/fernet.rb
+- lib/fernet/generator.rb
+- lib/fernet/verifier.rb
+- lib/fernet/version.rb
+- spec/fernet_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Easily generate and verify HMAC based authentication tokens
+test_files:
+- spec/fernet_spec.rb
+- spec/spec_helper.rb