touth 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6424a7f72477d07f75e3d86466f63b7309767e3
-  data.tar.gz: ba296cbb722b4d902d5727dcd954987fc50b1c70
+  metadata.gz: fb6f3f37d102cc22a9be19c43f1d56a174b32ed1
+  data.tar.gz: f691dac5c428d62b7077ffdaa09eaa0df4ba29a1
 SHA512:
-  metadata.gz: 8fd354d81d7ac6b1c873d31241bc6043cfca190febe0d2d3acca887371463e6cec7ad74e8d3dbbaba1fff7097dd5296ee88288a9a14ca60f499004ea334fc773
-  data.tar.gz: 8eadb69151befd9645955bfad92273eb2c1178afdd1f491e5f1b4cb8bd97924b0ef6c0a3b67cc8564b878057aa7a1b8e369311cdce3c32ff27dbdfef0d81f25a
+  metadata.gz: 2d166f9d6c80bf09865253d54c67e9338eb7888566df916203e798a2ed1823c0143c4200dedfa0de9788e125e4537920591593bfacf430ba030388008668bd18
+  data.tar.gz: 4ac78b3026d68cc44331b71392e029e5bf54ca7d5241a72353cf045a8421e80bbed61a637b1aa294d05f79f159059ab7f3c349346c67174f9c6887cbaa274e67

data/README.md

@@ -47,11 +47,7 @@ Checking if a user is signed in, and getting the current signed-in user, the fol
 
 ### Hooks
 
-- `authenticate_entity_from_token!`
-
-### Fallbacks
-
-- `token_authentication_error!(type)`
+- `authenticate_token!`
 
 
 Usage
@@ -63,12 +59,14 @@ Usage
 user_account = UserAccount.first
 
 
-# create access token for default lifetime
-t1 = user_account.access_token  #=> "9619feb4b8d54352ae07588d011da48385c8c4f072ab889d3996d127ad2142fc6213d553"
+# create access token
+t1 = user_account.access_token
+#=> "0c63df99a514563a274377bb5f382c3be3bc0ff75b3758be5cd145984134d73608fe77339f7f38abf71eec38ba6800c0e2e4af08227f251b0f81163878aa25ab04085b086310557365724163636f756e7469066c2b07cc536b54"
 
 
 # create token expires in 20 secounds
-t2 = user_account.access_token 20  #=> "ad60fa5bb2d05e72ac943c6d409e18e6cc24c15eae9833f66c8aab391241475fe2bd0954"
+t2 = user_account.access_token 20
+#=> "622bf3498d0c6d846f31f8bd486cbedf3dce0076661d98111231726b35709d3f6a46a419b4799fb84b94258025eafa304baf8196877c281145a434e6b859b90504085b086310557365724163636f756e7469066c2b07e1536b54"
 
 user_account.valid_access_token? t2  #=> true
 sleep 20
@@ -78,8 +76,7 @@ user_account.valid_access_token? t2  #=> false
 ### Authentication by request headers
 
 ```
-X-Auth-ID: 1
-X-Auth-Token: 9619feb4b8d54352ae07588d011da48385c8c4f072ab889d3996d127ad2142fc6213d553
+X-Access-Token: 2a20d42585159a9f1c9564afd051d48e2209af5e18d83c9685de1ae0df66c2b76c2bc7633e4b14748f1cf94b09e94d1a33804b1e74dad9d02d231b12e6c840b504085b086310557365724163636f756e7469066c2b0737546b54
 ```
 
 ### Invalidation
@@ -114,6 +111,9 @@ Touth.setup do |config|
   # :encrypted_password will work nice with devise model.
   config.password_field = :encrypted_password
 
