1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef GOOGLE_APIS_GAIA_OAUTH2_MINT_TOKEN_FLOW_H_
6 #define GOOGLE_APIS_GAIA_OAUTH2_MINT_TOKEN_FLOW_H_
11 #include "base/gtest_prod_util.h"
12 #include "base/memory/weak_ptr.h"
13 #include "base/strings/string16.h"
14 #include "google_apis/gaia/oauth2_api_call_flow.h"
17 class GoogleServiceAuthError
;
18 class OAuth2MintTokenFlowTest
;
21 class DictionaryValue
;
29 class URLRequestContextGetter
;
32 // IssueAdvice: messages to show to the user to get a user's approval.
33 // The structure is as follows:
43 struct IssueAdviceInfoEntry
{
45 IssueAdviceInfoEntry();
46 ~IssueAdviceInfoEntry();
48 base::string16 description
;
49 std::vector
<base::string16
> details
;
51 bool operator==(const IssueAdviceInfoEntry
& rhs
) const;
54 typedef std::vector
<IssueAdviceInfoEntry
> IssueAdviceInfo
;
56 // This class implements the OAuth2 flow to Google to mint an OAuth2 access
57 // token for the given client and the given set of scopes from the OAuthLogin
58 // scoped "master" OAuth2 token for the user logged in to Chrome.
59 class OAuth2MintTokenFlow
: public OAuth2ApiCallFlow
{
61 // There are four differnt modes when minting a token to grant
62 // access to third-party app for a user.
64 // Get the messages to display to the user without minting a token.
66 // Record a grant but do not get a token back.
68 // Mint a token for an existing grant.
69 MODE_MINT_TOKEN_NO_FORCE
,
70 // Mint a token forcefully even if there is no existing grant.
71 MODE_MINT_TOKEN_FORCE
,
74 // Parameters needed to mint a token.
78 Parameters(const std::string
& eid
,
79 const std::string
& cid
,
80 const std::vector
<std::string
>& scopes_arg
,
84 std::string extension_id
;
85 std::string client_id
;
86 std::vector
<std::string
> scopes
;
92 virtual void OnMintTokenSuccess(const std::string
& access_token
,
94 virtual void OnIssueAdviceSuccess(const IssueAdviceInfo
& issue_advice
) {}
95 virtual void OnMintTokenFailure(const GoogleServiceAuthError
& error
) {}
98 virtual ~Delegate() {}
101 OAuth2MintTokenFlow(Delegate
* delegate
, const Parameters
& parameters
);
102 ~OAuth2MintTokenFlow() override
;
105 // Implementation of template methods in OAuth2ApiCallFlow.
106 GURL
CreateApiCallUrl() override
;
107 std::string
CreateApiCallBody() override
;
109 void ProcessApiCallSuccess(const net::URLFetcher
* source
) override
;
110 void ProcessApiCallFailure(const net::URLFetcher
* source
) override
;
113 friend class OAuth2MintTokenFlowTest
;
114 FRIEND_TEST_ALL_PREFIXES(OAuth2MintTokenFlowTest
, CreateApiCallBody
);
115 FRIEND_TEST_ALL_PREFIXES(OAuth2MintTokenFlowTest
, ParseIssueAdviceResponse
);
116 FRIEND_TEST_ALL_PREFIXES(OAuth2MintTokenFlowTest
, ParseMintTokenResponse
);
117 FRIEND_TEST_ALL_PREFIXES(OAuth2MintTokenFlowTest
, ProcessApiCallSuccess
);
118 FRIEND_TEST_ALL_PREFIXES(OAuth2MintTokenFlowTest
, ProcessApiCallFailure
);
120 void ReportSuccess(const std::string
& access_token
, int time_to_live
);
121 void ReportIssueAdviceSuccess(const IssueAdviceInfo
& issue_advice
);
122 void ReportFailure(const GoogleServiceAuthError
& error
);
124 static bool ParseIssueAdviceResponse(
125 const base::DictionaryValue
* dict
, IssueAdviceInfo
* issue_advice
);
126 static bool ParseMintTokenResponse(
127 const base::DictionaryValue
* dict
, std::string
* access_token
,
131 Parameters parameters_
;
132 base::WeakPtrFactory
<OAuth2MintTokenFlow
> weak_factory_
;
134 DISALLOW_COPY_AND_ASSIGN(OAuth2MintTokenFlow
);
137 #endif // GOOGLE_APIS_GAIA_OAUTH2_MINT_TOKEN_FLOW_H_