sorcery 0.3.0 → 0.4.0

data/lib/sorcery/controller.rb

@@ -2,28 +2,17 @@ module Sorcery
   module Controller
     def self.included(klass)
       klass.class_eval do
-        extend ClassMethods
         include InstanceMethods
         Config.submodules.each do |mod|
-          begin # FIXME: is this protection needed?
+          begin
             include Submodules.const_get(mod.to_s.split("_").map {|p| p.capitalize}.join("")) 
           rescue NameError
             # don't stop on a missing submodule.
           end
         end
-        Config.update!
-      end
-    end
-    
-    module ClassMethods
-      def activate_sorcery!(&block)
-        yield Config if block_given?
-        after_config!
-      end
-      
-      def after_config!
-        Config.after_config.each {|c| send(c)}       
       end
+      Config.update!
+      Config.configure!
     end
     
     module InstanceMethods
@@ -73,12 +62,14 @@ module Sorcery
         @current_user ||= login_from_session || login_from_other_sources unless @current_user == false
       end
       
-      def return_or_redirect_to(url, flash_hash = {})
+      # used when a user tries to access a page while logged out, is asked to login, and we want to return him back to the page he originally wanted.
+      def redirect_back_or_to(url, flash_hash = {})
         redirect_to(session[:return_to_url] || url, :flash => flash_hash)
       end
       
       # The default action for denying non-authenticated users.
-      # You can override this method in your controllers.
+      # You can override this method in your controllers,
+      # or provide a different method in the configuration.
       def not_authenticated
         redirect_to root_path
       end
@@ -124,7 +115,7 @@ module Sorcery
       class << self
         attr_accessor :submodules,
         
-                      :user_class,                    # what class to use as the user class. Set automatically when you call activate_sorcery! in the User class.
+                      :user_class,                    # what class to use as the user class. Set automatically when you call authenticates_with_sorcery! in the User class.
                       
                       :not_authenticated_action,      # what controller action to call for non-authenticated users.
                       
@@ -135,9 +126,7 @@ module Sorcery
                       :after_login,
                       :after_failed_login,
                       :before_logout,
-                      :after_logout,
-                      :after_config
-                      
+                      :after_logout                      
                       
         def init!
           @defaults = {
@@ -149,7 +138,6 @@ module Sorcery
             :@after_failed_login                   => [],
             :@before_logout                        => [],
             :@after_logout                         => [],
-            :@after_config                         => [],
             :@save_return_to_url                   => true
           }
         end
@@ -166,6 +154,18 @@ module Sorcery
             instance_variable_set(k,v) if !instance_variable_defined?(k)
           end
         end
+        
+        def user_config(&blk)
+          block_given? ? @user_config = blk : @user_config
+        end
+        
+        def configure(&blk)
+          @configure_blk = blk
+        end
+        
+        def configure!
+          @configure_blk.call(self) if @configure_blk
+        end
       end
       init!
       reset!

data/lib/sorcery/crypto_providers/bcrypt.rb

@@ -42,7 +42,7 @@ module Sorcery
         # This is the :cost option for the BCrpyt library. The higher the cost the more secure it is and the longer is take the generate a hash. By default this is 10.
         # Set this to whatever you want, play around with it to get that perfect balance between security and performance.
         def cost
-          @cost ||= 1
+          @cost ||= 10
         end
         attr_writer :cost
         alias :stretches= :cost=

data/lib/sorcery/crypto_providers/common.rb

@@ -0,0 +1,35 @@
+module Sorcery
+  module CryptoProviders
+    module Common
+      def self.included(base)
+        base.class_eval do
+          class << self
+            attr_accessor :join_token
+
+            # The number of times to loop through the encryption.
+            def stretches
+              @stretches ||= 1
+            end
+            attr_writer :stretches
+
+            def encrypt(*tokens)
+              digest = tokens.flatten.join(join_token)
+              stretches.times { digest = secure_digest(digest) }
+              digest
+            end
+
+            # Does the crypted password match the tokens? Uses the same tokens that were used to encrypt.
+            def matches?(crypted, *tokens)
+              encrypt(*tokens) == crypted
+            end
+
+            def reset!
+              @stretches = 1
+              @join_token = nil
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sorcery/crypto_providers/md5.rb

