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
|
"""
test_oauthglue.py
~~~~~~~~~~~~~~~~~
Oauth glue tests - oauthglue is a very thin shim between FS and authlib
:copyright: (c) 2022-2024 by J. Christopher Wagner (jwag).
:license: MIT, see LICENSE for more details.
"""
import pytest
import urllib.parse
from urllib.parse import parse_qsl, urlsplit
from flask import redirect
from flask_wtf import CSRFProtect
from flask_security import FsOAuthProvider
from tests.test_utils import (
authenticate,
check_location,
get_csrf_token,
get_form_action,
get_form_input_value,
get_session,
init_app_with_options,
is_authenticated,
logout,
setup_tf_sms,
)
pytestmark = pytest.mark.oauth()
class MockRequestsResponse:
# authlib returns a Requests Response
def __init__(self, contents):
self.contents = contents
def json(self):
return self.contents
class MockProvider:
def __init__(self, name):
self.name = name
self.raise_exception = None
self.identity = "matt@lp.com"
def set_exception(self, raise_exception):
self.raise_exception = raise_exception
def set_identity(self, email):
self.identity = email
def get(self, field, token):
resp = MockRequestsResponse({"email": self.identity})
return resp
def authorize_access_token(self):
if self.raise_exception:
raise self.raise_exception
return "token"
def authorize_redirect(self, uri):
redirect_url = f"/whatever?redirect_uri={uri}"
return redirect(urllib.parse.quote(redirect_url))
class MockOAuth:
def __init__(self):
pass
def register(self, name, **kwargs):
setattr(self, name, MockProvider(name))
@pytest.mark.settings(oauth_enable=True, post_login_view="/post_login")
@pytest.mark.app_settings(wtf_csrf_enabled=True)
def test_github(app, sqlalchemy_datastore, get_message):
CSRFProtect(app)
init_app_with_options(
app, sqlalchemy_datastore, **{"security_args": {"oauth": MockOAuth()}}
)
client = app.test_client()
response = client.get("/login")
github_url = get_form_action(response, 1)
csrf_token = get_form_input_value(response, field_id="github_csrf_token")
# make sure required CSRF
response = client.post(github_url, follow_redirects=False)
assert b"The CSRF token is missing" in response.data
response = client.post(
github_url, data=dict(csrf_token=csrf_token), follow_redirects=False
)
assert "/whatever" in response.location
response = client.get("/login/oauthresponse/github", follow_redirects=False)
assert response.status_code == 302
assert "/post_login" in response.location
# verify logged in
response = client.get("/profile", follow_redirects=False)
assert response.status_code == 200
@pytest.mark.settings(
oauth_enable=True, post_login_view="/post_login", csrf_ignore_unauth_endpoints=True
)
@pytest.mark.app_settings(wtf_csrf_enabled=True, wtf_csrf_check_default=False)
def test_github_nocsrf(app, sqlalchemy_datastore, get_message):
# Test if ignore_unauth_endpoints is true - doesn't require CSRF
CSRFProtect(app)
init_app_with_options(
app, sqlalchemy_datastore, **{"security_args": {"oauth": MockOAuth()}}
)
client = app.test_client()
response = client.get("/login")
github_url = get_form_action(response, 1)
response = client.post(github_url, follow_redirects=False)
assert "/whatever" in response.location
@pytest.mark.settings(oauth_enable=True, post_login_view="/post_login")
def test_outside_register(app, sqlalchemy_datastore, get_message):
def myoauth_fetch_identity(oauth, token):
resp = oauth.myoauth.get("user", token=token)
profile = resp.json()
return "email", profile["email"]
authlib_oauth = MockOAuth()
authlib_oauth.register("myoauth")
init_app_with_options(
app, sqlalchemy_datastore, **{"security_args": {"oauth": authlib_oauth}}
)
# Have to register with Oauthglue.
app.security.oauthglue.register_provider("myoauth", None, myoauth_fetch_identity)
client = app.test_client()
response = client.get("/login")
myoauth_url = get_form_action(response, 2)
response = client.post(myoauth_url, follow_redirects=False)
assert "/whatever" in response.location
response = client.get("/login/oauthresponse/myoauth", follow_redirects=False)
assert response.status_code == 302
assert "/post_login" in response.location
# verify logged in
response = client.get("/profile", follow_redirects=False)
assert response.status_code == 200
@pytest.mark.settings(oauth_enable=True)
def test_bad_api(app, sqlalchemy_datastore, get_message):
init_app_with_options(
app, sqlalchemy_datastore, **{"security_args": {"oauth": MockOAuth()}}
)
client = app.test_client()
response = client.post("/login/oauthstart/foobar")
assert response.status_code == 404
response = client.get("/login/oauthresponse/foobar")
assert response.status_code == 404
from authlib.integrations.base_client.errors import MismatchingStateError
oauth_app = app.security.oauthglue.oauth_app
oauth_app.github.set_exception(MismatchingStateError)
response = client.get("/login/oauthresponse/github", follow_redirects=True)
assert response.status_code == 200
assert (
get_message(
"OAUTH_HANDSHAKE_ERROR",
exerror="mismatching_state",
exdesc="CSRF Warning! State not equal in request and response.",
)
in response.data
)
@pytest.mark.settings(oauth_enable=True)
def test_unknown_user(app, sqlalchemy_datastore, get_message):
init_app_with_options(
app, sqlalchemy_datastore, **{"security_args": {"oauth": MockOAuth()}}
)
client = app.test_client()
oauth_app = app.security.oauthglue.oauth_app
oauth_app.github.set_identity("jwag@lp.com")
response = client.get("/login/oauthresponse/github", follow_redirects=True)
assert get_message("IDENTITY_NOT_REGISTERED", id="jwag@lp.com") in response.data
@pytest.mark.two_factor()
@pytest.mark.settings(oauth_enable=True)
def test_tf(app, sqlalchemy_datastore, get_message):
init_app_with_options(
app, sqlalchemy_datastore, **{"security_args": {"oauth": MockOAuth()}}
)
client = app.test_client()
authenticate(client)
sms_sender = setup_tf_sms(client)
logout(client)
response = client.get("/login?next=/profile")
github_url = get_form_action(response, 1)
response = client.post(github_url, follow_redirects=False)
assert "/whatever" in response.location
redirect_url = urllib.parse.urlsplit(urllib.parse.unquote(response.location))
local_redirect = urllib.parse.parse_qs(redirect_url.query)["redirect_uri"][0]
response = client.get(local_redirect, follow_redirects=True)
sendcode_url = get_form_action(response, 0)
response = client.post(
sendcode_url,
data=dict(code=sms_sender.messages[0].split()[-1]),
follow_redirects=True,
)
assert b"Profile Page" in response.data
@pytest.mark.settings(
oauth_enable=True,
redirect_host="myui.com:8090",
redirect_behavior="spa",
login_error_view="/login-error",
post_oauth_login_view="/post-login",
csrf_ignore_unauth_endpoints=False,
)
@pytest.mark.app_settings(wtf_csrf_enabled=True)
def test_spa(app, sqlalchemy_datastore, get_message):
CSRFProtect(app)
headers = {"Accept": "application/json", "Content-Type": "application/json"}
init_app_with_options(
app, sqlalchemy_datastore, **{"security_args": {"oauth": MockOAuth()}}
)
client = app.test_client()
csrf_token = get_csrf_token(client)
headers["X-CSRF-Token"] = csrf_token
response = client.post("/login/oauthstart/github", headers=headers)
assert "/whatever" in response.location
redirect_url = urllib.parse.urlsplit(urllib.parse.unquote(response.location))
local_redirect = urllib.parse.parse_qs(redirect_url.query)["redirect_uri"][0]
response = client.get(local_redirect, headers=headers)
assert response.status_code == 302
split = urlsplit(response.location)
assert "myui.com:8090" == split.netloc
assert "/post-login" == split.path
qparams = dict(parse_qsl(split.query))
assert qparams["email"] == "matt@lp.com"
# try unknown user - should redirect to login_error_view
oauth_app = app.security.oauthglue.oauth_app
oauth_app.github.set_identity("jwag@lp.com")
response = client.get("/login/oauthresponse/github", follow_redirects=False)
split = urlsplit(response.location)
assert "/login-error" == split.path
qparams = dict(parse_qsl(split.query))
assert (
qparams["error"]
== get_message("IDENTITY_NOT_REGISTERED", id="jwag@lp.com").decode()
)
# try fake oauth exception
from authlib.integrations.base_client.errors import MismatchingStateError
oauth_app.github.set_exception(MismatchingStateError)
response = client.get("/login/oauthresponse/github", follow_redirects=False)
split = urlsplit(response.location)
assert "/login-error" == split.path
qparams = dict(parse_qsl(split.query))
msg = get_message(
"OAUTH_HANDSHAKE_ERROR",
exerror="mismatching_state",
exdesc="CSRF Warning! State not equal in request and response.",
)
assert qparams["error"] == msg.decode()
@pytest.mark.settings(oauth_enable=True, post_login_view="/post-login")
def test_already_auth(app, sqlalchemy_datastore, get_message):
headers = {"Accept": "application/json", "Content-Type": "application/json"}
init_app_with_options(
app, sqlalchemy_datastore, **{"security_args": {"oauth": MockOAuth()}}
)
client = app.test_client()
authenticate(client)
assert is_authenticated(client, get_message)
# json
response = client.post("/login/oauthstart/github", headers=headers)
assert response.status_code == 400
# forms
response = client.post("/login/oauthstart/github", follow_redirects=False)
assert response.status_code == 302
check_location(app, response.location, "/post-login")
@pytest.mark.settings(oauth_enable=True, post_login_view="/post-login")
def test_simple_next(app, sqlalchemy_datastore, get_message):
# For oauth we stash 'next' in the session since we can't really
# send it all around the oauth providers.
init_app_with_options(
app, sqlalchemy_datastore, **{"security_args": {"oauth": MockOAuth()}}
)
client = app.test_client()
response = client.get("/profile", follow_redirects=True)
github_url = get_form_action(response, 1)
response = client.post(github_url, follow_redirects=False)
assert "/whatever" in response.location
session = get_session(response)
assert "fs_oauth_next" in session
response = client.get("/login/oauthresponse/github", follow_redirects=False)
assert response.status_code == 302
assert check_location(app, response.location, "/profile")
session = get_session(response)
assert "fs_oauth_next" not in session
@pytest.mark.settings(oauth_enable=True, post_login_view="/post_login")
def test_provider_class(app, sqlalchemy_datastore, get_message):
from authlib.integrations.base_client.errors import MismatchingStateError
class MyOauthProvider(FsOAuthProvider):
def fetch_identity_cb(self, oauth, token):
resp = oauth.myoauth.get("user", token=token)
profile = resp.json()
return "email", profile["email"]
def oauth_response_failure(self, e):
return redirect("/uh-oh")
init_app_with_options(
app, sqlalchemy_datastore, **{"security_args": {"oauth": MockOAuth()}}
)
# Have to register with Oauthglue.
app.security.oauthglue.register_provider_ext(MyOauthProvider("myoauth"))
client = app.test_client()
response = client.get("/login")
myoauth_url = get_form_action(response, 2)
response = client.post(myoauth_url, follow_redirects=False)
assert "/whatever" in response.location
# test error - and that our handler is called
oauth_app = app.security.oauthglue.oauth_app
oauth_app.myoauth.set_exception(MismatchingStateError)
response = client.get("/login/oauthresponse/myoauth", follow_redirects=False)
assert response.status_code == 302
assert check_location(app, response.location, "/uh-oh")
# now log in successfully
oauth_app.myoauth.set_exception(None)
response = client.get("/login/oauthresponse/myoauth", follow_redirects=False)
assert response.status_code == 302
assert check_location(app, response.location, "/post_login")
assert is_authenticated(client, get_message)
|