Class: OmniAuth::Strategies::OAuth2
- Inherits:
-
Object
- Object
- OmniAuth::Strategies::OAuth2
- Includes:
- OmniAuth::Strategy
- Defined in:
- lib/omniauth/strategies/oauth2.rb
Overview
Authentication strategy for connecting with APIs constructed using the [OAuth 2.0 Specification](tools.ietf.org/html/draft-ietf-oauth-v2-10). You must generally register your application with the provider and utilize an application id and secret in order to authenticate using OAuth 2.0.
Defined Under Namespace
Classes: CallbackError
Instance Attribute Summary collapse
-
#access_token ⇒ Object
Returns the value of attribute access_token.
Instance Method Summary collapse
- #authorize_params ⇒ Object
-
#callback_phase ⇒ Object
rubocop:disable CyclomaticComplexity.
- #callback_url ⇒ Object
- #client ⇒ Object
- #request_phase ⇒ Object
- #token_params ⇒ Object
Instance Attribute Details
#access_token ⇒ Object
Returns the value of attribute access_token.
31 32 33 |
# File 'lib/omniauth/strategies/oauth2.rb', line 31 def access_token @access_token end |
Instance Method Details
#authorize_params ⇒ Object
53 54 55 56 57 58 59 60 61 62 |
# File 'lib/omniauth/strategies/oauth2.rb', line 53 def .[:state] = SecureRandom.hex(24) params = ..merge(('authorize')) if OmniAuth.config.test_mode @env ||= {} @env['rack.session'] ||= {} end session['omniauth.state'] = params[:state] params end |
#callback_phase ⇒ Object
rubocop:disable CyclomaticComplexity
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/omniauth/strategies/oauth2.rb', line 68 def callback_phase # rubocop:disable CyclomaticComplexity error = request.params['error_reason'] || request.params['error'] if error fail!(error, CallbackError.new(request.params['error'], request.params['error_description'] || request.params['error_reason'], request.params['error_uri'])) elsif !.provider_ignores_state && (request.params['state'].to_s.empty? || request.params['state'] != session.delete('omniauth.state')) fail!(:csrf_detected, CallbackError.new(:csrf_detected, 'CSRF detected')) else self.access_token = build_access_token self.access_token = access_token.refresh! if access_token.expired? super end rescue ::OAuth2::Error, CallbackError => e fail!(:invalid_credentials, e) rescue ::MultiJson::DecodeError => e fail!(:invalid_response, e) rescue ::Timeout::Error, ::Errno::ETIMEDOUT, Faraday::Error::TimeoutError => e fail!(:timeout, e) rescue ::SocketError, Faraday::Error::ConnectionFailed => e fail!(:failed_to_connect, e) end |
#callback_url ⇒ Object
37 38 39 |
# File 'lib/omniauth/strategies/oauth2.rb', line 37 def callback_url full_host + script_name + callback_path end |
#client ⇒ Object
33 34 35 |
# File 'lib/omniauth/strategies/oauth2.rb', line 33 def client ::OAuth2::Client.new(.client_id, .client_secret, deep_symbolize(.)) end |
#request_phase ⇒ Object
49 50 51 |
# File 'lib/omniauth/strategies/oauth2.rb', line 49 def request_phase redirect client.auth_code.({:redirect_uri => callback_url}.merge()) end |
#token_params ⇒ Object
64 65 66 |
# File 'lib/omniauth/strategies/oauth2.rb', line 64 def token_params .token_params.merge(('token')) end |