@@ -8,30 +8,10 @@ module Sorcery
     #
     # Please use any other provider offered by Sorcery.
     class MD5
+      include Common
       class << self
-        attr_accessor :join_token
-        
-        # The number of times to loop through the encryption.
-        def stretches
-          @stretches ||= 1
-        end
-        attr_writer :stretches
-        
-        # Turns your raw password into a MD5 hash.
-        def encrypt(*tokens)
-          digest = tokens.flatten.join(join_token)
-          stretches.times { digest = Digest::MD5.hexdigest(digest) }
-          digest
-        end
-        
-        # Does the crypted password match the tokens? Uses the same tokens that were used to encrypt.
-        def matches?(crypted, *tokens)
-          encrypt(*tokens) == crypted
-        end
-        
-        def reset!
-          @stretches = 1
-          @join_token = nil
+        def secure_digest(digest)
+          Digest::MD5.hexdigest(digest)
         end
       end
     end

data/lib/sorcery/crypto_providers/sha1.rb

@@ -5,34 +5,22 @@ module Sorcery
     # This class was made for the users transitioning from restful_authentication. I highly discourage using this
     # crypto provider as it inferior to your other options. Please use any other provider offered by Sorcery.
     class SHA1
+      include Common
       class << self
         def join_token
           @join_token ||= "--"
         end
-        attr_writer :join_token
-        
-        # The number of times to loop through the encryption. This is ten because that is what restful_authentication defaults to.
-        def stretches
-          @stretches ||= 10
-        end
-        attr_writer :stretches
         
         # Turns your raw password into a Sha1 hash.
         def encrypt(*tokens)
           tokens = tokens.flatten
           digest = tokens.shift
-          stretches.times { digest = Digest::SHA1.hexdigest([digest, *tokens].join(join_token)) }
+          stretches.times { digest = secure_digest([digest, *tokens].join(join_token)) }
           digest
         end
         
-        # Does the crypted password match the tokens? Uses the same tokens that were used to encrypt.
-        def matches?(crypted, *tokens)
-          encrypt(*tokens) == crypted
-        end
-        
-        def reset!
-          @stretches = 10
-          @join_token = nil
+        def secure_digest(digest)
+          Digest::SHA1.hexdigest(digest)
         end
       end
     end

data/lib/sorcery/crypto_providers/sha256.rb

@@ -24,30 +24,10 @@ module Sorcery
     #
     # Uses the Sha256 hash algorithm to encrypt passwords.
     class SHA256
+      include Common
       class << self
-        attr_accessor :join_token
-        
-        # The number of times to loop through the encryption.
-        def stretches
-          @stretches ||= 20
-        end
-        attr_writer :stretches
-        
-        # Turns your raw password into a Sha256 hash.
-        def encrypt(*tokens)
-          digest = tokens.flatten.join(join_token)
-          stretches.times { digest = Digest::SHA256.hexdigest(digest) }
-          digest
-        end
-        
-        # Does the crypted password match the tokens? Uses the same tokens that were used to encrypt.
-        def matches?(crypted, *tokens)
-          encrypt(*tokens) == crypted
-        end
-        
-        def reset!
-          @stretches = 20
-          @join_token = nil
+        def secure_digest(digest)
+          Digest::SHA256.hexdigest(digest)
         end
       end
     end

data/lib/sorcery/crypto_providers/sha512.rb

@@ -24,30 +24,10 @@ module Sorcery
     #
     # Uses the Sha512 hash algorithm to encrypt passwords.
     class SHA512
+      include Common
       class << self
