identity_api.h revision cedac228d2dd51db4b79ea1e72c7f249408ee061
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_BROWSER_EXTENSIONS_API_IDENTITY_IDENTITY_API_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_EXTENSIONS_API_IDENTITY_IDENTITY_API_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include <map> 990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include <set> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 1190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include <utility> 12c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include <vector> 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/ref_counted.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/weak_ptr.h" 16e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch#include "base/observer_list.h" 178bcbed890bc3ce4d7a057a8f32cab53fa534672eTorne (Richard Coles)#include "chrome/browser/extensions/api/identity/account_tracker.h" 18a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#include "chrome/browser/extensions/api/identity/extension_token_key.h" 1990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)#include "chrome/browser/extensions/api/identity/gaia_web_auth_flow.h" 20c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "chrome/browser/extensions/api/identity/identity_mint_queue.h" 21c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "chrome/browser/extensions/api/identity/identity_signin_flow.h" 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/extensions/api/identity/web_auth_flow.h" 231e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles)#include "chrome/browser/extensions/chrome_extension_function.h" 24c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "chrome/browser/signin/signin_global_error.h" 25a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)#include "extensions/browser/browser_context_keyed_api_factory.h" 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "google_apis/gaia/oauth2_mint_token_flow.h" 27424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)#include "google_apis/gaia/oauth2_token_service.h" 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class GoogleServiceAuthError; 30eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochclass MockGetAuthTokenFunction; 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 32a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)namespace content { 33a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)class BrowserContext; 341e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles)} 351e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace extensions { 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)class GetAuthTokenFunctionTest; 3990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)class MockGetAuthTokenFunction; 4090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace identity_constants { 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern const char kInvalidClientId[]; 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern const char kInvalidScopes[]; 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern const char kAuthFailure[]; 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern const char kNoGrant[]; 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern const char kUserRejected[]; 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern const char kUserNotSignedIn[]; 48c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)extern const char kInteractionRequired[]; 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern const char kInvalidRedirect[]; 50c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)extern const char kOffTheRecord[]; 51868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)extern const char kPageLoadFailure[]; 52e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdochextern const char kCanceled[]; 532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)} // namespace identity_constants 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdochclass IdentityTokenCacheValue { 56e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch public: 57e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch IdentityTokenCacheValue(); 58e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch explicit IdentityTokenCacheValue(const IssueAdviceInfo& issue_advice); 59e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch IdentityTokenCacheValue(const std::string& token, 60e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch base::TimeDelta time_to_live); 61e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch ~IdentityTokenCacheValue(); 62e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 63e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch // Order of these entries is used to determine whether or not new 64e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch // entries supercede older ones in SetCachedToken. 65e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch enum CacheValueStatus { 66e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch CACHE_STATUS_NOTFOUND, 67e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch CACHE_STATUS_ADVICE, 68e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch CACHE_STATUS_TOKEN 69e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch }; 70e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 71e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch CacheValueStatus status() const; 72e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch const IssueAdviceInfo& issue_advice() const; 73e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch const std::string& token() const; 74e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch const base::Time& expiration_time() const; 75e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 76e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch private: 77e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch bool is_expired() const; 78e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 79e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch CacheValueStatus status_; 80e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch IssueAdviceInfo issue_advice_; 81e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch std::string token_; 82e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch base::Time expiration_time_; 83e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch}; 84e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 85e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdochclass IdentityAPI : public BrowserContextKeyedAPI, 86e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch public AccountTracker::Observer { 87e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch public: 88e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch typedef std::map<ExtensionTokenKey, IdentityTokenCacheValue> CachedTokens; 89e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 90e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch class ShutdownObserver { 91e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch public: 92e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch virtual void OnShutdown() = 0; 93e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch }; 94e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 95e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch explicit IdentityAPI(content::BrowserContext* context); 96e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch virtual ~IdentityAPI(); 97e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 98e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch // Request serialization queue for getAuthToken. 99e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch IdentityMintRequestQueue* mint_queue(); 100e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 101e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch // Token cache 102e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch void SetCachedToken(const ExtensionTokenKey& key, 103e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch const IdentityTokenCacheValue& token_data); 104e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch void EraseCachedToken(const std::string& extension_id, 105e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch const std::string& token); 106e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch void EraseAllCachedTokens(); 107e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch const IdentityTokenCacheValue& GetCachedToken(const ExtensionTokenKey& key); 108e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 109e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch const CachedTokens& GetAllCachedTokens(); 110e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 111cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // Account queries. 112cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) std::vector<std::string> GetAccounts() const; 113cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 114cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // Global error reporting. 115e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch void ReportAuthError(const GoogleServiceAuthError& error); 116e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch GoogleServiceAuthError GetAuthStatusForTest() const; 117e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 118e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch // BrowserContextKeyedAPI implementation. 119e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch virtual void Shutdown() OVERRIDE; 120e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch static BrowserContextKeyedAPIFactory<IdentityAPI>* GetFactoryInstance(); 121e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 122e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch // AccountTracker::Observer implementation: 123e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch virtual void OnAccountAdded(const AccountIds& ids) OVERRIDE; 124e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch virtual void OnAccountRemoved(const AccountIds& ids) OVERRIDE; 125e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch virtual void OnAccountSignInChanged(const AccountIds& ids, 126e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch bool is_signed_in) OVERRIDE; 127e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 128e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch void AddShutdownObserver(ShutdownObserver* observer); 129e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch void RemoveShutdownObserver(ShutdownObserver* observer); 130e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 131cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) void SetAccountStateForTest(AccountIds ids, bool is_signed_in); 132cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 133e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch private: 134e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch friend class BrowserContextKeyedAPIFactory<IdentityAPI>; 135e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 136e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch // BrowserContextKeyedAPI implementation. 137e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch static const char* service_name() { return "IdentityAPI"; } 138e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch static const bool kServiceIsNULLWhileTesting = true; 139e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 140e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch content::BrowserContext* browser_context_; 141e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch IdentityMintRequestQueue mint_queue_; 142e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch CachedTokens token_cache_; 143e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch AccountTracker account_tracker_; 144e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch ObserverList<ShutdownObserver> shutdown_observer_list_; 145e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch}; 146e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 147e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdochtemplate <> 148e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdochvoid BrowserContextKeyedAPIFactory<IdentityAPI>::DeclareFactoryDependencies(); 149e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 150cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)class IdentityGetAccountsFunction : public ChromeUIThreadExtensionFunction { 151cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) public: 152cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) DECLARE_EXTENSION_FUNCTION("identity.getAccounts", 153cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) IDENTITY_GETACCOUNTS); 154cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 155cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) IdentityGetAccountsFunction(); 156cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 157cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) private: 158cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual ~IdentityGetAccountsFunction(); 159cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 160cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) // UIThreadExtensionFunction implementation. 161cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual ExtensionFunction::ResponseAction Run() OVERRIDE; 162cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)}; 163cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 164c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// identity.getAuthToken fetches an OAuth 2 function for the 165c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// caller. The request has three sub-flows: non-interactive, 166c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// interactive, and sign-in. 167c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// 168c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// In the non-interactive flow, getAuthToken requests a token from 169c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// GAIA. GAIA may respond with a token, an error, or "consent 170c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// required". In the consent required cases, getAuthToken proceeds to 171c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// the second, interactive phase. 172c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// 173c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// The interactive flow presents a scope approval dialog to the 174c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// user. If the user approves the request, a grant will be recorded on 175c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// the server, and an access token will be returned to the caller. 176c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// 177c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// In some cases we need to display a sign-in dialog. Normally the 178c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// profile will be signed in already, but if it turns out we need a 179c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// new login token, there is a sign-in flow. If that flow completes 180c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)// successfully, getAuthToken proceeds to the non-interactive flow. 1811e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles)class IdentityGetAuthTokenFunction : public ChromeAsyncExtensionFunction, 18290dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) public GaiaWebAuthFlow::Delegate, 183c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) public IdentityMintRequestQueue::Request, 184c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) public OAuth2MintTokenFlow::Delegate, 185eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch public IdentitySigninFlow::Delegate, 186e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch public OAuth2TokenService::Consumer, 187e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch public IdentityAPI::ShutdownObserver { 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 189c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) DECLARE_EXTENSION_FUNCTION("identity.getAuthToken", 190c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) EXPERIMENTAL_IDENTITY_GETAUTHTOKEN); 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) IdentityGetAuthTokenFunction(); 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~IdentityGetAuthTokenFunction(); 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 198eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch FRIEND_TEST_ALL_PREFIXES(GetAuthTokenFunctionTest, 199eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch ComponentWithChromeClientId); 200eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch FRIEND_TEST_ALL_PREFIXES(GetAuthTokenFunctionTest, 201eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch ComponentWithNormalClientId); 202e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch FRIEND_TEST_ALL_PREFIXES(GetAuthTokenFunctionTest, InteractiveQueueShutdown); 203e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch FRIEND_TEST_ALL_PREFIXES(GetAuthTokenFunctionTest, NoninteractiveShutdown); 2042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) friend class MockGetAuthTokenFunction; 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ExtensionFunction: 207010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) virtual bool RunAsync() OVERRIDE; 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 209c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Helpers to report async function results to the caller. 210e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch void StartAsyncRun(); 211e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch void CompleteAsyncRun(bool success); 212c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void CompleteFunctionWithResult(const std::string& access_token); 213c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void CompleteFunctionWithError(const std::string& error); 214c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 215c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Initiate/complete the sub-flows. 216c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void StartSigninFlow(); 217c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void StartMintTokenFlow(IdentityMintRequestQueue::MintType type); 218c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) void CompleteMintTokenFlow(); 219c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 220c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // IdentityMintRequestQueue::Request implementation: 221c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void StartMintToken(IdentityMintRequestQueue::MintType type) OVERRIDE; 222c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 2235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // OAuth2MintTokenFlow::Delegate implementation: 224c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void OnMintTokenSuccess(const std::string& access_token, 225c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) int time_to_live) OVERRIDE; 2265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnMintTokenFailure( 2275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const GoogleServiceAuthError& error) OVERRIDE; 2285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnIssueAdviceSuccess( 2295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const IssueAdviceInfo& issue_advice) OVERRIDE; 2305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 231c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // IdentitySigninFlow::Delegate implementation: 2327dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch virtual void SigninSuccess() OVERRIDE; 233c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void SigninFailed() OVERRIDE; 2345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 23590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) // GaiaWebAuthFlow::Delegate implementation: 23690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) virtual void OnGaiaFlowFailure(GaiaWebAuthFlow::Failure failure, 23790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) GoogleServiceAuthError service_error, 23890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) const std::string& oauth_error) OVERRIDE; 23990dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) virtual void OnGaiaFlowCompleted(const std::string& access_token, 24090dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) const std::string& expiration) OVERRIDE; 2415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 242eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch // OAuth2TokenService::Consumer implementation: 243eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch virtual void OnGetTokenSuccess(const OAuth2TokenService::Request* request, 244eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch const std::string& access_token, 245eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch const base::Time& expiration_time) OVERRIDE; 246eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch virtual void OnGetTokenFailure(const OAuth2TokenService::Request* request, 247eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch const GoogleServiceAuthError& error) OVERRIDE; 248eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 249e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch // IdentityAPI::ShutdownObserver implementation: 250e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch virtual void OnShutdown() OVERRIDE; 251e5d81f57cb97b3b6b7fccc9c5610d21eb81db09dBen Murdoch 2527dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch // Starts a login access token request. 2537dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch virtual void StartLoginAccessTokenRequest(); 2547dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch 2558bcbed890bc3ce4d7a057a8f32cab53fa534672eTorne (Richard Coles)#if defined(OS_CHROMEOS) 2568bcbed890bc3ce4d7a057a8f32cab53fa534672eTorne (Richard Coles) // Starts a login access token request for device robot account. This method 2578bcbed890bc3ce4d7a057a8f32cab53fa534672eTorne (Richard Coles) // will be called only in enterprise kiosk mode in ChromeOS. 2588bcbed890bc3ce4d7a057a8f32cab53fa534672eTorne (Richard Coles) virtual void StartDeviceLoginAccessTokenRequest(); 2598bcbed890bc3ce4d7a057a8f32cab53fa534672eTorne (Richard Coles)#endif 2608bcbed890bc3ce4d7a057a8f32cab53fa534672eTorne (Richard Coles) 261c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Starts a mint token request to GAIA. 2627dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch void StartGaiaRequest(const std::string& login_access_token); 2635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 264c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Methods for invoking UI. Overridable for testing. 2655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void ShowLoginPopup(); 2665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void ShowOAuthApprovalDialog(const IssueAdviceInfo& issue_advice); 2675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Caller owns the returned instance. 2685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual OAuth2MintTokenFlow* CreateMintTokenFlow( 2697dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch const std::string& login_access_token); 2705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Checks if there is a master login token to mint tokens for the extension. 2725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool HasLoginToken() const; 2735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 27490dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) // Maps OAuth2 protocol errors to an error message returned to the 27590dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) // developer in chrome.runtime.lastError. 27690dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) std::string MapOAuth2ErrorToDescription(const std::string& error); 27790dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) 278eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch std::string GetOAuth2ClientId() const; 279eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 280c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool should_prompt_for_scopes_; 281c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) IdentityMintRequestQueue::MintType mint_token_flow_type_; 282c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) scoped_ptr<OAuth2MintTokenFlow> mint_token_flow_; 2837dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch OAuth2MintTokenFlow::Mode gaia_mint_token_mode_; 284c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) bool should_prompt_for_signin_; 2855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 286a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) scoped_ptr<ExtensionTokenKey> token_key_; 287eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch std::string oauth2_client_id_; 2885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // When launched in interactive mode, and if there is no existing grant, 2895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // a permissions prompt will be popped up to the user. 290c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) IssueAdviceInfo issue_advice_; 29190dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) scoped_ptr<GaiaWebAuthFlow> gaia_web_auth_flow_; 292c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) scoped_ptr<IdentitySigninFlow> signin_flow_; 2937dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch scoped_ptr<OAuth2TokenService::Request> login_token_request_; 294c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)}; 295c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 2961e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles)class IdentityRemoveCachedAuthTokenFunction 2971e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) : public ChromeSyncExtensionFunction { 298c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) public: 299c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) DECLARE_EXTENSION_FUNCTION("identity.removeCachedAuthToken", 300c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) EXPERIMENTAL_IDENTITY_REMOVECACHEDAUTHTOKEN) 301c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) IdentityRemoveCachedAuthTokenFunction(); 302c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 303c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) protected: 304c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual ~IdentityRemoveCachedAuthTokenFunction(); 305c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 306c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // SyncExtensionFunction implementation: 3075c02ac1a9c1b504631c0a3d2b6e737b5d738bae1Bo Liu virtual bool RunSync() OVERRIDE; 3085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 3095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3101e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles)class IdentityLaunchWebAuthFlowFunction : public ChromeAsyncExtensionFunction, 3115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public WebAuthFlow::Delegate { 3125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 313c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) DECLARE_EXTENSION_FUNCTION("identity.launchWebAuthFlow", 314c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) EXPERIMENTAL_IDENTITY_LAUNCHWEBAUTHFLOW); 3155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) IdentityLaunchWebAuthFlowFunction(); 3175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 318b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // Tests may override extension_id. 319b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) void InitFinalRedirectURLPrefixForTest(const std::string& extension_id); 320c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 3215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 3225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~IdentityLaunchWebAuthFlowFunction(); 323010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) virtual bool RunAsync() OVERRIDE; 3245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // WebAuthFlow::Delegate implementation. 326c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void OnAuthFlowFailure(WebAuthFlow::Failure failure) OVERRIDE; 327c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual void OnAuthFlowURLChange(const GURL& redirect_url) OVERRIDE; 32890dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles) virtual void OnAuthFlowTitleChange(const std::string& title) OVERRIDE {} 329c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 330b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) // Helper to initialize final URL prefix. 331b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) void InitFinalRedirectURLPrefix(const std::string& extension_id); 3325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<WebAuthFlow> auth_flow_; 334b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles) GURL final_url_prefix_; 3355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 3365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace extensions 3385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_EXTENSIONS_API_IDENTITY_IDENTITY_API_H_ 340