Class: OmniAuth::Strategies::Identity

Inherits:
Object
  • Object
show all
Includes:
OmniAuth::Strategy
Defined in:
lib/omniauth/strategies/identity.rb

Overview

The identity strategy allows you to provide simple internal user authentication using the same process flow that you use for external OmniAuth providers.

Constant Summary collapse

DEFAULT_REGISTRATION_FIELDS = 
i[password password_confirmation].freeze

Instance Method Summary collapse

Instance Method Details

#callback_phase ⇒ Object 



37
38
39
40
41
 
# File 'lib/omniauth/strategies/identity.rb', line 37

def callback_phase
  return fail!(:invalid_credentials) unless identity

  super
end

#identity ⇒ Object 



106
107
108
109
110
111
112
113
114
 
# File 'lib/omniauth/strategies/identity.rb', line 106

def identity
  if options[:locate_conditions].is_a? Proc
    conditions = instance_exec(request, &options[:locate_conditions])
    conditions.to_hash
  else
    conditions = options[:locate_conditions].to_hash
  end
  @identity ||= model.authenticate(conditions, request['password'])
end

#model ⇒ Object 



116
117
118
 
# File 'lib/omniauth/strategies/identity.rb', line 116

def model
  options[:model] || ::Identity
end

#on_registration_path? ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/omniauth/strategies/identity.rb', line 102

def on_registration_path?
  on_path?(registration_path)
end

#other_phase ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/omniauth/strategies/identity.rb', line 43

def other_phase
  if options[:enable_registration] && on_registration_path?
    if request.get?
      registration_form
    elsif request.post?
      registration_phase
    else
      call_app!
    end
  elsif options[:enable_login] && on_request_path?
    # OmniAuth, by default, disables "GET" requests for security reasons.
    # This effectively disables omniauth-identity tool's login form feature.
    # Because it is disabled by default, and because enabling it would desecuritize all the other
    #   OmniAuth strategies that may be implemented, we do not ask users to modify that setting.
    # Instead we hook in here in the "other_phase", with a config setting of our own: `enable_login`
    request_phase
  else
    call_app!
  end
end

#registration_form(validation_message = nil) ⇒ Object 



64
65
66
67
68
69
70
 
# File 'lib/omniauth/strategies/identity.rb', line 64

def registration_form(validation_message = nil)
  if options[:on_registration]
    options[:on_registration].call(env)
  else
    build_omniauth_registration_form(validation_message).to_response
  end
end

#registration_path ⇒ Object 



98
99
100
 
# File 'lib/omniauth/strategies/identity.rb', line 98

def registration_path
  options[:registration_path] || "#{path_prefix}/#{name}/register"
end

#registration_phase ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/omniauth/strategies/identity.rb', line 72

def registration_phase
  attributes = (options[:fields] + DEFAULT_REGISTRATION_FIELDS).each_with_object({}) do |k, h|
    h[k] = request[k.to_s]
  end
  if model.respond_to?(:column_names) && model.column_names.include?('provider')
    attributes.reverse_merge!(provider: 'identity')
  end
  if validating?
    @identity = model.new(attributes)
    env['omniauth.identity'] = @identity
    if valid?
      @identity.save
      registration_result
    else
      registration_failure(options[:validation_failure_message])
    end
  else
    @identity = model.create(attributes)
    env['omniauth.identity'] = @identity
    registration_result
  end
end

#request_phase ⇒ Object 



29
30
31
32
33
34
35
 
# File 'lib/omniauth/strategies/identity.rb', line 29

def request_phase
  if options[:on_login]
    options[:on_login].call(env)
  else
    .to_response
  end
end