Skip to content

fix: validate URI template variables against dot segments #2194

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

Closed
blakeli0 wants to merge 1 commit into from
Closed

fix: validate URI template variables against dot segments #2194

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
18 changes: 18 additions & 0 deletions google-http-client/src/main/java/com/google/api/client/http/UriTemplate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,12 +320,30 @@ public static String expand(
}

private static String getSimpleValue(String name, String value, CompositeOutput compositeOutput) {
validatePathSegments(name, value, compositeOutput);
if (compositeOutput.requiresVarAssignment()) {
return String.format("%s=%s", name, compositeOutput.getEncodedValue(value));
}
return compositeOutput.getEncodedValue(value);
}

private static void validatePathSegments(
String name, String value, CompositeOutput compositeOutput) {
if (compositeOutput == CompositeOutput.SIMPLE) {
if (".".equals(value) || "..".equals(value)) {
throw new IllegalArgumentException(String.format("Invalid value %s for %s.", value, name));
}
} else if (compositeOutput == CompositeOutput.PLUS) {
for (String segment : Splitter.on('/').split(value)) {
if (".".equals(segment) || "..".equals(segment)) {
throw new IllegalArgumentException(
String.format(
"Value for %s must not contain segments that are exactly . or ..", name));
}
}
}
}

/**
* Expand the template of a composite list property. Eg: If d := ["red", "green", "blue"] then
* {/d*} is expanded to "/red/green/blue"
Expand Down
51 changes: 51 additions & 0 deletions google-http-client/src/test/java/com/google/api/client/http/UriTemplateTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
package com.google.api.client.http;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThrows;
import static org.junit.Assert.assertTrue;

import com.google.api.client.util.Value;
Expand Down Expand Up @@ -433,4 +434,54 @@ public void testExpandTemplates_reservedExpansion_mapWithMixedEncodedInput() {
assertEquals(
"#key1,val1%2F,key2,val2%2F,key3,val%20", UriTemplate.expand("{#keys}", variables, false));
}

@Test
public void testExpandTemplates_rejectsDotSegmentsInSimpleExpansion() {
Map<String, Object> variables = Maps.newLinkedHashMap();
variables.put("webhook", "..");
IllegalArgumentException dotDotEx =
assertThrows(
IllegalArgumentException.class,
() -> UriTemplate.expand("v3/webhooks/{webhook}", variables, false));
assertEquals("Invalid value .. for webhook.", dotDotEx.getMessage());

variables.put("webhook", ".");
IllegalArgumentException dotEx =
assertThrows(
IllegalArgumentException.class,
() -> UriTemplate.expand("v3/webhooks/{webhook}", variables, false));
assertEquals("Invalid value . for webhook.", dotEx.getMessage());
}

@Test
public void testExpandTemplates_rejectsDotSegmentsInReservedExpansion() {
for (String invalidValue :
Arrays.asList(
"projects/p/locations/l/agents/a/sessions/..",
"projects/p/locations/l/agents/a/sessions/.",
"projects/sys-prod-123/databases/default/documents/doc-1/../../default",
"../escape-db",
"projects/sys-prod-123/databases/default/documents/doc-1/./child")) {
Map<String, Object> variables = Maps.newLinkedHashMap();
variables.put("name", invalidValue);
IllegalArgumentException ex =
assertThrows(
IllegalArgumentException.class,
() -> UriTemplate.expand("v1/{+name}", variables, false));
assertEquals(
"Value for name must not contain segments that are exactly . or ..", ex.getMessage());
}
}

@Test
public void testExpandTemplates_allowsSafeDotsInSimpleAndReservedExpansion() {
Map<String, Object> variables = Maps.newLinkedHashMap();
variables.put("name", "projects/sys-prod-123/databases/default/documents/my-file..txt");
assertEquals(
"v1/projects/sys-prod-123/databases/default/documents/my-file..txt",
UriTemplate.expand("v1/{+name}", variables, false));

variables.put("id", ".well-known");
assertEquals("v1/.well-known", UriTemplate.expand("v1/{id}", variables, false));
}
}
Loading