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
|
import time
from unittest import mock
import pytest
from globus_sdk.globus_app.authorizer_factory import (
AccessTokenAuthorizerFactory,
ClientCredentialsAuthorizerFactory,
RefreshTokenAuthorizerFactory,
)
from globus_sdk.token_storage import (
HasRefreshTokensValidator,
MemoryTokenStorage,
NotExpiredValidator,
)
from globus_sdk.token_storage.validating_token_storage import (
ExpiredTokenError,
MissingTokenError,
ValidatingTokenStorage,
)
def make_mock_token_response(token_number=1):
ret = mock.Mock()
ret.by_resource_server = {
"rs1": {
"resource_server": "rs1",
"scope": "rs1:all",
"access_token": f"rs1_access_token_{token_number}",
"refresh_token": f"rs1_refresh_token_{token_number}",
"expires_at_seconds": int(time.time()) + 3600,
"token_type": "Bearer",
}
}
ret.decode_id_token.return_value = {"sub": "dummy_id"}
return ret
def _make_mem_token_storage(validators=()):
return ValidatingTokenStorage(MemoryTokenStorage(), validators=validators)
def test_access_token_authorizer_factory():
initial_response = make_mock_token_response()
mock_token_storage = _make_mem_token_storage()
mock_token_storage.store_token_response(initial_response)
factory = AccessTokenAuthorizerFactory(token_storage=mock_token_storage)
# cache is initially empty
assert factory._authorizer_cache == {}
# calling get_authorizer once creates a new authorizer from underlying storage
authorizer = factory.get_authorizer("rs1")
assert authorizer.get_authorization_header() == "Bearer rs1_access_token_1"
# calling get_authorizer again gets the same cached authorizer
authorizer2 = factory.get_authorizer("rs1")
assert authorizer is authorizer2
# calling store_token_response_and_clear_cache then get gets a new authorizer
new_data = make_mock_token_response(token_number=2)
factory.store_token_response_and_clear_cache(new_data)
assert factory._authorizer_cache == {}
authorizer = factory.get_authorizer("rs1")
assert authorizer.get_authorization_header() == "Bearer rs1_access_token_2"
def test_access_token_authorizer_factory_no_tokens():
initial_response = make_mock_token_response()
mock_token_storage = _make_mem_token_storage()
mock_token_storage.store_token_response(initial_response)
factory = AccessTokenAuthorizerFactory(token_storage=mock_token_storage)
with pytest.raises(MissingTokenError) as exc:
factory.get_authorizer("rs2")
assert str(exc.value) == "No token data for rs2"
def test_access_token_authorizer_factory_expired_access_token():
initial_response = make_mock_token_response()
initial_response.by_resource_server["rs1"]["expires_at_seconds"] = int(
time.time() - 3600
)
mock_token_storage = _make_mem_token_storage(validators=(NotExpiredValidator(),))
mock_token_storage.store_token_response(initial_response)
factory = AccessTokenAuthorizerFactory(token_storage=mock_token_storage)
with pytest.raises(ExpiredTokenError):
factory.get_authorizer("rs1")
def test_refresh_token_authorizer_factory():
initial_response = make_mock_token_response()
mock_token_storage = _make_mem_token_storage(
validators=(HasRefreshTokensValidator(),)
)
mock_token_storage.store_token_response(initial_response)
refresh_data = make_mock_token_response(token_number=2)
mock_auth_login_client = mock.Mock()
mock_refresh = mock.Mock()
mock_refresh.return_value = refresh_data
mock_auth_login_client.oauth2_refresh_token = mock_refresh
factory = RefreshTokenAuthorizerFactory(
token_storage=mock_token_storage,
auth_login_client=mock_auth_login_client,
)
# calling get authorizer creates a new authorizer with existing token data
authorizer1 = factory.get_authorizer("rs1")
assert authorizer1.get_authorization_header() == "Bearer rs1_access_token_1"
assert mock_auth_login_client.oauth2_refresh_token.call_count == 0
# standard refresh doesn't change the authorizer
authorizer1._get_new_access_token()
authorizer2 = factory.get_authorizer("rs1")
assert authorizer2 is authorizer1
assert authorizer2.get_authorization_header() == "Bearer rs1_access_token_2"
assert mock_auth_login_client.oauth2_refresh_token.call_count == 1
# calling store_token_response_and_clear_cache then get gets a new authorizer
factory.store_token_response_and_clear_cache(initial_response)
authorizer3 = factory.get_authorizer("rs1")
assert authorizer3 is not authorizer1
assert authorizer3.get_authorization_header() == "Bearer rs1_access_token_1"
def test_refresh_token_authorizer_factory_expired_access_token():
initial_response = make_mock_token_response()
initial_response.by_resource_server["rs1"]["expires_at_seconds"] = int(
time.time() - 3600
)
mock_token_storage = _make_mem_token_storage(
validators=(HasRefreshTokensValidator(),)
)
mock_token_storage.store_token_response(initial_response)
refresh_data = make_mock_token_response(token_number=2)
mock_auth_login_client = mock.Mock()
mock_refresh = mock.Mock()
mock_refresh.return_value = refresh_data
mock_auth_login_client.oauth2_refresh_token = mock_refresh
factory = RefreshTokenAuthorizerFactory(
token_storage=mock_token_storage,
auth_login_client=mock_auth_login_client,
)
# calling get_authorizer automatically causes a refresh call to get an access token
authorizer = factory.get_authorizer("rs1")
assert authorizer.get_authorization_header() == "Bearer rs1_access_token_2"
assert mock_refresh.call_count == 1
def test_refresh_token_authorizer_factory_no_refresh_token():
initial_response = make_mock_token_response()
initial_response.by_resource_server["rs1"]["refresh_token"] = None
mock_token_storage = _make_mem_token_storage(
validators=(HasRefreshTokensValidator(),)
)
mock_token_storage.store_token_response(initial_response)
factory = RefreshTokenAuthorizerFactory(
token_storage=mock_token_storage,
auth_login_client=mock.Mock(),
)
with pytest.raises(MissingTokenError) as exc:
factory.get_authorizer("rs1")
assert str(exc.value) == "No refresh_token for rs1"
def test_client_credentials_authorizer_factory():
initial_response = make_mock_token_response()
mock_token_storage = _make_mem_token_storage()
mock_token_storage.store_token_response(initial_response)
client_token_data = make_mock_token_response(token_number=2)
mock_confidential_client = mock.Mock()
mock_client_credentials_tokens = mock.Mock()
mock_client_credentials_tokens.return_value = client_token_data
mock_confidential_client.oauth2_client_credentials_tokens = (
mock_client_credentials_tokens
)
factory = ClientCredentialsAuthorizerFactory(
token_storage=mock_token_storage,
confidential_client=mock_confidential_client,
scope_requirements={"rs1": ["scope1"]},
)
# calling get_authorizer once creates a new authorizer using existing tokens
authorizer1 = factory.get_authorizer("rs1")
assert authorizer1.get_authorization_header() == "Bearer rs1_access_token_1"
assert mock_confidential_client.oauth2_client_credentials_tokens.call_count == 0
# renewing with existing tokens doesn't change the authorizer
authorizer1._get_new_access_token()
authorizer2 = factory.get_authorizer("rs1")
assert authorizer2 is authorizer1
assert authorizer2.get_authorization_header() == "Bearer rs1_access_token_2"
assert mock_confidential_client.oauth2_client_credentials_tokens.call_count == 1
# calling store_token_response_and_clear_cache then get gets a new authorizer
factory.store_token_response_and_clear_cache(initial_response)
authorizer3 = factory.get_authorizer("rs1")
assert authorizer3 is not authorizer1
assert authorizer3.get_authorization_header() == "Bearer rs1_access_token_1"
def test_client_credentials_authorizer_factory_no_tokens():
mock_token_storage = _make_mem_token_storage()
client_token_data = make_mock_token_response()
mock_confidential_client = mock.Mock()
mock_client_credentials_tokens = mock.Mock()
mock_client_credentials_tokens.return_value = client_token_data
mock_confidential_client.oauth2_client_credentials_tokens = (
mock_client_credentials_tokens
)
factory = ClientCredentialsAuthorizerFactory(
token_storage=mock_token_storage,
confidential_client=mock_confidential_client,
scope_requirements={"rs1": ["scope1"]},
)
# calling get_authorizer once creates a new authorizer automatically making
# a client credentials call to get an access token that is then stored
authorizer = factory.get_authorizer("rs1")
assert authorizer.get_authorization_header() == "Bearer rs1_access_token_1"
assert mock_client_credentials_tokens.call_count == 1
def test_client_credentials_authorizer_factory_no_scopes():
mock_token_storage = _make_mem_token_storage()
mock_confidential_client = mock.Mock()
factory = ClientCredentialsAuthorizerFactory(
token_storage=mock_token_storage,
confidential_client=mock_confidential_client,
scope_requirements={},
)
with pytest.raises(ValueError) as exc:
factory.get_authorizer("rs2")
assert (
str(exc.value)
== "ValidatingTokenStorage has no scope_requirements for resource_server rs2"
)
|
