Two-token mechanism for task execution to prevent token expiration while tasks wait in executor queues#60108
Conversation
b183c74 to
9c31417
Compare
c707ddc to
4ef9dfe
Compare
|
As per my understanding this was removed in #55506 to use a middleware that refreshes token. Are you running an instance with execution api only separately with api-server? Could this middleware approach be extended for task-sdk calls too? |
|
Hi @tirkarthi, I took a stab at extending that pattern in #60197, handling expired tokens transparently in JWTBearer + middleware so no client-side changes are needed. Would love your thoughts on it. Totally happy to go with whichever approach the team feels is better! |
Would love to hear @ashb or @amoghrajesh 's opinion on this one |
ashb
left a comment
There was a problem hiding this comment.
We can't do this approach. It lets any Execution API token be resurrected which fundamentally breaks lots of security assumptions -- it amounts to having tokens not expire. That is bad.
Instead what we should do is generate a new token (i.e. ones with extra/different set of JWT claims) that is only valid for the /run endpoint and valid for longer (say 24hours, make it configurable) and this is what gets sent in the workload.
The run endpoint then would set the header to give the running task a "short lived" token (the one we have right now basically) that is usable on the rest of the Execution API. This approach is safer as the existing controls in the /run endpoint already prevent a task being run one than once, which should also prevent against "resurrecting" an expired token and using it to access things like connections etc. And we should validate that the token used on all endpoints but run is explicitly lacking this new claim.
4ef9dfe to
b32da6b
Compare
14a516a to
5915391
Compare
ashb
left a comment
There was a problem hiding this comment.
Much better approach, and on the right track, thanks.
Some changes though:
-
"queue" is not the right thing to use, as these tokens could be used for executing other workloads soon (for instance we have already talked about wanting Dag level callbacks to be executed on the workers, not in the dag processor, which would be done by having a new type from the ExecuteTaskWorkload).
so maybe we have
"scope": "ExecuteTaskWorkload"? -
A little bit of refactoring is needed before we are ready to merge this.
airflow-core/src/airflow/api_fastapi/execution_api/routes/task_instances.py
Outdated
Show resolved
Hide resolved
e7e3ae1 to
e879863
Compare
b511b8f to
57ac225
Compare
There was a problem hiding this comment.
Pull request overview
Implements a two-token flow for the Execution API to avoid auth failures when tasks sit in executor queues long enough for their original JWT to expire.
Changes:
- Add workload token generation for task workloads (long-lived) and issue an execution token (short-lived) from
PATCH /runviaX-Execution-Token. - Update the Task SDK client to swap its bearer token when
X-Execution-Tokenis received (and prioritize it overRefreshed-API-Token). - Add configuration for workload-token expiration and expand tests/mocks to cover the new token behavior.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
task-sdk/src/airflow/sdk/api/client.py |
Swaps client auth when X-Execution-Token header is returned by the server. |
task-sdk/tests/task_sdk/api/test_client.py |
Adds tests validating execution-token swap and precedence over refreshed tokens. |
airflow-core/src/airflow/api_fastapi/auth/tokens.py |
Adds generate_workload_token() and adds a valid_for override to JWT generation. |
airflow-core/src/airflow/api_fastapi/execution_api/routes/task_instances.py |
Allows workload tokens on /run and returns X-Execution-Token on success. |
airflow-core/src/airflow/executors/workloads/base.py |
Switches workload token generation to the new workload-scoped token method. |
airflow-core/src/airflow/config_templates/config.yml |
Introduces execution_api.jwt_workload_token_expiration_time with a 24h default. |
airflow-core/tests/unit/api_fastapi/auth/test_tokens.py |
Adds tests for workload token scope and JWT valid_for override. |
airflow-core/tests/unit/api_fastapi/execution_api/conftest.py |
Registers a mocked JWTGenerator for execution API tests. |
airflow-core/tests/unit/api_fastapi/execution_api/versions/head/test_task_instances.py |
Adds a test asserting /run returns X-Execution-Token. |
airflow-core/tests/unit/jobs/test_scheduler_job.py |
Extends JWT generator mocks to include generate_workload_token(). |
devel-common/src/tests_common/test_utils/mock_executor.py |
Extends JWT generator mock to include generate_workload_token(). |
You can also share your feedback on Copilot code review. Take the survey.
airflow-core/src/airflow/api_fastapi/execution_api/routes/task_instances.py
Outdated
Show resolved
Hide resolved
airflow-core/src/airflow/api_fastapi/execution_api/routes/task_instances.py
Show resolved
Hide resolved
airflow-core/tests/unit/api_fastapi/execution_api/versions/head/test_task_instances.py
Show resolved
Hide resolved
ae3141d to
e1f8725
Compare
e1f8725 to
ff8f59c
Compare
| Seconds until workload JWT tokens expire. These long-lived tokens are sent | ||
| with task workloads to executors and can only call the /run endpoint. | ||
| Set long enough to cover maximum expected queue wait time. | ||
| version_added: 3.2.0 |
There was a problem hiding this comment.
I don't think we'll merge this for 3.2.0, so
| version_added: 3.2.0 | |
| version_added: 3.2.1 |
| assert resp.status_code == 403 | ||
| assert "Invalid token scope" in resp.json()["detail"] | ||
|
|
||
| def test_workload_scope_accepted_on_run_endpoint( |
There was a problem hiding this comment.
Maybe we already have a test for this, but I think the negative test is important too -- that the workload scoped token is not accepted on other endpoints. You don't have to exhaustively check all endpoints, but testing at least one other to ensure it gives a 4xx is worthwhile I think
There was a problem hiding this comment.
I also think we should check this once or twice on other routers too -- the workload scoped tokens should not work anywhere but the /run TI end point.
| if new_token := response.headers.get("X-Execution-Token"): | ||
| log.debug("Received execution token, swapping auth") | ||
| self.auth = BearerAuth(new_token) | ||
| elif new_token := response.headers.get("Refreshed-API-Token"): |
There was a problem hiding this comment.
Nit: do we even need a new header? Couldn't we use Refreshed-API-Token in both cases? Also if you do think a new header is worth it then remove the X- prefix -- that is not recommended by HTTP standards anymore.
amoghrajesh
left a comment
There was a problem hiding this comment.
Mostly looks good now, just a few basic qns / feedback otherwise I am good.
| generator: JWTGenerator = services.get(JWTGenerator) | ||
| execution_token = generator.generate(extras={"sub": str(task_instance_id)}) | ||
| response.headers["X-Execution-Token"] = execution_token |
There was a problem hiding this comment.
If services.get(JWTGenerator) raises or fails for whatever reason / if generate raises, the API would return 500 here, but we committed the TI as running earlier. To avoid this, I suggest to move this up in the try/except itself.
There was a problem hiding this comment.
I don't think it can ever fali really.
| Seconds until workload JWT tokens expire. These long-lived tokens are sent | ||
| with task workloads to executors and can only call the /run endpoint. | ||
| Set long enough to cover maximum expected queue wait time. | ||
| version_added: 3.2.0 |
| ) | ||
|
|
||
| generator: JWTGenerator = services.get(JWTGenerator) | ||
| execution_token = generator.generate(extras={"sub": str(task_instance_id)}) |
There was a problem hiding this comment.
Do we need to set the scope as execution here to be explicit?
| if new_token := response.headers.get("X-Execution-Token"): | ||
| log.debug("Received execution token, swapping auth") | ||
| self.auth = BearerAuth(new_token) | ||
| elif new_token := response.headers.get("Refreshed-API-Token"): |
ff8f59c to
4afd940
Compare
| "exp": 9999999999, | ||
| "iat": 1000000000, | ||
| } | ||
| lifespan.registry.register_value(JWTValidator, validator) |
There was a problem hiding this comment.
This JWTValidator registration is dead code -- the client fixture's mock_jwt_bearer overrides _jwt_bearer via FastAPI dependency overrides, so FastAPI never calls the real _jwt_bearer (which would use JWTValidator from the registry). Every request through client gets scope: "execution" regardless of what's registered here.
The test passes because execution-scoped tokens are allowed on /run, not because workload-scoped tokens are. To actually test workload token acceptance, the test needs to either:
- Remove the
_jwt_bearerdependency override for this test and let the real auth flow use thisJWTValidator, or - Override
mock_jwt_bearerto returnTIToken(..., claims={..., "scope": "workload"})instead of the conftest's hardcoded"scope": "execution".
|
|
||
| lifespan.registry.close() | ||
|
|
||
| exec_app.dependency_overrides.pop(_jwt_bearer, None) |
There was a problem hiding this comment.
lifespan.registry.close() is new here (no other test file does this), and the registry is shared across all tests via cached_app. Closing it could break subsequent tests that try to look up services from the same registry. The existing pattern in other test files (e.g., test_task_instances.py, test_router.py) registers values on lifespan.registry without closing it afterward. I'd drop this close() call to match what the rest of the test suite does.
| ) | ||
|
|
||
| generator: JWTGenerator = services.get(JWTGenerator) | ||
| execution_token = generator.generate(extras={"sub": str(task_instance_id)}) |
There was a problem hiding this comment.
Token generation happens outside the try...except SQLAlchemyError block. If services.get(JWTGenerator) or generator.generate() raises (missing service, crypto error, etc.), the client gets a raw 500 with no useful detail. Worth wrapping this in its own try/except, or at minimum a log line, so operators can tell the difference between "database error" and "token generation failed".
|
|
||
| kid: str = attrs.field(default=attrs.Factory(_generate_kid, takes_self=True)) | ||
| valid_for: float | ||
| workload_valid_for: float = attrs.field( |
There was a problem hiding this comment.
The workload_valid_for default reads from config via _conf_factory, and _jwt_generator() in app.py also reads the same config key and passes it explicitly. The explicit kwarg takes precedence, so the default factory never runs in production. Having two code paths that reference the same config key is easy to get out of sync -- consider dropping the attrs default (make it required like valid_for) and always passing it explicitly, or drop the explicit kwarg in _jwt_generator() and let the default handle it.
| # wait times so avoid refreshing them. | ||
| if claims.get("scope") == "workload": | ||
| return response | ||
|
|
There was a problem hiding this comment.
The early return for workload tokens skips the refresh logic (correct), but it also skips the except block below. If avalidated_claims raises for a workload token, execution falls into the outer except and the response still gets returned (with a warning log). Might be worth a comment clarifying that workload token validation errors are handled by the outer catch.
| # Cadwyn's versioned sub-apps don't inherit the main app's state, | ||
| # so lookups raise ServiceNotFoundError. This registry provides | ||
| # services needed by routes called during dag.test(). | ||
| # |
There was a problem hiding this comment.
The stub JWTGenerator uses secrets.token_urlsafe(32) as the secret key, so a new key is generated every time InProcessExecutionAPI.app is accessed. Since app is a cached_property, the key is stable for the lifetime of the object. But the token generated here by ti_run won't be validated by anything (since _jwt_bearer is also overridden with always_allow), so this stub only exists to satisfy the services.get(JWTGenerator) call. A brief comment noting that these tokens are never validated in dag.test() mode would help future readers.
4afd940 to
ec7e290
Compare
ec7e290 to
b6e5713
Compare
Summary
Tasks waiting in executor queues (Celery, Kubernetes) can have their JWT tokens expire before execution starts, causing auth failures on the Execution API. This is a real problem in production, when queues back up or workers are slow to pick up tasks, the original short-lived token expires and the worker gets a 403 when it finally tries to start the task.
Fixes: #53713
Related: #59553
Approach
Two-token mechanism: a long-lived workload token (24h default, configurable) travels with the task through the queue, and a short-lived execution token is issued when the task actually starts running.
The workload token carries a scope: "workload" claim and is restricted to the /run endpoint only, enforced via FastAPI SecurityScopes and a custom ExecutionAPIRoute. When /run succeeds, it returns an execution token via X-Execution-Token header. The SDK client picks it up and uses it for all subsequent API calls. The existing JWTReissueMiddleware handles refreshing execution tokens near expiry and skips workload tokens.
For dag.test() / InProcessExecutionAPI, auth is bypassed and a stub JWTGenerator with a random secret is used so no signing key configuration is needed.
New config: execution_api.jwt_workload_token_expiration_time (default 86400s)
Built on @ashb's SecurityScopes foundation.
Security considerations
Even if a workload token is intercepted, it can only call /run which already guards against running a task more than once (returns 409 if the task isn't in QUEUED/RESTARTING state). All other endpoints reject workload tokens , they require execution scope. The execution token issued by /run is short-lived and automatically refreshed, keeping the existing security posture for all API calls during task execution.
Testing
Tested end-to-end with CeleryExecutor in Breeze, triggered a DAG, confirmed tasks completed successfully with the token swap happening transparently. Unit tests cover token generation, scope enforcement (accepted on /run, rejected elsewhere), invalid scope handling, execution token header in response, SDK client token swap and priority, and registry teardown to prevent test pollution.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in airflow-core/newsfragments.