Skip to content

Avoid exposing configuration values in errors #8669

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

Avoid exposing configuration values in errors #8669

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
2 changes: 1 addition & 1 deletion exporters/otlp/all/src/main/java/io/opentelemetry/exporter/otlp/internal/OtlpConfigUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ static void configureOtlpHeaders(
// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#specifying-headers-via-environment-variables
addHeader.accept(key, URLDecoder.decode(value, StandardCharsets.UTF_8.name()));
} catch (Exception e) {
throw new ConfigurationException("Cannot decode header value: " + value, e);
throw new ConfigurationException("Cannot decode header value for header: " + key, e);
}
}
}
Expand Down
5 changes: 3 additions & 2 deletions ...l/src/test/java/io/opentelemetry/exporter/otlp/internal/OtlpSpanExporterProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,9 +303,10 @@ void createExporter_decodingError() {
() -> {
provider.createExporter(
DefaultConfigProperties.createFromMap(
Collections.singletonMap("otel.exporter.otlp.headers", "header-key=%-1")));
Collections.singletonMap(
"otel.exporter.otlp.headers", "header-key=Bearer%20s3cr3t%-1")));
})
.isInstanceOf(ConfigurationException.class)
.hasMessage("Cannot decode header value: %-1");
.hasMessage("Cannot decode header value for header: header-key");
}
}
3 changes: 1 addition & 2 deletions ...rc/main/java/io/opentelemetry/sdk/autoconfigure/spi/internal/DefaultConfigProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,8 +225,7 @@ public Map<String, String> getMap(String name) {
entry -> {
String[] split = entry.split("=", 2);
if (split.length != 2 || StringUtils.isNullOrEmpty(split[0])) {
throw new ConfigurationException(
"Invalid map property: " + name + "=" + config.get(name));
throw new ConfigurationException("Invalid map property: " + name);
}
return filterBlanksAndNulls(split);
})
Expand Down
7 changes: 4 additions & 3 deletions ...i/src/test/java/io/opentelemetry/sdk/autoconfigure/spi/internal/ConfigPropertiesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,16 +161,17 @@ void uncleanMap() {
void invalidMap() {
assertThatThrownBy(
() ->
DefaultConfigProperties.createFromMap(Collections.singletonMap("map", "a=1,b"))
DefaultConfigProperties.createFromMap(
Collections.singletonMap("map", "authorization=Bearer s3cr3t,malformed"))
.getMap("map"))
.isInstanceOf(ConfigurationException.class)
.hasMessage("Invalid map property: map=a=1,b");
.hasMessage("Invalid map property: map");
assertThatThrownBy(
() ->
DefaultConfigProperties.createFromMap(Collections.singletonMap("map", "a=1,=b"))
.getMap("map"))
.isInstanceOf(ConfigurationException.class)
.hasMessage("Invalid map property: map=a=1,=b");
.hasMessage("Invalid map property: map");
}

@Test
Expand Down
Loading