module OmniAuth::Strategy

The Strategy is the base unit of OmniAuth’s ability to wrangle multiple providers. Each strategy provided by OmniAuth includes this mixin to gain the default functionality necessary to be compatible with the OmniAuth library.

Constants

CURRENT_PATH_REGEX
EMPTY_STRING

Attributes

app[R]
env[R]
options[R]
response[R]

Public Class Methods

included(base) click to toggle source
# File lib/omniauth/strategy.rb, line 10
def self.included(base)
  OmniAuth.strategies << base

  base.extend ClassMethods
  base.class_eval do
    option :setup, false
    option :skip_info, false
    option :origin_param, 'origin'
  end
end
new(app, *args) { |options| ... } click to toggle source

Initializes the strategy by passing in the Rack endpoint, the unique URL segment name for this strategy, and any additional arguments. An ‘options` hash is automatically created from the last argument if it is a hash.

@param app [Rack application] The application on which this middleware is applied.

@overload new(app, options = {})

If nothing but a hash is supplied, initialized with the supplied options
overriding the strategy's default options via a deep merge.

@overload new(app, *args, options = {})

If the strategy has supplied custom arguments that it accepts, they may
will be passed through and set to the appropriate values.

@yield [Options] Yields options to block for further configuration.

# File lib/omniauth/strategy.rb, line 133
def initialize(app, *args, &block) # rubocop:disable UnusedMethodArgument
  @app = app
  @env = nil
  @options = self.class.default_options.dup

  options.deep_merge!(args.pop) if args.last.is_a?(Hash)
  options[:name] ||= self.class.to_s.split('::').last.downcase

  self.class.args.each do |arg|
    break if args.empty?

    options[arg] = args.shift
  end

  # Make sure that all of the args have been dealt with, otherwise error out.
  raise(ArgumentError.new("Received wrong number of arguments. #{args.inspect}")) unless args.empty?

  yield options if block_given?
end

Public Instance Methods

auth_hash() click to toggle source
# File lib/omniauth/strategy.rb, line 390
def auth_hash
  credentials_data = credentials
  extra_data = extra
  AuthHash.new(:provider => name, :uid => uid).tap do |auth|
    auth.info = info unless skip_info?
    auth.credentials = credentials_data if credentials_data
    auth.extra = extra_data if extra_data
  end
end
call(env) click to toggle source

Duplicates this instance and runs call! on it. @param [Hash] The Rack environment.

# File lib/omniauth/strategy.rb, line 168
def call(env)
  dup.call!(env)
end
call!(env) click to toggle source

The logic for dispatching any additional actions that need to be taken. For instance, calling the request phase if the request path is recognized.

@param env [Hash] The Rack environment.

# File lib/omniauth/strategy.rb, line 177
def call!(env) # rubocop:disable CyclomaticComplexity, PerceivedComplexity
  unless env['rack.session']
    error = OmniAuth::NoSessionError.new('You must provide a session to use OmniAuth.')
    raise(error)
  end

  @env = env

  warn_if_using_get_on_request_path

  @env['omniauth.strategy'] = self if on_auth_path?

  return mock_call!(env) if OmniAuth.config.test_mode

  begin
    return options_call if on_auth_path? && options_request?
    return request_call if on_request_path? && OmniAuth.config.allowed_request_methods.include?(request.request_method.downcase.to_sym)
    return callback_call if on_callback_path?
    return other_phase if respond_to?(:other_phase)
  rescue StandardError => e
    raise e if env.delete('omniauth.error.app')

    return fail!(e.message, e)
  end

  @app.call(env)
end
call_app!(env = @env) click to toggle source
# File lib/omniauth/strategy.rb, line 469
def call_app!(env = @env)
  @app.call(env)
rescue StandardError => e
  env['omniauth.error.app'] = true
  raise e
end
callback_call() click to toggle source

Performs the steps necessary to run the callback phase of a strategy.

# File lib/omniauth/strategy.rb, line 265
def callback_call
  setup_phase
  log :debug, 'Callback phase initiated.'
  @env['omniauth.origin'] = session.delete('omniauth.origin')
  @env['omniauth.origin'] = nil if env['omniauth.origin'] == ''
  @env['omniauth.params'] = session.delete('omniauth.params') || {}
  OmniAuth.config.before_callback_phase.call(@env) if OmniAuth.config.before_callback_phase
  callback_phase
end
callback_path() click to toggle source
# File lib/omniauth/strategy.rb, line 445
def callback_path
  @callback_path ||= begin
    path = options[:callback_path] if options[:callback_path].is_a?(String)
    path ||= current_path if options[:callback_path].respond_to?(:call) && options[:callback_path].call(env)
    path ||= custom_path(:request_path)
    path ||= "#{script_name}#{path_prefix}/#{name}/callback"
    path
  end
end
callback_phase() click to toggle source
# File lib/omniauth/strategy.rb, line 416
def callback_phase
  env['omniauth.auth'] = auth_hash
  call_app!
end
callback_url() click to toggle source
# File lib/omniauth/strategy.rb, line 496
def callback_url
  full_host + callback_path + query_string
end
credentials() click to toggle source
# File lib/omniauth/strategy.rb, line 382
def credentials
  merge_stack(self.class.credentials_stack(self))
end
current_path() click to toggle source
# File lib/omniauth/strategy.rb, line 461
def current_path
  @current_path ||= request.path.downcase.sub(CURRENT_PATH_REGEX, EMPTY_STRING)
end
custom_path(kind) click to toggle source
# File lib/omniauth/strategy.rb, line 425
def custom_path(kind)
  if options[kind].respond_to?(:call)
    result = options[kind].call(env)
    return nil unless result.is_a?(String)

    result
  else
    options[kind]
  end
end
extra() click to toggle source
# File lib/omniauth/strategy.rb, line 386
def extra
  merge_stack(self.class.extra_stack(self))
end
fail!(message_key, exception = nil) click to toggle source
# File lib/omniauth/strategy.rb, line 534
def fail!(message_key, exception = nil)
  env['omniauth.error'] = exception
  env['omniauth.error.type'] = message_key.to_sym
  env['omniauth.error.strategy'] = self

  if exception
    log :error, "Authentication failure! #{message_key}: #{exception.class}, #{exception.message}"
  else
    log :error, "Authentication failure! #{message_key} encountered."
  end

  OmniAuth.config.on_failure.call(env)
end
full_host() click to toggle source
# File lib/omniauth/strategy.rb, line 476
def full_host
  case OmniAuth.config.full_host
  when String
    OmniAuth.config.full_host
  when Proc
    OmniAuth.config.full_host.call(env)
  else
    # in Rack 1.3.x, request.url explodes if scheme is nil
    if request.scheme && request.url.match(URI::ABS_URI)
      uri = URI.parse(request.url.gsub(/\?.*$/, ''))
      uri.path = ''
      # sometimes the url is actually showing http inside rails because the
      # other layers (like nginx) have handled the ssl termination.
      uri.scheme = 'https' if ssl? # rubocop:disable BlockNesting
      uri.to_s
    else ''
    end
  end
end
info() click to toggle source
# File lib/omniauth/strategy.rb, line 378
def info
  merge_stack(self.class.info_stack(self))
end
inspect() click to toggle source
# File lib/omniauth/strategy.rb, line 153
def inspect
  "#<#{self.class}>"
end
log(level, message) click to toggle source

Direct access to the OmniAuth logger, automatically prefixed with this strategy’s name.

@example

log :warn, "This is a warning."
# File lib/omniauth/strategy.rb, line 162
def log(level, message)
  OmniAuth.logger.send(level, "(#{name}) #{message}")
end
mock_call!(*) click to toggle source

This is called in lieu of the normal request process in the event that OmniAuth has been configured to be in test mode.

# File lib/omniauth/strategy.rb, line 304
def mock_call!(*)
  begin
    return mock_request_call if on_request_path? && OmniAuth.config.allowed_request_methods.include?(request.request_method.downcase.to_sym)
    return mock_callback_call if on_callback_path?
  rescue StandardError => e
    raise e if env.delete('omniauth.error.app')

    return fail!(e.message, e)
  end

  call_app!
end
mock_callback_call() click to toggle source
# File lib/omniauth/strategy.rb, line 336
def mock_callback_call
  setup_phase
  @env['omniauth.origin'] = session.delete('omniauth.origin')
  @env['omniauth.origin'] = nil if env['omniauth.origin'] == ''
  @env['omniauth.params'] = session.delete('omniauth.params') || {}

  mocked_auth = OmniAuth.mock_auth_for(name.to_s)
  if mocked_auth.is_a?(Symbol)
    fail!(mocked_auth)
  else
    @env['omniauth.auth'] = mocked_auth
    OmniAuth.config.before_callback_phase.call(@env) if OmniAuth.config.before_callback_phase
    call_app!
  end
end
mock_request_call() click to toggle source
# File lib/omniauth/strategy.rb, line 317
def mock_request_call
  setup_phase

  session['omniauth.params'] = request.GET

  OmniAuth.config.request_validation_phase.call(env) if OmniAuth.config.request_validation_phase
  OmniAuth.config.before_request_phase.call(env) if OmniAuth.config.before_request_phase

  if options.origin_param
    if request.params[options.origin_param]
      session['omniauth.origin'] = request.params[options.origin_param]
    elsif env['HTTP_REFERER'] && !env['HTTP_REFERER'].match(/#{request_path}$/)
      session['omniauth.origin'] = env['HTTP_REFERER']
    end
  end

  redirect(callback_url)
end
name() click to toggle source
# File lib/omniauth/strategy.rb, line 513
def name
  options[:name]
end
on_auth_path?() click to toggle source

Returns true if the environment recognizes either the request or callback path.

# File lib/omniauth/strategy.rb, line 277
def on_auth_path?
  on_request_path? || on_callback_path?
end
on_callback_path?() click to toggle source
# File lib/omniauth/strategy.rb, line 289
def on_callback_path?
  on_path?(callback_path)
end
on_path?(path) click to toggle source
# File lib/omniauth/strategy.rb, line 293
def on_path?(path)
  current_path.casecmp(path).zero?
end
on_request_path?() click to toggle source
# File lib/omniauth/strategy.rb, line 281
def on_request_path?
  if options[:request_path].respond_to?(:call)
    options[:request_path].call(env)
  else
    on_path?(request_path)
  end
end
options_call() click to toggle source

Responds to an OPTIONS request.

# File lib/omniauth/strategy.rb, line 226
def options_call
  OmniAuth.config.before_options_phase.call(env) if OmniAuth.config.before_options_phase
  verbs = OmniAuth.config.allowed_request_methods.collect(&:to_s).collect(&:upcase).join(', ')
  [200, {'Allow' => verbs}, []]
end
options_request?() click to toggle source
# File lib/omniauth/strategy.rb, line 297
def options_request?
  request.request_method == 'OPTIONS'
end
path_prefix() click to toggle source
# File lib/omniauth/strategy.rb, line 421
def path_prefix
  options[:path_prefix] || OmniAuth.config.path_prefix
end
query_string() click to toggle source
# File lib/omniauth/strategy.rb, line 465
def query_string
  request.query_string.empty? ? '' : "?#{request.query_string}"
end
redirect(uri) click to toggle source
# File lib/omniauth/strategy.rb, line 517
def redirect(uri)
  r = Rack::Response.new

  if options[:iframe]
    r.write("<script type='text/javascript' charset='utf-8'>top.location.href = '#{uri}';</script>")
  else
    r.write("Redirecting to #{uri}...")
    r.redirect(uri)
  end

  r.finish
end
request() click to toggle source
# File lib/omniauth/strategy.rb, line 509
def request
  @request ||= Rack::Request.new(@env)
end
request_call() click to toggle source

Performs the steps necessary to run the request phase of a strategy.

# File lib/omniauth/strategy.rb, line 233
def request_call # rubocop:disable CyclomaticComplexity, MethodLength, PerceivedComplexity
  setup_phase
  log :debug, 'Request phase initiated.'

  # store query params from the request url, extracted in the callback_phase
  session['omniauth.params'] = request.GET

  OmniAuth.config.request_validation_phase.call(env) if OmniAuth.config.request_validation_phase
  OmniAuth.config.before_request_phase.call(env) if OmniAuth.config.before_request_phase

  if options.form.respond_to?(:call)
    log :debug, 'Rendering form from supplied Rack endpoint.'
    options.form.call(env)
  elsif options.form
    log :debug, 'Rendering form from underlying application.'
    call_app!
  elsif !options.origin_param
    request_phase
  else
    if request.params[options.origin_param]
      env['rack.session']['omniauth.origin'] = request.params[options.origin_param]
    elsif env['HTTP_REFERER'] && !env['HTTP_REFERER'].match(/#{request_path}$/)
      env['rack.session']['omniauth.origin'] = env['HTTP_REFERER']
    end

    request_phase
  end
rescue OmniAuth::AuthenticityError => e
  fail!(:authenticity_error, e)
end
request_path() click to toggle source
# File lib/omniauth/strategy.rb, line 436
def request_path
  @request_path ||=
    if options[:request_path].is_a?(String)
      options[:request_path]
    else
      "#{script_name}#{path_prefix}/#{name}"
    end
end
request_phase() click to toggle source

@abstract This method is called when the user is on the request path. You should perform any information gathering you need to be able to authenticate the user in this phase.

# File lib/omniauth/strategy.rb, line 370
def request_phase
  raise(NotImplementedError)
end
script_name() click to toggle source
# File lib/omniauth/strategy.rb, line 500
def script_name
  return '' if @env.nil?
  @env['SCRIPT_NAME'] || ''
end
session() click to toggle source
# File lib/omniauth/strategy.rb, line 505
def session
  @env['rack.session']
end
setup_path() click to toggle source
# File lib/omniauth/strategy.rb, line 455
def setup_path
  options[:setup_path] || "#{path_prefix}/#{name}/setup"
end
setup_phase() click to toggle source

The setup phase looks for the ‘:setup` option to exist and, if it is, will call either the Rack endpoint supplied to the `:setup` option or it will call out to the setup path of the underlying application. This will default to `/auth/:provider/setup`.

