oo_auth 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5200d37778ac2220a1003d8551caf8c12d69fbd
-  data.tar.gz: 5a10c0b125e737c49ca54ae444f9205bb06671e3
+  metadata.gz: 2c1f195a813ed4592a12273dafcf4421832150ef
+  data.tar.gz: ac91fdf7df2ae7900608a9ff10324ce672989c26
 SHA512:
-  metadata.gz: d4f0c1423e3e41f26ff2bce7acdb83cb42a7b623732385d7259a0cb88f722eb8b8779b2481aded7f454c197e2f47c94d4b00ef88fa39b83ade09323e1399a6ea
-  data.tar.gz: 32d8a1dc341e408ca95fcb50fec6fa58a7621309ea7c95de0286c9a64013b08e5b0315ac5f4f236e6e007e9567fbf6b7e941d93867d306932070dd85d6fd9444
+  metadata.gz: 119fedaad30ed7871268feae52e1eba5f5946482dfd6ba8589ca40abc5402b5443ed1a0ed6db527d3f450c5ac607b7c80f67f220909db38da102eb0868dbaf40
+  data.tar.gz: 26dd994008db1eb664dbc754c41e10225226a057aa9a1540af5d3b0c34c31b89e9e4607bbf870f7b04bf04f05388245518f0fc27c7f7c39416a9e53bc23753c2

data/README.md

@@ -26,32 +26,6 @@ In your Gemfile:
 gem 'oo_auth'
 ```
 
-## Prerequisites
-
-OoAuth requires your application to provide stores for authorization tokens 
-and OAuth nonces.
-
-OoAuth stores can be simple lambdas or regular ruby objects.
-
-### Authorization store
-
-The authorization store should return an instance of ```OoAuth::Credentials```.
-It can either be a lambda or an object implementing the `authorization` method.
-
-```ruby
-# your own implementation in SomeClass model
-OoAuth.authorization_store = lambda { |consumer_key, token| SomeClass.find_by_tokens(consumer_key, token) }
-```
-```ruby
-# direct lookup
-OoAuth.authorization_store = User
-```
-### Nonce store
-```ruby
-require 'oo_auth/nonce/redis_store'
-
-OoAuth.nonce_store = OoAuth::Nonce::RedisStore.new(namespace: 'foobar')
-```
 ## Use
 
 ### OAuth consumer
@@ -74,7 +48,7 @@ request['Authorization']
 ### OAuth provider
 
 ```ruby
-class FoobarController < ApplicationController
+class ApiController < ApplicationController
 
   before_filter :oauth_required
 
@@ -85,11 +59,87 @@ class FoobarController < ApplicationController
       self.current_user = authorization.user
     else
       render nothing: true, status: 401
+      false
     end
   end
+end
 ```
 
+## Prerequisites for OAuth providers
+
+OoAuth requires your provider application to provide stores for authorization tokens 
+and OAuth nonces. (You won't need these stores if you're only using OoAuth's client
+functionality.)
+
+OoAuth stores can be as simple lambdas or regular ruby objects.
+
+### Authorization store
+
+The authorization store is used for looking up OAuth credentials. It could for example
+be an API account or user model. OoAuth will query the authorization store by calling
+its method `authorization(consumer_key, token)` if it is a regular object, or just
+call it with the same arguments if it is a lambda.
+
+When the consumer key and token combination actually exists, the call should return
+an object representing the API account (e.g. user instance, API account instance).
+
+This instance again must implement the method `:credentials`, and return an instance
+of `OoAuth::Credentials` initialized with the account's full credential set.
+
+```ruby
+
+# app/models/api_account.rb
+class ApiAccount < ActiveRecord::Base
+
+  def self.authorization(consumer_key, token)
+    where(consumer_key: consumer_key, token: token).first
+  end
+  
+  def credentials
+    OoAuth::Credentials.new(consumer_key, consumer_secret, token, token_secret)
+  end
+end
+
+# config/initializers/oo_auth.rb
+OoAuth.authorization_store =  ApiAccount
+```
+
+### Nonce store
+
+The nonce store is needed by provider applications to temporarily store OAuth nonces.
+It must provide a `remember(nonce)` method or be a callable proc, where `nonce` is an
+instance of `OoAuth::Nonce`. 
+
+The store must ensure that each tuple `(timestamp, nonce value)` is only created once.
+This is required by the OAuth spec in order to prevent replay attacks.
+
+```ruby
+# app/models/nonce.rb
+class Nonce < ActiveRecord::Base
+  validates_presence_of :value, :timestamp
+  validates_uniqueness_of :value, scope: :timestamp
+  
+  def self.remember(ooauth_nonce)
+    new(value: ooauth_nonce.value, ooauth_nonce.timestamp).save
+  end
+end
+
+# config/initializers/oo_auth.rb
+OoAuth.nonce_store = Nonce
+```
+
+OoAuth comes with a pre-defined Redis nonce store, which can be enabled as following:
+```ruby
+# Gemfile
+gem 'redis'
+
+# config/initializers/oo_auth.rb
+require 'oo_auth/nonce/redis_store'
+
+OoAuth.nonce_store = OoAuth::Nonce::RedisStore.new(namespace: 'foobar')
+```
 
 ## TODO
 
-* Support POST body signing
+* Support POST body signing for non-formencoded data
+  http://oauth.googlecode.com/svn/spec/ext/body_hash/1.0/oauth-bodyhash.html

data/lib/oo_auth/nonce.rb

@@ -5,20 +5,6 @@ module OoAuth
     attr_reader :value, :timestamp, :errors
     
     class << self
-      def store
-        OoAuth.nonce_store || fail(ConfigurationError, 'no nonce store set')
-      end
-
-      def create(nonce)
-        if store.respond_to?(:call)
-          store.call(nonce)
-        elsif store.respond_to?(:create)
-          store.create(nonce)
-        else
-          fail ConfigurationError, 'nonce store not callable'
-        end
-      end
-
       def remember(value, timestamp)
         new(value, timestamp).save
       end
@@ -41,7 +27,20 @@ module OoAuth
     end
     
     def save
-      !!(valid? && self.class.create(self))
+      return false unless valid?
+      if store.respond_to?(:call)
+        store.call(self)
+      elsif store.respond_to?(:remember)
+        store.remember(self)
+      else
+        fail ConfigurationError, 'nonce store not callable'
+      end
+    end
+
+    private
+    
+    def store
+      OoAuth.nonce_store || fail(ConfigurationError, 'no nonce store set')
     end
     
   end

data/lib/oo_auth/nonce/abstract_store.rb

@@ -3,7 +3,7 @@ module OoAuth
     class AbstractStore
   
       class << self
-        def create(nonce)
+        def remember(nonce)
           #
         end  
       end

data/lib/oo_auth/nonce/redis_store.rb

@@ -10,7 +10,7 @@ module OoAuth
         @redis = Redis.new(options)
       end
 
-      def create(nonce)
+      def remember(nonce)
         return nonce if @redis.set(key(nonce), '1', { nx: true, ex: ttl })
         false
       rescue Errno::ECONNREFUSED

data/lib/oo_auth/signature.rb

@@ -33,7 +33,7 @@ module OoAuth
       
       # Verify signature and remember nonce - use this to authorize actual requests
       def verify!(proxy, credentials)
-        valid?(proxy, credentials) && remember_nonce!(proxy)
+        !!(valid?(proxy, credentials) && remember_nonce!(proxy))
       end
       
       private

data/lib/oo_auth/version.rb

@@ -1,3 +1,3 @@
 module OoAuth
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oo_auth
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matthias Grosser