-        attr_accessor :join_token
-        
-        # The number of times to loop through the encryption.
-        def stretches
-          @stretches ||= 20
-        end
-        attr_writer :stretches
-        
-        # Turns your raw password into a Sha512 hash.
-        def encrypt(*tokens)
-          digest = tokens.flatten.join(join_token)
-          stretches.times { digest = Digest::SHA512.hexdigest(digest) }
-          digest
-        end
-        
-        # Does the crypted password match the tokens? Uses the same tokens that were used to encrypt.
-        def matches?(crypted, *tokens)
-          encrypt(*tokens) == crypted
-        end
-        
-        def reset!
-          @stretches = 20
-          @join_token = nil
+        def secure_digest(digest)
+          Digest::SHA512.hexdigest(digest)
         end
       end
     end

data/lib/sorcery/engine.rb

@@ -23,5 +23,9 @@ module Sorcery
       end
     end
     
+    rake_tasks do
+      load "sorcery/railties/tasks.rake"
+    end
+    
   end
 end

data/lib/sorcery/initializers/initializer.rb

@@ -0,0 +1,86 @@
+# The first thing you need to configure is which modules you need in your app.
+# The default is nothing which will include only core features (password encryption, login/logout).
+# Available submodules are: :user_activation, :http_basic_auth, :remember_me, :reset_password, :session_timeout, :brute_force_protection, :activity_logging, :external
+Collaboration::Application.config.sorcery.submodules = []
+
+# Here you can configure each submodule's features.
+Collaboration::Application.config.sorcery.configure do |config|
+  # -- core --
+  # config.not_authenticated_action = :not_authenticated      # what controller action to call for non-authenticated users. You can also override 'not_authenticated' instead.
+  # config.save_return_to_url = true                          # when a non logged in user tries to enter a page that requires login, save the URL he wanted to reach, 
+                                                              # and send him there after login, using 'redirect_back_or_to'.
+  
+  # -- session timeout --
+  # config.session_timeout = 3600                             # how long in seconds to keep the session alive.
+  # config.session_timeout_from_last_action = false           # use the last action as the beginning of session timeout.
+  
+  # -- http_basic_auth --
+  # config.controller_to_realm_map = {"application" => "Application"} # What realm to display for which controller name.
+                                                                      # For example {"My App" => "Application"}
+  
+  # -- external --
+  # config.external_providers = []                            # What providers are supported by this app, i.e. [:twitter, :facebook] .
+  # 
+  # config.twitter.key = "eYVNBjBDi33aa9GkA3w"
+  # config.twitter.secret = "XpbeSdCoaKSmQGSeokz5qcUATClRW5u08QWNfv71N8"
+  # config.twitter.callback_url = "http://0.0.0.0:3000/oauth/callback?provider=twitter"
+  # config.twitter.user_info_mapping = {:email => "screen_name"}
+  # 
+  # config.facebook.key = "34cebc81c08a521bc66e212f947d73ec"
+  # config.facebook.secret = "5b458d179f61d4f036ee66a497ffbcd0"
+  # config.facebook.callback_url = "http://0.0.0.0:3000/oauth/callback?provider=facebook"
+  # config.facebook.user_info_mapping = {:email => "name"}
+  
+  # --- user config ---
+  config.user_config do |user|
+    # -- core --
+    # user.username_attribute_name =                          # change default username attribute, for example, to use :email as the login.
+    # user.password_attribute_name =                          # change *virtual* password attribute, the one which is used until an encrypted one is generated.
+    # user.email_attribute_name =                             # change default email attribute.
+    # user.crypted_password_attribute_name =                  # change default crypted_password attribute.
+    # user.salt_join_token =                                  # what pattern to use to join the password with the salt
+    # user.salt_attribute_name =                              # change default salt attribute.
+    # user.stretches =                                        # how many times to apply encryption to the password.
+    # user.encryption_key =                                   # encryption key used to encrypt reversible encryptions such as AES256.
+    # user.encryption_provider =                              # change default encryption_provider.
+    # user.custom_encryption_provider =                       # use an external encryption class.
+    # user.encryption_algorithm =                             # encryption algorithm name. See 'encryption_algorithm=' for available options.
+
+    # -- user_activation --
+    # user.activation_state_attribute_name =                  # the attribute name to hold activation state (active/pending).
+    # user.activation_token_attribute_name =                  # the attribute name to hold activation code (sent by email).
+    # user.activation_token_expires_at_attribute_name =       # the attribute name to hold activation code expiration date. 
+    # user.activation_token_expiration_period =               # how many seconds before the activation code expires. nil for never expires.
+    # user.user_activation_mailer =                           # your mailer class. Required.
+    # user.activation_needed_email_method_name =              # activation needed email method on your mailer class.
+    # user.activation_success_email_method_name =             # activation success email method on your mailer class.
+    # user.prevent_non_active_users_to_login =                # do you want to prevent or allow users that did not activate by email to login?                     
+
+    # -- reset_password --
+    # user.reset_password_token_attribute_name =              # reset password code attribute name.
+    # user.reset_password_token_expires_at_attribute_name =   # expires at attribute name.
+    # user.reset_password_email_sent_at_attribute_name =      # when was email sent, used for hammering protection.
+    # user.reset_password_mailer =                            # mailer class. Needed.
+    # user.reset_password_email_method_name =                 # reset password email method on your mailer class.
+    # user.reset_password_expiration_period =                 # how many seconds before the reset request expires. nil for never expires.
+    # user.reset_password_time_between_emails =               # hammering protection, how long to wait before allowing another email to be sent.
+    
+    # -- brute_force_protection --
+    # user.failed_logins_count_attribute_name =               # failed logins attribute name.
+    # user.lock_expires_at_attribute_name =                   # this field indicates whether user is banned and when it will be active again.
+    # user.consecutive_login_retries_amount_limit =           # how many failed logins allowed.
+    # user.login_lock_time_period =                           # how long the user should be banned. in seconds. 0 for permanent.
+                              
+    # -- activity logging --
+    # user.last_login_at_attribute_name =                     # last login attribute name.
+    # user.last_logout_at_attribute_name =                    # last logout attribute name.
+    # user.last_activity_at_attribute_name =                  # last activity attribute name.
+    # user.activity_timeout =                                 # how long since last activity is the user defined logged out?
+
+    # -- external --                                             
+    # user.authentications_class =                            # class which holds the various external provider data for this user.
+    # user.authentications_user_id_attribute_name =           # user's identifier in authentications class.
+    # user.provider_attribute_name =                          # provider's identifier in authentications class.
+    # user.provider_uid_attribute_name =                      # user's external unique identifier in authentications class.
+  end
+end

