Skip to content

feat: enable self-signed JWTs by default in ServiceOptions #13338

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

Draft
whowes wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −0
Draft

feat: enable self-signed JWTs by default in ServiceOptions #13338

Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions ...gquery/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQueryOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,11 @@ public static HttpTransportOptions getDefaultHttpTransportOptions() {
return HttpTransportOptions.newBuilder().setReadTimeout(DEFAULT_READ_API_TIME_OUT).build();
}

@Override
protected boolean useSelfSignedJwt() {
return false;
}

@Override
protected Set<String> getScopes() {
return SCOPES;
Expand Down
8 changes: 8 additions & 0 deletions ...tform-java/java-core/google-cloud-core/src/main/java/com/google/cloud/ServiceOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -650,9 +650,17 @@ public Credentials getScopedCredentials() {
&& ((GoogleCredentials) credentials).createScopedRequired()) {
credentialsToReturn = ((GoogleCredentials) credentials).createScoped(getScopes());
}
if (useSelfSignedJwt() && credentialsToReturn instanceof ServiceAccountCredentials) {
credentialsToReturn =
((ServiceAccountCredentials) credentialsToReturn).createWithUseJwtAccessWithScope(true);
}
Comment on lines +653 to +656
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Jun 2, 2026

Choose a reason for hiding this comment

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

medium

To avoid unnecessary object creation and copying, we can check if isUseJwtAccessWithScope() is already true before calling createWithUseJwtAccessWithScope(true).

    if (useSelfSignedJwt() && credentialsToReturn instanceof ServiceAccountCredentials) {
      ServiceAccountCredentials sac = (ServiceAccountCredentials) credentialsToReturn;
      if (!sac.isUseJwtAccessWithScope()) {
        credentialsToReturn = sac.createWithUseJwtAccessWithScope(true);
      }
    }
References
  1. Reuse pre-configured objects from options classes directly instead of creating new ones and copying settings.

return credentialsToReturn;
}

protected boolean useSelfSignedJwt() {
return true;
}
Comment on lines +660 to +662
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Jun 2, 2026

Choose a reason for hiding this comment

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

high

Enabling self-signed JWTs by default in the base ServiceOptions class will affect all inheriting Google Cloud services (e.g., Storage, Pub/Sub, Datastore, Spanner, etc.). If any of these services do not support self-signed JWTs, they will break unless they explicitly override this method to return false.

A safer and more defensive approach is to default to false in ServiceOptions and let individual services that support and benefit from self-signed JWTs opt-in by overriding this method to return true. Alternatively, if this is intended to be opt-out, please ensure that all inheriting services in the repository have been verified and updated if they do not support self-signed JWTs.


/** Returns configuration parameters for request retries. */
public RetrySettings getRetrySettings() {
return retrySettings;
Expand Down
Loading