1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
|
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import copy
import mock
import pytest
from google.auth import exceptions
from google.oauth2 import reauth
MOCK_REQUEST = mock.Mock()
CHALLENGES_RESPONSE_TEMPLATE = {
"status": "CHALLENGE_REQUIRED",
"sessionId": "123",
"challenges": [
{
"status": "READY",
"challengeId": 1,
"challengeType": "PASSWORD",
"securityKey": {},
}
],
}
CHALLENGES_RESPONSE_AUTHENTICATED = {
"status": "AUTHENTICATED",
"sessionId": "123",
"encodedProofOfReauthToken": "new_rapt_token",
}
class MockChallenge(object):
def __init__(self, name, locally_eligible, challenge_input):
self.name = name
self.is_locally_eligible = locally_eligible
self.challenge_input = challenge_input
def obtain_challenge_input(self, metadata):
return self.challenge_input
def test_is_interactive():
with mock.patch("sys.stdin.isatty", return_value=True):
assert reauth.is_interactive()
def test__get_challenges():
with mock.patch(
"google.oauth2._client._token_endpoint_request"
) as mock_token_endpoint_request:
reauth._get_challenges(MOCK_REQUEST, ["SAML"], "token")
mock_token_endpoint_request.assert_called_with(
MOCK_REQUEST,
reauth._REAUTH_API + ":start",
{"supportedChallengeTypes": ["SAML"]},
access_token="token",
use_json=True,
)
def test__get_challenges_with_scopes():
with mock.patch(
"google.oauth2._client._token_endpoint_request"
) as mock_token_endpoint_request:
reauth._get_challenges(
MOCK_REQUEST, ["SAML"], "token", requested_scopes=["scope"]
)
mock_token_endpoint_request.assert_called_with(
MOCK_REQUEST,
reauth._REAUTH_API + ":start",
{
"supportedChallengeTypes": ["SAML"],
"oauthScopesForDomainPolicyLookup": ["scope"],
},
access_token="token",
use_json=True,
)
def test__send_challenge_result():
with mock.patch(
"google.oauth2._client._token_endpoint_request"
) as mock_token_endpoint_request:
reauth._send_challenge_result(
MOCK_REQUEST, "123", "1", {"credential": "password"}, "token"
)
mock_token_endpoint_request.assert_called_with(
MOCK_REQUEST,
reauth._REAUTH_API + "/123:continue",
{
"sessionId": "123",
"challengeId": "1",
"action": "RESPOND",
"proposalResponse": {"credential": "password"},
},
access_token="token",
use_json=True,
)
def test__run_next_challenge_not_ready():
challenges_response = copy.deepcopy(CHALLENGES_RESPONSE_TEMPLATE)
challenges_response["challenges"][0]["status"] = "STATUS_UNSPECIFIED"
assert (
reauth._run_next_challenge(challenges_response, MOCK_REQUEST, "token") is None
)
def test__run_next_challenge_not_supported():
challenges_response = copy.deepcopy(CHALLENGES_RESPONSE_TEMPLATE)
challenges_response["challenges"][0]["challengeType"] = "CHALLENGE_TYPE_UNSPECIFIED"
with pytest.raises(exceptions.ReauthFailError) as excinfo:
reauth._run_next_challenge(challenges_response, MOCK_REQUEST, "token")
assert excinfo.match(r"Unsupported challenge type CHALLENGE_TYPE_UNSPECIFIED")
def test__run_next_challenge_not_locally_eligible():
mock_challenge = MockChallenge("PASSWORD", False, "challenge_input")
with mock.patch(
"google.oauth2.challenges.AVAILABLE_CHALLENGES", {"PASSWORD": mock_challenge}
):
with pytest.raises(exceptions.ReauthFailError) as excinfo:
reauth._run_next_challenge(
CHALLENGES_RESPONSE_TEMPLATE, MOCK_REQUEST, "token"
)
assert excinfo.match(r"Challenge PASSWORD is not locally eligible")
def test__run_next_challenge_no_challenge_input():
mock_challenge = MockChallenge("PASSWORD", True, None)
with mock.patch(
"google.oauth2.challenges.AVAILABLE_CHALLENGES", {"PASSWORD": mock_challenge}
):
assert (
reauth._run_next_challenge(
CHALLENGES_RESPONSE_TEMPLATE, MOCK_REQUEST, "token"
)
is None
)
def test__run_next_challenge_success():
mock_challenge = MockChallenge("PASSWORD", True, {"credential": "password"})
with mock.patch(
"google.oauth2.challenges.AVAILABLE_CHALLENGES", {"PASSWORD": mock_challenge}
):
with mock.patch(
"google.oauth2.reauth._send_challenge_result"
) as mock_send_challenge_result:
reauth._run_next_challenge(
CHALLENGES_RESPONSE_TEMPLATE, MOCK_REQUEST, "token"
)
mock_send_challenge_result.assert_called_with(
MOCK_REQUEST, "123", 1, {"credential": "password"}, "token"
)
def test__obtain_rapt_authenticated():
with mock.patch(
"google.oauth2.reauth._get_challenges",
return_value=CHALLENGES_RESPONSE_AUTHENTICATED,
):
assert reauth._obtain_rapt(MOCK_REQUEST, "token", None) == "new_rapt_token"
def test__obtain_rapt_authenticated_after_run_next_challenge():
with mock.patch(
"google.oauth2.reauth._get_challenges",
return_value=CHALLENGES_RESPONSE_TEMPLATE,
):
with mock.patch(
"google.oauth2.reauth._run_next_challenge",
side_effect=[
CHALLENGES_RESPONSE_TEMPLATE,
CHALLENGES_RESPONSE_AUTHENTICATED,
],
):
with mock.patch("google.oauth2.reauth.is_interactive", return_value=True):
assert (
reauth._obtain_rapt(MOCK_REQUEST, "token", None) == "new_rapt_token"
)
def test__obtain_rapt_unsupported_status():
challenges_response = copy.deepcopy(CHALLENGES_RESPONSE_TEMPLATE)
challenges_response["status"] = "STATUS_UNSPECIFIED"
with mock.patch(
"google.oauth2.reauth._get_challenges", return_value=challenges_response
):
with pytest.raises(exceptions.ReauthFailError) as excinfo:
reauth._obtain_rapt(MOCK_REQUEST, "token", None)
assert excinfo.match(r"API error: STATUS_UNSPECIFIED")
def test__obtain_rapt_not_interactive():
with mock.patch(
"google.oauth2.reauth._get_challenges",
return_value=CHALLENGES_RESPONSE_TEMPLATE,
):
with mock.patch("google.oauth2.reauth.is_interactive", return_value=False):
with pytest.raises(exceptions.ReauthFailError) as excinfo:
reauth._obtain_rapt(MOCK_REQUEST, "token", None)
assert excinfo.match(r"not in an interactive session")
def test__obtain_rapt_not_authenticated():
with mock.patch(
"google.oauth2.reauth._get_challenges",
return_value=CHALLENGES_RESPONSE_TEMPLATE,
):
with mock.patch("google.oauth2.reauth.RUN_CHALLENGE_RETRY_LIMIT", 0):
with pytest.raises(exceptions.ReauthFailError) as excinfo:
reauth._obtain_rapt(MOCK_REQUEST, "token", None)
assert excinfo.match(r"Reauthentication failed")
def test_get_rapt_token():
with mock.patch(
"google.oauth2._client.refresh_grant", return_value=("token", None, None, None)
) as mock_refresh_grant:
with mock.patch(
"google.oauth2.reauth._obtain_rapt", return_value="new_rapt_token"
) as mock_obtain_rapt:
assert (
reauth.get_rapt_token(
MOCK_REQUEST,
"client_id",
"client_secret",
"refresh_token",
"token_uri",
)
== "new_rapt_token"
)
mock_refresh_grant.assert_called_with(
request=MOCK_REQUEST,
client_id="client_id",
client_secret="client_secret",
refresh_token="refresh_token",
token_uri="token_uri",
scopes=[reauth._REAUTH_SCOPE],
)
mock_obtain_rapt.assert_called_with(
MOCK_REQUEST, "token", requested_scopes=None
)
def test_refresh_grant_failed():
with mock.patch(
"google.oauth2._client._token_endpoint_request_no_throw"
) as mock_token_request:
mock_token_request.return_value = (False, {"error": "Bad request"})
with pytest.raises(exceptions.RefreshError) as excinfo:
reauth.refresh_grant(
MOCK_REQUEST,
"token_uri",
"refresh_token",
"client_id",
"client_secret",
scopes=["foo", "bar"],
rapt_token="rapt_token",
)
assert excinfo.match(r"Bad request")
mock_token_request.assert_called_with(
MOCK_REQUEST,
"token_uri",
{
"grant_type": "refresh_token",
"client_id": "client_id",
"client_secret": "client_secret",
"refresh_token": "refresh_token",
"scope": "foo bar",
"rapt": "rapt_token",
},
)
def test_refresh_grant_success():
with mock.patch(
"google.oauth2._client._token_endpoint_request_no_throw"
) as mock_token_request:
mock_token_request.side_effect = [
(False, {"error": "invalid_grant", "error_subtype": "rapt_required"}),
(True, {"access_token": "access_token"}),
]
with mock.patch(
"google.oauth2.reauth.get_rapt_token", return_value="new_rapt_token"
):
assert reauth.refresh_grant(
MOCK_REQUEST, "token_uri", "refresh_token", "client_id", "client_secret"
) == (
"access_token",
"refresh_token",
None,
{"access_token": "access_token"},
"new_rapt_token",
)
|
