clearance 2.0.0.beta2 → 2.3.0

data/lib/clearance/password_strategies.rb

@@ -13,10 +13,7 @@ module Clearance
   # `password=(new_password)`. For an example of how to implement these methods,
   # see {Clearance::PasswordStrategies::BCrypt}.
   module PasswordStrategies
-    autoload :BCrypt, 'clearance/password_strategies/bcrypt'
-    autoload :BCryptMigrationFromSHA1,
-      'clearance/password_strategies/bcrypt_migration_from_sha1'
-    autoload :Blowfish, 'clearance/password_strategies/blowfish'
-    autoload :SHA1, 'clearance/password_strategies/sha1'
+    autoload :BCrypt, "clearance/password_strategies/bcrypt"
+    autoload :Argon2, "clearance/password_strategies/argon2"
   end
 end

data/lib/clearance/password_strategies/argon2.rb

@@ -0,0 +1,23 @@
+module Clearance
+  module PasswordStrategies
+    # Uses Argon2 to authenticate users and store encrypted passwords.
+
+    module Argon2
+      require "argon2"
+
+      def authenticated?(password)
+        if encrypted_password.present?
+          ::Argon2::Password.verify_password(password, encrypted_password)
+        end
+      end
+
+      def password=(new_password)
+        @password = new_password
+
+        if new_password.present?
+          self.encrypted_password = ::Argon2::Password.new.create(new_password)
+        end
+      end
+    end
+  end
+end

data/lib/clearance/password_strategies/bcrypt.rb

@@ -2,10 +2,14 @@ module Clearance
   module PasswordStrategies
     # Uses BCrypt to authenticate users and store encrypted passwords.
     #
-    # The BCrypt cost (the measure of how many key expansion iterations BCrypt
-    # will perform) is automatically set to the minimum allowed value when
-    # Rails is operating in the test environment and the default cost in all
-    # other envionments. This provides a speed boost in tests.
+    # BCrypt has a `cost` argument which determines how computationally
+    # expensive the hash is to calculate. The higher the cost, the harder it is
+    # for attackers to crack passwords even if they posess a database dump of
+    # the encrypted passwords. Clearance uses the `bcrypt-ruby` default cost
+    # except in the test environment, where it uses the minimum cost value for
+    # speed. If you wish to increase the cost over the default, you can do so
+    # by setting a higher cost in an initializer:
+    # `BCrypt::Engine.cost = 12`
     module BCrypt
       require 'bcrypt'
 
@@ -19,18 +23,20 @@ module Clearance
         @password = new_password
 
         if new_password.present?
-          cost = if defined?(::Rails) && ::Rails.env.test?
-                   ::BCrypt::Engine::MIN_COST
-                 else
-                   ::BCrypt::Engine::DEFAULT_COST
-                 end
-
           self.encrypted_password = ::BCrypt::Password.create(
             new_password,
-            cost: cost,
+            cost: configured_bcrypt_cost,
           )
         end
       end
+
+      def configured_bcrypt_cost
+        if defined?(::Rails) && ::Rails.env.test?
+          ::BCrypt::Engine::MIN_COST
+        else
+          ::BCrypt::Engine.cost
+        end
+      end
     end
   end
 end

data/lib/clearance/rack_session.rb

@@ -21,7 +21,11 @@ module Clearance
       session = Clearance::Session.new(env)
       env[:clearance] = session
       response = @app.call(env)
-      session.add_cookie_to_headers response[1]
+
+      if session.authentication_successful?
+        session.add_cookie_to_headers response[1]
+      end
+
       response
     end
   end

data/lib/clearance/session.rb

@@ -81,7 +81,7 @@ module Clearance
       end
 
       @current_user = nil
-      cookies.delete remember_token_cookie
+      cookies.delete remember_token_cookie, delete_cookie_options
     end
 
     # True if {#current_user} is set.
@@ -98,6 +98,13 @@ module Clearance
       ! signed_in?
     end
 
+    # True if a successful authentication has been performed
+    #
+    # @return [Boolean]
+    def authentication_successful?
+      !!@current_user
+    end
+
     private
 
     # @api private
@@ -147,7 +154,7 @@ module Clearance
       guards = Clearance.configuration.sign_in_guards
 
       guards.inject(default_guard) do |stack, guard_class|