# File lib/omniauth/strategy.rb, line 356
def setup_phase
  if options[:setup].respond_to?(:call)
    log :debug, 'Setup endpoint detected, running now.'
    options[:setup].call(env)
  elsif options[:setup]
    log :debug, 'Calling through to underlying application for setup.'
    setup_env = env.merge('PATH_INFO' => setup_path, 'REQUEST_METHOD' => 'GET')
    call_app!(setup_env)
  end
end
skip_info?() click to toggle source

Determines whether or not user info should be retrieved. This allows some strategies to save a call to an external API service for existing users. You can use it either by setting the ‘:skip_info` to true or by setting `:skip_info` to a Proc that takes a uid and evaluates to true when you would like to skip info.

@example

use MyStrategy, :skip_info => lambda{|uid| User.find_by_uid(uid)}
# File lib/omniauth/strategy.rb, line 409
def skip_info?
  return false unless options.skip_info?
  return true unless options.skip_info.respond_to?(:call)

  options.skip_info.call(uid)
end
uid() click to toggle source
# File lib/omniauth/strategy.rb, line 374
def uid
  self.class.uid_stack(self).last
end
user_info() click to toggle source
# File lib/omniauth/strategy.rb, line 530
def user_info
  {}
end
warn_if_using_get_on_request_path() click to toggle source
# File lib/omniauth/strategy.rb, line 205
    def warn_if_using_get_on_request_path
      return unless on_request_path?
      return unless OmniAuth.config.allowed_request_methods.include?(:get)
      return if OmniAuth.config.silence_get_warning

      log :warn, <<-WARN
  You are using GET as an allowed request method for OmniAuth. This may leave
  you open to CSRF attacks. As of v2.0.0, OmniAuth by default allows only POST
  to its own routes. You should review the following resources to guide your
  mitigation:
  https://github.com/omniauth/omniauth/wiki/Resolving-CVE-2015-9284
  https://github.com/omniauth/omniauth/issues/960
  https://nvd.nist.gov/vuln/detail/CVE-2015-9284
  https://github.com/omniauth/omniauth/pull/809

  You can ignore this warning by setting:
  OmniAuth.config.silence_get_warning = true
      WARN
    end

Protected Instance Methods

initialize_copy(*args) click to toggle source
Calls superclass method
# File lib/omniauth/strategy.rb, line 552
def initialize_copy(*args)
  super
  @options = @options.dup
end
merge_stack(stack) click to toggle source
# File lib/omniauth/strategy.rb, line 557
def merge_stack(stack)
  stack.inject({}) do |a, e|
    a.merge!(e)
    a
  end
end
ssl?() click to toggle source
# File lib/omniauth/strategy.rb, line 564
def ssl?
  request.env['HTTPS'] == 'on' ||
    request.env['HTTP_X_FORWARDED_SSL'] == 'on' ||
    request.env['HTTP_X_FORWARDED_SCHEME'] == 'https' ||
    (request.env['HTTP_X_FORWARDED_PROTO'] && request.env['HTTP_X_FORWARDED_PROTO'].split(',')[0] == 'https') ||
    request.env['rack.url_scheme'] == 'https'
end