Skip to content

xds: Validate ring_hash requestHashHeader when parsing the config #13161

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
hidingmyname wants to merge 1 commit into
base: master
Choose a base branch
from
Open

xds: Validate ring_hash requestHashHeader when parsing the config #13161

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
11 changes: 11 additions & 0 deletions xds/src/main/java/io/grpc/xds/RingHashLoadBalancerProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import io.grpc.LoadBalancer;
import io.grpc.LoadBalancer.Helper;
import io.grpc.LoadBalancerProvider;
import io.grpc.Metadata;
import io.grpc.NameResolver.ConfigOrError;
import io.grpc.Status;
import io.grpc.internal.GrpcUtil;
Expand Down Expand Up @@ -106,6 +107,16 @@ private ConfigOrError parseLoadBalancingPolicyConfigInternal(
return ConfigOrError.fromError(Status.UNAVAILABLE.withDescription(
"Invalid 'minRingSize'/'maxRingSize'"));
}
if (!requestHashHeader.isEmpty()) {
// gRFC A76: reject header names that are invalid or refer to a binary (-bin) header.
try {
requestHashHeader =
Metadata.Key.of(requestHashHeader, Metadata.ASCII_STRING_MARSHALLER).name();
} catch (IllegalArgumentException e) {
return ConfigOrError.fromError(Status.UNAVAILABLE.withDescription(
"Invalid 'requestHashHeader': " + requestHashHeader).withCause(e));
}
}
return ConfigOrError.fromConfig(
new RingHashConfig(minRingSize, maxRingSize, requestHashHeader));
}
Expand Down
50 changes: 50 additions & 0 deletions xds/src/test/java/io/grpc/xds/RingHashLoadBalancerProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,56 @@ public void parseLoadBalancingConfig_requestHashHeaderUnsetWhenEnvVarSet_useDefa
}
}

@Test
public void parseLoadBalancingConfig_requestHashHeaderWithBinSuffix_rejected()
throws IOException {
System.setProperty(GRPC_EXPERIMENTAL_RING_HASH_SET_REQUEST_HASH_KEY, "true");
try {
String lbConfig = "{\"requestHashHeader\" : \"dummy-hash-bin\"}";
ConfigOrError configOrError =
provider.parseLoadBalancingPolicyConfig(parseJsonObject(lbConfig));
assertThat(configOrError.getError()).isNotNull();
assertThat(configOrError.getError().getCode()).isEqualTo(Code.UNAVAILABLE);
assertThat(configOrError.getError().getDescription())
.isEqualTo("Invalid 'requestHashHeader': dummy-hash-bin");
} finally {
System.clearProperty(GRPC_EXPERIMENTAL_RING_HASH_SET_REQUEST_HASH_KEY);
}
}

@Test
public void parseLoadBalancingConfig_requestHashHeaderWithInvalidCharacters_rejected()
throws IOException {
System.setProperty(GRPC_EXPERIMENTAL_RING_HASH_SET_REQUEST_HASH_KEY, "true");
try {
String lbConfig = "{\"requestHashHeader\" : \"dummy!hash\"}";
ConfigOrError configOrError =
provider.parseLoadBalancingPolicyConfig(parseJsonObject(lbConfig));
assertThat(configOrError.getError()).isNotNull();
assertThat(configOrError.getError().getCode()).isEqualTo(Code.UNAVAILABLE);
assertThat(configOrError.getError().getDescription())
.isEqualTo("Invalid 'requestHashHeader': dummy!hash");
} finally {
System.clearProperty(GRPC_EXPERIMENTAL_RING_HASH_SET_REQUEST_HASH_KEY);
}
}

@Test
public void parseLoadBalancingConfig_requestHashHeaderMixedCase_lowerCased()
throws IOException {
System.setProperty(GRPC_EXPERIMENTAL_RING_HASH_SET_REQUEST_HASH_KEY, "true");
try {
String lbConfig = "{\"requestHashHeader\" : \"Dummy-Hash\"}";
ConfigOrError configOrError =
provider.parseLoadBalancingPolicyConfig(parseJsonObject(lbConfig));
assertThat(configOrError.getConfig()).isNotNull();
RingHashConfig config = (RingHashConfig) configOrError.getConfig();
assertThat(config.requestHashHeader).isEqualTo("dummy-hash");
} finally {
System.clearProperty(GRPC_EXPERIMENTAL_RING_HASH_SET_REQUEST_HASH_KEY);
}
}

@SuppressWarnings("unchecked")
private static Map<String, ?> parseJsonObject(String json) throws IOException {
return (Map<String, ?>) JsonParser.parse(json);
Expand Down
Loading