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
|
import time
import pytest
from flask import json
from flask import jsonify
from authlib.common.security import generate_token
from authlib.integrations.flask_oauth2 import ResourceProtector
from authlib.integrations.flask_oauth2 import current_token
from authlib.jose import jwt
from authlib.oauth2.rfc9068 import JWTBearerTokenValidator
from tests.util import read_file_path
from ..models import Token
from ..models import User
from ..models import db
issuer = "https://provider.test/"
resource_server = "resource-server-id"
@pytest.fixture(autouse=True)
def token_validator(jwks):
class MyJWTBearerTokenValidator(JWTBearerTokenValidator):
def get_jwks(self):
return jwks
validator = MyJWTBearerTokenValidator(
issuer=issuer, resource_server=resource_server
)
return validator
@pytest.fixture(autouse=True)
def resource_protector(app, token_validator):
require_oauth = ResourceProtector()
require_oauth.register_token_validator(token_validator)
@app.route("/protected")
@require_oauth()
def protected():
user = db.session.get(User, current_token["sub"])
return jsonify(
id=user.id,
username=user.username,
token=current_token._get_current_object(),
)
@app.route("/protected-by-scope")
@require_oauth("profile")
def protected_by_scope():
user = db.session.get(User, current_token["sub"])
return jsonify(
id=user.id,
username=user.username,
token=current_token._get_current_object(),
)
@app.route("/protected-by-groups")
@require_oauth(groups=["admins"])
def protected_by_groups():
user = db.session.get(User, current_token["sub"])
return jsonify(
id=user.id,
username=user.username,
token=current_token._get_current_object(),
)
@app.route("/protected-by-roles")
@require_oauth(roles=["student"])
def protected_by_roles():
user = db.session.get(User, current_token["sub"])
return jsonify(
id=user.id,
username=user.username,
token=current_token._get_current_object(),
)
@app.route("/protected-by-entitlements")
@require_oauth(entitlements=["captain"])
def protected_by_entitlements():
user = db.session.get(User, current_token["sub"])
return jsonify(
id=user.id,
username=user.username,
token=current_token._get_current_object(),
)
return require_oauth
@pytest.fixture
def jwks():
return read_file_path("jwks_private.json")
@pytest.fixture(autouse=True)
def user(db):
user = User(username="foo")
db.session.add(user)
db.session.commit()
yield user
db.session.delete(user)
@pytest.fixture(autouse=True)
def client(client, db):
client.set_client_metadata(
{
"scope": "profile",
"redirect_uris": ["https://client.test/authorized"],
"response_types": ["code"],
"token_endpoint_auth_method": "client_secret_post",
"grant_types": ["authorization_code"],
}
)
db.session.add(client)
db.session.commit()
return client
def create_access_token_claims(client, user):
now = int(time.time())
expires_in = now + 3600
auth_time = now - 60
return {
"iss": issuer,
"exp": expires_in,
"aud": resource_server,
"sub": user.get_user_id(),
"client_id": client.client_id,
"iat": now,
"jti": generate_token(16),
"auth_time": auth_time,
"scope": client.scope,
"groups": ["admins"],
"roles": ["student"],
"entitlements": ["captain"],
}
@pytest.fixture(autouse=True)
def claims(client, user):
return create_access_token_claims(client, user)
def create_access_token(claims, jwks, alg="RS256", typ="at+jwt"):
access_token = jwt.encode(
{"alg": alg, "typ": typ},
claims,
key=jwks,
check=False,
)
return access_token.decode()
@pytest.fixture
def access_token(claims, jwks):
return create_access_token(claims, jwks)
@pytest.fixture
def token(access_token, user):
token = Token(
user_id=user.user_id,
client_id="resource-server",
token_type="bearer",
access_token=access_token,
scope="profile",
expires_in=3600,
)
db.session.add(token)
db.session.commit()
yield token
db.session.delete(token)
def test_access_resource(test_client, access_token):
headers = {"Authorization": f"Bearer {access_token}"}
rv = test_client.get("/protected", headers=headers)
resp = json.loads(rv.data)
assert resp["username"] == "foo"
def test_missing_authorization(test_client):
rv = test_client.get("/protected")
assert rv.status_code == 401
resp = json.loads(rv.data)
assert resp["error"] == "missing_authorization"
def test_unsupported_token_type(test_client):
headers = {"Authorization": "invalid token"}
rv = test_client.get("/protected", headers=headers)
assert rv.status_code == 401
resp = json.loads(rv.data)
assert resp["error"] == "unsupported_token_type"
def test_invalid_token(test_client):
headers = {"Authorization": "Bearer invalid"}
rv = test_client.get("/protected", headers=headers)
assert rv.status_code == 401
resp = json.loads(rv.data)
assert resp["error"] == "invalid_token"
def test_typ(test_client, access_token, claims, jwks):
"""The resource server MUST verify that the 'typ' header value is 'at+jwt' or
'application/at+jwt' and reject tokens carrying any other value.
"""
headers = {"Authorization": f"Bearer {access_token}"}
rv = test_client.get("/protected", headers=headers)
resp = json.loads(rv.data)
assert resp["username"] == "foo"
access_token = create_access_token(claims, jwks, typ="application/at+jwt")
headers = {"Authorization": f"Bearer {access_token}"}
rv = test_client.get("/protected", headers=headers)
resp = json.loads(rv.data)
assert resp["username"] == "foo"
access_token = create_access_token(claims, jwks, typ="invalid")
headers = {"Authorization": f"Bearer {access_token}"}
rv = test_client.get("/protected", headers=headers)
resp = json.loads(rv.data)
assert resp["error"] == "invalid_token"
def test_missing_required_claims(test_client, client, user, jwks):
required_claims = ["iss", "exp", "aud", "sub", "client_id", "iat", "jti"]
for claim in required_claims:
claims = create_access_token_claims(client, user)
del claims[claim]
access_token = create_access_token(claims, jwks)
headers = {"Authorization": f"Bearer {access_token}"}
rv = test_client.get("/protected", headers=headers)
resp = json.loads(rv.data)
assert resp["error"] == "invalid_token"
def test_invalid_iss(test_client, claims, jwks):
"""The issuer identifier for the authorization server (which is typically obtained
during discovery) MUST exactly match the value of the 'iss' claim.
"""
claims["iss"] = "invalid-issuer"
access_token = create_access_token(claims, jwks)
headers = {"Authorization": f"Bearer {access_token}"}
rv = test_client.get("/protected", headers=headers)
resp = json.loads(rv.data)
assert resp["error"] == "invalid_token"
def test_invalid_aud(test_client, claims, jwks):
"""The resource server MUST validate that the 'aud' claim contains a resource
indicator value corresponding to an identifier the resource server expects for
itself. The JWT access token MUST be rejected if 'aud' does not contain a
resource indicator of the current resource server as a valid audience.
"""
claims["aud"] = "invalid-resource-indicator"
access_token = create_access_token(claims, jwks)
headers = {"Authorization": f"Bearer {access_token}"}
rv = test_client.get("/protected", headers=headers)
resp = json.loads(rv.data)
assert resp["error"] == "invalid_token"
def test_invalid_exp(test_client, claims, jwks):
"""The current time MUST be before the time represented by the 'exp' claim.
Implementers MAY provide for some small leeway, usually no more than a few
minutes, to account for clock skew.
"""
claims["exp"] = time.time() - 1
access_token = create_access_token(claims, jwks)
headers = {"Authorization": f"Bearer {access_token}"}
rv = test_client.get("/protected", headers=headers)
resp = json.loads(rv.data)
assert resp["error"] == "invalid_token"
def test_scope_restriction(test_client, claims, jwks):
"""If an authorization request includes a scope parameter, the corresponding
issued JWT access token SHOULD include a 'scope' claim as defined in Section
4.2 of [RFC8693]. All the individual scope strings in the 'scope' claim MUST
have meaning for the resources indicated in the 'aud' claim. See Section 5 for
more considerations about the relationship between scope strings and resources
indicated by the 'aud' claim.
"""
claims["scope"] = ["invalid-scope"]
access_token = create_access_token(claims, jwks)
headers = {"Authorization": f"Bearer {access_token}"}
rv = test_client.get("/protected", headers=headers)
resp = json.loads(rv.data)
assert resp["username"] == "foo"
rv = test_client.get("/protected-by-scope", headers=headers)
resp = json.loads(rv.data)
assert resp["error"] == "insufficient_scope"
def test_entitlements_restriction(test_client, client, user, jwks):
"""Many authorization servers embed authorization attributes that go beyond the
delegated scenarios described by [RFC7519] in the access tokens they issue.
Typical examples include resource owner memberships in roles and groups that
are relevant to the resource being accessed, entitlements assigned to the
resource owner for the targeted resource that the authorization server knows
about, and so on. An authorization server wanting to include such attributes
in a JWT access token SHOULD use the 'groups', 'roles', and 'entitlements'
attributes of the 'User' resource schema defined by Section 4.1.2 of
[RFC7643]) as claim types.
"""
for claim in ["groups", "roles", "entitlements"]:
claims = create_access_token_claims(client, user)
claims[claim] = ["invalid"]
access_token = create_access_token(claims, jwks)
headers = {"Authorization": f"Bearer {access_token}"}
rv = test_client.get("/protected", headers=headers)
resp = json.loads(rv.data)
assert resp["username"] == "foo"
rv = test_client.get(f"/protected-by-{claim}", headers=headers)
resp = json.loads(rv.data)
assert resp["error"] == "invalid_token"
def test_extra_attributes(test_client, claims, jwks):
"""Authorization servers MAY return arbitrary attributes not defined in any
existing specification, as long as the corresponding claim names are collision
resistant or the access tokens are meant to be used only within a private
subsystem. Please refer to Sections 4.2 and 4.3 of [RFC7519] for details.
"""
claims["email"] = "user@example.org"
access_token = create_access_token(claims, jwks)
headers = {"Authorization": f"Bearer {access_token}"}
rv = test_client.get("/protected", headers=headers)
resp = json.loads(rv.data)
assert resp["token"]["email"] == "user@example.org"
def test_invalid_auth_time(test_client, claims, jwks):
claims["auth_time"] = "invalid-auth-time"
access_token = create_access_token(claims, jwks)
headers = {"Authorization": f"Bearer {access_token}"}
rv = test_client.get("/protected", headers=headers)
resp = json.loads(rv.data)
assert resp["error"] == "invalid_token"
def test_invalid_amr(test_client, claims, jwks):
claims["amr"] = "invalid-amr"
access_token = create_access_token(claims, jwks)
headers = {"Authorization": f"Bearer {access_token}"}
rv = test_client.get("/protected", headers=headers)
resp = json.loads(rv.data)
assert resp["error"] == "invalid_token"
|