Skip to content

test(oauth2): auto-sync oidc-jwt-1 provider JWKs on SA key rotation - #14914

Open
macastelaz wants to merge 3 commits into
googleapis:mainfrom
macastelaz:fix-wif-mtls-test-key-rotation
Open

macastelaz wants to merge 3 commits into
googleapis:mainfrom
macastelaz:fix-wif-mtls-test-key-rotation

Conversation

@macastelaz

@macastelaz macastelaz commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Automatically syncs the oidc-jwt-1 Workload Identity Pool Provider's static jwksJson in ITWorkloadIdentityFederationTest whenever the integration test service account (it-service-account@gcloud-devel.iam.gserviceaccount.com) rotates keys bi-monthly (java_it_service_account_rotation).

Background

  • The 4 mTLS + actor_token Workload Identity Federation tests added in feat(oauth2): support certificate-bound OAuth2 tokens and mTLS rotation for Workload Identity Federation #14781 sign mock OIDC JWTs with it-service-account@gcloud-devel.iam.gserviceaccount.com's private key (GOOGLE_APPLICATION_CREDENTIALS), verified against the oidc-jwt-1 OIDC provider in gcloud-devel.
  • When it-service-account rotates keys every two months, the new private_key_id (kid) is not in oidc-jwt-1's static jwksJson, causing STS token exchange to fail with 400 Bad Request: Invalid JWT signature.
  • Because ITWorkloadIdentityFederationTest runs authenticated as it-service-account@gcloud-devel.iam.gserviceaccount.com—which already holds roles/iam.workloadIdentityPoolAdmin on gcloud-devel—ensureOidcJwtProviderJwksSynced() checks once per test run whether oidc-jwt-1's jwksJson includes privateKeyId. On the first run after a key rotation, it fetches the service account's live public JWK set (https://www.googleapis.com/service_accounts/v1/jwk/<client_email>) and patches oidc-jwt-1.

See https://docs.google.com/document/d/1cjtmXb4tGZgyvTgL2hfn96KaNnAukdt6FJ8j4CV2H_k/view for more details

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the workload identity federation integration tests to use a static test private key instead of the service account's private key. It modifies the setup script to append this static key to the JWK set retrieved from Google. The review feedback suggests improving the inline Python script in the setup script by adding a timeout and using a context manager for the network request to prevent potential hangs in CI/CD pipelines.

@macastelaz macastelaz changed the title test(oauth2): sign mTLS WIF OIDC test JWTs with static test key to prevent key-rotation breakage test(oauth2): auto-sync oidc-jwt-1 provider JWKs on SA key rotation Nov 3, 2026
@macastelaz
macastelaz marked this pull request as ready for review November 16, 2026 18:36
@macastelaz
macastelaz requested review from a team as code owners November 16, 2026 18:36
@macastelaz
macastelaz enabled auto-merge (squash) November 16, 2026 18:48
@macastelaz
macastelaz disabled auto-merge November 16, 2026 18:51

private String generateSignedOidcJwt(String audience, String x5tS256, boolean includeMayAct)
throws IOException {
ensureOidcJwtProviderJwksSynced();

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.

qq, should we call this in something like a @BeforeAll or something? Also if this call fails, should we just fail the rest of the tests in this file?

This branch has not been deployed

No deployments
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.

3 participants