+  # Header name
+  config.header_name = 'X-Access-Token'
+
 end
 ```
 
@@ -123,23 +123,9 @@ Contributing
 
 Contributions are always welcome!
 
-### Bug reports
-
-1. Ensure the bug can be reproduced on the latest master.
-1. Check it's not a duplicate.
-1. Raise an issue.
-
-
-### Pull requests
-
-1. Fork the repository.
-1. Create a branch.
-1. Create a new pull request.
-
 
 License
 -------
 
 This project is copyright by [Creasty](http://www.creasty.com), released under the MIT lisence.  
 See `LICENSE` file for details.
-

data/lib/touth.rb

@@ -1,13 +1,11 @@
 require 'active_support'
 
 
-#  Touth
-#-----------------------------------------------
 module Touth
 
   extend ActiveSupport::Autoload
 
-  autoload :ActsAsTokenAuthenticatable
+  autoload :Authenticator
   autoload :ActiveRecordSupport
   autoload :ActionControllerSupport
   autoload :VERSION
@@ -16,12 +14,14 @@ module Touth
 
     attr_accessor :access_token_lifetime,
       :client_secret_key,
-      :password_field
+      :password_field,
+      :header_name
 
     def initialize
       @access_token_lifetime = 60 * (24 * 60 * 60)  # 60 days
       @client_secret_key     = ''  # use SecureRandom.hex(64) to generate one
       @password_field        = :encrypted_password
+      @header_name           = 'X-Access-Token'
     end
 
   end
@@ -54,18 +54,4 @@ module Touth
 
 end
 
-
-#  Setup
-#-----------------------------------------------
 Touth.setup
-
-
-#  Include
-#-----------------------------------------------
-ActiveSupport.on_load(:active_record) do
-  extend Touth::ActiveRecordSupport::ClassMethods
-end
-ActiveSupport.on_load(:action_controller) do
-  extend Touth::ActionControllerSupport::ClassMethods
-  include Touth::ActionControllerSupport::InstanceMethods
-end

data/lib/touth/action_controller_support.rb

@@ -1,27 +1,24 @@
 module Touth
   module ActionControllerSupport
-
     module ClassMethods
 
-      mattr_accessor :token_authentication_on
-
-      def token_authentication_for(scope)
-        scope = scope.to_s
-        name = scope.gsub('::', '_').underscore
+      mattr_accessor :access_token_resources
 
-        self.token_authentication_on = {
-          class:   scope.camelize.constantize,
-          current: nil,
-        }
+      def token_authentication_for(resource_name)
+        resource_name = resource_name.to_s
+        name = resource_name.gsub('::', '_').underscore
 
-        before_action :authenticate_entity_from_token!
+        unless self.access_token_resources
+          self.access_token_resources = {}
+          before_action :authenticate_token!
+        end
 
         define_method "#{name}_signed_in?" do
-          !!self.class.token_authentication_on[:current]
+          !!self.class.access_token_resources[resource_name]
         end
 
         define_method "current_#{name}" do
-          self.class.token_authentication_on[:current]
+          self.class.access_token_resources[resource_name]
         end
       end
 
@@ -31,36 +28,23 @@ module Touth
 
     protected
 
-      def token_authentication_header
-        @token_authentication_header ||= {
-          id:    request.headers['X-Auth-ID'],
-          token: request.headers['X-Auth-Token'],
-        }
-      end
+      def authenticate_token!
+        token = request.headers[Touth.header_name]
 
-      def authenticate_entity_from_token!
-        id = token_authentication_header[:id]
-
-        model = id.present? \
-          && self.class.token_authentication_on[:class].find(id)
-
-        unless model
-          return token_authentication_error! :no_entity
+        if Authenticator.valid_access_token? token
+          render nothing: true, status: :unauthorized
+          return false
         end
 
-        unless model.valid_access_token? token_authentication_header[:token]
-          return token_authentication_error! :invalid_token
-        end
-
-        self.class.token_authentication_on[:current] = model
-      end
-
-      def token_authentication_error!(type)
-        render nothing: true, status: :unauthorized
-        false
+        model = Authenticator.get_model token
+        self.class.access_token_resources[model.name] = model
       end
 
     end
-
   end
 end
+
+ActiveSupport.on_load(:action_controller) do
+  extend Touth::ActionControllerSupport::ClassMethods
+  include Touth::ActionControllerSupport::InstanceMethods
+end

data/lib/touth/active_record_support.rb

@@ -1,13 +1,27 @@
 module Touth
   module ActiveRecordSupport
-
     module ClassMethods
 
       def acts_as_token_authenticatable
-        include Touth::ActsAsTokenAuthenticatable
+        include Touth::ActiveRecordSupport::InstanceMethods
       end
 
     end
 
+    module InstanceMethods
+ 
+      def access_token(*args)
+        Authenticator.issue_access_token self, *args
+      end
+
+      def valid_access_token?(token)
+        Authenticator.get_model(token) == self
+      end
+
+    end
   end
 end
+
+ActiveSupport.on_load(:active_record) do
+  extend Touth::ActiveRecordSupport::ClassMethods
+end

data/lib/touth/authenticator.rb

@@ -0,0 +1,57 @@
+module Touth
+  module Authenticator
+
+  module_function
+
+    def issue_access_token(model, lifetime = Touth.access_token_lifetime)
+      expires_at = Time.now.to_i + lifetime
+
+      data = Marshal.dump([
+        model.class,
+        model.id,
+        expires_at,
+      ])
+
+      data_sign = Touth.digest data
+      data_key = gen_data_key model, data_sign
+
+      [
+        data_sign,
+        data_key,
+        data,
+      ].join.unpack('H*')[0]
+    end
+
+    def valid_access_token?(token)
+      !!get_model(token)
+    end
+
+    def get_model(token)
+      @access_token_data_cache ||= {}
+      model = @access_token_data_cache[token]
+
+      return model if model
+
+      begin
+        data_sign, data_key, data = [token].pack('H*').unpack 'A32A32A*'
+
+        if data_sign == Touth.digest(data)
+          model_class, id, expires_at = Marshal.load data
+
+          model = model_class.find id
+
+          if gen_data_key(model, data_sign) == data_key && Time.now.to_i < expires_at
+            @access_token_data_cache[token] = model
+          end
+        end
+      rescue
+        nil
+      end
+    end
+
+    def gen_data_key(model, data_sign)
+      Touth.digest [data_sign, model.send(Touth.password_field)].join
+    end
+
+  end
+end

data/lib/touth/version.rb

@@ -1,3 +1,3 @@
 module Touth
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: touth
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Yuki Iwanaga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-18 00:00:00.000000000 Z
+date: 2014-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -73,7 +73,7 @@ files:
 - lib/touth.rb
 - lib/touth/action_controller_support.rb
 - lib/touth/active_record_support.rb
-- lib/touth/acts_as_token_authenticatable.rb
+- lib/touth/authenticator.rb
 - lib/touth/version.rb
 - touth.gemspec
 homepage: https://github.com/creasty/touth

data/lib/touth/acts_as_token_authenticatable.rb

@@ -1,36 +0,0 @@
-module Touth
-  module ActsAsTokenAuthenticatable
-
-    def access_token(lifetime = Touth.access_token_lifetime)
-      expires_at = Time.now.to_i + lifetime
-
-      [access_token_id(expires_at), [expires_at].pack('V')].join.unpack('H*')[0]
-    end
-
-    def valid_access_token?(token)
-      begin
-        data = [token].pack 'H*'
-        token_id, timestamp = data.unpack 'A32A*'
-        expires_at = timestamp.unpack('V')[0]
-
-        access_token_id(expires_at) == token_id && Time.now.to_i < expires_at
-      rescue
-        false
-      end
-    end
-
-  private
-
-    def access_token_id(expires_at)
-      raw = [
-        expires_at,
-        self.class.name,
-        self.id,
-        self.send(Touth.password_field),
-      ].join ':'
-
-      Touth.digest raw
-    end
-
-  end
-end