Skip to content

Remove user sensitive data from self-diagnostics #3976

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

Merged
merged 1 commit into from
Jan 9, 2025
Merged

Remove user sensitive data from self-diagnostics #3976

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
33 changes: 31 additions & 2 deletions .../src/main/java/com/microsoft/applicationinsights/agent/internal/init/FirstEntryPoint.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,11 @@
import java.lang.management.RuntimeMXBean;
import java.nio.charset.StandardCharsets;
import java.nio.file.Path;
import java.util.AbstractMap.SimpleEntry;
import java.util.Locale;
import java.util.Map;
import java.util.Properties;
import java.util.stream.Collectors;
import javax.annotation.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Expand Down Expand Up @@ -122,7 +126,7 @@ public void init(EarlyInitAgentConfig earlyConfig) {
startupLogger.trace("OS: " + System.getProperty("os.name"));
startupLogger.trace("Classpath: " + System.getProperty("java.class.path"));
startupLogger.trace("Netty versions: " + NettyVersions.extract());
startupLogger.trace("Env: " + System.getenv());
startupLogger.trace("Env: " + findEnvVariables());
startupLogger.trace("System properties: " + findSystemProperties());
}

Expand All @@ -138,6 +142,30 @@ public void init(EarlyInitAgentConfig earlyConfig) {
}
}

private static Map<String, String> findEnvVariables() {
Map<String, String> env = System.getenv();
return env.entrySet().stream()
.map(
entry -> {
String key = entry.getKey();
String value = entry.getValue().toString();
String valueToDisplay = maskValueOfSensitiveKey(key, value);
return new SimpleEntry<>(key, valueToDisplay);
})
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
}

private static String maskValueOfSensitiveKey(String key, String value) {
return isSensitive(key) ? "***" : value;
}

private static boolean isSensitive(String key) {
String keyInLowerCase = key.toLowerCase(Locale.ROOT);
return keyInLowerCase.contains("password")
|| keyInLowerCase.contains("pwd")
|| keyInLowerCase.contains("secret");
}

private static void checkTlsConnectionsToVirtualServersEnabled() {
String tlsConnectionsToVirtualServersProp = "jsse.enableSNIExtension";
String propValue = System.getProperty(tlsConnectionsToVirtualServersProp);
Expand All @@ -156,7 +184,8 @@ private static String findSystemProperties() {
if (!firstProperty) {
propsBuilder.append(", ");
}
propsBuilder.append("(" + key + "=" + value + ")");
String valueToDisplay = maskValueOfSensitiveKey(key.toString(), value.toString());
propsBuilder.append("(" + key + "=" + valueToDisplay + ")");
});
return propsBuilder.toString();
}
Expand Down
Loading