-        guard_class.new(self, stack)
+        guard_class.to_s.constantize.new(self, stack)
       end
     end
 
@@ -157,12 +164,22 @@ module Clearance
         domain: domain,
         expires: remember_token_expires,
         httponly: Clearance.configuration.httponly,
+        same_site: Clearance.configuration.same_site,
         path: Clearance.configuration.cookie_path,
         secure: Clearance.configuration.secure_cookie,
         value: remember_token,
       }
     end
 
+    # @api private
+    def delete_cookie_options
+      Hash.new.tap do |options|
+        if configured_cookie_domain
+          options[:domain] = domain
+        end
+      end
+    end
+
     # @api private
     def domain
       if configured_cookie_domain.respond_to?(:call)

data/lib/clearance/testing/deny_access_matcher.rb

@@ -78,12 +78,8 @@ module Clearance
           @controller.request.env[:clearance]
         end
 
-        def flash_alert
-          @controller.flash[:alert]
-        end
-
         def flash_alert_value
-          flash_alert.values.first
+          @controller.flash[:alert]
         end
 
         def redirects_to_url?

data/lib/clearance/user.rb

@@ -60,7 +60,7 @@ module Clearance
   #   @see PasswordStrategies
   #   @return [void]
   #
-  # @!method authenticated?
+  # @!method authenticated?(password)
   #   Check's the provided password against the user's encrypted password using
   #   the configured password strategy. By default, this will be
   #   {PasswordStrategies::BCrypt#authenticated?}, but can be changed with
@@ -117,11 +117,13 @@ module Clearance
           if password.present? && user.authenticated?(password)
             user
           end
+        else
+          prevent_timing_attack
         end
       end
 
       def find_by_normalized_email(email)
-        find_by_email normalize_email(email)
+        find_by(email: normalize_email(email))
       end
 
       def normalize_email(email)
@@ -130,6 +132,13 @@ module Clearance
 
       private
 
+      DUMMY_PASSWORD = "*"
+
+      def prevent_timing_attack
+        new(password: DUMMY_PASSWORD)
+        nil
+      end
+
       def password_strategy
         Clearance.configuration.password_strategy || PasswordStrategies::BCrypt
       end
@@ -143,7 +152,7 @@ module Clearance
         validates :email,
           email: { strict_mode: true },
           presence: true,
-          uniqueness: { allow_blank: true },
+          uniqueness: { allow_blank: true, case_sensitive: false },
           unless: :email_optional?
 
         validates :password, presence: true, unless: :skip_password_validation?

data/lib/clearance/version.rb

@@ -1,3 +1,3 @@
 module Clearance
-  VERSION = "2.0.0.beta2".freeze
+  VERSION = "2.3.0".freeze
 end

data/lib/generators/clearance/install/install_generator.rb

@@ -122,6 +122,16 @@ module Clearance
         "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
       end
 
+      def migration_primary_key_type_string
+        if configured_key_type
+          ", id: :#{configured_key_type}"
+        end
+      end
+
+      def configured_key_type
+        Rails.configuration.generators.active_record[:primary_key_type]
+      end
+
       def models_inherit_from
         "ApplicationRecord"
       end

data/lib/generators/clearance/install/templates/README

@@ -8,9 +8,11 @@ Next steps:
     # config/environments/{development,test}.rb
     config.action_mailer.default_url_options = { host: 'localhost:3000' }
 
-    In production it should be your app's domain name.
+    In the production environment it should be your application's full hostname.
 
-2. Display user session and flashes. For example, in your application layout:
+2. Display user session status.
+
+    From somewhere in your layout, render sign in and sign out buttons:
 
     <% if signed_in? %>
       Signed in as: <%= current_user.email %>
@@ -19,14 +21,18 @@ Next steps:
       <%= link_to 'Sign in', sign_in_path %>
     <% end %>
 
+3. Render the flash contents.
+
+    Make sure the flash is being rendered in your views using something like:
+
     <div id="flash">
       <% flash.each do |key, value| %>
         <div class="flash <%= key %>"><%= value %></div>
       <% end %>
     </div>
 
-3. Migrate:
+4. Migrate:
 
-    rails db:migrate
+    Run `rails db:migrate` to add the clearance database changes.
 
 *******************************************************************************