data/lib/sorcery/model/submodules/{oauth.rb → external.rb}

@@ -1,9 +1,9 @@
 module Sorcery
   module Model
     module Submodules
-      # This submodule helps you login users from OAuth providers such as Twitter.
+      # This submodule helps you login users from external providers such as Twitter.
       # This is the model part which handles finding the user using access tokens.
-      # For the controller options see Sorcery::Controller::Oauth.
+      # For the controller options see Sorcery::Controller::External.
       #
       # Socery assumes (read: requires) you will create external users in the same table where you keep your regular users,
       # but that you will have a separate table for keeping their external authentication data,
@@ -11,7 +11,7 @@ module Sorcery
       #
       # External users will have a null crypted_password field, since we do not hold their password.
       # They will not be sent activation emails on creation.
-      module Oauth
+      module External
         def self.included(base)
           base.sorcery_config.class_eval do
             attr_accessor :authentications_class,

data/lib/sorcery/model.rb

@@ -9,11 +9,13 @@ module Sorcery
     def self.included(klass)
       klass.class_eval do
         class << self
-          def activate_sorcery!
+          def authenticates_with_sorcery!
             @sorcery_config = Config.new
             self.class_eval do
               extend ClassMethods # included here, before submodules, so they can be overriden by them.
               include InstanceMethods
+              
+              # set the user_class for the controller methods which call it
               ::Sorcery::Controller::Config.user_class = self
               @sorcery_config.submodules = ::Sorcery::Controller::Config.submodules
               @sorcery_config.submodules.each do |mod|
@@ -25,7 +27,7 @@ module Sorcery
               end
             end
             
-            yield @sorcery_config if block_given?
+            ::Sorcery::Controller::Config.user_config.tap{|blk| blk.call(@sorcery_config) if blk}
             
             self.class_eval do
               attr_accessor @sorcery_config.password_attribute_name
@@ -56,12 +58,6 @@ module Sorcery
         user if user && @sorcery_config.before_authenticate.all? {|c| user.send(c)} && credentials_match?(user.send(@sorcery_config.crypted_password_attribute_name),credentials[1],_salt)
       end
       
-      # Calls the configured encryption provider to compare the supplied password with the encrypted one.
-      def credentials_match?(crypted, *tokens)
-        return crypted == tokens.join if @sorcery_config.encryption_provider.nil?
-        @sorcery_config.encryption_provider.matches?(crypted, *tokens)
-      end
-      
       # encrypt tokens using current encryption_provider.
       def encrypt(*tokens)
         return tokens.first if @sorcery_config.encryption_provider.nil?
@@ -71,6 +67,15 @@ module Sorcery
         CryptoProviders::AES256.key = @sorcery_config.encryption_key if @sorcery_config.encryption_algorithm == :aes256
         @sorcery_config.encryption_provider.encrypt(*tokens)
       end
+      
+      protected
+      
+      # Calls the configured encryption provider to compare the supplied password with the encrypted one.
+      def credentials_match?(crypted, *tokens)
+        return crypted == tokens.join if @sorcery_config.encryption_provider.nil?
+        @sorcery_config.encryption_provider.matches?(crypted, *tokens)
+      end
+      
     end
     
     module InstanceMethods

data/lib/sorcery/railties/tasks.rake

@@ -0,0 +1,10 @@
+require 'fileutils'
+
+namespace :sorcery do
+  desc "Adds sorcery's initializer file"
+  task :bootstrap do
+    src = File.join(File.dirname(__FILE__), '..', 'initializers', 'initializer.rb')
+    target = File.join(Rails.root, "config", "initializers", "sorcery.rb")
+    FileUtils.cp(src, target)
+  end
+end

data/lib/sorcery/sinatra.rb

@@ -2,13 +2,4 @@ ActiveRecord::Base.send(:include, Sorcery::Model) if defined?(ActiveRecord)
 if defined?(Sinatra::Base)
   Sinatra::Base.send(:include, Sorcery::Controller::Adapters::Sinatra)
   Sinatra::Base.send(:include, Sorcery::Controller)
-  # Sorcery::Controller::Config.class_eval do
-  #   class << self
-  #     def submodules=(mods)
-  #       @submodules = mods
-  #       Sinatra::Base.send(:include, Sorcery::Controller::Adapters::Sinatra)
-  #       Sinatra::Base.send(:include, Sorcery::Controller)
-  #     end
-  #   end
-  # end
 end

data/lib/sorcery/test_helpers/rails.rb

@@ -20,23 +20,20 @@ module Sorcery
         ::Sorcery::Controller::Config.user_class = nil
         ActionController::Base.send(:include,::Sorcery::Controller)
 
-        User.activate_sorcery! do |config|
+        ::Sorcery::Controller::Config.user_config do |user|
           options.each do |property,value|
-            config.send(:"#{property}=", value)
+            user.send(:"#{property}=", value)
           end
         end
+        User.authenticates_with_sorcery!
       end
       
       def sorcery_controller_property_set(property, value)
-        ApplicationController.activate_sorcery! do |config|
-          config.send(:"#{property}=", value)
-        end
+        ::Sorcery::Controller::Config.send(:"#{property}=", value)
       end
 
-      def sorcery_controller_oauth_property_set(provider, property, value)
-        ApplicationController.activate_sorcery! do |config|
-          config.send(provider).send(:"#{property}=", value)
-        end
+      def sorcery_controller_external_property_set(provider, property, value)
+        ::Sorcery::Controller::Config.send(provider).send(:"#{property}=", value)
       end
       
       def login_user(user = nil)

data/lib/sorcery/test_helpers/sinatra.rb

@@ -108,23 +108,20 @@ module Sorcery
         ::Sinatra::Application.send(:include, Sorcery::Controller::Adapters::Sinatra)
         ::Sinatra::Application.send(:include, Sorcery::Controller)
         
-        User.activate_sorcery! do |config|
+        ::Sorcery::Controller::Config.user_config do |user|
           options.each do |property,value|
-            config.send(:"#{property}=", value)
+            user.send(:"#{property}=", value)
           end
         end
+        User.authenticates_with_sorcery!
       end
       
       def sorcery_controller_property_set(property, value)
-        ::Sinatra::Application.activate_sorcery! do |config|
-          config.send(:"#{property}=", value)
-        end
+        ::Sorcery::Controller::Config.send(:"#{property}=", value)
       end
 
-      def sorcery_controller_oauth_property_set(provider, property, value)
-        ::Sinatra::Application.activate_sorcery! do |config|
-          config.send(provider).send(:"#{property}=", value)
-        end
+      def sorcery_controller_external_property_set(provider, property, value)
+        ::Sorcery::Controller::Config.send(provider).send(:"#{property}=", value)
       end
     end
   end

data/lib/sorcery/test_helpers.rb

@@ -1,5 +1,17 @@
 module Sorcery
+  # This file will be included in the spec_helper file.
   module TestHelpers
+    def self.included(base)
+      # reducing default cost for specs speed
+      CryptoProviders::BCrypt.class_eval do
+        class << self
+          def cost
+            1
+          end
+        end
+      end
+    end
+    
     # a patch to fix a bug in testing that happens when you 'destroy' a session twice.
     # After the first destroy, the session is an ordinary hash, and then when destroy is called again there's an exception.
     class ::Hash

data/lib/sorcery.rb

@@ -8,7 +8,7 @@ module Sorcery
       autoload :RememberMe, 'sorcery/model/submodules/remember_me'
       autoload :ActivityLogging, 'sorcery/model/submodules/activity_logging'
       autoload :BruteForceProtection, 'sorcery/model/submodules/brute_force_protection'
-      autoload :Oauth, 'sorcery/model/submodules/oauth'
+      autoload :External, 'sorcery/model/submodules/external'
     end
   end
   autoload :Controller, 'sorcery/controller'
@@ -19,13 +19,15 @@ module Sorcery
       autoload :BruteForceProtection, 'sorcery/controller/submodules/brute_force_protection'
       autoload :HttpBasicAuth, 'sorcery/controller/submodules/http_basic_auth'
       autoload :ActivityLogging, 'sorcery/controller/submodules/activity_logging'
-      autoload :Oauth, 'sorcery/controller/submodules/oauth'
-      module Oauth
-        autoload :Oauth1, 'sorcery/controller/submodules/oauth/oauth1'
-        autoload :Oauth2, 'sorcery/controller/submodules/oauth/oauth2'
+      autoload :External, 'sorcery/controller/submodules/external'
+      module External
+        module Protocols
+          autoload :Oauth1, 'sorcery/controller/submodules/external/protocols/oauth1'
+          autoload :Oauth2, 'sorcery/controller/submodules/external/protocols/oauth2'
+        end
         module Providers
-          autoload :Twitter, 'sorcery/controller/submodules/oauth/providers/twitter'
-          autoload :Facebook, 'sorcery/controller/submodules/oauth/providers/facebook'
+          autoload :Twitter, 'sorcery/controller/submodules/external/providers/twitter'
+          autoload :Facebook, 'sorcery/controller/submodules/external/providers/facebook'
         end
       end
     end
@@ -34,6 +36,7 @@ module Sorcery
     end
   end
   module CryptoProviders
+    autoload :Common, 'sorcery/crypto_providers/common'
     autoload :AES256, 'sorcery/crypto_providers/aes256'
     autoload :BCrypt, 'sorcery/crypto_providers/bcrypt'
     autoload :MD5,    'sorcery/crypto_providers/md5'