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
309
310
311
312
|
# Copyright 2014 Google Inc.
#
# 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 json
import os
import mock
import pytest # type: ignore
from google.auth import environment_vars
from google.auth import exceptions
from google.auth import transport
from google.oauth2 import id_token
from google.oauth2 import service_account
import yatest.common
SERVICE_ACCOUNT_FILE = os.path.join(
yatest.common.test_source_path(), "data/service_account.json"
)
ID_TOKEN_AUDIENCE = "https://pubsub.googleapis.com"
def make_request(status, data=None):
response = mock.create_autospec(transport.Response, instance=True)
response.status = status
if data is not None:
response.data = json.dumps(data).encode("utf-8")
request = mock.create_autospec(transport.Request)
request.return_value = response
return request
def test__fetch_certs_success():
certs = {"1": "cert"}
request = make_request(200, certs)
returned_certs = id_token._fetch_certs(request, mock.sentinel.cert_url)
request.assert_called_once_with(mock.sentinel.cert_url, method="GET")
assert returned_certs == certs
def test__fetch_certs_failure():
request = make_request(404)
with pytest.raises(exceptions.TransportError):
id_token._fetch_certs(request, mock.sentinel.cert_url)
request.assert_called_once_with(mock.sentinel.cert_url, method="GET")
@mock.patch("google.auth.jwt.decode", autospec=True)
@mock.patch("google.oauth2.id_token._fetch_certs", autospec=True)
def test_verify_token(_fetch_certs, decode):
result = id_token.verify_token(mock.sentinel.token, mock.sentinel.request)
assert result == decode.return_value
_fetch_certs.assert_called_once_with(
mock.sentinel.request, id_token._GOOGLE_OAUTH2_CERTS_URL
)
decode.assert_called_once_with(
mock.sentinel.token,
certs=_fetch_certs.return_value,
audience=None,
clock_skew_in_seconds=0,
)
@mock.patch("google.auth.jwt.decode", autospec=True)
@mock.patch("google.oauth2.id_token._fetch_certs", autospec=True)
def test_verify_token_args(_fetch_certs, decode):
result = id_token.verify_token(
mock.sentinel.token,
mock.sentinel.request,
audience=mock.sentinel.audience,
certs_url=mock.sentinel.certs_url,
)
assert result == decode.return_value
_fetch_certs.assert_called_once_with(mock.sentinel.request, mock.sentinel.certs_url)
decode.assert_called_once_with(
mock.sentinel.token,
certs=_fetch_certs.return_value,
audience=mock.sentinel.audience,
clock_skew_in_seconds=0,
)
@mock.patch("google.auth.jwt.decode", autospec=True)
@mock.patch("google.oauth2.id_token._fetch_certs", autospec=True)
def test_verify_token_clock_skew(_fetch_certs, decode):
result = id_token.verify_token(
mock.sentinel.token,
mock.sentinel.request,
audience=mock.sentinel.audience,
certs_url=mock.sentinel.certs_url,
clock_skew_in_seconds=10,
)
assert result == decode.return_value
_fetch_certs.assert_called_once_with(mock.sentinel.request, mock.sentinel.certs_url)
decode.assert_called_once_with(
mock.sentinel.token,
certs=_fetch_certs.return_value,
audience=mock.sentinel.audience,
clock_skew_in_seconds=10,
)
@mock.patch("google.oauth2.id_token.verify_token", autospec=True)
def test_verify_oauth2_token(verify_token):
verify_token.return_value = {"iss": "accounts.google.com"}
result = id_token.verify_oauth2_token(
mock.sentinel.token, mock.sentinel.request, audience=mock.sentinel.audience
)
assert result == verify_token.return_value
verify_token.assert_called_once_with(
mock.sentinel.token,
mock.sentinel.request,
audience=mock.sentinel.audience,
certs_url=id_token._GOOGLE_OAUTH2_CERTS_URL,
clock_skew_in_seconds=0,
)
@mock.patch("google.oauth2.id_token.verify_token", autospec=True)
def test_verify_oauth2_token_clock_skew(verify_token):
verify_token.return_value = {"iss": "accounts.google.com"}
result = id_token.verify_oauth2_token(
mock.sentinel.token,
mock.sentinel.request,
audience=mock.sentinel.audience,
clock_skew_in_seconds=10,
)
assert result == verify_token.return_value
verify_token.assert_called_once_with(
mock.sentinel.token,
mock.sentinel.request,
audience=mock.sentinel.audience,
certs_url=id_token._GOOGLE_OAUTH2_CERTS_URL,
clock_skew_in_seconds=10,
)
@mock.patch("google.oauth2.id_token.verify_token", autospec=True)
def test_verify_oauth2_token_invalid_iss(verify_token):
verify_token.return_value = {"iss": "invalid_issuer"}
with pytest.raises(exceptions.GoogleAuthError):
id_token.verify_oauth2_token(
mock.sentinel.token, mock.sentinel.request, audience=mock.sentinel.audience
)
@mock.patch("google.oauth2.id_token.verify_token", autospec=True)
def test_verify_firebase_token(verify_token):
result = id_token.verify_firebase_token(
mock.sentinel.token, mock.sentinel.request, audience=mock.sentinel.audience
)
assert result == verify_token.return_value
verify_token.assert_called_once_with(
mock.sentinel.token,
mock.sentinel.request,
audience=mock.sentinel.audience,
certs_url=id_token._GOOGLE_APIS_CERTS_URL,
clock_skew_in_seconds=0,
)
@mock.patch("google.oauth2.id_token.verify_token", autospec=True)
def test_verify_firebase_token_clock_skew(verify_token):
result = id_token.verify_firebase_token(
mock.sentinel.token,
mock.sentinel.request,
audience=mock.sentinel.audience,
clock_skew_in_seconds=10,
)
assert result == verify_token.return_value
verify_token.assert_called_once_with(
mock.sentinel.token,
mock.sentinel.request,
audience=mock.sentinel.audience,
certs_url=id_token._GOOGLE_APIS_CERTS_URL,
clock_skew_in_seconds=10,
)
def test_fetch_id_token_credentials_optional_request(monkeypatch):
monkeypatch.delenv(environment_vars.CREDENTIALS, raising=False)
# Test a request object is created if not provided
with mock.patch("google.auth.compute_engine._metadata.ping", return_value=True):
with mock.patch(
"google.auth.compute_engine.IDTokenCredentials.__init__", return_value=None
):
with mock.patch(
"google.auth.transport.requests.Request.__init__", return_value=None
) as mock_request:
id_token.fetch_id_token_credentials(ID_TOKEN_AUDIENCE)
mock_request.assert_called()
def test_fetch_id_token_credentials_from_metadata_server(monkeypatch):
monkeypatch.delenv(environment_vars.CREDENTIALS, raising=False)
mock_req = mock.Mock()
with mock.patch("google.auth.compute_engine._metadata.ping", return_value=True):
with mock.patch(
"google.auth.compute_engine.IDTokenCredentials.__init__", return_value=None
) as mock_init:
id_token.fetch_id_token_credentials(ID_TOKEN_AUDIENCE, request=mock_req)
mock_init.assert_called_once_with(
mock_req, ID_TOKEN_AUDIENCE, use_metadata_identity_endpoint=True
)
def test_fetch_id_token_credentials_from_explicit_cred_json_file(monkeypatch):
monkeypatch.setenv(environment_vars.CREDENTIALS, SERVICE_ACCOUNT_FILE)
cred = id_token.fetch_id_token_credentials(ID_TOKEN_AUDIENCE)
assert isinstance(cred, service_account.IDTokenCredentials)
assert cred._target_audience == ID_TOKEN_AUDIENCE
def test_fetch_id_token_credentials_no_cred_exists(monkeypatch):
monkeypatch.delenv(environment_vars.CREDENTIALS, raising=False)
with mock.patch(
"google.auth.compute_engine._metadata.ping",
side_effect=exceptions.TransportError(),
):
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
id_token.fetch_id_token_credentials(ID_TOKEN_AUDIENCE)
assert excinfo.match(
r"Neither metadata server or valid service account credentials are found."
)
with mock.patch("google.auth.compute_engine._metadata.ping", return_value=False):
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
id_token.fetch_id_token_credentials(ID_TOKEN_AUDIENCE)
assert excinfo.match(
r"Neither metadata server or valid service account credentials are found."
)
def test_fetch_id_token_credentials_invalid_cred_file_type(monkeypatch):
user_credentials_file = os.path.join(
yatest.common.test_source_path(), "data/authorized_user.json"
)
monkeypatch.setenv(environment_vars.CREDENTIALS, user_credentials_file)
with mock.patch("google.auth.compute_engine._metadata.ping", return_value=False):
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
id_token.fetch_id_token_credentials(ID_TOKEN_AUDIENCE)
assert excinfo.match(
r"Neither metadata server or valid service account credentials are found."
)
def test_fetch_id_token_credentials_invalid_json(monkeypatch):
not_json_file = os.path.join(yatest.common.test_source_path(), "data/public_cert.pem")
monkeypatch.setenv(environment_vars.CREDENTIALS, not_json_file)
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
id_token.fetch_id_token_credentials(ID_TOKEN_AUDIENCE)
assert excinfo.match(
r"GOOGLE_APPLICATION_CREDENTIALS is not valid service account credentials."
)
def test_fetch_id_token_credentials_invalid_cred_path(monkeypatch):
not_json_file = os.path.join(yatest.common.test_source_path(), "data/not_exists.json")
monkeypatch.setenv(environment_vars.CREDENTIALS, not_json_file)
with pytest.raises(exceptions.DefaultCredentialsError) as excinfo:
id_token.fetch_id_token_credentials(ID_TOKEN_AUDIENCE)
assert excinfo.match(
r"GOOGLE_APPLICATION_CREDENTIALS path is either not found or invalid."
)
def test_fetch_id_token(monkeypatch):
mock_cred = mock.MagicMock()
mock_cred.token = "token"
mock_req = mock.Mock()
with mock.patch(
"google.oauth2.id_token.fetch_id_token_credentials", return_value=mock_cred
) as mock_fetch:
token = id_token.fetch_id_token(mock_req, ID_TOKEN_AUDIENCE)
mock_fetch.assert_called_once_with(ID_TOKEN_AUDIENCE, request=mock_req)
mock_cred.refresh.assert_called_once_with(mock_req)
assert token == "token"
|
