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
|
import urllib.parse
import uuid
import pytest
import globus_sdk
from globus_sdk._missing import MISSING
from globus_sdk.scopes import TransferScopes
from globus_sdk.services.auth.flow_managers.native_app import _make_native_app_challenge
from globus_sdk.testing import load_response
CLIENT_ID = "d0f1d9b0-bd81-4108-be74-ea981664453a"
@pytest.fixture
def native_client():
client = globus_sdk.NativeAppAuthClient(client_id=CLIENT_ID)
with client.retry_config.tune(max_retries=0):
yield client
@pytest.fixture
def confidential_client():
client = globus_sdk.ConfidentialAppAuthClient(
client_id=CLIENT_ID, client_secret="SECRET_SECRET_HES_GOT_A_SECRET"
)
with client.retry_config.tune(max_retries=0):
yield client
# build a nearly-diagonal matrix over
#
# domain: str | list[str]
# identities: uuid | str | list[uuid] | list[str] | list[str | uuid]
# policies: uuid | str | list[uuid] | list[str] | list[str | uuid]
# mfa: True | False
# message: str | None
# prompt: Literal["prompt"] | None
#
# The order of these options is consequential.
# They are declared in the same order they tuple-unpack in the parametrized test.
# `None` values, though valid for each parameter, are omitted;
# they will be tested exactly once by a single all-`None` option test.
domain_options = ("example.edu", ["example.edu", "example.org"])
identity_options = (
uuid.UUID(int=0),
"foo-id",
[uuid.UUID(int=0), uuid.UUID(int=1)],
["foo-id", "bar-id"],
["foo-id", uuid.UUID(int=2)],
)
policy_options = (
uuid.UUID(int=3),
"baz-id",
[uuid.UUID(int=3), uuid.UUID(int=4)],
["baz-id", "quux-id"],
["baz-id", uuid.UUID(int=5)],
)
message_options = ("Test message",)
mfa_options = (True, False)
prompt_options = ("login",)
# Seed an all-`None` option test, then use a loop to fill in the rest.
# The number of parameters here must match the test parameters:
_ALL_SESSION_PARAM_COMBINATIONS = [(MISSING,) * 6]
for idx, options in enumerate(
(
domain_options,
identity_options,
policy_options,
mfa_options,
message_options,
prompt_options,
)
):
for option in options:
parameters = [MISSING] * 6
parameters[idx] = option
_ALL_SESSION_PARAM_COMBINATIONS.append(tuple(parameters))
@pytest.mark.parametrize("flow_type", ("native_app", "confidential_app"))
# parametrize over both what is and what *is not* passed as a parameter
@pytest.mark.parametrize(
[
"domain_option",
"identity_option",
"policy_option",
"mfa_option",
"message_option",
"prompt_option",
],
_ALL_SESSION_PARAM_COMBINATIONS,
)
def test_oauth2_get_authorize_url_supports_session_params(
native_client,
confidential_client,
flow_type,
domain_option,
identity_option,
policy_option,
mfa_option,
message_option,
prompt_option,
):
if flow_type == "native_app":
client = native_client
elif flow_type == "confidential_app":
client = confidential_client
else:
raise NotImplementedError
# get the url...
client.oauth2_start_flow(redirect_uri="https://example.com", requested_scopes="foo")
url_res = client.oauth2_get_authorize_url(
session_required_single_domain=domain_option,
session_required_identities=identity_option,
session_required_policies=policy_option,
session_required_mfa=mfa_option,
session_message=message_option,
prompt=prompt_option,
)
# parse the result...
parsed_url = urllib.parse.urlparse(url_res)
parsed_params = urllib.parse.parse_qs(parsed_url.query)
# prepare some helper data...
expected_params_keys = {
"session_required_single_domain" if domain_option else None,
"session_required_identities" if identity_option else None,
"session_required_policies" if policy_option else None,
"session_required_mfa" if mfa_option is not MISSING else None,
"prompt" if prompt_option else None,
}
expected_params_keys.discard(None)
unexpected_query_params = {
"session_required_single_domain",
"session_required_identities",
"session_required_policies",
"session_required_mfa",
"prompt",
} - expected_params_keys
parsed_params_keys = set(parsed_params.keys())
# ...and validate!
assert expected_params_keys <= parsed_params_keys
assert (unexpected_query_params - parsed_params_keys) == unexpected_query_params
if domain_option is not MISSING:
strized_option = (
",".join(str(x) for x in domain_option)
if isinstance(domain_option, list)
else str(domain_option)
)
assert parsed_params["session_required_single_domain"] == [strized_option]
if identity_option is not MISSING:
strized_option = (
",".join(str(x) for x in identity_option)
if isinstance(identity_option, list)
else str(identity_option)
)
assert parsed_params["session_required_identities"] == [strized_option]
if policy_option is not MISSING:
strized_option = (
",".join(str(x) for x in policy_option)
if isinstance(policy_option, list)
else str(policy_option)
)
assert parsed_params["session_required_policies"] == [strized_option]
if mfa_option is not MISSING:
strized_option = "True" if mfa_option else "False"
assert parsed_params["session_required_mfa"] == [strized_option]
if prompt_option is not MISSING:
assert parsed_params["prompt"] == [prompt_option]
def test_oauth2_get_authorize_url_native_defaults(native_client):
flow_manager = globus_sdk.services.auth.GlobusNativeAppFlowManager(
native_client,
TransferScopes.all,
)
native_client.current_oauth2_flow_manager = flow_manager
# get url and validate results
url_res = native_client.oauth2_get_authorize_url()
parsed_url = urllib.parse.urlparse(url_res)
assert f"https://{parsed_url.netloc}/" == native_client.base_url
assert parsed_url.path == "/v2/oauth2/authorize"
parsed_params = urllib.parse.parse_qs(parsed_url.query)
assert parsed_params == {
"client_id": [native_client.client_id],
"redirect_uri": [native_client.base_url + "v2/web/auth-code"],
"scope": [str(TransferScopes.all)],
"state": ["_default"],
"response_type": ["code"],
"code_challenge": [flow_manager.challenge],
"code_challenge_method": ["S256"],
"access_type": ["online"],
}
def test_oauth2_get_authorize_url_native_custom_params(native_client):
# starting flow with custom parameters, should not warn because a scope is specified
flow_manager = globus_sdk.services.auth.GlobusNativeAppFlowManager(
native_client,
requested_scopes="scopes",
redirect_uri="uri",
state="state",
verifier=("a" * 43),
refresh_tokens=True,
)
native_client.current_oauth2_flow_manager = flow_manager
# get url_and validate results
url_res = native_client.oauth2_get_authorize_url()
verifier, remade_challenge = _make_native_app_challenge("a" * 43)
parsed_url = urllib.parse.urlparse(url_res)
assert f"https://{parsed_url.netloc}/" == native_client.base_url
assert parsed_url.path == "/v2/oauth2/authorize"
parsed_params = urllib.parse.parse_qs(parsed_url.query)
assert parsed_params == {
"client_id": [native_client.client_id],
"redirect_uri": ["uri"],
"scope": ["scopes"],
"state": ["state"],
"response_type": ["code"],
"code_challenge": [urllib.parse.quote_plus(remade_challenge)],
"code_challenge_method": ["S256"],
"access_type": ["offline"],
}
def test_oauth2_get_authorize_url_confidential_defaults(confidential_client):
flow_manager = globus_sdk.services.auth.GlobusAuthorizationCodeFlowManager(
confidential_client, "uri", TransferScopes.all
)
confidential_client.current_oauth2_flow_manager = flow_manager
# get url_and validate results
url_res = confidential_client.oauth2_get_authorize_url()
parsed_url = urllib.parse.urlparse(url_res)
assert f"https://{parsed_url.netloc}/" == confidential_client.base_url
assert parsed_url.path == "/v2/oauth2/authorize"
parsed_params = urllib.parse.parse_qs(parsed_url.query)
assert parsed_params == {
"client_id": [confidential_client.client_id],
"redirect_uri": ["uri"],
"scope": [str(TransferScopes.all)],
"state": ["_default"],
"response_type": ["code"],
"access_type": ["online"],
}
def test_oauth2_get_authorize_url_confidential_custom_params(confidential_client):
# starting flow with specified parameters
flow_manager = globus_sdk.services.auth.GlobusAuthorizationCodeFlowManager(
confidential_client,
requested_scopes="scopes",
redirect_uri="uri",
state="state",
refresh_tokens=True,
)
confidential_client.current_oauth2_flow_manager = flow_manager
# get url_and validate results
url_res = confidential_client.oauth2_get_authorize_url()
parsed_url = urllib.parse.urlparse(url_res)
assert f"https://{parsed_url.netloc}/" == confidential_client.base_url
assert parsed_url.path == "/v2/oauth2/authorize"
parsed_params = urllib.parse.parse_qs(parsed_url.query)
assert parsed_params == {
"client_id": [confidential_client.client_id],
"redirect_uri": ["uri"],
"scope": ["scopes"],
"state": ["state"],
"response_type": ["code"],
"access_type": ["offline"],
}
def test_oauth2_exchange_code_for_tokens_native(native_client):
"""
Starts a NativeAppFlowManager, Confirms invalid code raises 401
Further testing cannot be done without user login credentials
"""
load_response(native_client.oauth2_exchange_code_for_tokens, case="invalid_grant")
flow_manager = globus_sdk.services.auth.GlobusNativeAppFlowManager(
native_client, requested_scopes=TransferScopes.all
)
native_client.current_oauth2_flow_manager = flow_manager
with pytest.raises(globus_sdk.AuthAPIError) as excinfo:
native_client.oauth2_exchange_code_for_tokens("invalid_code")
assert excinfo.value.http_status == 401
assert excinfo.value.code is None
def test_oauth2_exchange_code_for_tokens_confidential(confidential_client):
"""
Starts an AuthorizationCodeFlowManager, Confirms bad code raises 401
Further testing cannot be done without user login credentials
"""
load_response(
confidential_client.oauth2_exchange_code_for_tokens, case="invalid_grant"
)
flow_manager = globus_sdk.services.auth.GlobusAuthorizationCodeFlowManager(
confidential_client, "uri", requested_scopes=TransferScopes.all
)
confidential_client.current_oauth2_flow_manager = flow_manager
with pytest.raises(globus_sdk.AuthAPIError) as excinfo:
confidential_client.oauth2_exchange_code_for_tokens("invalid_code")
assert excinfo.value.http_status == 401
assert excinfo.value.code is None
|