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 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
|
# Copyright 2020 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 http.client as http_client
import json
import urllib
import mock
import pytest # type: ignore
from google.auth import exceptions
from google.auth import transport
from google.oauth2 import sts
from google.oauth2 import utils
CLIENT_ID = "username"
CLIENT_SECRET = "password"
# Base64 encoding of "username:password"
BASIC_AUTH_ENCODING = "dXNlcm5hbWU6cGFzc3dvcmQ="
class TestStsClient(object):
GRANT_TYPE = "urn:ietf:params:oauth:grant-type:token-exchange"
RESOURCE = "https://api.example.com/"
AUDIENCE = "urn:example:cooperation-context"
SCOPES = ["scope1", "scope2"]
REQUESTED_TOKEN_TYPE = "urn:ietf:params:oauth:token-type:access_token"
SUBJECT_TOKEN = "HEADER.SUBJECT_TOKEN_PAYLOAD.SIGNATURE"
SUBJECT_TOKEN_TYPE = "urn:ietf:params:oauth:token-type:jwt"
ACTOR_TOKEN = "HEADER.ACTOR_TOKEN_PAYLOAD.SIGNATURE"
ACTOR_TOKEN_TYPE = "urn:ietf:params:oauth:token-type:jwt"
TOKEN_EXCHANGE_ENDPOINT = "https://example.com/token.oauth2"
ADDON_HEADERS = {"x-client-version": "0.1.2"}
ADDON_OPTIONS = {"additional": {"non-standard": ["options"], "other": "some-value"}}
SUCCESS_RESPONSE = {
"access_token": "ACCESS_TOKEN",
"issued_token_type": "urn:ietf:params:oauth:token-type:access_token",
"token_type": "Bearer",
"expires_in": 3600,
"scope": "scope1 scope2",
}
SUCCESS_RESPONSE_WITH_REFRESH = {
"access_token": "abc",
"refresh_token": "xyz",
"expires_in": 3600,
}
ERROR_RESPONSE = {
"error": "invalid_request",
"error_description": "Invalid subject token",
"error_uri": "https://tools.ietf.org/html/rfc6749",
}
CLIENT_AUTH_BASIC = utils.ClientAuthentication(
utils.ClientAuthType.basic, CLIENT_ID, CLIENT_SECRET
)
CLIENT_AUTH_REQUEST_BODY = utils.ClientAuthentication(
utils.ClientAuthType.request_body, CLIENT_ID, CLIENT_SECRET
)
@classmethod
def make_client(cls, client_auth=None):
return sts.Client(cls.TOKEN_EXCHANGE_ENDPOINT, client_auth)
@classmethod
def make_mock_request(cls, data, status=http_client.OK):
response = mock.create_autospec(transport.Response, instance=True)
response.status = status
response.data = json.dumps(data).encode("utf-8")
request = mock.create_autospec(transport.Request)
request.return_value = response
return request
@classmethod
def assert_request_kwargs(cls, request_kwargs, headers, request_data):
"""Asserts the request was called with the expected parameters.
"""
assert request_kwargs["url"] == cls.TOKEN_EXCHANGE_ENDPOINT
assert request_kwargs["method"] == "POST"
assert request_kwargs["headers"] == headers
assert request_kwargs["body"] is not None
body_tuples = urllib.parse.parse_qsl(request_kwargs["body"])
for (k, v) in body_tuples:
assert v.decode("utf-8") == request_data[k.decode("utf-8")]
assert len(body_tuples) == len(request_data.keys())
def test_exchange_token_full_success_without_auth(self):
"""Test token exchange success without client authentication using full
parameters.
"""
client = self.make_client()
headers = self.ADDON_HEADERS.copy()
headers["Content-Type"] = "application/x-www-form-urlencoded"
request_data = {
"grant_type": self.GRANT_TYPE,
"resource": self.RESOURCE,
"audience": self.AUDIENCE,
"scope": " ".join(self.SCOPES),
"requested_token_type": self.REQUESTED_TOKEN_TYPE,
"subject_token": self.SUBJECT_TOKEN,
"subject_token_type": self.SUBJECT_TOKEN_TYPE,
"actor_token": self.ACTOR_TOKEN,
"actor_token_type": self.ACTOR_TOKEN_TYPE,
"options": urllib.parse.quote(json.dumps(self.ADDON_OPTIONS)),
}
request = self.make_mock_request(
status=http_client.OK, data=self.SUCCESS_RESPONSE
)
response = client.exchange_token(
request,
self.GRANT_TYPE,
self.SUBJECT_TOKEN,
self.SUBJECT_TOKEN_TYPE,
self.RESOURCE,
self.AUDIENCE,
self.SCOPES,
self.REQUESTED_TOKEN_TYPE,
self.ACTOR_TOKEN,
self.ACTOR_TOKEN_TYPE,
self.ADDON_OPTIONS,
self.ADDON_HEADERS,
)
self.assert_request_kwargs(request.call_args[1], headers, request_data)
assert response == self.SUCCESS_RESPONSE
def test_exchange_token_partial_success_without_auth(self):
"""Test token exchange success without client authentication using
partial (required only) parameters.
"""
client = self.make_client()
headers = {"Content-Type": "application/x-www-form-urlencoded"}
request_data = {
"grant_type": self.GRANT_TYPE,
"audience": self.AUDIENCE,
"requested_token_type": self.REQUESTED_TOKEN_TYPE,
"subject_token": self.SUBJECT_TOKEN,
"subject_token_type": self.SUBJECT_TOKEN_TYPE,
}
request = self.make_mock_request(
status=http_client.OK, data=self.SUCCESS_RESPONSE
)
response = client.exchange_token(
request,
grant_type=self.GRANT_TYPE,
subject_token=self.SUBJECT_TOKEN,
subject_token_type=self.SUBJECT_TOKEN_TYPE,
audience=self.AUDIENCE,
requested_token_type=self.REQUESTED_TOKEN_TYPE,
)
self.assert_request_kwargs(request.call_args[1], headers, request_data)
assert response == self.SUCCESS_RESPONSE
def test_exchange_token_non200_without_auth(self):
"""Test token exchange without client auth responding with non-200 status.
"""
client = self.make_client()
request = self.make_mock_request(
status=http_client.BAD_REQUEST, data=self.ERROR_RESPONSE
)
with pytest.raises(exceptions.OAuthError) as excinfo:
client.exchange_token(
request,
self.GRANT_TYPE,
self.SUBJECT_TOKEN,
self.SUBJECT_TOKEN_TYPE,
self.RESOURCE,
self.AUDIENCE,
self.SCOPES,
self.REQUESTED_TOKEN_TYPE,
self.ACTOR_TOKEN,
self.ACTOR_TOKEN_TYPE,
self.ADDON_OPTIONS,
self.ADDON_HEADERS,
)
assert excinfo.match(
r"Error code invalid_request: Invalid subject token - https://tools.ietf.org/html/rfc6749"
)
def test_exchange_token_full_success_with_basic_auth(self):
"""Test token exchange success with basic client authentication using full
parameters.
"""
client = self.make_client(self.CLIENT_AUTH_BASIC)
headers = self.ADDON_HEADERS.copy()
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Authorization"] = "Basic {}".format(BASIC_AUTH_ENCODING)
request_data = {
"grant_type": self.GRANT_TYPE,
"resource": self.RESOURCE,
"audience": self.AUDIENCE,
"scope": " ".join(self.SCOPES),
"requested_token_type": self.REQUESTED_TOKEN_TYPE,
"subject_token": self.SUBJECT_TOKEN,
"subject_token_type": self.SUBJECT_TOKEN_TYPE,
"actor_token": self.ACTOR_TOKEN,
"actor_token_type": self.ACTOR_TOKEN_TYPE,
"options": urllib.parse.quote(json.dumps(self.ADDON_OPTIONS)),
}
request = self.make_mock_request(
status=http_client.OK, data=self.SUCCESS_RESPONSE
)
response = client.exchange_token(
request,
self.GRANT_TYPE,
self.SUBJECT_TOKEN,
self.SUBJECT_TOKEN_TYPE,
self.RESOURCE,
self.AUDIENCE,
self.SCOPES,
self.REQUESTED_TOKEN_TYPE,
self.ACTOR_TOKEN,
self.ACTOR_TOKEN_TYPE,
self.ADDON_OPTIONS,
self.ADDON_HEADERS,
)
self.assert_request_kwargs(request.call_args[1], headers, request_data)
assert response == self.SUCCESS_RESPONSE
def test_exchange_token_partial_success_with_basic_auth(self):
"""Test token exchange success with basic client authentication using
partial (required only) parameters.
"""
client = self.make_client(self.CLIENT_AUTH_BASIC)
headers = {
"Content-Type": "application/x-www-form-urlencoded",
"Authorization": "Basic {}".format(BASIC_AUTH_ENCODING),
}
request_data = {
"grant_type": self.GRANT_TYPE,
"audience": self.AUDIENCE,
"requested_token_type": self.REQUESTED_TOKEN_TYPE,
"subject_token": self.SUBJECT_TOKEN,
"subject_token_type": self.SUBJECT_TOKEN_TYPE,
}
request = self.make_mock_request(
status=http_client.OK, data=self.SUCCESS_RESPONSE
)
response = client.exchange_token(
request,
grant_type=self.GRANT_TYPE,
subject_token=self.SUBJECT_TOKEN,
subject_token_type=self.SUBJECT_TOKEN_TYPE,
audience=self.AUDIENCE,
requested_token_type=self.REQUESTED_TOKEN_TYPE,
)
self.assert_request_kwargs(request.call_args[1], headers, request_data)
assert response == self.SUCCESS_RESPONSE
def test_exchange_token_non200_with_basic_auth(self):
"""Test token exchange with basic client auth responding with non-200
status.
"""
client = self.make_client(self.CLIENT_AUTH_BASIC)
request = self.make_mock_request(
status=http_client.BAD_REQUEST, data=self.ERROR_RESPONSE
)
with pytest.raises(exceptions.OAuthError) as excinfo:
client.exchange_token(
request,
self.GRANT_TYPE,
self.SUBJECT_TOKEN,
self.SUBJECT_TOKEN_TYPE,
self.RESOURCE,
self.AUDIENCE,
self.SCOPES,
self.REQUESTED_TOKEN_TYPE,
self.ACTOR_TOKEN,
self.ACTOR_TOKEN_TYPE,
self.ADDON_OPTIONS,
self.ADDON_HEADERS,
)
assert excinfo.match(
r"Error code invalid_request: Invalid subject token - https://tools.ietf.org/html/rfc6749"
)
def test_exchange_token_full_success_with_reqbody_auth(self):
"""Test token exchange success with request body client authenticaiton
using full parameters.
"""
client = self.make_client(self.CLIENT_AUTH_REQUEST_BODY)
headers = self.ADDON_HEADERS.copy()
headers["Content-Type"] = "application/x-www-form-urlencoded"
request_data = {
"grant_type": self.GRANT_TYPE,
"resource": self.RESOURCE,
"audience": self.AUDIENCE,
"scope": " ".join(self.SCOPES),
"requested_token_type": self.REQUESTED_TOKEN_TYPE,
"subject_token": self.SUBJECT_TOKEN,
"subject_token_type": self.SUBJECT_TOKEN_TYPE,
"actor_token": self.ACTOR_TOKEN,
"actor_token_type": self.ACTOR_TOKEN_TYPE,
"options": urllib.parse.quote(json.dumps(self.ADDON_OPTIONS)),
"client_id": CLIENT_ID,
"client_secret": CLIENT_SECRET,
}
request = self.make_mock_request(
status=http_client.OK, data=self.SUCCESS_RESPONSE
)
response = client.exchange_token(
request,
self.GRANT_TYPE,
self.SUBJECT_TOKEN,
self.SUBJECT_TOKEN_TYPE,
self.RESOURCE,
self.AUDIENCE,
self.SCOPES,
self.REQUESTED_TOKEN_TYPE,
self.ACTOR_TOKEN,
self.ACTOR_TOKEN_TYPE,
self.ADDON_OPTIONS,
self.ADDON_HEADERS,
)
self.assert_request_kwargs(request.call_args[1], headers, request_data)
assert response == self.SUCCESS_RESPONSE
def test_exchange_token_partial_success_with_reqbody_auth(self):
"""Test token exchange success with request body client authentication
using partial (required only) parameters.
"""
client = self.make_client(self.CLIENT_AUTH_REQUEST_BODY)
headers = {"Content-Type": "application/x-www-form-urlencoded"}
request_data = {
"grant_type": self.GRANT_TYPE,
"audience": self.AUDIENCE,
"requested_token_type": self.REQUESTED_TOKEN_TYPE,
"subject_token": self.SUBJECT_TOKEN,
"subject_token_type": self.SUBJECT_TOKEN_TYPE,
"client_id": CLIENT_ID,
"client_secret": CLIENT_SECRET,
}
request = self.make_mock_request(
status=http_client.OK, data=self.SUCCESS_RESPONSE
)
response = client.exchange_token(
request,
grant_type=self.GRANT_TYPE,
subject_token=self.SUBJECT_TOKEN,
subject_token_type=self.SUBJECT_TOKEN_TYPE,
audience=self.AUDIENCE,
requested_token_type=self.REQUESTED_TOKEN_TYPE,
)
self.assert_request_kwargs(request.call_args[1], headers, request_data)
assert response == self.SUCCESS_RESPONSE
def test_exchange_token_non200_with_reqbody_auth(self):
"""Test token exchange with POST request body client auth responding
with non-200 status.
"""
client = self.make_client(self.CLIENT_AUTH_REQUEST_BODY)
request = self.make_mock_request(
status=http_client.BAD_REQUEST, data=self.ERROR_RESPONSE
)
with pytest.raises(exceptions.OAuthError) as excinfo:
client.exchange_token(
request,
self.GRANT_TYPE,
self.SUBJECT_TOKEN,
self.SUBJECT_TOKEN_TYPE,
self.RESOURCE,
self.AUDIENCE,
self.SCOPES,
self.REQUESTED_TOKEN_TYPE,
self.ACTOR_TOKEN,
self.ACTOR_TOKEN_TYPE,
self.ADDON_OPTIONS,
self.ADDON_HEADERS,
)
assert excinfo.match(
r"Error code invalid_request: Invalid subject token - https://tools.ietf.org/html/rfc6749"
)
def test_refresh_token_success(self):
"""Test refresh token with successful response."""
client = self.make_client(self.CLIENT_AUTH_BASIC)
request = self.make_mock_request(
status=http_client.OK, data=self.SUCCESS_RESPONSE
)
response = client.refresh_token(request, "refreshtoken")
headers = {
"Authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
"Content-Type": "application/x-www-form-urlencoded",
}
request_data = {"grant_type": "refresh_token", "refresh_token": "refreshtoken"}
self.assert_request_kwargs(request.call_args[1], headers, request_data)
assert response == self.SUCCESS_RESPONSE
def test_refresh_token_success_with_refresh(self):
"""Test refresh token with successful response."""
client = self.make_client(self.CLIENT_AUTH_BASIC)
request = self.make_mock_request(
status=http_client.OK, data=self.SUCCESS_RESPONSE_WITH_REFRESH
)
response = client.refresh_token(request, "refreshtoken")
headers = {
"Authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
"Content-Type": "application/x-www-form-urlencoded",
}
request_data = {"grant_type": "refresh_token", "refresh_token": "refreshtoken"}
self.assert_request_kwargs(request.call_args[1], headers, request_data)
assert response == self.SUCCESS_RESPONSE_WITH_REFRESH
def test_refresh_token_failure(self):
"""Test refresh token with failure response."""
client = self.make_client(self.CLIENT_AUTH_BASIC)
request = self.make_mock_request(
status=http_client.BAD_REQUEST, data=self.ERROR_RESPONSE
)
with pytest.raises(exceptions.OAuthError) as excinfo:
client.refresh_token(request, "refreshtoken")
assert excinfo.match(
r"Error code invalid_request: Invalid subject token - https://tools.ietf.org/html/rfc6749"
)
def test__make_request_success(self):
"""Test base method with successful response."""
client = self.make_client(self.CLIENT_AUTH_BASIC)
request = self.make_mock_request(
status=http_client.OK, data=self.SUCCESS_RESPONSE
)
response = client._make_request(request, {"a": "b"}, {"c": "d"})
headers = {
"Authorization": "Basic dXNlcm5hbWU6cGFzc3dvcmQ=",
"Content-Type": "application/x-www-form-urlencoded",
"a": "b",
}
request_data = {"c": "d"}
self.assert_request_kwargs(request.call_args[1], headers, request_data)
assert response == self.SUCCESS_RESPONSE
def test_make_request_failure(self):
"""Test refresh token with failure response."""
client = self.make_client(self.CLIENT_AUTH_BASIC)
request = self.make_mock_request(
status=http_client.BAD_REQUEST, data=self.ERROR_RESPONSE
)
with pytest.raises(exceptions.OAuthError) as excinfo:
client._make_request(request, {"a": "b"}, {"c": "d"})
assert excinfo.match(
r"Error code invalid_request: Invalid subject token - https://tools.ietf.org/html/rfc6749"
)
|