Class: Karst::Web::BrowserIdentity

Inherits:
Object
  • Object
show all
Defined in:
lib/karst/web/browser_identity.rb

Overview

State-changing browser identity operations. Synchronizer-token behavior belongs to Web::Csrf and is shared with other Rack-boundary forms.

Constant Summary collapse

ACTIVE_KEY = 
"karst.browser_identity_active"
SCOPE_KEY =

The exact Devise/Warden scope the currently assumed identity was established under (see Identity.assume_browser), retained for the lifetime of the browser session so #clear can hand it straight back to Identity.clear_browser instead of that having to guess which of several selected sources produced the principal being cleared.

"karst.browser_identity_scope"

Instance Method Summary collapse

Constructor Details

#initialize(request, csrf: Csrf.new(request)) ⇒ BrowserIdentity

Returns a new instance of BrowserIdentity.



20
21
22
23
 
# File 'lib/karst/web/browser_identity.rb', line 20

def initialize(request, csrf: Csrf.new(request))
  @request = request
  @csrf = csrf
end

Instance Method Details

#active? ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/karst/web/browser_identity.rb', line 29

def active?
  session[ACTIVE_KEY] == true
end

#assume(params) ⇒ Object

Raises:



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/karst/web/browser_identity.rb', line 33

def assume(params)
  verify_token!(params["csrf_token"])
  target = return_path(params["path"])
  principal = Identity.resolve(model_name: params["principal_type"], id: params["principal_id"])
  raise Identity::Unavailable, "principal is not in the configured source" unless principal

  scope = Identity.assume_browser(@request, principal)
  # Authentication hooks may clear or replace the host session. Rebuild
  # Karst's control state only after that transition, and invalidate the
  # token which authorized it rather than carrying pre-assumption state
  # into the assumed identity.
  session[ACTIVE_KEY] = true
  session[SCOPE_KEY] = scope&.to_s
  rotate_token!
  target
end

#clear(params) ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'lib/karst/web/browser_identity.rb', line 50

def clear(params)
  verify_token!(params["csrf_token"])
  target = return_path(params["path"])
  scope = session[SCOPE_KEY]
  Identity.clear_browser(@request, scope: scope&.to_sym)
  session.delete(ACTIVE_KEY)
  session.delete(SCOPE_KEY)
  target
end

#token ⇒ Object 



25
26
27
 
# File 'lib/karst/web/browser_identity.rb', line 25

def token
  @csrf.token
end