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
|
import json
from authlib.common.urls import add_params_to_uri
from authlib.jose import jwt
from authlib.oauth2 import rfc7591
from authlib.oauth2 import rfc9101
from authlib.oauth2.rfc6749.grants import (
AuthorizationCodeGrant as _AuthorizationCodeGrant,
)
from tests.util import read_file_path
from .models import Client
from .models import CodeGrantMixin
from .models import User
from .models import db
from .models import save_authorization_code
from .oauth2_server import TestCase
from .oauth2_server import create_authorization_server
class AuthorizationCodeGrant(CodeGrantMixin, _AuthorizationCodeGrant):
TOKEN_ENDPOINT_AUTH_METHODS = ["client_secret_basic", "client_secret_post", "none"]
def save_authorization_code(self, code, request):
return save_authorization_code(code, request)
class AuthorizationCodeTest(TestCase):
def register_grant(self, server):
server.register_grant(AuthorizationCodeGrant)
def prepare_data(
self,
request_object=None,
support_request=True,
support_request_uri=True,
metadata=None,
client_require_signed_request_object=False,
):
class JWTAuthenticationRequest(rfc9101.JWTAuthenticationRequest):
def resolve_client_public_key(self, client):
return read_file_path("jwk_public.json")
def get_request_object(self, request_uri: str):
return request_object
def get_server_metadata(self):
return metadata
def get_client_require_signed_request_object(self, client):
return client.client_metadata.get(
"require_signed_request_object", False
)
class ClientRegistrationEndpoint(rfc7591.ClientRegistrationEndpoint):
software_statement_alg_values_supported = ["RS256"]
def authenticate_token(self, request):
auth_header = request.headers.get("Authorization")
request.user_id = 1
return auth_header
def resolve_public_key(self, request):
return read_file_path("rsa_public.pem")
def save_client(self, client_info, client_metadata, request):
client = Client(user_id=request.user_id, **client_info)
client.set_client_metadata(client_metadata)
db.session.add(client)
db.session.commit()
return client
def get_server_metadata(self):
return metadata
server = create_authorization_server(self.app)
server.register_extension(
JWTAuthenticationRequest(
support_request=support_request, support_request_uri=support_request_uri
)
)
self.register_grant(server)
server.register_endpoint(
ClientRegistrationEndpoint(
claims_classes=[
rfc7591.ClientMetadataClaims,
rfc9101.ClientMetadataClaims,
]
)
)
self.server = server
user = User(username="foo")
db.session.add(user)
db.session.commit()
@self.app.route("/create_client", methods=["POST"])
def create_client():
return server.create_endpoint_response("client_registration")
client = Client(
user_id=user.id,
client_id="code-client",
client_secret="code-secret",
)
client.set_client_metadata(
{
"redirect_uris": ["https://a.b"],
"scope": "profile address",
"token_endpoint_auth_method": "client_secret_basic",
"response_types": ["code"],
"grant_types": ["authorization_code"],
"jwks": read_file_path("jwks_public.json"),
"require_signed_request_object": client_require_signed_request_object,
}
)
self.authorize_url = "/oauth/authorize"
db.session.add(client)
db.session.commit()
def test_request_parameter_get(self):
"""Pass the authentication payload in a JWT in the request query parameter."""
self.prepare_data()
payload = {"response_type": "code", "client_id": "code-client"}
request_obj = jwt.encode(
{"alg": "RS256"}, payload, read_file_path("jwk_private.json")
)
url = add_params_to_uri(
self.authorize_url, {"client_id": "code-client", "request": request_obj}
)
rv = self.client.get(url)
assert rv.data == b"ok"
def test_request_uri_parameter_get(self):
"""Pass the authentication payload in a JWT in the request_uri query parameter."""
payload = {"response_type": "code", "client_id": "code-client"}
request_obj = jwt.encode(
{"alg": "RS256"}, payload, read_file_path("jwk_private.json")
)
self.prepare_data(request_object=request_obj)
url = add_params_to_uri(
self.authorize_url,
{
"client_id": "code-client",
"request_uri": "https://client.test/request_object",
},
)
rv = self.client.get(url)
assert rv.data == b"ok"
def test_request_and_request_uri_parameters(self):
"""Passing both requests and request_uri parameters should return an error."""
payload = {"response_type": "code", "client_id": "code-client"}
request_obj = jwt.encode(
{"alg": "RS256"}, payload, read_file_path("jwk_private.json")
)
self.prepare_data(request_object=request_obj)
url = add_params_to_uri(
self.authorize_url,
{
"client_id": "code-client",
"request": request_obj,
"request_uri": "https://client.test/request_object",
},
)
rv = self.client.get(url)
params = json.loads(rv.data)
assert params["error"] == "invalid_request"
assert (
params["error_description"]
== "The 'request' and 'request_uri' parameters are mutually exclusive."
)
def test_neither_request_nor_request_uri_parameter(self):
"""Passing parameters in the query string and not in a request object should still work."""
self.prepare_data()
url = add_params_to_uri(
self.authorize_url, {"response_type": "code", "client_id": "code-client"}
)
rv = self.client.get(url)
assert rv.data == b"ok"
def test_server_require_request_object(self):
"""When server metadata 'require_signed_request_object' is true, request objects must be used."""
self.prepare_data(metadata={"require_signed_request_object": True})
url = add_params_to_uri(
self.authorize_url, {"response_type": "code", "client_id": "code-client"}
)
rv = self.client.get(url)
params = json.loads(rv.data)
assert params["error"] == "invalid_request"
assert (
params["error_description"]
== "Authorization requests for this server must use signed request objects."
)
def test_server_require_request_object_alg_none(self):
"""When server metadata 'require_signed_request_object' is true, the JWT alg cannot be none."""
self.prepare_data(metadata={"require_signed_request_object": True})
payload = {"response_type": "code", "client_id": "code-client"}
request_obj = jwt.encode(
{"alg": "none"}, payload, read_file_path("jwk_private.json")
)
url = add_params_to_uri(
self.authorize_url, {"client_id": "code-client", "request": request_obj}
)
rv = self.client.get(url)
params = json.loads(rv.data)
assert params["error"] == "invalid_request"
assert (
params["error_description"]
== "Authorization requests for this server must use signed request objects."
)
def test_client_require_signed_request_object(self):
"""When client metadata 'require_signed_request_object' is true, request objects must be used."""
self.prepare_data(client_require_signed_request_object=True)
url = add_params_to_uri(
self.authorize_url, {"response_type": "code", "client_id": "code-client"}
)
rv = self.client.get(url)
params = json.loads(rv.data)
assert params["error"] == "invalid_request"
assert (
params["error_description"]
== "Authorization requests for this client must use signed request objects."
)
def test_client_require_signed_request_object_alg_none(self):
"""When client metadata 'require_signed_request_object' is true, the JWT alg cannot be none."""
self.prepare_data(client_require_signed_request_object=True)
payload = {"response_type": "code", "client_id": "code-client"}
request_obj = jwt.encode({"alg": "none"}, payload, "")
url = add_params_to_uri(
self.authorize_url, {"client_id": "code-client", "request": request_obj}
)
rv = self.client.get(url)
params = json.loads(rv.data)
assert params["error"] == "invalid_request"
assert (
params["error_description"]
== "Authorization requests for this client must use signed request objects."
)
def test_unsupported_request_parameter(self):
"""Passing the request parameter when unsupported should raise a 'request_not_supported' error."""
self.prepare_data(support_request=False)
payload = {"response_type": "code", "client_id": "code-client"}
request_obj = jwt.encode(
{"alg": "RS256"}, payload, read_file_path("jwk_private.json")
)
url = add_params_to_uri(
self.authorize_url, {"client_id": "code-client", "request": request_obj}
)
rv = self.client.get(url)
params = json.loads(rv.data)
assert params["error"] == "request_not_supported"
assert (
params["error_description"]
== "The authorization server does not support the use of the request parameter."
)
def test_unsupported_request_uri_parameter(self):
"""Passing the request parameter when unsupported should raise a 'request_uri_not_supported' error."""
payload = {"response_type": "code", "client_id": "code-client"}
request_obj = jwt.encode(
{"alg": "RS256"}, payload, read_file_path("jwk_private.json")
)
self.prepare_data(request_object=request_obj, support_request_uri=False)
url = add_params_to_uri(
self.authorize_url,
{
"client_id": "code-client",
"request_uri": "https://client.test/request_object",
},
)
rv = self.client.get(url)
params = json.loads(rv.data)
assert params["error"] == "request_uri_not_supported"
assert (
params["error_description"]
== "The authorization server does not support the use of the request_uri parameter."
)
def test_invalid_request_uri_parameter(self):
"""Invalid request_uri (or unreachable etc.) should raise a invalid_request_uri error."""
self.prepare_data()
url = add_params_to_uri(
self.authorize_url,
{
"client_id": "code-client",
"request_uri": "https://client.test/request_object",
},
)
rv = self.client.get(url)
params = json.loads(rv.data)
assert params["error"] == "invalid_request_uri"
assert (
params["error_description"]
== "The request_uri in the authorization request returns an error or contains invalid data."
)
def test_invalid_request_object(self):
"""Invalid request object should raise a invalid_request_object error."""
self.prepare_data()
url = add_params_to_uri(
self.authorize_url,
{
"client_id": "code-client",
"request": "invalid",
},
)
rv = self.client.get(url)
params = json.loads(rv.data)
assert params["error"] == "invalid_request_object"
assert (
params["error_description"]
== "The request parameter contains an invalid Request Object."
)
def test_missing_client_id(self):
"""The client_id parameter is mandatory."""
self.prepare_data()
payload = {"response_type": "code", "client_id": "code-client"}
request_obj = jwt.encode(
{"alg": "RS256"}, payload, read_file_path("jwk_private.json")
)
url = add_params_to_uri(self.authorize_url, {"request": request_obj})
rv = self.client.get(url)
params = json.loads(rv.data)
assert params["error"] == "invalid_client"
assert params["error_description"] == "Missing 'client_id' parameter."
def test_invalid_client_id(self):
"""The client_id parameter is mandatory."""
self.prepare_data()
payload = {"response_type": "code", "client_id": "invalid"}
request_obj = jwt.encode(
{"alg": "RS256"}, payload, read_file_path("jwk_private.json")
)
url = add_params_to_uri(
self.authorize_url, {"client_id": "invalid", "request": request_obj}
)
rv = self.client.get(url)
params = json.loads(rv.data)
assert params["error"] == "invalid_client"
assert (
params["error_description"] == "The client does not exist on this server."
)
def test_different_client_id(self):
"""The client_id parameter should be the same in the request payload and the request object."""
self.prepare_data()
payload = {"response_type": "code", "client_id": "other-code-client"}
request_obj = jwt.encode(
{"alg": "RS256"}, payload, read_file_path("jwk_private.json")
)
url = add_params_to_uri(
self.authorize_url, {"client_id": "code-client", "request": request_obj}
)
rv = self.client.get(url)
params = json.loads(rv.data)
assert params["error"] == "invalid_request"
assert (
params["error_description"]
== "The 'client_id' claim from the request parameters and the request object claims don't match."
)
def test_request_param_in_request_object(self):
"""The request and request_uri parameters should not be present in the request object."""
self.prepare_data()
payload = {
"response_type": "code",
"client_id": "code-client",
"request_uri": "https://client.test/request_object",
}
request_obj = jwt.encode(
{"alg": "RS256"}, payload, read_file_path("jwk_private.json")
)
url = add_params_to_uri(
self.authorize_url, {"client_id": "code-client", "request": request_obj}
)
rv = self.client.get(url)
params = json.loads(rv.data)
assert params["error"] == "invalid_request"
assert (
params["error_description"]
== "The 'request' and 'request_uri' parameters must not be included in the request object."
)
def test_registration(self):
"""The 'require_signed_request_object' parameter should be available for client registration."""
self.prepare_data()
headers = {"Authorization": "bearer abc"}
# Default case
body = {
"client_name": "Authlib",
}
rv = self.client.post("/create_client", json=body, headers=headers)
resp = json.loads(rv.data)
assert resp["client_name"] == "Authlib"
assert resp["require_signed_request_object"] is False
# Nominal case
body = {
"require_signed_request_object": True,
"client_name": "Authlib",
}
rv = self.client.post("/create_client", json=body, headers=headers)
resp = json.loads(rv.data)
assert resp["client_name"] == "Authlib"
assert resp["require_signed_request_object"] is True
# Error case
body = {
"require_signed_request_object": "invalid",
"client_name": "Authlib",
}
rv = self.client.post("/create_client", json=body, headers=headers)
resp = json.loads(rv.data)
assert resp["error"] == "invalid_client_metadata"
|
