devise 3.2.2 → 4.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +281 -957
- data/MIT-LICENSE +2 -1
- data/README.md +410 -120
- data/app/controllers/devise/confirmations_controller.rb +11 -5
- data/app/controllers/devise/omniauth_callbacks_controller.rb +12 -6
- data/app/controllers/devise/passwords_controller.rb +21 -8
- data/app/controllers/devise/registrations_controller.rb +59 -26
- data/app/controllers/devise/sessions_controller.rb +47 -17
- data/app/controllers/devise/unlocks_controller.rb +9 -4
- data/app/controllers/devise_controller.rb +69 -33
- data/app/helpers/devise_helper.rb +23 -18
- data/app/mailers/devise/mailer.rb +13 -3
- data/app/views/devise/confirmations/new.html.erb +9 -5
- data/app/views/devise/mailer/confirmation_instructions.html.erb +1 -1
- data/app/views/devise/mailer/email_changed.html.erb +7 -0
- data/app/views/devise/mailer/password_change.html.erb +3 -0
- data/app/views/devise/mailer/reset_password_instructions.html.erb +1 -1
- data/app/views/devise/mailer/unlock_instructions.html.erb +1 -1
- data/app/views/devise/passwords/edit.html.erb +16 -7
- data/app/views/devise/passwords/new.html.erb +9 -5
- data/app/views/devise/registrations/edit.html.erb +29 -15
- data/app/views/devise/registrations/new.html.erb +20 -9
- data/app/views/devise/sessions/new.html.erb +19 -10
- data/app/views/devise/shared/_error_messages.html.erb +15 -0
- data/app/views/devise/shared/{_links.erb → _links.html.erb} +9 -9
- data/app/views/devise/unlocks/new.html.erb +9 -5
- data/config/locales/en.yml +24 -18
- data/lib/devise/controllers/helpers.rb +113 -33
- data/lib/devise/controllers/rememberable.rb +15 -6
- data/lib/devise/controllers/scoped_views.rb +3 -1
- data/lib/devise/controllers/sign_in_out.rb +47 -29
- data/lib/devise/controllers/store_location.rb +31 -5
- data/lib/devise/controllers/url_helpers.rb +10 -8
- data/lib/devise/delegator.rb +2 -0
- data/lib/devise/encryptor.rb +24 -0
- data/lib/devise/failure_app.rb +119 -40
- data/lib/devise/hooks/activatable.rb +7 -6
- data/lib/devise/hooks/csrf_cleaner.rb +5 -1
- data/lib/devise/hooks/forgetable.rb +2 -0
- data/lib/devise/hooks/lockable.rb +5 -3
- data/lib/devise/hooks/proxy.rb +4 -2
- data/lib/devise/hooks/rememberable.rb +4 -2
- data/lib/devise/hooks/timeoutable.rb +16 -9
- data/lib/devise/hooks/trackable.rb +3 -1
- data/lib/devise/mailers/helpers.rb +15 -12
- data/lib/devise/mapping.rb +9 -3
- data/lib/devise/models/authenticatable.rb +91 -61
- data/lib/devise/models/confirmable.rb +138 -43
- data/lib/devise/models/database_authenticatable.rb +112 -31
- data/lib/devise/models/lockable.rb +39 -18
- data/lib/devise/models/omniauthable.rb +3 -1
- data/lib/devise/models/recoverable.rb +64 -28
- data/lib/devise/models/registerable.rb +4 -0
- data/lib/devise/models/rememberable.rb +62 -33
- data/lib/devise/models/timeoutable.rb +4 -8
- data/lib/devise/models/trackable.rb +20 -4
- data/lib/devise/models/validatable.rb +16 -9
- data/lib/devise/models.rb +3 -1
- data/lib/devise/modules.rb +12 -10
- data/lib/devise/omniauth/config.rb +2 -0
- data/lib/devise/omniauth/url_helpers.rb +14 -5
- data/lib/devise/omniauth.rb +4 -5
- data/lib/devise/orm/active_record.rb +5 -1
- data/lib/devise/orm/mongoid.rb +6 -2
- data/lib/devise/parameter_filter.rb +4 -0
- data/lib/devise/parameter_sanitizer.rb +139 -65
- data/lib/devise/rails/deprecated_constant_accessor.rb +39 -0
- data/lib/devise/rails/routes.rb +151 -120
- data/lib/devise/rails/warden_compat.rb +3 -10
- data/lib/devise/rails.rb +10 -13
- data/lib/devise/secret_key_finder.rb +27 -0
- data/lib/devise/strategies/authenticatable.rb +21 -10
- data/lib/devise/strategies/base.rb +3 -1
- data/lib/devise/strategies/database_authenticatable.rb +14 -6
- data/lib/devise/strategies/rememberable.rb +15 -3
- data/lib/devise/test/controller_helpers.rb +167 -0
- data/lib/devise/test/integration_helpers.rb +63 -0
- data/lib/devise/test_helpers.rb +7 -124
- data/lib/devise/time_inflector.rb +4 -2
- data/lib/devise/token_generator.rb +3 -41
- data/lib/devise/version.rb +3 -1
- data/lib/devise.rb +107 -84
- data/lib/generators/active_record/devise_generator.rb +64 -12
- data/lib/generators/active_record/templates/migration.rb +9 -7
- data/lib/generators/active_record/templates/migration_existing.rb +9 -7
- data/lib/generators/devise/controllers_generator.rb +46 -0
- data/lib/generators/devise/devise_generator.rb +8 -6
- data/lib/generators/devise/install_generator.rb +18 -1
- data/lib/generators/devise/orm_helpers.rb +10 -21
- data/lib/generators/devise/views_generator.rb +49 -28
- data/lib/generators/mongoid/devise_generator.rb +21 -19
- data/lib/generators/templates/README +13 -12
- data/lib/generators/templates/controllers/README +14 -0
- data/lib/generators/templates/controllers/confirmations_controller.rb +30 -0
- data/lib/generators/templates/controllers/omniauth_callbacks_controller.rb +30 -0
- data/lib/generators/templates/controllers/passwords_controller.rb +34 -0
- data/lib/generators/templates/controllers/registrations_controller.rb +62 -0
- data/lib/generators/templates/controllers/sessions_controller.rb +27 -0
- data/lib/generators/templates/controllers/unlocks_controller.rb +30 -0
- data/lib/generators/templates/devise.rb +94 -37
- data/lib/generators/templates/markerb/confirmation_instructions.markerb +1 -1
- data/lib/generators/templates/markerb/email_changed.markerb +7 -0
- data/lib/generators/templates/markerb/password_change.markerb +3 -0
- data/lib/generators/templates/markerb/reset_password_instructions.markerb +1 -1
- data/lib/generators/templates/markerb/unlock_instructions.markerb +1 -1
- data/lib/generators/templates/simple_form_for/confirmations/new.html.erb +6 -2
- data/lib/generators/templates/simple_form_for/passwords/edit.html.erb +12 -4
- data/lib/generators/templates/simple_form_for/passwords/new.html.erb +5 -2
- data/lib/generators/templates/simple_form_for/registrations/edit.html.erb +14 -6
- data/lib/generators/templates/simple_form_for/registrations/new.html.erb +12 -4
- data/lib/generators/templates/simple_form_for/sessions/new.html.erb +11 -6
- data/lib/generators/templates/simple_form_for/unlocks/new.html.erb +5 -2
- metadata +50 -284
- data/.gitignore +0 -10
- data/.travis.yml +0 -20
- data/.yardopts +0 -9
- data/CONTRIBUTING.md +0 -14
- data/Gemfile +0 -31
- data/Gemfile.lock +0 -160
- data/Rakefile +0 -35
- data/devise.gemspec +0 -27
- data/devise.png +0 -0
- data/gemfiles/Gemfile.rails-3.2.x +0 -31
- data/gemfiles/Gemfile.rails-3.2.x.lock +0 -159
- data/test/controllers/custom_strategy_test.rb +0 -62
- data/test/controllers/helpers_test.rb +0 -276
- data/test/controllers/internal_helpers_test.rb +0 -120
- data/test/controllers/passwords_controller_test.rb +0 -31
- data/test/controllers/sessions_controller_test.rb +0 -99
- data/test/controllers/url_helpers_test.rb +0 -59
- data/test/delegator_test.rb +0 -19
- data/test/devise_test.rb +0 -94
- data/test/failure_app_test.rb +0 -232
- data/test/generators/active_record_generator_test.rb +0 -103
- data/test/generators/devise_generator_test.rb +0 -39
- data/test/generators/install_generator_test.rb +0 -13
- data/test/generators/mongoid_generator_test.rb +0 -23
- data/test/generators/views_generator_test.rb +0 -67
- data/test/helpers/devise_helper_test.rb +0 -51
- data/test/integration/authenticatable_test.rb +0 -713
- data/test/integration/confirmable_test.rb +0 -284
- data/test/integration/database_authenticatable_test.rb +0 -84
- data/test/integration/http_authenticatable_test.rb +0 -105
- data/test/integration/lockable_test.rb +0 -239
- data/test/integration/omniauthable_test.rb +0 -133
- data/test/integration/recoverable_test.rb +0 -334
- data/test/integration/registerable_test.rb +0 -349
- data/test/integration/rememberable_test.rb +0 -167
- data/test/integration/timeoutable_test.rb +0 -183
- data/test/integration/trackable_test.rb +0 -92
- data/test/mailers/confirmation_instructions_test.rb +0 -115
- data/test/mailers/reset_password_instructions_test.rb +0 -96
- data/test/mailers/unlock_instructions_test.rb +0 -91
- data/test/mapping_test.rb +0 -127
- data/test/models/authenticatable_test.rb +0 -13
- data/test/models/confirmable_test.rb +0 -454
- data/test/models/database_authenticatable_test.rb +0 -249
- data/test/models/lockable_test.rb +0 -298
- data/test/models/omniauthable_test.rb +0 -7
- data/test/models/recoverable_test.rb +0 -184
- data/test/models/registerable_test.rb +0 -7
- data/test/models/rememberable_test.rb +0 -183
- data/test/models/serializable_test.rb +0 -49
- data/test/models/timeoutable_test.rb +0 -51
- data/test/models/trackable_test.rb +0 -13
- data/test/models/validatable_test.rb +0 -127
- data/test/models_test.rb +0 -144
- data/test/omniauth/config_test.rb +0 -57
- data/test/omniauth/url_helpers_test.rb +0 -54
- data/test/orm/active_record.rb +0 -10
- data/test/orm/mongoid.rb +0 -13
- data/test/parameter_sanitizer_test.rb +0 -81
- data/test/rails_app/Rakefile +0 -6
- data/test/rails_app/app/active_record/admin.rb +0 -6
- data/test/rails_app/app/active_record/shim.rb +0 -2
- data/test/rails_app/app/active_record/user.rb +0 -6
- data/test/rails_app/app/controllers/admins/sessions_controller.rb +0 -6
- data/test/rails_app/app/controllers/admins_controller.rb +0 -11
- data/test/rails_app/app/controllers/application_controller.rb +0 -9
- data/test/rails_app/app/controllers/home_controller.rb +0 -25
- data/test/rails_app/app/controllers/publisher/registrations_controller.rb +0 -2
- data/test/rails_app/app/controllers/publisher/sessions_controller.rb +0 -2
- data/test/rails_app/app/controllers/users/omniauth_callbacks_controller.rb +0 -14
- data/test/rails_app/app/controllers/users_controller.rb +0 -31
- data/test/rails_app/app/helpers/application_helper.rb +0 -3
- data/test/rails_app/app/mailers/users/mailer.rb +0 -12
- data/test/rails_app/app/mongoid/admin.rb +0 -29
- data/test/rails_app/app/mongoid/shim.rb +0 -23
- data/test/rails_app/app/mongoid/user.rb +0 -39
- data/test/rails_app/app/views/admins/index.html.erb +0 -1
- data/test/rails_app/app/views/admins/sessions/new.html.erb +0 -2
- data/test/rails_app/app/views/home/admin_dashboard.html.erb +0 -1
- data/test/rails_app/app/views/home/index.html.erb +0 -1
- data/test/rails_app/app/views/home/join.html.erb +0 -1
- data/test/rails_app/app/views/home/private.html.erb +0 -1
- data/test/rails_app/app/views/home/user_dashboard.html.erb +0 -1
- data/test/rails_app/app/views/layouts/application.html.erb +0 -24
- data/test/rails_app/app/views/users/edit_form.html.erb +0 -1
- data/test/rails_app/app/views/users/index.html.erb +0 -1
- data/test/rails_app/app/views/users/mailer/confirmation_instructions.erb +0 -1
- data/test/rails_app/app/views/users/sessions/new.html.erb +0 -1
- data/test/rails_app/bin/bundle +0 -3
- data/test/rails_app/bin/rails +0 -4
- data/test/rails_app/bin/rake +0 -4
- data/test/rails_app/config/application.rb +0 -40
- data/test/rails_app/config/boot.rb +0 -14
- data/test/rails_app/config/database.yml +0 -18
- data/test/rails_app/config/environment.rb +0 -5
- data/test/rails_app/config/environments/development.rb +0 -30
- data/test/rails_app/config/environments/production.rb +0 -80
- data/test/rails_app/config/environments/test.rb +0 -36
- data/test/rails_app/config/initializers/backtrace_silencers.rb +0 -7
- data/test/rails_app/config/initializers/devise.rb +0 -181
- data/test/rails_app/config/initializers/inflections.rb +0 -2
- data/test/rails_app/config/initializers/secret_token.rb +0 -8
- data/test/rails_app/config/initializers/session_store.rb +0 -1
- data/test/rails_app/config/routes.rb +0 -104
- data/test/rails_app/config.ru +0 -4
- data/test/rails_app/db/migrate/20100401102949_create_tables.rb +0 -71
- data/test/rails_app/db/schema.rb +0 -55
- data/test/rails_app/lib/shared_admin.rb +0 -17
- data/test/rails_app/lib/shared_user.rb +0 -29
- data/test/rails_app/public/404.html +0 -26
- data/test/rails_app/public/422.html +0 -26
- data/test/rails_app/public/500.html +0 -26
- data/test/rails_app/public/favicon.ico +0 -0
- data/test/routes_test.rb +0 -250
- data/test/support/assertions.rb +0 -40
- data/test/support/helpers.rb +0 -70
- data/test/support/integration.rb +0 -92
- data/test/support/locale/en.yml +0 -8
- data/test/support/webrat/integrations/rails.rb +0 -24
- data/test/test_helper.rb +0 -27
- data/test/test_helpers_test.rb +0 -173
- data/test/test_models.rb +0 -33
@@ -1,20 +1,28 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
require 'devise/strategies/authenticatable'
|
2
4
|
|
3
5
|
module Devise
|
4
6
|
module Strategies
|
5
|
-
# Default strategy for signing in a user, based on
|
7
|
+
# Default strategy for signing in a user, based on their email and password in the database.
|
6
8
|
class DatabaseAuthenticatable < Authenticatable
|
7
9
|
def authenticate!
|
8
|
-
resource =
|
9
|
-
|
10
|
+
resource = password.present? && mapping.to.find_for_database_authentication(authentication_hash)
|
11
|
+
hashed = false
|
10
12
|
|
11
|
-
if validate(resource){
|
13
|
+
if validate(resource){ hashed = true; resource.valid_password?(password) }
|
14
|
+
remember_me(resource)
|
12
15
|
resource.after_database_authentication
|
13
16
|
success!(resource)
|
14
17
|
end
|
15
18
|
|
16
|
-
|
17
|
-
|
19
|
+
# In paranoid mode, hash the password even when a resource doesn't exist for the given authentication key.
|
20
|
+
# This is necessary to prevent enumeration attacks - e.g. the request is faster when a resource doesn't
|
21
|
+
# exist in the database if the password hashing algorithm is not called.
|
22
|
+
mapping.to.new.password = password if !hashed && Devise.paranoid
|
23
|
+
unless resource
|
24
|
+
Devise.paranoid ? fail(:invalid) : fail(:not_found_in_database)
|
25
|
+
end
|
18
26
|
end
|
19
27
|
end
|
20
28
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
require 'devise/strategies/authenticatable'
|
2
4
|
|
3
5
|
module Devise
|
@@ -25,15 +27,25 @@ module Devise
|
|
25
27
|
end
|
26
28
|
|
27
29
|
if validate(resource)
|
30
|
+
remember_me(resource) if extend_remember_me?(resource)
|
31
|
+
resource.after_remembered
|
28
32
|
success!(resource)
|
29
33
|
end
|
30
34
|
end
|
31
35
|
|
36
|
+
# No need to clean up the CSRF when using rememberable.
|
37
|
+
# In fact, cleaning it up here would be a bug because
|
38
|
+
# rememberable is triggered on GET requests which means
|
39
|
+
# we would render a page on first access with all csrf
|
40
|
+
# tokens expired.
|
41
|
+
def clean_up_csrf?
|
42
|
+
false
|
43
|
+
end
|
44
|
+
|
32
45
|
private
|
33
46
|
|
34
|
-
def
|
35
|
-
|
36
|
-
resource.extend_remember_period = mapping.to.extend_remember_period if resource.respond_to?(:extend_remember_period=)
|
47
|
+
def extend_remember_me?(resource)
|
48
|
+
resource.respond_to?(:extend_remember_period) && resource.extend_remember_period
|
37
49
|
end
|
38
50
|
|
39
51
|
def remember_me?
|
@@ -0,0 +1,167 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Devise
|
4
|
+
module Test
|
5
|
+
# `Devise::Test::ControllerHelpers` provides a facility to test controllers
|
6
|
+
# in isolation when using `ActionController::TestCase` allowing you to
|
7
|
+
# quickly sign_in or sign_out a user. Do not use
|
8
|
+
# `Devise::Test::ControllerHelpers` in integration tests.
|
9
|
+
#
|
10
|
+
# Examples
|
11
|
+
#
|
12
|
+
# class PostsTest < ActionController::TestCase
|
13
|
+
# include Devise::Test::ControllerHelpers
|
14
|
+
#
|
15
|
+
# test 'authenticated users can GET index' do
|
16
|
+
# sign_in users(:bob)
|
17
|
+
#
|
18
|
+
# get :index
|
19
|
+
# assert_response :success
|
20
|
+
# end
|
21
|
+
# end
|
22
|
+
#
|
23
|
+
# Important: you should not test Warden specific behavior (like callbacks)
|
24
|
+
# using `Devise::Test::ControllerHelpers` since it is a stub of the actual
|
25
|
+
# behavior. Such callbacks should be tested in your integration suite instead.
|
26
|
+
module ControllerHelpers
|
27
|
+
extend ActiveSupport::Concern
|
28
|
+
|
29
|
+
included do
|
30
|
+
setup :setup_controller_for_warden, :warden
|
31
|
+
end
|
32
|
+
|
33
|
+
# Override process to consider warden.
|
34
|
+
def process(*)
|
35
|
+
_catch_warden { super }
|
36
|
+
|
37
|
+
@response
|
38
|
+
end
|
39
|
+
|
40
|
+
ruby2_keywords(:process) if respond_to?(:ruby2_keywords, true)
|
41
|
+
|
42
|
+
# We need to set up the environment variables and the response in the controller.
|
43
|
+
def setup_controller_for_warden #:nodoc:
|
44
|
+
@request.env['action_controller.instance'] = @controller
|
45
|
+
end
|
46
|
+
|
47
|
+
# Quick access to Warden::Proxy.
|
48
|
+
def warden #:nodoc:
|
49
|
+
@request.env['warden'] ||= begin
|
50
|
+
manager = Warden::Manager.new(nil) do |config|
|
51
|
+
config.merge! Devise.warden_config
|
52
|
+
end
|
53
|
+
Warden::Proxy.new(@request.env, manager)
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
# sign_in a given resource by storing its keys in the session.
|
58
|
+
# This method bypass any warden authentication callback.
|
59
|
+
#
|
60
|
+
# * +resource+ - The resource that should be authenticated
|
61
|
+
# * +scope+ - An optional +Symbol+ with the scope where the resource
|
62
|
+
# should be signed in with.
|
63
|
+
# Examples:
|
64
|
+
#
|
65
|
+
# sign_in users(:alice)
|
66
|
+
# sign_in users(:alice), scope: :admin
|
67
|
+
def sign_in(resource, deprecated = nil, scope: nil)
|
68
|
+
if deprecated.present?
|
69
|
+
scope = resource
|
70
|
+
resource = deprecated
|
71
|
+
|
72
|
+
ActiveSupport::Deprecation.warn <<-DEPRECATION.strip_heredoc
|
73
|
+
[Devise] sign_in(:#{scope}, resource) on controller tests is deprecated and will be removed from Devise.
|
74
|
+
Please use sign_in(resource, scope: :#{scope}) instead.
|
75
|
+
DEPRECATION
|
76
|
+
end
|
77
|
+
|
78
|
+
scope ||= Devise::Mapping.find_scope!(resource)
|
79
|
+
|
80
|
+
warden.instance_variable_get(:@users).delete(scope)
|
81
|
+
warden.session_serializer.store(resource, scope)
|
82
|
+
end
|
83
|
+
|
84
|
+
# Sign out a given resource or scope by calling logout on Warden.
|
85
|
+
# This method bypass any warden logout callback.
|
86
|
+
#
|
87
|
+
# Examples:
|
88
|
+
#
|
89
|
+
# sign_out :user # sign_out(scope)
|
90
|
+
# sign_out @user # sign_out(resource)
|
91
|
+
#
|
92
|
+
def sign_out(resource_or_scope)
|
93
|
+
scope = Devise::Mapping.find_scope!(resource_or_scope)
|
94
|
+
@controller.instance_variable_set(:"@current_#{scope}", nil)
|
95
|
+
user = warden.instance_variable_get(:@users).delete(scope)
|
96
|
+
warden.session_serializer.delete(scope, user)
|
97
|
+
end
|
98
|
+
|
99
|
+
protected
|
100
|
+
|
101
|
+
# Catch warden continuations and handle like the middleware would.
|
102
|
+
# Returns nil when interrupted, otherwise the normal result of the block.
|
103
|
+
def _catch_warden(&block)
|
104
|
+
result = catch(:warden, &block)
|
105
|
+
|
106
|
+
env = @controller.request.env
|
107
|
+
|
108
|
+
result ||= {}
|
109
|
+
|
110
|
+
# Set the response. In production, the rack result is returned
|
111
|
+
# from Warden::Manager#call, which the following is modelled on.
|
112
|
+
case result
|
113
|
+
when Array
|
114
|
+
if result.first == 401 && intercept_401?(env) # does this happen during testing?
|
115
|
+
_process_unauthenticated(env)
|
116
|
+
else
|
117
|
+
result
|
118
|
+
end
|
119
|
+
when Hash
|
120
|
+
_process_unauthenticated(env, result)
|
121
|
+
else
|
122
|
+
result
|
123
|
+
end
|
124
|
+
end
|
125
|
+
|
126
|
+
def _process_unauthenticated(env, options = {})
|
127
|
+
options[:action] ||= :unauthenticated
|
128
|
+
proxy = request.env['warden']
|
129
|
+
result = options[:result] || proxy.result
|
130
|
+
|
131
|
+
ret = case result
|
132
|
+
when :redirect
|
133
|
+
body = proxy.message || "You are being redirected to #{proxy.headers['Location']}"
|
134
|
+
[proxy.status, proxy.headers, [body]]
|
135
|
+
when :custom
|
136
|
+
proxy.custom_response
|
137
|
+
else
|
138
|
+
request.env["PATH_INFO"] = "/#{options[:action]}"
|
139
|
+
request.env["warden.options"] = options
|
140
|
+
Warden::Manager._run_callbacks(:before_failure, env, options)
|
141
|
+
|
142
|
+
status, headers, response = Devise.warden_config[:failure_app].call(env).to_a
|
143
|
+
@controller.response.headers.merge!(headers)
|
144
|
+
@controller.response.content_type = headers["Content-Type"] unless Rails::VERSION::MAJOR >= 5
|
145
|
+
@controller.status = status
|
146
|
+
@controller.response_body = response.body
|
147
|
+
nil # causes process return @response
|
148
|
+
end
|
149
|
+
|
150
|
+
# ensure that the controller response is set up. In production, this is
|
151
|
+
# not necessary since warden returns the results to rack. However, at
|
152
|
+
# testing time, we want the response to be available to the testing
|
153
|
+
# framework to verify what would be returned to rack.
|
154
|
+
if ret.is_a?(Array)
|
155
|
+
status, headers, body = *ret
|
156
|
+
# ensure the controller response is set to our response.
|
157
|
+
@controller.response ||= @response
|
158
|
+
@response.status = status
|
159
|
+
@response.headers.merge!(headers)
|
160
|
+
@response.body = body
|
161
|
+
end
|
162
|
+
|
163
|
+
ret
|
164
|
+
end
|
165
|
+
end
|
166
|
+
end
|
167
|
+
end
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Devise
|
4
|
+
# Devise::Test::IntegrationHelpers is a helper module for facilitating
|
5
|
+
# authentication on Rails integration tests to bypass the required steps for
|
6
|
+
# signin in or signin out a record.
|
7
|
+
#
|
8
|
+
# Examples
|
9
|
+
#
|
10
|
+
# class PostsTest < ActionDispatch::IntegrationTest
|
11
|
+
# include Devise::Test::IntegrationHelpers
|
12
|
+
#
|
13
|
+
# test 'authenticated users can see posts' do
|
14
|
+
# sign_in users(:bob)
|
15
|
+
#
|
16
|
+
# get '/posts'
|
17
|
+
# assert_response :success
|
18
|
+
# end
|
19
|
+
# end
|
20
|
+
module Test
|
21
|
+
module IntegrationHelpers
|
22
|
+
def self.included(base)
|
23
|
+
base.class_eval do
|
24
|
+
include Warden::Test::Helpers
|
25
|
+
|
26
|
+
setup :setup_integration_for_devise
|
27
|
+
teardown :teardown_integration_for_devise
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
# Signs in a specific resource, mimicking a successful sign in
|
32
|
+
# operation through +Devise::SessionsController#create+.
|
33
|
+
#
|
34
|
+
# * +resource+ - The resource that should be authenticated
|
35
|
+
# * +scope+ - An optional +Symbol+ with the scope where the resource
|
36
|
+
# should be signed in with.
|
37
|
+
def sign_in(resource, scope: nil)
|
38
|
+
scope ||= Devise::Mapping.find_scope!(resource)
|
39
|
+
|
40
|
+
login_as(resource, scope: scope)
|
41
|
+
end
|
42
|
+
|
43
|
+
# Signs out a specific scope from the session.
|
44
|
+
#
|
45
|
+
# * +resource_or_scope+ - The resource or scope that should be signed out.
|
46
|
+
def sign_out(resource_or_scope)
|
47
|
+
scope = Devise::Mapping.find_scope!(resource_or_scope)
|
48
|
+
|
49
|
+
logout scope
|
50
|
+
end
|
51
|
+
|
52
|
+
protected
|
53
|
+
|
54
|
+
def setup_integration_for_devise
|
55
|
+
Warden.test_mode!
|
56
|
+
end
|
57
|
+
|
58
|
+
def teardown_integration_for_devise
|
59
|
+
Warden.test_reset!
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
data/lib/devise/test_helpers.rb
CHANGED
@@ -1,132 +1,15 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
module Devise
|
2
|
-
# Devise::TestHelpers provides a facility to test controllers in isolation
|
3
|
-
# when using ActionController::TestCase allowing you to quickly sign_in or
|
4
|
-
# sign_out a user. Do not use Devise::TestHelpers in integration tests.
|
5
|
-
#
|
6
|
-
# Notice you should not test Warden specific behavior (like Warden callbacks)
|
7
|
-
# using Devise::TestHelpers since it is a stub of the actual behavior. Such
|
8
|
-
# callbacks should be tested in your integration suite instead.
|
9
4
|
module TestHelpers
|
10
5
|
def self.included(base)
|
11
6
|
base.class_eval do
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
def process(*)
|
18
|
-
# Make sure we always return @response, a la ActionController::TestCase::Behaviour#process, even if warden interrupts
|
19
|
-
_catch_warden { super } || @response
|
20
|
-
end
|
21
|
-
|
22
|
-
# We need to setup the environment variables and the response in the controller.
|
23
|
-
def setup_controller_for_warden #:nodoc:
|
24
|
-
@request.env['action_controller.instance'] = @controller
|
25
|
-
end
|
26
|
-
|
27
|
-
# Quick access to Warden::Proxy.
|
28
|
-
def warden #:nodoc:
|
29
|
-
@warden ||= begin
|
30
|
-
manager = Warden::Manager.new(nil) do |config|
|
31
|
-
config.merge! Devise.warden_config
|
32
|
-
end
|
33
|
-
@request.env['warden'] = Warden::Proxy.new(@request.env, manager)
|
7
|
+
ActiveSupport::Deprecation.warn <<-DEPRECATION.strip_heredoc
|
8
|
+
[Devise] including `Devise::TestHelpers` is deprecated and will be removed from Devise.
|
9
|
+
For controller tests, please include `Devise::Test::ControllerHelpers` instead.
|
10
|
+
DEPRECATION
|
11
|
+
include Devise::Test::ControllerHelpers
|
34
12
|
end
|
35
13
|
end
|
36
|
-
|
37
|
-
# sign_in a given resource by storing its keys in the session.
|
38
|
-
# This method bypass any warden authentication callback.
|
39
|
-
#
|
40
|
-
# Examples:
|
41
|
-
#
|
42
|
-
# sign_in :user, @user # sign_in(scope, resource)
|
43
|
-
# sign_in @user # sign_in(resource)
|
44
|
-
#
|
45
|
-
def sign_in(resource_or_scope, resource=nil)
|
46
|
-
scope ||= Devise::Mapping.find_scope!(resource_or_scope)
|
47
|
-
resource ||= resource_or_scope
|
48
|
-
warden.instance_variable_get(:@users).delete(scope)
|
49
|
-
warden.session_serializer.store(resource, scope)
|
50
|
-
end
|
51
|
-
|
52
|
-
# Sign out a given resource or scope by calling logout on Warden.
|
53
|
-
# This method bypass any warden logout callback.
|
54
|
-
#
|
55
|
-
# Examples:
|
56
|
-
#
|
57
|
-
# sign_out :user # sign_out(scope)
|
58
|
-
# sign_out @user # sign_out(resource)
|
59
|
-
#
|
60
|
-
def sign_out(resource_or_scope)
|
61
|
-
scope = Devise::Mapping.find_scope!(resource_or_scope)
|
62
|
-
@controller.instance_variable_set(:"@current_#{scope}", nil)
|
63
|
-
user = warden.instance_variable_get(:@users).delete(scope)
|
64
|
-
warden.session_serializer.delete(scope, user)
|
65
|
-
end
|
66
|
-
|
67
|
-
protected
|
68
|
-
|
69
|
-
# Catch warden continuations and handle like the middleware would.
|
70
|
-
# Returns nil when interrupted, otherwise the normal result of the block.
|
71
|
-
def _catch_warden(&block)
|
72
|
-
result = catch(:warden, &block)
|
73
|
-
|
74
|
-
env = @controller.request.env
|
75
|
-
|
76
|
-
result ||= {}
|
77
|
-
|
78
|
-
# Set the response. In production, the rack result is returned
|
79
|
-
# from Warden::Manager#call, which the following is modelled on.
|
80
|
-
case result
|
81
|
-
when Array
|
82
|
-
if result.first == 401 && intercept_401?(env) # does this happen during testing?
|
83
|
-
_process_unauthenticated(env)
|
84
|
-
else
|
85
|
-
result
|
86
|
-
end
|
87
|
-
when Hash
|
88
|
-
_process_unauthenticated(env, result)
|
89
|
-
else
|
90
|
-
result
|
91
|
-
end
|
92
|
-
end
|
93
|
-
|
94
|
-
def _process_unauthenticated(env, options = {})
|
95
|
-
options[:action] ||= :unauthenticated
|
96
|
-
proxy = env['warden']
|
97
|
-
result = options[:result] || proxy.result
|
98
|
-
|
99
|
-
ret = case result
|
100
|
-
when :redirect
|
101
|
-
body = proxy.message || "You are being redirected to #{proxy.headers['Location']}"
|
102
|
-
[proxy.status, proxy.headers, [body]]
|
103
|
-
when :custom
|
104
|
-
proxy.custom_response
|
105
|
-
else
|
106
|
-
env["PATH_INFO"] = "/#{options[:action]}"
|
107
|
-
env["warden.options"] = options
|
108
|
-
Warden::Manager._run_callbacks(:before_failure, env, options)
|
109
|
-
|
110
|
-
status, headers, response = Devise.warden_config[:failure_app].call(env).to_a
|
111
|
-
@controller.response.headers.merge!(headers)
|
112
|
-
@controller.send :render, :status => status, :text => response.body,
|
113
|
-
:content_type => headers["Content-Type"], :location => headers["Location"]
|
114
|
-
nil # causes process return @response
|
115
|
-
end
|
116
|
-
|
117
|
-
# ensure that the controller response is set up. In production, this is
|
118
|
-
# not necessary since warden returns the results to rack. However, at
|
119
|
-
# testing time, we want the response to be available to the testing
|
120
|
-
# framework to verify what would be returned to rack.
|
121
|
-
if ret.is_a?(Array)
|
122
|
-
# ensure the controller response is set to our response.
|
123
|
-
@controller.response ||= @response
|
124
|
-
@response.status = ret.first
|
125
|
-
@response.headers = ret.second
|
126
|
-
@response.body = ret.third
|
127
|
-
end
|
128
|
-
|
129
|
-
ret
|
130
|
-
end
|
131
14
|
end
|
132
15
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
require "active_support/core_ext/module/delegation"
|
2
4
|
|
3
5
|
module Devise
|
@@ -6,9 +8,9 @@ module Devise
|
|
6
8
|
|
7
9
|
class << self
|
8
10
|
attr_reader :instance
|
9
|
-
delegate :time_ago_in_words, :
|
11
|
+
delegate :time_ago_in_words, to: :instance
|
10
12
|
end
|
11
13
|
|
12
14
|
@instance = new
|
13
15
|
end
|
14
|
-
end
|
16
|
+
end
|
@@ -1,11 +1,10 @@
|
|
1
|
-
#
|
2
|
-
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
3
|
require 'openssl'
|
4
|
-
require 'securerandom'
|
5
4
|
|
6
5
|
module Devise
|
7
6
|
class TokenGenerator
|
8
|
-
def initialize(key_generator, digest="SHA256")
|
7
|
+
def initialize(key_generator, digest = "SHA256")
|
9
8
|
@key_generator = key_generator
|
10
9
|
@digest = digest
|
11
10
|
end
|
@@ -30,41 +29,4 @@ module Devise
|
|
30
29
|
@key_generator.generate_key("Devise #{column}")
|
31
30
|
end
|
32
31
|
end
|
33
|
-
|
34
|
-
# KeyGenerator is a simple wrapper around OpenSSL's implementation of PBKDF2
|
35
|
-
# It can be used to derive a number of keys for various purposes from a given secret.
|
36
|
-
# This lets Rails applications have a single secure secret, but avoid reusing that
|
37
|
-
# key in multiple incompatible contexts.
|
38
|
-
class KeyGenerator
|
39
|
-
def initialize(secret, options = {})
|
40
|
-
@secret = secret
|
41
|
-
# The default iterations are higher than required for our key derivation uses
|
42
|
-
# on the off chance someone uses this for password storage
|
43
|
-
@iterations = options[:iterations] || 2**16
|
44
|
-
end
|
45
|
-
|
46
|
-
# Returns a derived key suitable for use. The default key_size is chosen
|
47
|
-
# to be compatible with the default settings of ActiveSupport::MessageVerifier.
|
48
|
-
# i.e. OpenSSL::Digest::SHA1#block_length
|
49
|
-
def generate_key(salt, key_size=64)
|
50
|
-
OpenSSL::PKCS5.pbkdf2_hmac_sha1(@secret, salt, @iterations, key_size)
|
51
|
-
end
|
52
|
-
end
|
53
|
-
|
54
|
-
# CachingKeyGenerator is a wrapper around KeyGenerator which allows users to avoid
|
55
|
-
# re-executing the key generation process when it's called using the same salt and
|
56
|
-
# key_size
|
57
|
-
class CachingKeyGenerator
|
58
|
-
def initialize(key_generator)
|
59
|
-
@key_generator = key_generator
|
60
|
-
@cache_keys = ThreadSafe::Cache.new
|
61
|
-
end
|
62
|
-
|
63
|
-
# Returns a derived key suitable for use. The default key_size is chosen
|
64
|
-
# to be compatible with the default settings of ActiveSupport::MessageVerifier.
|
65
|
-
# i.e. OpenSSL::Digest::SHA1#block_length
|
66
|
-
def generate_key(salt, key_size=64)
|
67
|
-
@cache_keys["#{salt}#{key_size}"] ||= @key_generator.generate_key(salt, key_size)
|
68
|
-
end
|
69
|
-
end
|
70
32
|
end
|
data/lib/devise/version.rb
CHANGED