Class: DeviseTokens::OmniauthCallbacksController

Inherits:
ApplicationController show all
Defined in:
app/controllers/devise_tokens/omniauth_callbacks_controller.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from ApplicationController

#resource_data, #resource_errors

Instance Attribute Details

#auth_params ⇒ Object (readonly)

Returns the value of attribute auth_params.



3
4
5
 
# File 'app/controllers/devise_tokens/omniauth_callbacks_controller.rb', line 3

def auth_params
  @auth_params
end

Instance Method Details

#default_devise_mapping ⇒ Object

This method will only be called if get_devise_mapping cannot find the mapping in omniauth.params.

One example use-case here is for IDP-initiated SAML login. In that case, there will have been no initial request in which to save the devise mapping. If you are in a situation like that, and your app allows for you to determine somehow what the devise mapping should be (because, for example, it is always the same), then you can handle it by overriding this method.

Raises:

  • (NotImplementedError) 


51
52
53
 
# File 'app/controllers/devise_tokens/omniauth_callbacks_controller.rb', line 51

def default_devise_mapping
  raise NotImplementedError.new('no default_devise_mapping set')
end

#get_devise_mapping ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'app/controllers/devise_tokens/omniauth_callbacks_controller.rb', line 33

def get_devise_mapping
   # derive target redirect route from 'resource_class' param, which was set
   # before authentication.
   devise_mapping = [request.env['omniauth.params']['namespace_name'],
                     request.env['omniauth.params']['resource_class'].underscore.gsub('/', '_')].compact.join('_')
rescue NoMethodError => err
  default_devise_mapping
end

#get_redirect_route(devise_mapping) ⇒ Object 



27
28
29
30
31
 
# File 'app/controllers/devise_tokens/omniauth_callbacks_controller.rb', line 27

def get_redirect_route(devise_mapping)
  path = "#{Devise.mappings[devise_mapping.to_sym].fullpath}/#{params[:provider]}/callback"
  klass = request.scheme == 'https' ? URI::HTTPS : URI::HTTP
  redirect_route = klass.build(host: request.host, port: request.port, path: path).to_s
end

#omniauth_failure ⇒ Object 



74
75
76
77
 
# File 'app/controllers/devise_tokens/omniauth_callbacks_controller.rb', line 74

def omniauth_failure
  @error = params[:message]
  render_data_or_redirect('authFailure', error: @error)
end

#omniauth_success {|@resource| ... } ⇒ Object

Yields:

  • (@resource) 


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'app/controllers/devise_tokens/omniauth_callbacks_controller.rb', line 55

def omniauth_success
  get_resource_from_auth_hash
  set_token_on_resource
  create_auth_params

  if confirmable_enabled?
    # don't send confirmation email!!!
    @resource.skip_confirmation!
  end

  (:user, @resource, store: false, bypass: false)

  @resource.save!

  yield @resource if block_given?

  render_data_or_redirect('deliverCredentials', @auth_params.as_json, @resource.as_json)
end

#redirect_callbacks ⇒ Object

intermediary route for successful omniauth authentication. omniauth does not support multiple models, so we must resort to this terrible hack.



12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'app/controllers/devise_tokens/omniauth_callbacks_controller.rb', line 12

def redirect_callbacks

  # derive target redirect route from 'resource_class' param, which was set
  # before authentication.
  devise_mapping = get_devise_mapping
  redirect_route = get_redirect_route(devise_mapping)

  # preserve omniauth info for success route. ignore 'extra' in twitter
  # auth response to avoid CookieOverflow.
  session['dta.omniauth.auth'] = request.env['omniauth.auth'].except('extra')
  session['dta.omniauth.params'] = request.env['omniauth.params']

  redirect_to redirect_route
end

#validate_auth_origin_url_param ⇒ Object 



79
80
81
 
# File 'app/controllers/devise_tokens/omniauth_callbacks_controller.rb', line 79

def validate_auth_origin_url_param
  return render_error_not_allowed_auth_origin_url if auth_origin_url && blacklisted_redirect_url?(auth_origin_url)
end