Skip to content

feat(server): allow standard FastAPI Security in routes #785

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.

Sign up for GitHub

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
ianchi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(server): allow standard FastAPI Security in routes #785

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions src/a2a/server/apps/jsonrpc/fastapi_app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
import logging

from collections.abc import Awaitable, Callable
from collections.abc import Awaitable, Callable, Sequence
from typing import TYPE_CHECKING, Any


if TYPE_CHECKING:
from fastapi import FastAPI
from fastapi.params import Depends

_package_fastapi_installed = True
else:
try:
from fastapi import FastAPI
from fastapi.params import Depends

_package_fastapi_installed = True
except ImportError:
Expand Down Expand Up @@ -121,6 +123,7 @@ def add_routes_to_app(
agent_card_url: str = AGENT_CARD_WELL_KNOWN_PATH,
rpc_url: str = DEFAULT_RPC_URL,
extended_agent_card_url: str = EXTENDED_AGENT_CARD_PATH,
dependencies: Sequence[Depends] | None = None,
) -> None:
"""Adds the routes to the FastAPI application.

Expand All @@ -129,7 +132,16 @@ def add_routes_to_app(
agent_card_url: The URL for the agent card endpoint.
rpc_url: The URL for the A2A JSON-RPC endpoint.
extended_agent_card_url: The URL for the authenticated extended agent card endpoint.
dependencies: Optional sequence of FastAPI dependencies (e.g.
`[Security(get_current_active_user, scopes=["a2a"])]`)
applied to the RPC endpoint and the authenticated extended
agent card endpoint. The public agent card endpoint is left
unprotected.
"""
route_deps: dict[str, Any] = {}
if dependencies:
route_deps['dependencies'] = list(dependencies)

app.post(
rpc_url,
openapi_extra={
Expand All @@ -145,6 +157,7 @@ def add_routes_to_app(
'description': 'A2ARequest',
}
},
**route_deps,
)(self._handle_requests)
app.get(agent_card_url)(self._handle_get_agent_card)

Expand All @@ -156,7 +169,7 @@ def add_routes_to_app(
)

if self.agent_card.supports_authenticated_extended_card:
app.get(extended_agent_card_url)(
app.get(extended_agent_card_url, **route_deps)(
self._handle_get_authenticated_extended_agent_card
)

Expand All @@ -165,6 +178,7 @@ def build(
agent_card_url: str = AGENT_CARD_WELL_KNOWN_PATH,
rpc_url: str = DEFAULT_RPC_URL,
extended_agent_card_url: str = EXTENDED_AGENT_CARD_PATH,
dependencies: Sequence[Depends] | None = None,
**kwargs: Any,
) -> FastAPI:
"""Builds and returns the FastAPI application instance.
Expand All @@ -173,6 +187,10 @@ def build(
agent_card_url: The URL for the agent card endpoint.
rpc_url: The URL for the A2A JSON-RPC endpoint.
extended_agent_card_url: The URL for the authenticated extended agent card endpoint.
dependencies: Optional sequence of FastAPI dependencies (e.g.
`[Security(get_current_active_user, scopes=["a2a"])]`)
applied to authenticated routes. See
:meth:`add_routes_to_app`.
**kwargs: Additional keyword arguments to pass to the FastAPI constructor.

Returns:
Expand All @@ -181,7 +199,7 @@ def build(
app = A2AFastAPI(**kwargs)

self.add_routes_to_app(
app, agent_card_url, rpc_url, extended_agent_card_url
app, agent_card_url, rpc_url, extended_agent_card_url, dependencies
)

return app
Loading