Added option to hide ip addresses in console and logs

Closes #416

Author: RaphiMC

src/main/java/net/raphimc/viaproxy/protocoltranslator/viaproxy/ViaProxyConfig.java

@@ -211,6 +211,12 @@ public class ViaProxyConfig {
     })
     private boolean sendConnectionDetails = false;
 
+    @Option("log-ips")
+    @Description({
+            "Disable this if you want to hide IP addresses in the console and log files.",
+    })
+    private boolean logIps = true;
+
     @Option("log-client-status-requests")
     @Description({
             "Enable this if you want to see client status requests in the console and log files.",
@@ -548,6 +554,15 @@ public void setSendConnectionDetails(final boolean sendConnectionDetails) {
         this.save();
     }
 
+    public boolean shouldLogIps() {
+        return this.logIps;
+    }
+
+    public void setLogIps(final boolean logIps) {
+        this.logIps = logIps;
+        this.save();
+    }
+
     public boolean shouldLogClientStatusRequests() {
         return this.logClientStatusRequests;
     }

src/main/java/net/raphimc/viaproxy/util/logging/IpRedactor.java

@@ -0,0 +1,55 @@
+/*
+ * This file is part of ViaProxy - https://github.com/RaphiMC/ViaProxy
+ * Copyright (C) 2021-2025 RK_01/RaphiMC and contributors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package net.raphimc.viaproxy.util.logging;
+
+import net.raphimc.viaproxy.ViaProxy;
+import org.apache.logging.log4j.core.LogEvent;
+import org.apache.logging.log4j.core.config.plugins.Plugin;
+import org.apache.logging.log4j.core.pattern.ConverterKeys;
+import org.apache.logging.log4j.core.pattern.LogEventPatternConverter;
+import org.apache.logging.log4j.core.pattern.PatternConverter;
+
+import java.util.regex.Pattern;
+
+@Plugin(name = "ip_redactor", category = PatternConverter.CATEGORY)
+@ConverterKeys({"ip_redactor"})
+public class IpRedactor extends LogEventPatternConverter {
+
+    private final Pattern IPV4_REGEX = Pattern.compile("(\\b25[0-5]|\\b2[0-4][0-9]|\\b[01]?[0-9][0-9]?)(\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}");
+    private final Pattern IPV6_REGEX = Pattern.compile("(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]+|::(ffff(:0{1,4})?:)?((25[0-5]|(2[0-4]|1?[0-9])?[0-9])\\.){3}(25[0-5]|(2[0-4]|1?[0-9])?[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1?[0-9])?[0-9])\\.){3}(25[0-5]|(2[0-4]|1?[0-9])?[0-9]))");
+
+    public static IpRedactor newInstance(final String[] options) {
+        return new IpRedactor();
+    }
+
+    private IpRedactor() {
+        super("IpRedactor", null);
+    }
+
+    @Override
+    public void format(final LogEvent event, final StringBuilder toAppendTo) {
+        if (ViaProxy.getConfig() != null && !ViaProxy.getConfig().shouldLogIps()) {
+            String message = toAppendTo.toString();
+            message = IPV4_REGEX.matcher(message).replaceAll("REDACTED_IP");
+            message = IPV6_REGEX.matcher(message).replaceAll("REDACTED_IP");
+            toAppendTo.setLength(0);
+            toAppendTo.append(message);
+        }
+    }
+
+}

src/main/java/net/raphimc/viaproxy/util/logging/Logger.java

@@ -22,6 +22,7 @@
 import net.raphimc.viaproxy.util.AddressUtil;
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.core.config.plugins.util.PluginManager;
 import org.jline.jansi.AnsiConsole;
 
 import java.io.PrintStream;
@@ -30,6 +31,10 @@
 
 public class Logger {
 
+    static {
+        PluginManager.addPackage("net.raphimc.viaproxy.util.logging");
+    }
+
     public static final org.apache.logging.log4j.Logger LOGGER = LogManager.getLogger("ViaProxy");
 
     public static final PrintStream SYSOUT = System.out;

src/main/resources/log4j2.xml

@@ -3,12 +3,12 @@
 	<Appenders>
 		<!--	System out	-->
 		<Console name="SysOut" target="SYSTEM_OUT">
-			<PatternLayout pattern="%style{[%d{HH:mm:ss}]}{blue} %highlight{[%t/%level]}{FATAL=red, ERROR=red, WARN=yellow, INFO=green, DEBUG=green, TRACE=blue} %style{(%logger{1})}{cyan} %highlight{%msg%n}{FATAL=red, ERROR=red, WARN=normal, INFO=normal, DEBUG=normal, TRACE=normal}" disableAnsi="false"/>
+			<PatternLayout pattern="%style{[%d{HH:mm:ss}]}{blue} %highlight{[%t/%level]}{FATAL=red, ERROR=red, WARN=yellow, INFO=green, DEBUG=green, TRACE=blue} %style{(%logger{1})}{cyan} %highlight{%msg{nolookups}%ip_redactor%n}{FATAL=red, ERROR=red, WARN=normal, INFO=normal, DEBUG=normal, TRACE=normal}" disableAnsi="false"/>
 		</Console>
 
 		<!--	latest.log same as vanilla	-->
 		<RollingRandomAccessFile name="LatestFile" fileName="${sys:user.dir}/logs/latest.log" filePattern="${sys:user.dir}/logs/%d{yyyy-MM-dd}-%i.log.gz">
-			<PatternLayout pattern="[%d{HH:mm:ss}] [%t/%level] (%logger{1}) %msg{nolookups}%n"/>
+			<PatternLayout pattern="[%d{HH:mm:ss}] [%t/%level] (%logger{1}) %msg{nolookups}%ip_redactor%n"/>
 			<Policies>
 				<TimeBasedTriggeringPolicy />
 				<OnStartupTriggeringPolicy />
@@ -17,7 +17,7 @@
 
 		<!--	Debug log file	-->
 		<RollingRandomAccessFile name="DebugFile" fileName="${sys:user.dir}/logs/debug.log" filePattern="${sys:user.dir}/logs/debug-%i.log.gz">
-			<PatternLayout pattern="[%d{HH:mm:ss}] [%t/%level] (%logger) %msg{nolookups}%n"/>
+			<PatternLayout pattern="[%d{HH:mm:ss}] [%t/%level] (%logger) %msg{nolookups}%ip_redactor%n"/>
 
 			<!--	Keep 5 files max	-->
 			<DefaultRolloverStrategy max="5" fileIndex="min"/>