-
Notifications
You must be signed in to change notification settings - Fork 3.3k
[v1.x] fix(auth): coerce empty-string optional URL fields to None in OAuthClientMetadata #2405
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
felixweinberger
wants to merge
1
commit into
v1.x
Choose a base branch
from
fweinberger/dcr-empty-url-coerce-v1x
base: v1.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+92
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🟣 This PR correctly adds empty-string coercion for
OAuthClientMetadata, butOAuthMetadataandProtectedResourceMetadatahave the same defect for their optionalAnyHttpUrlfields and are left unprotected. This is a pre-existing gap — the PR does not introduce or modify these classes — but the same Postel's law rationale applies equally to them.Extended reasoning...
What the bug is
The PR adds a
field_validatortoOAuthClientMetadatathat coerces empty strings toNonefor five optionalAnyHttpUrlfields. The same class of defect exists in two sibling models that were not touched by this PR:OAuthMetadata(RFC 8414 Authorization Server Metadata):registration_endpoint,service_documentation,op_policy_uri,op_tos_uri,revocation_endpoint,introspection_endpoint— all declaredAnyHttpUrl | Noneat lines 135, 142–149, with no empty-string validator.ProtectedResourceMetadata(RFC 9728 Protected Resource Metadata):jwks_uri,resource_documentation,resource_policy_uri,resource_tos_uri— all declaredAnyHttpUrl | Noneat lines 164, 169–171, with no empty-string validator.How it manifests
If a non-compliant authorization server or resource server echoes any of these optional URL fields as "" (rather than omitting the key), Pydantic's
AnyHttpUrlvalidator rejects the empty string and raisesValidationError. The entire discovery response is discarded — the same failure mode this PR was authored to fix.Step-by-step proof
"op_tos_uri": "".OAuthMetadata.model_validate(data).""throughAnyHttpUrl— nofield_validatorintercepts it.AnyHttpUrlraisesValidationErrorbecause an empty string is not a valid URL.The same sequence applies to any of the unprotected fields in
ProtectedResourceMetadata.Why existing code does not prevent it
The new validator is defined only on
OAuthClientMetadataand is not inherited byOAuthMetadataorProtectedResourceMetadata(they are not subclasses). Neither of those models defines anyfield_validatorfor their URL fields.Impact
Any MCP client connecting to a non-compliant server that echoes empty-string URL fields in its authorization server metadata or protected resource metadata response will fail OAuth discovery entirely. The behavior is identical to what the PR describes for DCR responses — a valid discovery document is thrown away because of a cosmetic serialization quirk in a single optional field.
How to fix
Add the same
_empty_string_optional_url_to_nonefield_validator(or a shared mixin) toOAuthMetadataandProtectedResourceMetadata, covering all their optionalAnyHttpUrlfields.Pre-existing status
This is a pre-existing issue that predates this PR. The PR neither introduces these models nor adds new call sites for them — it is scoped entirely to DCR response parsing via
OAuthClientMetadata. The gap in coverage is worth addressing as a follow-up given the PR's stated motivation.