data/lib/generators/clearance/install/templates/db/migrate/add_clearance_to_users.rb.erb

@@ -13,7 +13,7 @@ class AddClearanceToUsers < ActiveRecord::Migration<%= migration_version %>
     users = select_all("SELECT id FROM users WHERE remember_token IS NULL")
 
     users.each do |user|
-      update <<-SQL
+      update <<-SQL.squish
         UPDATE users
         SET remember_token = '#{Clearance::Token.new}'
         WHERE id = '#{user['id']}'

data/lib/generators/clearance/install/templates/db/migrate/create_users.rb.erb

@@ -1,6 +1,6 @@
 class CreateUsers < ActiveRecord::Migration<%= migration_version %>
   def change
-    create_table :users do |t|
+    create_table :users<%= migration_primary_key_type_string %> do |t|
       t.timestamps null: false
       t.string :email, null: false
       t.string :encrypted_password, limit: 128, null: false

data/lib/generators/clearance/routes/templates/routes.rb

@@ -4,7 +4,7 @@
   resources :users, controller: "clearance/users", only: [:create] do
     resource :password,
       controller: "clearance/passwords",
-      only: [:create, :edit, :update]
+      only: [:edit, :update]
   end
 
   get "/sign_in" => "clearance/sessions#new", as: "sign_in"

data/spec/acceptance/clearance_installation_spec.rb

@@ -36,9 +36,6 @@ describe "Clearance Installation" do
        --skip-keeps
        --skip-sprockets
     CMD
-
-    FileUtils.rm_f("public/index.html")
-    FileUtils.rm_f("app/views/layouts/application.html.erb")
   end
 
   def testapp_templates
@@ -47,7 +44,6 @@ describe "Clearance Installation" do
 
   def configure_test_app
     FileUtils.rm_f("public/index.html")
-    FileUtils.rm_f("app/views/layouts/application.html.erb")
     FileUtils.cp_r(testapp_templates, "..")
   end
 

data/spec/app_templates/app/models/user.rb

@@ -1,4 +1,4 @@
-class User < ActiveRecord::Base
+class User < ApplicationRecord
   def previously_existed?
     true
   end

data/spec/app_templates/testapp/app/views/layouts/application.html.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <%= javascript_include_tag 'application' %>
+    <%= csrf_meta_tag %>
+  </head>
+  <body>
+    <div id="header">
+      <% if signed_in? -%>
+        <%= button_to t(".sign_out"), sign_out_path, method: :delete %>
+      <% else -%>
+        <%= link_to t(".sign_in"), sign_in_path %>
+      <% end -%>
+    </div>
+
+    <div id="flash">
+      <% flash.each do |key, value| -%>
+        <div id="flash_<%= key %>"><%=h value %></div>
+      <% end %>
+    </div>
+
+    <%= yield %>
+  </body>
+</html>

data/spec/clearance/back_door_spec.rb

@@ -46,6 +46,18 @@ describe Clearance::BackDoor do
     end
   end
 
+  it "strips 'as' from the params" do
+    user_id = "123"
+    user = double("user")
+    allow(User).to receive(:find).with(user_id).and_return(user)
+    env = build_env(as: user_id, foo: :bar)
+    back_door = Clearance::BackDoor.new(mock_app)
+
+    back_door.call(env)
+
+    expect(env["QUERY_STRING"]).to eq("foo=bar")
+  end
+
   context "when the environments are disabled" do
     before do
       Clearance.configuration.allowed_backdoor_environments = nil
@@ -84,14 +96,18 @@ describe Clearance::BackDoor do
     env_for_user_id("")
   end
 
-  def env_for_user_id(user_id)
+  def build_env(params)
+    query = Rack::Utils.build_query(params)
     clearance = double("clearance", sign_in: true)
-    Rack::MockRequest.env_for("/?as=#{user_id}").merge(clearance: clearance)
+    Rack::MockRequest.env_for("/?#{query}").merge(clearance: clearance)
+  end
+
+  def env_for_user_id(user_id)
+    build_env(as: user_id)
   end
 
   def env_for_username(username)
-    clearance = double("clearance", sign_in: true)
-    Rack::MockRequest.env_for("/?as=#{username}").merge(clearance: clearance)
+    build_env(as: username)
   end
 
   def mock_app

data/spec/clearance/rack_session_spec.rb

@@ -11,6 +11,8 @@ describe Clearance::RackSession do
     env = Rack::MockRequest.env_for('/')
     expected_session = "the session"
     allow(expected_session).to receive(:add_cookie_to_headers)
+    allow(expected_session).to receive(:authentication_successful?).
+      and_return(true)
     allow(Clearance::Session).to receive(:new).
       with(env).
       and_return(expected_session)

data/spec/clearance/session_spec.rb

@@ -129,6 +129,12 @@ describe Clearance::Session do
 
       def stub_guard_class(guard)
         double("guard_class").tap do |guard_class|
+          allow(guard_class).to receive(:to_s).
+            and_return(guard_class)
+
+          allow(guard_class).to receive(:constantize).
+            and_return(guard_class)
+
           allow(guard_class).to receive(:new).
             with(session, stub_default_sign_in_guard).
             and_return(guard)
@@ -170,6 +176,31 @@ describe Clearance::Session do
     end
   end
 
+  context "if same_site is set" do
+    before do
+      Clearance.configuration.same_site = :lax
+      session.sign_in(user)
+    end
+
+    it "sets a same-site cookie" do
+      session.add_cookie_to_headers(headers)
+
+      expect(headers["Set-Cookie"]).to match(/remember_token=.+; SameSite/)
+    end
+  end
+
+  context "if same_site is not set" do
+    before do
+      session.sign_in(user)
+    end
+
+    it "sets a standard cookie" do
+      session.add_cookie_to_headers(headers)
+
+      expect(headers["Set-Cookie"]).to_not match(/remember_token=.+; SameSite/)
+    end
+  end
+
   describe 'remember token cookie expiration' do
     context 'default configuration' do
       it 'is set to 1 year from now' do
@@ -309,14 +340,63 @@ describe Clearance::Session do
     expect(headers["Set-Cookie"]).to be nil
   end
 
-  it 'signs out a user' do
-    user = create(:user)
-    old_remember_token = user.remember_token
-    env = env_with_remember_token(old_remember_token)
-    session = Clearance::Session.new(env)
-    session.sign_out
-    expect(session.current_user).to be_nil
-    expect(user.reload.remember_token).not_to eq old_remember_token
+  describe "#sign_out" do
+    it "signs out a user" do
+      user = create(:user)
+      old_remember_token = user.remember_token
+      env = env_with_remember_token(old_remember_token)
+      session = Clearance::Session.new(env)
+      cookie_jar = ActionDispatch::Request.new(env).cookie_jar
+      expect(cookie_jar.deleted?(:remember_token)).to be false
+
+      session.sign_out
+
+      expect(cookie_jar.deleted?(:remember_token)).to be true
+      expect(session.current_user).to be_nil
+      expect(user.reload.remember_token).not_to eq old_remember_token
+    end
+
+    context "with custom cookie domain" do
+      let(:domain) { ".example.com" }
+
+      before do
+        Clearance.configuration.cookie_domain = domain
+      end
+
+      it "clears cookie" do
+        user = create(:user)
+        env = env_with_remember_token(
+          value: user.remember_token,
+          domain: domain,
+        )
+        session = Clearance::Session.new(env)
+        cookie_jar = ActionDispatch::Request.new(env).cookie_jar
+        expect(cookie_jar.deleted?(:remember_token, domain: domain)).to be false
+
+        session.sign_out
+
+        expect(cookie_jar.deleted?(:remember_token, domain: domain)).to be true
+      end
+    end
+
+    context 'with callable cookie domain' do
+      it 'clears cookie' do
+        domain = '.example.com'
+        Clearance.configuration.cookie_domain = ->(_) { domain }
+        user = create(:user)
+        env = env_with_remember_token(
+          value: user.remember_token,
+          domain: domain
+        )
+        session = Clearance::Session.new(env)
+        cookie_jar = ActionDispatch::Request.new(env).cookie_jar
+        expect(cookie_jar.deleted?(:remember_token, domain: domain)).to be false
+
+        session.sign_out
+
+        expect(cookie_jar.deleted?(:remember_token, domain: domain)).to be true
+      end
+    end
   end
 
   def env_with_cookies(cookies)