-
Notifications
You must be signed in to change notification settings - Fork 204
/
proxy.rb
395 lines (342 loc) · 12.4 KB
/
proxy.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
# encoding: utf-8
# frozen_string_literal: true
module Warden
class UserNotSet < RuntimeError; end
class Proxy
# An accessor to the winning strategy
# :api: private
attr_accessor :winning_strategy
# An accessor to the rack env hash, the proxy owner and its config
# :api: public
attr_reader :env, :manager, :config, :winning_strategies
extend ::Forwardable
include ::Warden::Mixins::Common
ENV_WARDEN_ERRORS = 'warden.errors'.freeze
ENV_SESSION_OPTIONS = 'rack.session.options'.freeze
# :api: private
def_delegators :winning_strategy, :headers, :status, :custom_response
# :api: public
def_delegators :config, :default_strategies
def initialize(env, manager) #:nodoc:
@env, @users, @winning_strategies, @locked = env, {}, {}, false
@manager, @config = manager, manager.config.dup
@strategies = Hash.new { |h,k| h[k] = {} }
end
# Run the on_request callbacks
# :api: private
def on_request
manager._run_callbacks(:on_request, self)
end
# Lazily initiate errors object in session.
# :api: public
def errors
@env[ENV_WARDEN_ERRORS] ||= Errors.new
end
# Points to a SessionSerializer instance responsible for handling
# everything related with storing, fetching and removing the user
# session.
# :api: public
def session_serializer
@session_serializer ||= Warden::SessionSerializer.new(@env)
end
# Clear the cache of performed strategies so far. Warden runs each
# strategy just once during the request lifecycle. You can clear the
# strategies cache if you want to allow a strategy to be run more than
# once.
#
# This method has the same API as authenticate, allowing you to clear
# specific strategies for given scope:
#
# Parameters:
# args - a list of symbols (labels) that name the strategies to attempt
# opts - an options hash that contains the :scope of the user to check
#
# Example:
# # Clear all strategies for the configured default_scope
# env['warden'].clear_strategies_cache!
#
# # Clear all strategies for the :admin scope
# env['warden'].clear_strategies_cache!(:scope => :admin)
#
# # Clear password strategy for the :admin scope
# env['warden'].clear_strategies_cache!(:password, :scope => :admin)
#
# :api: public
def clear_strategies_cache!(*args)
scope, _opts = _retrieve_scope_and_opts(args)
@winning_strategies.delete(scope)
@strategies[scope].each do |k, v|
v.clear! if args.empty? || args.include?(k)
end
end
# Locks the proxy so new users cannot authenticate during the
# request lifecycle. This is useful when the request cannot
# be verified (for example, using a CSRF verification token).
# Notice that already authenticated users are kept as so.
#
# :api: public
def lock!
@locked = true
end
# Run the authentication strategies for the given strategies.
# If there is already a user logged in for a given scope, the strategies are not run
# This does not halt the flow of control and is a passive attempt to authenticate only
# When scope is not specified, the default_scope is assumed.
#
# Parameters:
# args - a list of symbols (labels) that name the strategies to attempt
# opts - an options hash that contains the :scope of the user to check
#
# Example:
# env['warden'].authenticate(:password, :basic, :scope => :sudo)
#
# :api: public
def authenticate(*args)
user, _opts = _perform_authentication(*args)
user
end
# Same API as authenticate, but returns a boolean instead of a user.
# The difference between this method (authenticate?) and authenticated?
# is that the former will run strategies if the user has not yet been
# authenticated, and the second relies on already performed ones.
# :api: public
def authenticate?(*args)
result = !!authenticate(*args)
yield if result && block_given?
result
end
# The same as +authenticate+ except on failure it will throw a :warden symbol causing the request to be halted
# and rendered through the +failure_app+
#
# Example
# env['warden'].authenticate!(:password, :scope => :publisher) # throws if it cannot authenticate
#
# :api: public
def authenticate!(*args)
user, opts = _perform_authentication(*args)
throw(:warden, opts) unless user
user
end
# Check to see if there is an authenticated user for the given scope.
# This brings the user from the session, but does not run strategies before doing so.
# If you want strategies to be run, please check authenticate?.
#
# Parameters:
# scope - the scope to check for authentication. Defaults to default_scope
#
# Example:
# env['warden'].authenticated?(:admin)
#
# :api: public
def authenticated?(scope = @config.default_scope)
result = !!user(scope)
yield if block_given? && result
result
end
# Same API as authenticated?, but returns false when authenticated.
# :api: public
def unauthenticated?(scope = @config.default_scope)
result = !authenticated?(scope)
yield if block_given? && result
result
end
# Manually set the user into the session and auth proxy
#
# Parameters:
# user - An object that has been setup to serialize into and out of the session.
# opts - An options hash. Use the :scope option to set the scope of the user, set the :store option to false to skip serializing into the session, set the :run_callbacks to false to skip running the callbacks (the default is true).
#
# :api: public
def set_user(user, opts = {})
scope = (opts[:scope] ||= @config.default_scope)
# Get the default options from the master configuration for the given scope
opts = (@config[:scope_defaults][scope] || {}).merge(opts)
opts[:event] ||= :set_user
@users[scope] = user
if opts[:store] != false && opts[:event] != :fetch
options = env[ENV_SESSION_OPTIONS]
if options
if options.frozen?
env[ENV_SESSION_OPTIONS] = options.merge(:renew => true).freeze
else
options[:renew] = true
end
end
session_serializer.store(user, scope)
end
run_callbacks = opts.fetch(:run_callbacks, true)
manager._run_callbacks(:after_set_user, user, self, opts) if run_callbacks
@users[scope]
end
# Provides access to the user object in a given scope for a request.
# Will be nil if not logged in. Please notice that this method does not
# perform strategies.
#
# Example:
# # without scope (default user)
# env['warden'].user
#
# # with scope
# env['warden'].user(:admin)
#
# # as a Hash
# env['warden'].user(:scope => :admin)
#
# # with default scope and run_callbacks option
# env['warden'].user(:run_callbacks => false)
#
# # with a scope and run_callbacks option
# env['warden'].user(:scope => :admin, :run_callbacks => true)
#
# :api: public
def user(argument = {})
opts = argument.is_a?(Hash) ? argument : { :scope => argument }
scope = (opts[:scope] ||= @config.default_scope)
if @users.has_key?(scope)
@users[scope]
else
unless user = session_serializer.fetch(scope)
run_callbacks = opts.fetch(:run_callbacks, true)
manager._run_callbacks(:after_failed_fetch, user, self, :scope => scope) if run_callbacks
end
@users[scope] = user ? set_user(user, opts.merge(:event => :fetch)) : nil
end
end
# Provides a scoped session data for authenticated users.
# Warden manages clearing out this data when a user logs out
#
# Example
# # default scope
# env['warden'].session[:foo] = "bar"
#
# # :sudo scope
# env['warden'].session(:sudo)[:foo] = "bar"
#
# :api: public
def session(scope = @config.default_scope)
raise NotAuthenticated, "#{scope.inspect} user is not logged in" unless authenticated?(scope)
raw_session["warden.user.#{scope}.session"] ||= {}
end
# Provides logout functionality.
# The logout also manages any authenticated data storage and clears it when a user logs out.
#
# Parameters:
# scopes - a list of scopes to logout
#
# Example:
# # Logout everyone and clear the session
# env['warden'].logout
#
# # Logout the default user but leave the rest of the session alone
# env['warden'].logout(:default)
#
# # Logout the :publisher and :admin user
# env['warden'].logout(:publisher, :admin)
#
# :api: public
def logout(*scopes)
if scopes.empty?
scopes = @users.keys
reset_session = true
end
scopes.each do |scope|
user = @users.delete(scope)
manager._run_callbacks(:before_logout, user, self, :scope => scope)
raw_session.delete("warden.user.#{scope}.session") unless raw_session.nil?
session_serializer.delete(scope, user)
end
reset_session! if reset_session
end
# proxy methods through to the winning strategy
# :api: private
def result # :nodoc:
winning_strategy && winning_strategy.result
end
# Proxy through to the authentication strategy to find out the message that was generated.
# :api: public
def message
winning_strategy && winning_strategy.message
end
# Provides a way to return a 401 without warden deferring to the failure app
# The result is a direct passthrough of your own response
# :api: public
def custom_failure!
@custom_failure = true
end
# Check to see if the custom failure flag has been set
# :api: public
def custom_failure?
if instance_variable_defined?(:@custom_failure)
!!@custom_failure
else
false
end
end
# Check to see if this is an asset request
# :api: public
def asset_request?
::Warden::asset_paths.any? { |r| env['PATH_INFO'].to_s.match(r) }
end
def inspect(*args)
"Warden::Proxy:#{object_id} @config=#{@config.inspect}"
end
def to_s(*args)
inspect(*args)
end
private
def _perform_authentication(*args)
scope, opts = _retrieve_scope_and_opts(args)
user = nil
# Look for an existing user in the session for this scope.
# If there was no user in the session, see if we can get one from the request.
return user, opts if user = user(opts.merge(:scope => scope))
_run_strategies_for(scope, args)
if winning_strategy && winning_strategy.successful?
opts[:store] = opts.fetch(:store, winning_strategy.store?)
set_user(winning_strategy.user, opts.merge!(:event => :authentication))
end
[@users[scope], opts]
end
def _retrieve_scope_and_opts(args) #:nodoc:
opts = args.last.is_a?(Hash) ? args.pop : {}
scope = opts[:scope] || @config.default_scope
opts = (@config[:scope_defaults][scope] || {}).merge(opts)
[scope, opts]
end
# Run the strategies for a given scope
def _run_strategies_for(scope, args) #:nodoc:
self.winning_strategy = @winning_strategies[scope]
return if winning_strategy && winning_strategy.halted?
# Do not run any strategy if locked
return if @locked
if args.empty?
defaults = @config[:default_strategies]
strategies = defaults[scope] || defaults[:_all]
end
(strategies || args).each do |name|
strategy = _fetch_strategy(name, scope)
next unless strategy && !strategy.performed? && strategy.valid?
catch(:warden) do
_update_winning_strategy(strategy, scope)
end
strategy._run!
_update_winning_strategy(strategy, scope)
break if strategy.halted?
end
end
# Fetches strategies and keep them in a hash cache.
def _fetch_strategy(name, scope)
@strategies[scope][name] ||= if klass = Warden::Strategies[name]
klass.new(@env, scope)
elsif @config.silence_missing_strategies?
nil
else
raise "Invalid strategy #{name}"
end
end
# Updates the winning strategy for a given scope
def _update_winning_strategy(strategy, scope)
self.winning_strategy = @winning_strategies[scope] = strategy
end
end # Proxy
end # Warden