Skip to content

fix: base64-encode "." and ".." in Pushgateway URL path segments #2633

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

fix: base64-encode "." and ".." in Pushgateway URL path segments #2633

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
10 changes: 8 additions & 2 deletions ...ter-pushgateway/src/main/java/io/prometheus/metrics/exporter/pushgateway/PushGateway.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,7 +508,7 @@ private URL makeUrl(@Nullable ExporterPushgatewayProperties properties)
StringBuilder url =
new StringBuilder(getScheme(properties) + "://" + getAddress(properties) + "/metrics/");
String job = getJob(properties);
if (job.contains("/")) {
if (needsBase64(job)) {
url.append("job@base64/").append(base64url(job));
} else {
url.append("job/").append(URLEncoder.encode(job, "UTF-8"));
Expand All @@ -518,7 +518,7 @@ private URL makeUrl(@Nullable ExporterPushgatewayProperties properties)
url.append("/")
.append(escapeName(entry.getKey(), EscapingScheme.VALUE_ENCODING_ESCAPING))
.append("@base64/=");
} else if (entry.getValue().contains("/")) {
} else if (needsBase64(entry.getValue())) {
url.append("/")
.append(escapeName(entry.getKey(), EscapingScheme.VALUE_ENCODING_ESCAPING))
.append("@base64/")
Expand All @@ -533,6 +533,12 @@ private URL makeUrl(@Nullable ExporterPushgatewayProperties properties)
return URI.create(url.toString()).normalize().toURL();
}

// "/" would split the value into several path segments, and "." and ".." are dot segments
// that normalize() would remove from the path, sending the request to a different group.
private boolean needsBase64(String v) {
return v.contains("/") || v.equals(".") || v.equals("..");
}

private String base64url(String v) {
return Base64.getEncoder()
.encodeToString(v.getBytes(StandardCharsets.UTF_8))
Expand Down
19 changes: 19 additions & 0 deletions ...pushgateway/src/test/java/io/prometheus/metrics/exporter/pushgateway/PushGatewayTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,25 @@ void testPushWithGroupingKeyWithSlashes() throws IOException {
pg.push();
}

@Test
void testPushWithDotSegmentJobAndGroupingKey() throws IOException {
mockServerClient
.when(
request()
.withMethod("PUT")
.withPath("/metrics/job@base64/Li4=/l@base64/Lg==/l2@base64/Li4="))
.respond(response().withStatusCode(202));
PushGateway pg =
PushGateway.builder()
.address("localhost:" + mockServerClient.getPort())
.registry(registry)
.job("..")
.groupingKey("l", ".")
.groupingKey("l2", "..")
.build();
pg.push();
}

@Test
void testPushCollectorWithGroupingKey() throws IOException {
mockServerClient
Expand Down