Skip to content

xds: Move JwtTokenFileCallCredentials to xds.client package #13006

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
kannanjgithub wants to merge 2 commits into
base: master
Choose a base branch
from
Open

xds: Move JwtTokenFileCallCredentials to xds.client package #13006

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f14a55
xds: Move JwtTokenFileCallCredentials to xds.client package and make …
kannanjgithub Aug 26, 2026
ab69245
Refactor xDS bootstrapper to improve role separation between io.grpc.…
kannanjgithub Aug 31, 2026
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
1 change: 0 additions & 1 deletion xds/src/main/java/io/grpc/xds/client/BootstrapperImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
import io.grpc.CompositeCallCredentials;
import io.grpc.Internal;
import io.grpc.InternalLogId;
import io.grpc.auth.JwtTokenFileCallCredentials;
import io.grpc.internal.GrpcUtil;
import io.grpc.internal.GrpcUtil.GrpcBuildVersion;
import io.grpc.internal.JsonParser;
Expand Down
6 changes: 3 additions & 3 deletions ...rpc/auth/JwtTokenFileCallCredentials.java → ...s/client/JwtTokenFileCallCredentials.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

package io.grpc.auth;
package io.grpc.xds.client;

import static com.google.common.base.Preconditions.checkNotNull;

Expand Down Expand Up @@ -45,7 +45,7 @@
* A {@link CallCredentials} implementation that loads a JWT token from a file,
* parses it to extract its expiration time, and caches/refreshes it.
*/
public final class JwtTokenFileCallCredentials extends CallCredentials {
final class JwtTokenFileCallCredentials extends CallCredentials {
private static final int MAX_FILE_SIZE_BYTES = 1048576;

private static final Logger log = Logger.getLogger(JwtTokenFileCallCredentials.class.getName());
Expand Down Expand Up @@ -87,7 +87,7 @@ public long currentTimeMillis() {
}
};

public JwtTokenFileCallCredentials(String filePath) {
JwtTokenFileCallCredentials(String filePath) {
this(filePath, SYSTEM_TIME_PROVIDER);
}

Expand Down
255 changes: 0 additions & 255 deletions xds/src/test/java/io/grpc/xds/GrpcBootstrapperImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,8 @@

import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Iterables;
import io.grpc.CallCredentials;
import io.grpc.InsecureChannelCredentials;
import io.grpc.TlsChannelCredentials;
import io.grpc.auth.JwtTokenFileCallCredentials;
import io.grpc.internal.GrpcUtil;
import io.grpc.internal.GrpcUtil.GrpcBuildVersion;
import io.grpc.xds.client.AllowedGrpcServices;
Expand Down Expand Up @@ -1061,257 +1059,4 @@ private static Node.Builder getNodeBuilder() {
.addClientFeatures(GrpcBootstrapperImpl.CLIENT_FEATURE_RESOURCE_IN_SOTW);
}

private static void setEnableXdsBootstrapCallCreds(boolean enable) {
io.grpc.xds.client.BootstrapperImpl.enableXdsBootstrapCallCreds = enable;
}

private static String getFilePath(JwtTokenFileCallCredentials credentials) {
try {
java.lang.reflect.Field field =
JwtTokenFileCallCredentials.class.getDeclaredField("filePath");
field.setAccessible(true);
return (String) field.get(credentials);
} catch (Exception e) {
throw new RuntimeException(e);
}
}

@Test
public void parseBootstrap_callCreds_flagDisabled() throws Exception {
setEnableXdsBootstrapCallCreds(false);
try {
String rawData = "{\n"
+ " \"xds_servers\": [\n"
+ " {\n"
+ " \"server_uri\": \"" + SERVER_URI + "\",\n"
+ " \"channel_creds\": [{\"type\": \"insecure\"}],\n"
+ " \"call_creds\": [\n"
+ " {\n"
+ " \"type\": \"jwt_token_file\",\n"
+ " \"config\": {\n"
+ " \"jwt_token_file\": \"/var/run/secrets/token\"\n"
+ " }\n"
+ " }\n"
+ " ]\n"
+ " }\n"
+ " ]\n"
+ "}";
bootstrapper.setFileReader(createFileReader(BOOTSTRAP_FILE_PATH, rawData));
BootstrapInfo info = bootstrapper.bootstrap();
assertThat(info.servers()).hasSize(1);
ServerInfo serverInfo = Iterables.getOnlyElement(info.servers());
assertThat(serverInfo.callCredentials()).isNull();
} finally {
setEnableXdsBootstrapCallCreds(false);
}
}

@Test
public void parseBootstrap_xdsServers_jwtTokenFileCallCreds() throws Exception {
setEnableXdsBootstrapCallCreds(true);
try {
String rawData = "{\n"
+ " \"xds_servers\": [\n"
+ " {\n"
+ " \"server_uri\": \"" + SERVER_URI + "\",\n"
+ " \"channel_creds\": [{\"type\": \"insecure\"}],\n"
+ " \"call_creds\": [\n"
+ " {\n"
+ " \"type\": \"jwt_token_file\",\n"
+ " \"config\": {\n"
+ " \"jwt_token_file\": \"/var/run/secrets/token\"\n"
+ " }\n"
+ " }\n"
+ " ]\n"
+ " }\n"
+ " ]\n"
+ "}";
bootstrapper.setFileReader(createFileReader(BOOTSTRAP_FILE_PATH, rawData));
BootstrapInfo info = bootstrapper.bootstrap();
assertThat(info.servers()).hasSize(1);
ServerInfo serverInfo = Iterables.getOnlyElement(info.servers());
assertThat(serverInfo.callCredentials())
.isInstanceOf(JwtTokenFileCallCredentials.class);
assertThat(getFilePath((JwtTokenFileCallCredentials) serverInfo.callCredentials()))
.isEqualTo("/var/run/secrets/token");
} finally {
setEnableXdsBootstrapCallCreds(false);
}
}

@Test
public void parseBootstrap_authorities_jwtTokenFileCallCreds() throws Exception {
setEnableXdsBootstrapCallCreds(true);
try {
String rawData = "{\n"
+ " \"authorities\": {\n"
+ " \"a.com\": {\n"
+ " \"xds_servers\": [\n"
+ " {\n"
+ " \"server_uri\": \"td2.googleapis.com:443\",\n"
+ " \"channel_creds\": [\n"
+ " {\"type\": \"insecure\"}\n"
+ " ],\n"
+ " \"call_creds\": [\n"
+ " {\n"
+ " \"type\": \"jwt_token_file\",\n"
+ " \"config\": {\n"
+ " \"jwt_token_file\": \"/var/run/secrets/authority_token\"\n"
+ " }\n"
+ " }\n"
+ " ]\n"
+ " }\n"
+ " ]\n"
+ " }\n"
+ " },\n"
+ " \"xds_servers\": [\n"
+ " {\n"
+ " \"server_uri\": \"" + SERVER_URI + "\",\n"
+ " \"channel_creds\": [\n"
+ " {\"type\": \"insecure\"}\n"
+ " ]\n"
+ " }\n"
+ " ]\n"
+ "}";
bootstrapper.setFileReader(createFileReader(BOOTSTRAP_FILE_PATH, rawData));
BootstrapInfo info = bootstrapper.bootstrap();
assertThat(info.authorities()).hasSize(1);
AuthorityInfo authorityInfo = info.authorities().get("a.com");
assertThat(authorityInfo.xdsServers()).hasSize(1);
ServerInfo serverInfo = authorityInfo.xdsServers().get(0);
assertThat(serverInfo.callCredentials())
.isInstanceOf(JwtTokenFileCallCredentials.class);
assertThat(getFilePath((JwtTokenFileCallCredentials) serverInfo.callCredentials()))
.isEqualTo("/var/run/secrets/authority_token");
} finally {
setEnableXdsBootstrapCallCreds(false);
}
}

@Test
public void parseBootstrap_unsupportedCallCredsType_ignored() throws Exception {
setEnableXdsBootstrapCallCreds(true);
try {
String rawData = "{\n"
+ " \"xds_servers\": [\n"
+ " {\n"
+ " \"server_uri\": \"" + SERVER_URI + "\",\n"
+ " \"channel_creds\": [{\"type\": \"insecure\"}],\n"
+ " \"call_creds\": [\n"
+ " {\n"
+ " \"type\": \"unsupported_type\",\n"
+ " \"config\": {\n"
+ " \"some_field\": \"some_val\"\n"
+ " }\n"
+ " },\n"
+ " {\n"
+ " \"type\": \"jwt_token_file\",\n"
+ " \"config\": {\n"
+ " \"jwt_token_file\": \"/var/run/secrets/token\"\n"
+ " }\n"
+ " }\n"
+ " ]\n"
+ " }\n"
+ " ]\n"
+ "}";
bootstrapper.setFileReader(createFileReader(BOOTSTRAP_FILE_PATH, rawData));
BootstrapInfo info = bootstrapper.bootstrap();
assertThat(info.servers()).hasSize(1);
ServerInfo serverInfo = Iterables.getOnlyElement(info.servers());
assertThat(serverInfo.callCredentials())
.isInstanceOf(JwtTokenFileCallCredentials.class);
assertThat(getFilePath((JwtTokenFileCallCredentials) serverInfo.callCredentials()))
.isEqualTo("/var/run/secrets/token");
} finally {
setEnableXdsBootstrapCallCreds(false);
}
}

@Test
public void parseBootstrap_malformedCallCreds_throws() throws Exception {
setEnableXdsBootstrapCallCreds(true);
try {
String rawData = "{\n"
+ " \"xds_servers\": [\n"
+ " {\n"
+ " \"server_uri\": \"" + SERVER_URI + "\",\n"
+ " \"channel_creds\": [{\"type\": \"insecure\"}],\n"
+ " \"call_creds\": [\n"
+ " {\n"
+ " \"type\": \"jwt_token_file\",\n"
+ " \"config\": {}\n"
+ " }\n"
+ " ]\n"
+ " }\n"
+ " ]\n"
+ "}";
bootstrapper.setFileReader(createFileReader(BOOTSTRAP_FILE_PATH, rawData));
XdsInitializationException e = assertThrows(XdsInitializationException.class,
bootstrapper::bootstrap);
assertThat(e).hasMessageThat().contains("jwt_token_file' jwt_token_file missing or empty");
} finally {
setEnableXdsBootstrapCallCreds(false);
}
}

@Test
public void parseBootstrap_xdsServers_multipleValidCallCreds() throws Exception {
setEnableXdsBootstrapCallCreds(true);
try {
String rawData = "{\n"
+ " \"xds_servers\": [\n"
+ " {\n"
+ " \"server_uri\": \"" + SERVER_URI + "\",\n"
+ " \"channel_creds\": [{\"type\": \"insecure\"}],\n"
+ " \"call_creds\": [\n"
+ " {\n"
+ " \"type\": \"jwt_token_file\",\n"
+ " \"config\": { \"jwt_token_file\": \"/var/run/secrets/token1\" }\n"
+ " },\n"
+ " {\n"
+ " \"type\": \"jwt_token_file\",\n"
+ " \"config\": { \"jwt_token_file\": \"/var/run/secrets/token2\" }\n"
+ " }\n"
+ " ]\n"
+ " }\n"
+ " ]\n"
+ "}";
bootstrapper.setFileReader(createFileReader(BOOTSTRAP_FILE_PATH, rawData));
BootstrapInfo info = bootstrapper.bootstrap();
assertThat(info.servers()).hasSize(1);
ServerInfo serverInfo = info.servers().get(0);
CallCredentials creds = serverInfo.callCredentials();
assertThat(creds).isNotNull();
assertThat(creds).isInstanceOf(io.grpc.CompositeCallCredentials.class);
} finally {
setEnableXdsBootstrapCallCreds(false);
}
}

@Test
public void parseBootstrap_xdsServers_missingTypeCallCreds() throws Exception {
setEnableXdsBootstrapCallCreds(true);
try {
String rawData = "{\n"
+ " \"xds_servers\": [\n"
+ " {\n"
+ " \"server_uri\": \"" + SERVER_URI + "\",\n"
+ " \"channel_creds\": [{\"type\": \"insecure\"}],\n"
+ " \"call_creds\": [\n"
+ " {\n"
+ " \"config\": { \"jwt_token_file\": \"/var/run/secrets/token\" }\n"
+ " }\n"
+ " ]\n"
+ " }\n"
+ " ]\n"
+ "}";
bootstrapper.setFileReader(createFileReader(BOOTSTRAP_FILE_PATH, rawData));
bootstrapper.bootstrap();
fail("Expected exception");
} catch (XdsInitializationException e) {
assertThat(e).hasMessageThat().contains("with 'call_creds' type unspecified");
} finally {
setEnableXdsBootstrapCallCreds(false);
}
}
}
Loading
Loading