feat(auth): implement regional access boundary support for standalone JWT and async service accounts#17025
feat(auth): implement regional access boundary support for standalone JWT and async service accounts#17025nbayati wants to merge 24 commits into
Conversation
There was a problem hiding this comment.
Code Review
This pull request implements asynchronous support for Regional Access Boundary (RAB) management, including background refresh tasks and mTLS endpoint support. Key changes include the addition of _AsyncRegionalAccessBoundaryRefreshManager, updates to JWT and service account credentials to handle RAB state during cloning and serialization, and comprehensive test coverage for these new flows. However, a critical issue was identified where the refresh method in google/auth/jwt.py was renamed to _perform_refresh_token, which will break token updates as the base class expects a refresh method. Additionally, a typo was found in a test assertion URL.
| except ValueError: | ||
| response_data = response_body | ||
|
|
||
| if response.status == http_client.OK: |
There was a problem hiding this comment.
In google.auth.aio.transport.Response, the HTTP status code is exposed via the status_code property, not status. Passing a compliant google.auth.aio transport callable raises AttributeError: 'Response' object has no attribute 'status'. Please update the async lookup and grant methods to check .status_code.
There was a problem hiding this comment.
Actually decided to only apply the fix to the RAB lookup, and instead open a bug to bring the grant methods up to date separately. This was can keep the blast radius of this PR smaller and limit it to only RAB changes without touching any token fetching flows.
There was a problem hiding this comment.
Created #17139 to track the necessary changes for the token endpoints.
| # A refresh is already in progress. | ||
| return | ||
|
|
||
| async def _worker(): |
There was a problem hiding this comment.
Unlike the synchronous refresh manager which safely deepcopies the transport (copied_request = copy.deepcopy(request)), the async manager passes the exact same request instance directly into the background coroutine task. Because start_refresh is invoked inside before_request, the main application coroutine immediately proceeds to make its actual service API HTTP call using the exact same request transport while the background task is concurrently using it, risking HTTP state corruption or interleaved headers.
Additionally, spawning asyncio.create_task(_worker()) without tracking cancellation hooks upon client session closure can potentially cause dangling tasks that raise RuntimeError: Session is closed when executing against closed client sessions.
There was a problem hiding this comment.
Both concerns are valid, but safe under the hood:
-
Deepcopying the Transport is impossible and not needed in async
The async transport object (e.g., aiohttp_requests.Request) contains an active aiohttp.ClientSession with open TCP sockets. Attempting to copy.deepcopy(request) will instantly raise a TypeError: cannot pickle 'ClientSession' object and crash the application at runtime. Unlike synchronous transports running on separate OS threads, async HTTP clients (like aiohttp or httpx) are natively designed to handle concurrent requests sharing the same connection session. All request-specific states (headers, payloads) are stored in localized coroutine call stack frames, preventing any HTTP state corruption or interleaving. -
Session closure and dangling tasks are handled safely
The background worker is a single-shot asyncio task that executes exactly one lookup request and then immediately terminates and gets garbage-collected.
If the user's application closes the underlying client session while a background task is still running, the resulting RuntimeError: Session is closed is safely caught by the worker's generic except Exception as e: block. It logs a warning, fails open cleanly, and does not raise an unhandled exception or crash the application.
I think no code changes are required here, as the current design is fully protected.
| expected_url_standard = "https://iamcredentials.googleapis.com/v1/projects/-/serviceAccounts/{}/allowedLocations".format( | ||
| self.SERVICE_ACCOUNT_EMAIL | ||
| ) | ||
| expected_url_mtls = "https://iamcredentials.mtls.googleapis.com/v1/projects/-/serviceAccounts/{}/allowedLocations".format( |
There was a problem hiding this comment.
Can you remind me what prompted the mTLS addition?
We should have test(s) that set that signal and makes sure the right endpoint is called on refresh etc.
There was a problem hiding this comment.
I realized that we only had hardcoded the non-mtls endpoint, while the other existing endpoints switch between mtls and non-mtls dynalically at runtime. I added the same treatment to the RAB URL, however, based on my recent talk with Yao, it seems like it's safe to always just send the request to the mtls one. If that ends up being the case, we can simplify the code and always call the mtls RAB endpoint.
There was a problem hiding this comment.
Leaving this comment thread open, so I either come back and add more unit tests as you requested, or simplify the logic and update the existing unit tests.
There was a problem hiding this comment.
After further investigation, it turned out that we couldn't just always call mtls endpoint, and the library had to switch dynamically between the two. I did a refactoring to move the RAB endpoints to the RAB file and out of iam. I'm filing an issue to add unit tests to iam, and have them dynamically switch too, because the current static decision that happens in the beginning of the run won't cover the GCE's CUJ for dynamically changing identity to MWLID. I've opened a separate issue (#17282) to migrate the rest of the endpoints.
…ement async refresh manager
…support Regional Access Boundary logic
…y data and config
…ager in service account credentials
be67ab6 to
7e65ee7
Compare
This PR implements the following changes: