Skip to content

fix(server): validate push-notification URLs at config creation - #1173

Open
SashaMIT wants to merge 4 commits into
a2aproject:mainfrom
SashaMIT:fix/push-notification-config-url-validation
Open

fix(server): validate push-notification URLs at config creation#1173
SashaMIT wants to merge 4 commits into
a2aproject:mainfrom
SashaMIT:fix/push-notification-config-url-validation

Conversation

@SashaMIT

@SashaMIT SashaMIT commented Aug 9, 2026

Copy link
Copy Markdown

Summary

The on_create_task_push_notification_config handlers (v1 and v2) stored client-supplied URLs without any validation. A caller who can create a push notification config can point the server at loopback, private-network, link-local, or cloud-metadata hosts, and the server will POST task events to that URL on every state change.

Root cause

src/a2a/server/request_handlers/default_request_handler.py and default_request_handler_v2.py call push_config_store.set_info(task_id, params, context) without checking params.url. The dispatch path (BasePushNotificationSender._dispatch_notification) is covered by #1164; this PR closes the write path.

Fix

  • Added push_url_validation_error to base_push_notification_sender.py (same logic as fix(server): validate push-notification URLs before dispatch (SSRF hardening) #1164: blocks non-http(s) schemes, loopback, private, link-local, multicast, reserved, and unresolvable hosts).
  • Called it in both on_create_task_push_notification_config handlers before storing the config.
  • Raises InvalidParamsError with a descriptive message on rejection.

Testing

  • uv run pytest tests/server/request_handlers/ -k push_notification — 55 passed.
  • New test: test_on_create_task_push_notification_config_rejects_invalid_url covers loopback and file: scheme rejection.
  • Updated existing tests that used unresolvable fixture URLs (1.example.com, callback.com) to use example.com (resolvable in CI).

Relation to #1164

#1164 validates at dispatch time (read path). This PR validates at config creation time (write path). Both are needed: write-time validation fails fast and gives the client immediate feedback; dispatch-time validation is a defense-in-depth backstop.

Made with Cursor

The on_create_task_push_notification_config handlers (v1 and v2) stored
client-supplied URLs without validation. A malicious client could register
a push notification config pointing at loopback, private-network, or
cloud-metadata hosts, and the server would POST task events to that URL
on every state change.

Add push_url_validation_error checks to both create handlers, rejecting
non-http(s) schemes and hosts that resolve to non-public addresses.
This complements a2aproject#1164 (dispatch-time validation) by closing the write
path.

Test: test_on_create_task_push_notification_config_rejects_invalid_url
Co-authored-by: Cursor <cursoragent@cursor.com>
@SashaMIT
SashaMIT requested a review from a team as a code owner August 9, 2026 14:37
- default_request_handler_v2: restore a2a.server.tasks imports under
  TYPE_CHECKING (patch dedented them, tripping TC001) and sort import block
- base_push_notification_sender: catch OSError instead of naming
  socket.gaierror (check-spelling rejects the token)
- cross-version client_1_0 lifecycle test uses example.com placeholder:
  creation now validates resolvability/public reachability, and the CRUD
  lifecycle never dials the URL
Upstream's own push-notification e2e tests register loopback webhooks with
real local receivers, which creation-time validation rejects by design.
Add allow_private_push_urls (default False) to both request handlers and
opt the test harness in, matching the dispatch-path sibling's shape
(a2aproject#1164). Also: str() the getaddrinfo sockaddr host for ty, ruff-format
the v1 handler test.
@github-actions

github-actions Bot commented Aug 9, 2026

Copy link
Copy Markdown

🧪 Code Coverage (vs main)

⬇️ Download Full Report

Base PR Delta
src/a2a/server/request_handlers/default_request_handler.py 98.13% 98.20% 🟢 +0.07%
src/a2a/server/request_handlers/default_request_handler_v2.py 94.25% 92.89% 🔴 -1.36%
src/a2a/server/tasks/base_push_notification_sender.py 94.44% 85.71% 🔴 -8.73%
Total 93.12% 93.03% 🔴 -0.09%

Generated by coverage-comment.yml

[AgentCard, ServerCallContext], Awaitable[AgentCard]
]
| None = None,
allow_private_push_urls: bool = False,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we rather do something like

push_url_validator: Callable[...] | None = push_url_validation_error ?

A callable lets developers supply their own policy. The spec lists these as checks that SHOULD be done, not MUST and says "implement URL allowlists where appropriate." So the right policy is deployment specific, and the A2A library shouldn't hard-code one.

[AgentCard, ServerCallContext], Awaitable[AgentCard]
]
| None = None,
allow_private_push_urls: bool = False,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above, something like:

push_url_validator: Callable[...] | None = push_url_validation_error ?

if self._push_config_store and params.configuration.HasField(
'task_push_notification_config'
):
await self._push_config_store.set_info(

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should also add a check before this call.

if self._push_config_store and params.configuration.HasField(
'task_push_notification_config'
):
await self._push_config_store.set_info(

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also check before this call.

)


def push_url_validation_error(url: str) -> str | None:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make this async and use the loop's resolver?

Something like:

 async def push_url_validation_error(url: str) -> str | None:
   ...
   loop = asyncio.get_running_loop()
   infos = await loop.getaddrinfo(host, port, type=socket.SOCK_STREAM)

socket.getaddrinfo is blocking, and both call sites are async def handlers.

@SashaMIT

Copy link
Copy Markdown
Author

Thanks. The library default is now an injectable async push_url_validator (default push_url_validation_error, None skips). Validation runs before both set_info sites, including the send-message path. Resolver uses the running loop's getaddrinfo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants