Class: Google::Auth::WebUserAuthorizer
- Inherits:
-
UserAuthorizer
- Object
- UserAuthorizer
- Google::Auth::WebUserAuthorizer
- Defined in:
- lib/googleauth/web_user_authorizer.rb
Overview
Requires sessions are enabled
Varation on UserAuthorizer adapted for Rack based web applications.
Example usage:
get('/') do
user_id = request.session['user_email']
credentials = authorizer.get_credentials(user_id, request)
if credentials.nil?
redirect authorizer.get_authorization_url(user_id: user_id,
request: request)
end
# Credentials are valid, can call APIs
...
end
get('/oauth2callback') do url = Google::Auth::WebUserAuthorizer.handle_auth_callback_deferred( request) redirect url end
Instead of implementing the callback directly, applications are encouraged to use CallbackApp instead.
Defined Under Namespace
Classes: CallbackApp
Constant Summary collapse
- STATE_PARAM =
"state".freeze
- AUTH_CODE_KEY =
"code".freeze
- ERROR_CODE_KEY =
"error".freeze
- SESSION_ID_KEY =
"session_id".freeze
- CALLBACK_STATE_KEY =
"g-auth-callback".freeze
- CURRENT_URI_KEY =
"current_uri".freeze
- XSRF_KEY =
"g-xsrf-token".freeze
- SCOPE_KEY =
"scope".freeze
- NIL_REQUEST_ERROR =
"Request is required.".freeze
- NIL_SESSION_ERROR =
"Sessions must be enabled".freeze
- MISSING_AUTH_CODE_ERROR =
"Missing authorization code in request".freeze
- AUTHORIZATION_ERROR =
"Authorization error: %s".freeze
- INVALID_STATE_TOKEN_ERROR =
"State token does not match expected value".freeze
Constants inherited from UserAuthorizer
UserAuthorizer::MISMATCHED_CLIENT_ID_ERROR, UserAuthorizer::MISSING_ABSOLUTE_URL_ERROR, UserAuthorizer::NIL_CLIENT_ID_ERROR, UserAuthorizer::NIL_SCOPE_ERROR, UserAuthorizer::NIL_TOKEN_STORE_ERROR, UserAuthorizer::NIL_USER_ID_ERROR
Class Attribute Summary collapse
-
.default ⇒ Object
Returns the value of attribute default.
Class Method Summary collapse
- .extract_callback_state(request) ⇒ Object
-
.handle_auth_callback_deferred(request) ⇒ Object
Handle the result of the oauth callback.
-
.validate_callback_state(state, request) ⇒ Object
Verifies the results of an authorization callback.
Instance Method Summary collapse
-
#get_authorization_url(options = {}) ⇒ String
Build the URL for requesting authorization.
-
#get_credentials(user_id, request = nil, scope = nil) ⇒ Google::Auth::UserRefreshCredentials
Fetch stored credentials for the user from the given request session.
-
#handle_auth_callback(user_id, request) ⇒ Google::Auth::UserRefreshCredentials, String
Handle the result of the oauth callback.
-
#initialize(client_id, scope, token_store, callback_uri = nil, code_verifier: nil) ⇒ WebUserAuthorizer
constructor
Initialize the authorizer.
Methods inherited from UserAuthorizer
#code_verifier=, generate_code_verifier, #get_and_store_credentials_from_code, #get_credentials_from_code, #revoke_authorization, #store_credentials
Constructor Details
#initialize(client_id, scope, token_store, callback_uri = nil, code_verifier: nil) ⇒ WebUserAuthorizer
Initialize the authorizer
102 103 104 105 |
# File 'lib/googleauth/web_user_authorizer.rb', line 102 def initialize client_id, scope, token_store, callback_uri = nil, code_verifier: nil super client_id, scope, token_store, callback_uri, code_verifier: code_verifier end |
Class Attribute Details
.default ⇒ Object
Returns the value of attribute default.
68 69 70 |
# File 'lib/googleauth/web_user_authorizer.rb', line 68 def default @default end |
Class Method Details
.extract_callback_state(request) ⇒ Object
198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/googleauth/web_user_authorizer.rb', line 198 def self.extract_callback_state request state = MultiJson.load(request.params[STATE_PARAM] || "{}") redirect_uri = state[CURRENT_URI_KEY] callback_state = { AUTH_CODE_KEY => request.params[AUTH_CODE_KEY], ERROR_CODE_KEY => request.params[ERROR_CODE_KEY], SESSION_ID_KEY => state[SESSION_ID_KEY], SCOPE_KEY => request.params[SCOPE_KEY] } [callback_state, redirect_uri] end |
.handle_auth_callback_deferred(request) ⇒ Object
Handle the result of the oauth callback. This version defers the exchange of the code by temporarily stashing the results in the user's session. This allows apps to use the generic CallbackApp handler for the callback without any additional customization.
Apps that wish to handle the callback directly should use #handle_auth_callback instead.
82 83 84 85 86 |
# File 'lib/googleauth/web_user_authorizer.rb', line 82 def self.handle_auth_callback_deferred request callback_state, redirect_uri = extract_callback_state request request.session[CALLBACK_STATE_KEY] = MultiJson.dump callback_state redirect_uri end |
.validate_callback_state(state, request) ⇒ Object
Verifies the results of an authorization callback
220 221 222 223 224 225 226 227 228 |
# File 'lib/googleauth/web_user_authorizer.rb', line 220 def self.validate_callback_state state, request raise Signet::AuthorizationError, MISSING_AUTH_CODE_ERROR if state[AUTH_CODE_KEY].nil? if state[ERROR_CODE_KEY] raise Signet::AuthorizationError, format(AUTHORIZATION_ERROR, state[ERROR_CODE_KEY]) elsif request.session[XSRF_KEY] != state[SESSION_ID_KEY] raise Signet::AuthorizationError, INVALID_STATE_TOKEN_ERROR end end |
Instance Method Details
#get_authorization_url(options = {}) ⇒ String
Build the URL for requesting authorization.
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
# File 'lib/googleauth/web_user_authorizer.rb', line 147 def = {} = .dup request = [:request] raise NIL_REQUEST_ERROR if request.nil? raise NIL_SESSION_ERROR if request.session.nil? state = [:state] || {} redirect_to = [:redirect_to] || request.url request.session[XSRF_KEY] = SecureRandom.base64 [:state] = MultiJson.dump(state.merge( SESSION_ID_KEY => request.session[XSRF_KEY], CURRENT_URI_KEY => redirect_to )) [:base_url] = request.url super end |
#get_credentials(user_id, request = nil, scope = nil) ⇒ Google::Auth::UserRefreshCredentials
Fetch stored credentials for the user from the given request session.
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/googleauth/web_user_authorizer.rb', line 180 def get_credentials user_id, request = nil, scope = nil if request&.session&.key? CALLBACK_STATE_KEY # Note - in theory, no need to check required scope as this is # expected to be called immediately after a return from authorization state_json = request.session.delete CALLBACK_STATE_KEY callback_state = MultiJson.load state_json WebUserAuthorizer.validate_callback_state callback_state, request get_and_store_credentials_from_code( user_id: user_id, code: callback_state[AUTH_CODE_KEY], scope: callback_state[SCOPE_KEY], base_url: request.url ) else super user_id, scope end end |
#handle_auth_callback(user_id, request) ⇒ Google::Auth::UserRefreshCredentials, String
Handle the result of the oauth callback. Exchanges the authorization code from the request and persists to storage.
116 117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/googleauth/web_user_authorizer.rb', line 116 def handle_auth_callback user_id, request callback_state, redirect_uri = WebUserAuthorizer.extract_callback_state( request ) WebUserAuthorizer.validate_callback_state callback_state, request credentials = get_and_store_credentials_from_code( user_id: user_id, code: callback_state[AUTH_CODE_KEY], scope: callback_state[SCOPE_KEY], base_url: request.url ) [credentials, redirect_uri] end |