openid-store-redis 0.1.0

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/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rally Software Development Corp
+
+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,52 @@
+# OpenID::Store::Redis [![Build Status](https://travis-ci.org/RallySoftware/openid-store-redis.png)](https://travis-ci.org/RallySoftware/openid-store-redis)
+
+A Redis storage backend for ruby-openid
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'openid-store-redis'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openid-store-redis
+
+## Usage
+
+Set up OpenID consumer (or provider) using Redis store
+
+```ruby
+redis = Redis.new
+store = OpenID::Store::Redis.new(redis)
+@consumer = OpenID::Consumer.new(session, store)
+```
+
+If you're using Omniauth
+
+```ruby
+use OmniAuth::Builder do
+  provider :open_id, :store => OpenID::Store::Redis.new(Redis.new)
+end
+```
+
+Redis store defaults to ```Redis.current``` when Redis client is not given as
+argument to store.
+
+## 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
+
+## Copyright
+
+© Rally Software Development Corp. Released under MIT license, see
+[LICENSE](https://github.com/RallySoftware/openid-redis-store/blob/master/LICENSE.txt)
+for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+

data/lib/openid/store/redis/version.rb

@@ -0,0 +1,5 @@
+module OpenID
+  module Store
+    REDIS_VERSION = "0.1.0"
+  end
+end

data/lib/openid/store/redis.rb

@@ -0,0 +1,90 @@
+require "openid/store/redis/version"
+require "openid/store/interface"
+require "redis"
+
+module OpenID
+  module Store
+    class Redis < Interface
+      attr_reader :prefix
+      def initialize(client = ::Redis.current, prefix = "openid-store")
+        @redis = client
+        @prefix = prefix
+      end
+
+      # Store an Association in Redis
+      def store_association(server_url, association)
+        serialized = serialize(association)
+        [nil, association.handle].each do |handle|
+          key = assoc_key(server_url, handle)
+          @redis.setex(key, association.lifetime, serialized)
+        end
+      end
+
+      # Fetch and deserialize an Association object from Redis
+      def get_association(server_url, handle=nil)
+        if serialized = @redis.get(assoc_key(server_url, handle))
+          deserialize(serialized)
+        else
+          nil
+        end
+      end
+
+      # Remove matching association from Redis
+      #
+      # return true when data is removed, otherwise false
+      def remove_association(url, handle)
+        deleted = @redis.del(assoc_key(url, handle))
+        assoc = get_association(url)
+        if assoc && assoc.handle == handle
+          deleted + @redis.del(assoc_key(url))
+        else
+          deleted
+        end > 0
+      end
+
+
+      # Use nonce and store that it has been used in Redis temporarily
+      #
+      # Returns true if nonce has not been used before and is still usable,
+      def use_nonce(server_url, timestamp, salt)
+        return false if (timestamp - Time.now.to_i).abs > Nonce.skew
+        ts = timestamp.to_s # base 10 seconds since epoch
+        nonce_key = prefix + ':n:' + server_url + ':' + ts + ':' + salt
+        if @redis.setnx(nonce_key, '')
+          @redis.expire(nonce_key, Nonce.skew + 5)
+          true
+        else
+          false
+        end
+      end
+
+      def cleanup_nonces
+      end
+
+      def cleanup
+      end
+
+      def cleanup_associations
+      end
+
+      private
+
+      def assoc_key(server_url, assoc_handle=nil)
+        key = prefix + ':a:' + server_url
+        if assoc_handle
+          key + ':' + assoc_handle
+        else
+          key
+        end
+      end
+
+      def serialize(assoc)
+        Marshal.dump(assoc)
+      end
+
+      def deserialize(assoc_str)
+        Marshal.load(assoc_str)
+      end
+    end
+  end
+end

data/lib/openid-store-redis.rb

@@ -0,0 +1 @@
+require 'openid/store/redis'

data/openid-store-redis.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'openid/store/redis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "openid-store-redis"
+  spec.version       = OpenID::Store::REDIS_VERSION
+  spec.authors       = ["Ville Lautanala"]
+  spec.email         = ["lautis@gmail.com"]
+  spec.description   = %q{Use Redis to store OpenID associations and nonces with ruby-openid}
+  spec.summary       = %q{A Redis storage backend for ruby-openid}
+  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_runtime_dependency "ruby-openid", ">= 2.1.7"
+  spec.add_runtime_dependency "redis", "~> 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13"
+  spec.add_development_dependency "mock_redis"
+end

data/spec/openid/store/redis_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+require 'securerandom'
+require 'openid/association'
+require 'openid/store/nonce'
+Nonce = OpenID::Nonce
+
+describe OpenID::Store::Redis do
+  let(:redis) { MockRedis.new }
+  let(:url) { 'https://example.com/' + SecureRandom.base64 }
+  let(:handle) { SecureRandom.base64 }
+
+  subject { OpenID::Store::Redis.new(redis) }
+
+  describe '#get_association' do
+    it 'returns nil when association does not exist' do
+      subject.get_association(url).should be_nil
+    end
+
+    it 'returns nil when association with handle does not exist' do
+      server_url = 'test/url'
+      handle = 'test/handle'
+      subject.get_association(url, handle).should be_nil
+    end
+
+    it 'returns association when exists' do
+      assn = association(0)
+      redis.set('openid-store:a:' + url, Marshal.dump(assn))
+      subject.get_association(url).handle.should eql assn.handle
+      subject.get_association(url).secret.should eql assn.secret
+    end
+
+    it 'returns association with handle' do
+      assoc = association(0)
+      redis.set('openid-store:a:' + url + ":" + handle, Marshal.dump(assoc))
+      subject.get_association(url, handle).handle.should eql assoc.handle
+      subject.get_association(url, handle).secret.should eql assoc.secret
+    end
+  end
+
+  describe '#store_association' do
+    it 'stores association to redis' do
+      assoc = association(0)
+      serialized = Marshal.dump(assoc)
+      subject.store_association(url, assoc)
+      redis.get('openid-store:a:' + url).should eql(serialized)
+    end
+
+    it 'stores with handle' do
+      assoc = association(0)
+      serialized = Marshal.dump(assoc)
+      subject.store_association(url, assoc)
+      redis.get('openid-store:a:' + url + ':' + assoc.handle).should eql(serialized)
+    end
+
+    it 'expires the association after lifetime' do
+      assoc = association(0)
+      subject.store_association(url, assoc)
+      ttl = redis.ttl('openid-store:a:' + url + ':' + assoc.handle)
+      ttl.should eql(assoc.lifetime)
+    end
+  end
+
+  describe '#remove_association' do
+    let(:assoc) { association(0) }
+    before :each do
+      redis.set('openid-store:a:' + url + ":" + assoc.handle, Marshal.dump(assoc))
+      redis.set('openid-store:a:' + url, Marshal.dump(assoc))
+    end
+
+    it 'removes association from redis' do
+      subject.remove_association(url, assoc.handle)
+      redis.get('openid-store:a:' + url + ":" + assoc.handle).should be_nil
+      redis.get('openid-store:a:' + url).should be_nil
+    end
+
+    it 'does not remove when handles do not match' do
+      subject.remove_association(url, assoc.handle  + 'fail')
+      redis.get('openid-store:a:' + url + ":" + assoc.handle).should_not be_nil
+    end
+
+    it 'returns true when data is removed' do
+      subject.remove_association(url, assoc.handle).should be(true)
+    end
+
+    it 'returns false when data is not removed' do
+      subject.remove_association(url + 'fail', assoc.handle).should be(false)
+    end
+  end
+
+  describe '#use_nonce' do
+    it 'allows nonce to be used once' do
+      timestamp, salt = Nonce::split_nonce(Nonce::mk_nonce)
+      subject.use_nonce(url, timestamp.to_i, salt).should be_true
+    end
+
+    it 'does not allow multiple uses of nonce' do
+      timestamp, salt = Nonce::split_nonce(Nonce::mk_nonce)
+      subject.use_nonce(url, timestamp.to_i, salt)
+      subject.use_nonce(url, timestamp.to_i, salt).should be_false
+    end
+
+    it 'creates nonce if time is within skew' do
+      now = Time.now
+      timestamp = now.to_f + OpenID::Nonce.skew - 1
+      subject.use_nonce(url, timestamp, 'salt').should be_true
+    end
+
+    it 'returns false if time is beyond skew' do
+      now = Time.now
+      timestamp = now.to_f + OpenID::Nonce.skew + 1
+      subject.use_nonce(url, timestamp, 'salt').should be_false
+    end
+
+    it 'removes nonce from redis after skew timeout' do
+      ts, salt = Nonce::split_nonce(Nonce::mk_nonce)
+      subject.use_nonce(url, ts.to_i, salt)
+      ttl = redis.ttl('openid-store:n:' + url + ':' + ts.to_s + ':' + salt)
+      ttl.should eql(OpenID::Nonce.skew + 5)
+    end
+  end
+end
+
+def association(issued, lifetime=600)
+   OpenID::Association.new(SecureRandom.hex(128),
+                           SecureRandom.base64(20),
+                           Time.now + issued,
+                           lifetime,
+                           'HMAC-SHA1')
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+require "openid-store-redis"
+require "rspec"
+require "mock_redis"
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: openid-store-redis
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors:
+- Ville Lautanala
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.7
+  name: ruby-openid
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.7
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: redis
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  name: bundler
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  name: rspec
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: mock_redis
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+description: Use Redis to store OpenID associations and nonces with ruby-openid
+email:
+- lautis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/openid-store-redis.rb
+- lib/openid/store/redis.rb
+- lib/openid/store/redis/version.rb
+- openid-store-redis.gemspec
+- spec/openid/store/redis_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 881735339377992324
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 881735339377992324
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Redis storage backend for ruby-openid
+test_files:
+- spec/openid/store/redis_spec.rb
+- spec/spec_helper.rb