forked from modelcontextprotocol/python-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathauth.py
More file actions
854 lines (700 loc) · 35 KB
/
Copy pathauth.py
File metadata and controls
854 lines (700 loc) · 35 KB
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
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
"""
OAuth2 Authentication implementation for HTTPX.
Implements authorization code flow with PKCE and automatic token refresh.
"""
import base64
import hashlib
import logging
import re
import secrets
import string
import time
from collections.abc import AsyncGenerator, Awaitable, Callable
from dataclasses import dataclass, field
from typing import Protocol
from urllib.parse import urlencode, urljoin, urlparse
import anyio
import httpx
from pydantic import BaseModel, Field, ValidationError
from mcp.client.streamable_http import MCP_PROTOCOL_VERSION
from mcp.shared.auth import (
OAuthClientInformationFull,
OAuthClientMetadata,
OAuthMetadata,
OAuthToken,
ProtectedResourceMetadata,
)
from mcp.shared.auth_utils import check_resource_allowed, resource_url_from_server_url
from mcp.types import LATEST_PROTOCOL_VERSION
logger = logging.getLogger(__name__)
class OAuthFlowError(Exception):
"""Base exception for OAuth flow errors."""
class OAuthTokenError(OAuthFlowError):
"""Raised when token operations fail."""
class OAuthRegistrationError(OAuthFlowError):
"""Raised when client registration fails."""
class PKCEParameters(BaseModel):
"""PKCE (Proof Key for Code Exchange) parameters."""
code_verifier: str = Field(..., min_length=43, max_length=128)
code_challenge: str = Field(..., min_length=43, max_length=128)
@classmethod
def generate(cls) -> "PKCEParameters":
"""Generate new PKCE parameters."""
code_verifier = "".join(secrets.choice(string.ascii_letters + string.digits + "-._~") for _ in range(128))
digest = hashlib.sha256(code_verifier.encode()).digest()
code_challenge = base64.urlsafe_b64encode(digest).decode().rstrip("=")
return cls(code_verifier=code_verifier, code_challenge=code_challenge)
class TokenStorage(Protocol):
"""Protocol for token storage implementations."""
async def get_tokens(self) -> OAuthToken | None:
"""Get stored tokens."""
...
async def set_tokens(self, tokens: OAuthToken) -> None:
"""Store tokens."""
...
async def get_client_info(self) -> OAuthClientInformationFull | None:
"""Get stored client information."""
...
async def set_client_info(self, client_info: OAuthClientInformationFull) -> None:
"""Store client information."""
...
@dataclass
class OAuthContext:
"""OAuth flow context."""
server_url: str
client_metadata: OAuthClientMetadata
storage: TokenStorage
redirect_handler: Callable[[str], Awaitable[None]]
callback_handler: Callable[[], Awaitable[tuple[str, str | None]]]
timeout: float = 300.0
# Discovered metadata
protected_resource_metadata: ProtectedResourceMetadata | None = None
oauth_metadata: OAuthMetadata | None = None
auth_server_url: str | None = None
protocol_version: str | None = None
# Client registration
client_info: OAuthClientInformationFull | None = None
# Token management
current_tokens: OAuthToken | None = None
token_expiry_time: float | None = None
# State
lock: anyio.Lock = field(default_factory=anyio.Lock)
# Discovery state for fallback support
discovery_base_url: str | None = None
discovery_pathname: str | None = None
def get_authorization_base_url(self, server_url: str) -> str:
"""Extract base URL by removing path component."""
parsed = urlparse(server_url)
return f"{parsed.scheme}://{parsed.netloc}"
def update_token_expiry(self, token: OAuthToken) -> None:
"""Update token expiry time."""
if token.expires_in:
self.token_expiry_time = time.time() + token.expires_in
else:
self.token_expiry_time = None
def is_token_valid(self) -> bool:
"""Check if the current token is valid."""
return bool(
self.current_tokens
and self.current_tokens.access_token
and (not self.token_expiry_time or time.time() <= self.token_expiry_time)
)
def can_refresh_token(self) -> bool:
"""Check if the token can be refreshed."""
return bool(self.current_tokens and self.current_tokens.refresh_token and self.client_info)
def clear_tokens(self) -> None:
"""Clear current tokens."""
self.current_tokens = None
self.token_expiry_time = None
def get_resource_url(self) -> str:
"""Get resource URL for RFC 8707.
Uses PRM resource if it's a valid parent, otherwise uses canonical server URL.
"""
resource = resource_url_from_server_url(self.server_url)
# If PRM provides a resource that's a valid parent, use it
if self.protected_resource_metadata and self.protected_resource_metadata.resource:
prm_resource = str(self.protected_resource_metadata.resource)
if check_resource_allowed(requested_resource=resource, configured_resource=prm_resource):
resource = prm_resource
return resource
def should_include_resource_param(self, protocol_version: str | None = None) -> bool:
"""Determine if the resource parameter should be included in OAuth requests.
Returns True if:
- Protected resource metadata is available, OR
- MCP-Protocol-Version header is 2025-06-18 or later
"""
# If we have protected resource metadata, include the resource param
if self.protected_resource_metadata is not None:
return True
# If no protocol version provided, don't include resource param
if not protocol_version:
return False
# Check if protocol version is 2025-06-18 or later
# Version format is YYYY-MM-DD, so string comparison works
return protocol_version >= "2025-06-18"
class BaseOAuthProvider(httpx.Auth):
"""Common OAuth utilities for discovery, registration, and client auth."""
requires_response_body = True
def __init__(
self,
server_url: str,
client_metadata: OAuthClientMetadata,
storage: TokenStorage,
timeout: float = 300.0,
) -> None:
self.server_url = server_url
self.client_metadata = client_metadata
self.storage = storage
self.timeout = timeout
self._metadata: OAuthMetadata | None = None
self._client_info: OAuthClientInformationFull | None = None
def _get_authorization_base_url(self, url: str) -> str:
parsed = urlparse(url)
return f"{parsed.scheme}://{parsed.netloc}"
def _get_discovery_urls(self, server_url: str | None = None) -> list[str]:
url = server_url or self.server_url
parsed = urlparse(url)
base_url = f"{parsed.scheme}://{parsed.netloc}"
urls: list[str] = []
if parsed.path and parsed.path != "/":
oauth_path = f"/.well-known/oauth-authorization-server{parsed.path.rstrip('/')}"
urls.append(urljoin(base_url, oauth_path))
urls.append(urljoin(base_url, "/.well-known/oauth-authorization-server"))
if parsed.path and parsed.path != "/":
oidc_path = f"/.well-known/openid-configuration{parsed.path.rstrip('/')}"
urls.append(urljoin(base_url, oidc_path))
urls.append(f"{url.rstrip('/')}/.well-known/openid-configuration")
return urls
def _create_oauth_metadata_request(self, url: str) -> httpx.Request:
return httpx.Request("GET", url, headers={MCP_PROTOCOL_VERSION: LATEST_PROTOCOL_VERSION})
async def _handle_oauth_metadata_response(self, response: httpx.Response) -> None:
content = await response.aread()
metadata = OAuthMetadata.model_validate_json(content)
self._metadata = metadata
if self.client_metadata.scope is None and metadata.scopes_supported is not None:
self.client_metadata.scope = " ".join(metadata.scopes_supported)
def _create_registration_request(self, metadata: OAuthMetadata | None = None) -> httpx.Request | None:
if self._client_info:
return None
if metadata and metadata.registration_endpoint:
registration_url = str(metadata.registration_endpoint)
else:
auth_base_url = self._get_authorization_base_url(self.server_url)
registration_url = urljoin(auth_base_url, "/register")
registration_data = self.client_metadata.model_dump(by_alias=True, mode="json", exclude_none=True)
return httpx.Request(
"POST",
registration_url,
json=registration_data,
headers={"Content-Type": "application/json"},
)
async def _handle_registration_response(self, response: httpx.Response) -> None:
if response.status_code not in (200, 201):
await response.aread()
raise OAuthRegistrationError(f"Registration failed: {response.status_code} {response.text}")
content = await response.aread()
client_info = OAuthClientInformationFull.model_validate_json(content)
self._client_info = client_info
await self.storage.set_client_info(client_info)
def _apply_client_auth(
self,
token_data: dict[str, str],
headers: dict[str, str],
client_info: OAuthClientInformationFull,
) -> None:
auth_method = "client_secret_post"
if self._metadata and self._metadata.token_endpoint_auth_methods_supported:
supported = self._metadata.token_endpoint_auth_methods_supported
if "client_secret_basic" in supported:
auth_method = "client_secret_basic"
elif "client_secret_post" in supported:
auth_method = "client_secret_post"
if auth_method == "client_secret_basic":
if client_info.client_secret is None:
raise OAuthFlowError("Client secret required for client_secret_basic")
credential = f"{client_info.client_id}:{client_info.client_secret}"
headers["Authorization"] = f"Basic {base64.b64encode(credential.encode()).decode()}"
else:
token_data["client_id"] = client_info.client_id
if client_info.client_secret:
token_data["client_secret"] = client_info.client_secret
class OAuthClientProvider(BaseOAuthProvider):
"""
OAuth2 authentication for httpx.
Handles OAuth flow with automatic client registration and token storage.
"""
requires_response_body = True
def __init__(
self,
server_url: str,
client_metadata: OAuthClientMetadata,
storage: TokenStorage,
redirect_handler: Callable[[str], Awaitable[None]],
callback_handler: Callable[[], Awaitable[tuple[str, str | None]]],
timeout: float = 300.0,
):
"""Initialize OAuth2 authentication."""
super().__init__(server_url, client_metadata, storage, timeout)
self.context = OAuthContext(
server_url=server_url,
client_metadata=client_metadata,
storage=storage,
redirect_handler=redirect_handler,
callback_handler=callback_handler,
timeout=timeout,
)
self._initialized = False
def _extract_resource_metadata_from_www_auth(self, init_response: httpx.Response) -> str | None:
"""
Extract protected resource metadata URL from WWW-Authenticate header as per RFC9728.
Returns:
Resource metadata URL if found in WWW-Authenticate header, None otherwise
"""
if not init_response or init_response.status_code != 401:
return None
www_auth_header = init_response.headers.get("WWW-Authenticate")
if not www_auth_header:
return None
# Pattern matches: resource_metadata="url" or resource_metadata=url (unquoted)
pattern = r'resource_metadata=(?:"([^"]+)"|([^\s,]+))'
match = re.search(pattern, www_auth_header)
if match:
# Return quoted value if present, otherwise unquoted value
return match.group(1) or match.group(2)
return None
async def _discover_protected_resource(self, init_response: httpx.Response) -> httpx.Request:
# RFC9728: Try to extract resource_metadata URL from WWW-Authenticate header of the initial response
url = self._extract_resource_metadata_from_www_auth(init_response)
if not url:
# Fallback to well-known discovery
auth_base_url = self.context.get_authorization_base_url(self.context.server_url)
url = urljoin(auth_base_url, "/.well-known/oauth-protected-resource")
return httpx.Request("GET", url, headers={MCP_PROTOCOL_VERSION: LATEST_PROTOCOL_VERSION})
async def _handle_protected_resource_response(self, response: httpx.Response) -> None:
"""Handle discovery response."""
if response.status_code == 200:
try:
content = await response.aread()
metadata = ProtectedResourceMetadata.model_validate_json(content)
self.context.protected_resource_metadata = metadata
if metadata.authorization_servers:
self.context.auth_server_url = str(metadata.authorization_servers[0])
except ValidationError:
pass
# Discovery and registration helpers provided by BaseOAuthProvider
async def _perform_authorization(self) -> tuple[str, str]:
"""Perform the authorization redirect and get auth code."""
if self.context.oauth_metadata and self.context.oauth_metadata.authorization_endpoint:
auth_endpoint = str(self.context.oauth_metadata.authorization_endpoint)
else:
auth_base_url = self.context.get_authorization_base_url(self.context.server_url)
auth_endpoint = urljoin(auth_base_url, "/authorize")
if not self.context.client_info:
raise OAuthFlowError("No client info available for authorization")
# Generate PKCE parameters
pkce_params = PKCEParameters.generate()
state = secrets.token_urlsafe(32)
auth_params = {
"response_type": "code",
"client_id": self.context.client_info.client_id,
"redirect_uri": str(self.context.client_metadata.redirect_uris[0]),
"state": state,
"code_challenge": pkce_params.code_challenge,
"code_challenge_method": "S256",
}
# Only include resource param if conditions are met
if self.context.should_include_resource_param(self.context.protocol_version):
auth_params["resource"] = self.context.get_resource_url() # RFC 8707
if self.context.client_metadata.scope:
auth_params["scope"] = self.context.client_metadata.scope
authorization_url = f"{auth_endpoint}?{urlencode(auth_params)}"
await self.context.redirect_handler(authorization_url)
# Wait for callback
auth_code, returned_state = await self.context.callback_handler()
if returned_state is None or not secrets.compare_digest(returned_state, state):
raise OAuthFlowError(f"State parameter mismatch: {returned_state} != {state}")
if not auth_code:
raise OAuthFlowError("No authorization code received")
# Return auth code and code verifier for token exchange
return auth_code, pkce_params.code_verifier
async def _exchange_token(self, auth_code: str, code_verifier: str) -> httpx.Request:
"""Build token exchange request."""
if not self.context.client_info:
raise OAuthFlowError("Missing client info")
if self.context.oauth_metadata and self.context.oauth_metadata.token_endpoint:
token_url = str(self.context.oauth_metadata.token_endpoint)
else:
auth_base_url = self.context.get_authorization_base_url(self.context.server_url)
token_url = urljoin(auth_base_url, "/token")
token_data = {
"grant_type": "authorization_code",
"code": auth_code,
"redirect_uri": str(self.context.client_metadata.redirect_uris[0]),
"code_verifier": code_verifier,
}
# Only include resource param if conditions are met
if self.context.should_include_resource_param(self.context.protocol_version):
token_data["resource"] = self.context.get_resource_url() # RFC 8707
headers = {"Content-Type": "application/x-www-form-urlencoded"}
self._apply_client_auth(token_data, headers, self.context.client_info)
return httpx.Request("POST", token_url, data=token_data, headers=headers)
async def _handle_token_response(self, response: httpx.Response) -> None:
"""Handle token exchange response."""
if response.status_code != 200:
raise OAuthTokenError(f"Token exchange failed: {response.status_code}")
try:
content = await response.aread()
token_response = OAuthToken.model_validate_json(content)
# Validate scopes
if token_response.scope and self.context.client_metadata.scope:
requested_scopes = set(self.context.client_metadata.scope.split())
returned_scopes = set(token_response.scope.split())
unauthorized_scopes = returned_scopes - requested_scopes
if unauthorized_scopes:
raise OAuthTokenError(f"Server granted unauthorized scopes: {unauthorized_scopes}")
self.context.current_tokens = token_response
self.context.update_token_expiry(token_response)
await self.context.storage.set_tokens(token_response)
except ValidationError as e:
raise OAuthTokenError(f"Invalid token response: {e}")
async def _refresh_token(self) -> httpx.Request:
"""Build token refresh request."""
if not self.context.current_tokens or not self.context.current_tokens.refresh_token:
raise OAuthTokenError("No refresh token available")
if not self.context.client_info:
raise OAuthTokenError("No client info available")
if self.context.oauth_metadata and self.context.oauth_metadata.token_endpoint:
token_url = str(self.context.oauth_metadata.token_endpoint)
else:
auth_base_url = self.context.get_authorization_base_url(self.context.server_url)
token_url = urljoin(auth_base_url, "/token")
refresh_data = {
"grant_type": "refresh_token",
"refresh_token": self.context.current_tokens.refresh_token,
}
# Only include resource param if conditions are met
if self.context.should_include_resource_param(self.context.protocol_version):
refresh_data["resource"] = self.context.get_resource_url() # RFC 8707
headers = {"Content-Type": "application/x-www-form-urlencoded"}
self._apply_client_auth(refresh_data, headers, self.context.client_info)
return httpx.Request("POST", token_url, data=refresh_data, headers=headers)
async def _handle_refresh_response(self, response: httpx.Response) -> bool:
"""Handle token refresh response. Returns True if successful."""
if response.status_code != 200:
logger.warning(f"Token refresh failed: {response.status_code}")
self.context.clear_tokens()
return False
try:
content = await response.aread()
token_response = OAuthToken.model_validate_json(content)
self.context.current_tokens = token_response
self.context.update_token_expiry(token_response)
await self.context.storage.set_tokens(token_response)
return True
except ValidationError:
logger.exception("Invalid refresh response")
self.context.clear_tokens()
return False
async def _initialize(self) -> None:
"""Load stored tokens and client info."""
self.context.current_tokens = await self.context.storage.get_tokens()
self.context.client_info = await self.context.storage.get_client_info()
self._initialized = True
def _add_auth_header(self, request: httpx.Request) -> None:
"""Add authorization header to request if we have valid tokens."""
if self.context.current_tokens and self.context.current_tokens.access_token:
request.headers["Authorization"] = f"Bearer {self.context.current_tokens.access_token}"
async def async_auth_flow(self, request: httpx.Request) -> AsyncGenerator[httpx.Request, httpx.Response]:
"""HTTPX auth flow integration."""
async with self.context.lock:
if not self._initialized:
await self._initialize()
# Capture protocol version from request headers
self.context.protocol_version = request.headers.get(MCP_PROTOCOL_VERSION)
if not self.context.is_token_valid() and self.context.can_refresh_token():
# Try to refresh token
refresh_request = await self._refresh_token()
refresh_response = yield refresh_request
if not await self._handle_refresh_response(refresh_response):
# Refresh failed, need full re-authentication
self._initialized = False
if self.context.is_token_valid():
self._add_auth_header(request)
response = yield request
if response.status_code == 401:
# Perform full OAuth flow
try:
# OAuth flow must be inline due to generator constraints
# Step 1: Discover protected resource metadata (RFC9728 with WWW-Authenticate support)
discovery_request = await self._discover_protected_resource(response)
discovery_response = yield discovery_request
await self._handle_protected_resource_response(discovery_response)
# Step 2: Discover OAuth metadata (with fallback for legacy servers)
discovery_urls = self._get_discovery_urls(self.context.auth_server_url or self.context.server_url)
for url in discovery_urls:
oauth_metadata_request = self._create_oauth_metadata_request(url)
oauth_metadata_response = yield oauth_metadata_request
if oauth_metadata_response.status_code == 200:
try:
await self._handle_oauth_metadata_response(oauth_metadata_response)
self.context.oauth_metadata = self._metadata
break
except ValidationError:
continue
elif oauth_metadata_response.status_code < 400 or oauth_metadata_response.status_code >= 500:
break # Non-4XX error, stop trying
# Step 3: Register client if needed
registration_request = self._create_registration_request(self._metadata)
if registration_request:
registration_response = yield registration_request
await self._handle_registration_response(registration_response)
self.context.client_info = self._client_info
# Step 4: Perform authorization
auth_code, code_verifier = await self._perform_authorization()
# Step 5: Exchange authorization code for tokens
token_request = await self._exchange_token(auth_code, code_verifier)
token_response = yield token_request
await self._handle_token_response(token_response)
except Exception:
logger.exception("OAuth flow error")
raise
# Retry with new tokens
self._add_auth_header(request)
yield request
class ClientCredentialsProvider(BaseOAuthProvider):
"""HTTPX auth using the OAuth2 client credentials grant."""
def __init__(
self,
server_url: str,
client_metadata: OAuthClientMetadata,
storage: TokenStorage,
resource: str | None = None,
timeout: float = 300.0,
) -> None:
super().__init__(server_url, client_metadata, storage, timeout)
self.resource = resource or resource_url_from_server_url(server_url)
self._current_tokens: OAuthToken | None = None
self._token_expiry_time: float | None = None
self._token_lock = anyio.Lock()
def _has_valid_token(self) -> bool:
if not self._current_tokens or not self._current_tokens.access_token:
return False
if self._token_expiry_time and time.time() > self._token_expiry_time:
return False
return True
async def _validate_token_scopes(self, token_response: OAuthToken) -> None:
if not token_response.scope:
return
requested_scopes: set[str] = set()
if self.client_metadata.scope:
requested_scopes = set(self.client_metadata.scope.split())
returned_scopes = set(token_response.scope.split())
unauthorized_scopes = returned_scopes - requested_scopes
if unauthorized_scopes:
raise Exception(f"Server granted unauthorized scopes: {unauthorized_scopes}.")
else:
granted = set(token_response.scope.split())
logger.debug(
"No explicit scopes requested, accepting server-granted scopes: %s",
granted,
)
async def initialize(self) -> None:
self._current_tokens = await self.storage.get_tokens()
self._client_info = await self.storage.get_client_info()
async def _get_or_register_client(self) -> OAuthClientInformationFull:
if not self._client_info:
request = self._create_registration_request(self._metadata)
if request:
async with httpx.AsyncClient(timeout=self.timeout) as client:
response: httpx.Response = await client.send(request)
await self._handle_registration_response(response)
assert self._client_info
return self._client_info
async def _request_token(self) -> None:
if not self._metadata:
discovery_urls = self._get_discovery_urls(self.server_url)
async with httpx.AsyncClient(timeout=self.timeout) as client:
for url in discovery_urls:
req = self._create_oauth_metadata_request(url)
resp: httpx.Response = await client.send(req)
if resp.status_code == 200:
try:
await self._handle_oauth_metadata_response(resp)
break
except ValidationError:
continue
elif resp.status_code < 400 or resp.status_code >= 500:
break
client_info = await self._get_or_register_client()
if self._metadata and self._metadata.token_endpoint:
token_url = str(self._metadata.token_endpoint)
else:
auth_base_url = self._get_authorization_base_url(self.server_url)
token_url = urljoin(auth_base_url, "/token")
token_data: dict[str, str] = {
"grant_type": "client_credentials",
"resource": self.resource,
}
if self.client_metadata.scope:
token_data["scope"] = self.client_metadata.scope
headers = {"Content-Type": "application/x-www-form-urlencoded"}
self._apply_client_auth(token_data, headers, client_info)
async with httpx.AsyncClient(timeout=self.timeout) as client:
response: httpx.Response = await client.post(
token_url,
data=token_data,
headers=headers,
)
if response.status_code != 200:
raise Exception(f"Token request failed: {response.status_code} {response.text}")
token_response = OAuthToken.model_validate(response.json())
await self._validate_token_scopes(token_response)
if token_response.expires_in:
self._token_expiry_time = time.time() + token_response.expires_in
else:
self._token_expiry_time = None
await self.storage.set_tokens(token_response)
self._current_tokens = token_response
async def ensure_token(self) -> None:
async with self._token_lock:
if self._has_valid_token():
return
await self._request_token()
async def async_auth_flow(self, request: httpx.Request) -> AsyncGenerator[httpx.Request, httpx.Response]:
if not self._has_valid_token():
await self.initialize()
await self.ensure_token()
if self._current_tokens and self._current_tokens.access_token:
request.headers["Authorization"] = f"Bearer {self._current_tokens.access_token}"
response = yield request
if response.status_code == 401:
self._current_tokens = None
class TokenExchangeProvider(BaseOAuthProvider):
"""OAuth2 token exchange based on RFC 8693."""
def __init__(
self,
server_url: str,
client_metadata: OAuthClientMetadata,
storage: TokenStorage,
subject_token_supplier: Callable[[], Awaitable[str]],
subject_token_type: str = "access_token",
actor_token_supplier: Callable[[], Awaitable[str]] | None = None,
actor_token_type: str | None = None,
audience: str | None = None,
resource: str | None = None,
timeout: float = 300.0,
) -> None:
super().__init__(server_url, client_metadata, storage, timeout)
self.subject_token_supplier = subject_token_supplier
self.subject_token_type = subject_token_type
self.actor_token_supplier = actor_token_supplier
self.actor_token_type = actor_token_type
self.audience = audience
self.resource = resource or resource_url_from_server_url(server_url)
self._current_tokens: OAuthToken | None = None
self._token_expiry_time: float | None = None
self._token_lock = anyio.Lock()
def _has_valid_token(self) -> bool:
if not self._current_tokens or not self._current_tokens.access_token:
return False
if self._token_expiry_time and time.time() > self._token_expiry_time:
return False
return True
async def _validate_token_scopes(self, token_response: OAuthToken) -> None:
if not token_response.scope:
return
requested_scopes: set[str] = set()
if self.client_metadata.scope:
requested_scopes = set(self.client_metadata.scope.split())
returned_scopes = set(token_response.scope.split())
unauthorized_scopes = returned_scopes - requested_scopes
if unauthorized_scopes:
raise Exception(f"Server granted unauthorized scopes: {unauthorized_scopes}.")
else:
granted = set(token_response.scope.split())
logger.debug(
"No explicit scopes requested, accepting server-granted scopes: %s",
granted,
)
async def initialize(self) -> None:
self._current_tokens = await self.storage.get_tokens()
self._client_info = await self.storage.get_client_info()
async def _get_or_register_client(self) -> OAuthClientInformationFull:
if not self._client_info:
request = self._create_registration_request(self._metadata)
if request:
async with httpx.AsyncClient(timeout=self.timeout) as client:
response: httpx.Response = await client.send(request)
await self._handle_registration_response(response)
assert self._client_info
return self._client_info
async def _request_token(self) -> None:
if not self._metadata:
discovery_urls = self._get_discovery_urls(self.server_url)
async with httpx.AsyncClient(timeout=self.timeout) as client:
for url in discovery_urls:
req = self._create_oauth_metadata_request(url)
resp: httpx.Response = await client.send(req)
if resp.status_code == 200:
try:
await self._handle_oauth_metadata_response(resp)
break
except ValidationError:
continue
elif resp.status_code < 400 or resp.status_code >= 500:
break
client_info = await self._get_or_register_client()
if self._metadata and self._metadata.token_endpoint:
token_url = str(self._metadata.token_endpoint)
else:
auth_base_url = self._get_authorization_base_url(self.server_url)
token_url = urljoin(auth_base_url, "/token")
subject_token = await self.subject_token_supplier()
actor_token = await self.actor_token_supplier() if self.actor_token_supplier else None
token_data: dict[str, str] = {
"grant_type": "token_exchange",
"subject_token": subject_token,
"subject_token_type": self.subject_token_type,
}
if actor_token:
token_data["actor_token"] = actor_token
if self.actor_token_type:
token_data["actor_token_type"] = self.actor_token_type
if self.audience:
token_data["audience"] = self.audience
if self.resource:
token_data["resource"] = self.resource
if self.client_metadata.scope:
token_data["scope"] = self.client_metadata.scope
headers = {"Content-Type": "application/x-www-form-urlencoded"}
self._apply_client_auth(token_data, headers, client_info)
async with httpx.AsyncClient(timeout=self.timeout) as client:
response: httpx.Response = await client.post(
token_url,
data=token_data,
headers=headers,
)
if response.status_code != 200:
raise Exception(f"Token request failed: {response.status_code} {response.text}")
token_response = OAuthToken.model_validate(response.json())
await self._validate_token_scopes(token_response)
if token_response.expires_in:
self._token_expiry_time = time.time() + token_response.expires_in
else:
self._token_expiry_time = None
await self.storage.set_tokens(token_response)
self._current_tokens = token_response
async def ensure_token(self) -> None:
async with self._token_lock:
if self._has_valid_token():
return
await self._request_token()
async def async_auth_flow(self, request: httpx.Request) -> AsyncGenerator[httpx.Request, httpx.Response]:
if not self._has_valid_token():
await self.initialize()
await self.ensure_token()
if self._current_tokens and self._current_tokens.access_token:
request.headers["Authorization"] = f"Bearer {self._current_tokens.access_token}"
response = yield request
if response.status_code == 401:
self._current_tokens = None