]> nmode's Git Repositories - signal-cli/blob - src/main/java/org/asamk/signal/logging/LogConfigurator.java
Improve scrubbing of sensitive identifiers
[signal-cli] / src / main / java / org / asamk / signal / logging / LogConfigurator.java
1 package org.asamk.signal.logging;
2
3 import java.io.File;
4
5 import ch.qos.logback.classic.Level;
6 import ch.qos.logback.classic.Logger;
7 import ch.qos.logback.classic.LoggerContext;
8 import ch.qos.logback.classic.PatternLayout;
9 import ch.qos.logback.classic.jul.LevelChangePropagator;
10 import ch.qos.logback.classic.spi.Configurator;
11 import ch.qos.logback.classic.spi.ILoggingEvent;
12 import ch.qos.logback.core.ConsoleAppender;
13 import ch.qos.logback.core.FileAppender;
14 import ch.qos.logback.core.Layout;
15 import ch.qos.logback.core.encoder.LayoutWrappingEncoder;
16 import ch.qos.logback.core.filter.Filter;
17 import ch.qos.logback.core.spi.ContextAwareBase;
18 import ch.qos.logback.core.spi.FilterReply;
19
20 public class LogConfigurator extends ContextAwareBase implements Configurator {
21
22 private static int verboseLevel = 0;
23 private static File logFile = null;
24 private static boolean scrubSensitiveInformation = false;
25
26 public static void setVerboseLevel(int verboseLevel) {
27 LogConfigurator.verboseLevel = verboseLevel;
28 }
29
30 public static void setLogFile(File logFile) {
31 LogConfigurator.logFile = logFile;
32 }
33
34 public static void setScrubSensitiveInformation(final boolean scrubSensitiveInformation) {
35 LogConfigurator.scrubSensitiveInformation = scrubSensitiveInformation;
36 }
37
38 @Override
39 public ExecutionStatus configure(LoggerContext lc) {
40 lc.addListener(new LevelChangePropagator() {{
41 setContext(lc);
42 }});
43 final var rootLogger = lc.getLogger(Logger.ROOT_LOGGER_NAME);
44
45 final var defaultLevel = verboseLevel > 2 ? Level.ALL : verboseLevel > 0 ? Level.INFO : Level.WARN;
46 rootLogger.setLevel(defaultLevel);
47
48 final var consoleLayout = verboseLevel == 0 || logFile != null
49 ? createSimpleLoggingLayout(lc)
50 : createDetailedLoggingLayout(lc);
51 final var consoleAppender = createLoggingConsoleAppender(lc, createLayoutWrappingEncoder(consoleLayout));
52 rootLogger.addAppender(consoleAppender);
53
54 lc.getLogger("org.asamk").setLevel(verboseLevel > 1 ? Level.ALL : verboseLevel > 0 ? Level.DEBUG : Level.INFO);
55 lc.getLogger("org.asamk.Signal")
56 .setLevel(verboseLevel > 2 ? Level.ALL : verboseLevel > 1 ? Level.INFO : Level.WARN);
57 lc.getLogger("com.zaxxer.hikari.pool.PoolBase")
58 .setLevel(verboseLevel > 2 ? Level.ALL : verboseLevel > 1 ? Level.INFO : Level.WARN);
59 lc.getLogger("org.sqlite.core.NativeDB")
60 .setLevel(verboseLevel > 3 ? Level.ALL : verboseLevel > 1 ? Level.INFO : Level.WARN);
61
62 if (logFile != null) {
63 consoleAppender.addFilter(new Filter<>() {
64 @Override
65 public FilterReply decide(final ILoggingEvent event) {
66 return !"LibSignal".equals(event.getLoggerName()) && (
67 event.getLevel().isGreaterOrEqual(Level.WARN) || (
68 event.getLevel().isGreaterOrEqual(Level.INFO) && event.getLoggerName()
69 .startsWith("org.asamk")
70 )
71 )
72
73 ? FilterReply.NEUTRAL : FilterReply.DENY;
74 }
75 });
76
77 final var fileLayout = createDetailedLoggingLayout(lc);
78 final var fileAppender = createLoggingFileAppender(lc, createLayoutWrappingEncoder(fileLayout));
79 rootLogger.addAppender(fileAppender);
80 }
81 return ExecutionStatus.DO_NOT_INVOKE_NEXT_IF_ANY;
82 }
83
84 private ConsoleAppender<ILoggingEvent> createLoggingConsoleAppender(
85 final LoggerContext lc, final LayoutWrappingEncoder<ILoggingEvent> layoutEncoder
86 ) {
87 return new ConsoleAppender<>() {{
88 setContext(lc);
89 setName("console");
90 setTarget("System.err");
91 setEncoder(layoutEncoder);
92 start();
93 }};
94 }
95
96 private FileAppender<ILoggingEvent> createLoggingFileAppender(
97 final LoggerContext lc, final LayoutWrappingEncoder<ILoggingEvent> layoutEncoder
98 ) {
99 return new FileAppender<>() {{
100 setContext(lc);
101 setName("file");
102 setFile(logFile.getAbsolutePath());
103 setEncoder(layoutEncoder);
104 start();
105 }};
106 }
107
108 private LayoutWrappingEncoder<ILoggingEvent> createLayoutWrappingEncoder(final Layout<ILoggingEvent> l) {
109 return new LayoutWrappingEncoder<>() {{
110 setContext(l.getContext());
111 setLayout(l);
112 }};
113 }
114
115 private PatternLayout createSimpleLoggingLayout(final LoggerContext lc) {
116 final var patternLayout = getPatternLayout();
117 patternLayout.setPattern("%-5level %logger{0} - %msg%n");
118 patternLayout.setContext(lc);
119 patternLayout.start();
120 return patternLayout;
121 }
122
123 private PatternLayout createDetailedLoggingLayout(final LoggerContext lc) {
124 final var patternLayout = getPatternLayout();
125 patternLayout.setPattern("%d{yyyy-MM-dd'T'HH:mm:ss.SSSXX} [%thread] %-5level %logger{36} - %msg%n");
126 patternLayout.setContext(lc);
127 patternLayout.start();
128 return patternLayout;
129 }
130
131 private PatternLayout getPatternLayout() {
132 if (scrubSensitiveInformation) {
133 return new ScrubberPatternLayout();
134 } else {
135 return new PatternLayout();
136 }
137 }
138 }