Merge branch 'CDOC2-51-censor-file-name-in-logs' into 'master'

CDOC-51: Censor filename's in logs

See merge request cdoc2/cdoc2-java-ref-impl!123

Author: Hain Zuppur

CHANGELOG.md

@@ -11,6 +11,7 @@
 * Add attentional unit tests to cdoc2-cli for `secp256r1` elliptic curve support.
 * Add bats tests for `secp256r1` elliptic curve support.
 * Upgraded Spring boot 3.3.3 -> 4.0.1 + other third-party dependency updates.
+* Censor the file name in the logs.
 
 ### Maven package versions:
 ```

cdoc2-cli/src/main/java/ee/cyber/cdoc2/cli/commands/CDocCreateCmd.java

@@ -33,6 +33,7 @@
 
 import static ee.cyber.cdoc2.cli.util.CDocCommonHelper.getServerProperties;
 import static ee.cyber.cdoc2.config.Cdoc2ConfigurationProperties.KEY_CAPSULE_POST_PROPERTIES;
+import static ee.cyber.cdoc2.util.LoggingUtil.censorFileNames;
 
 //S106 - Standard outputs should not be used directly to log anything
 //CLI needs to interact with standard outputs
@@ -132,7 +133,7 @@ public Void call() throws Exception {
                 (recipient.labeledPasswordParam != null) ? "****" : null,
                 Arrays.toString(recipient.sidCodes),
                 Arrays.toString(recipient.midCodes),
-                Arrays.toString(inputFiles));
+                censorFileNames(inputFiles));
         }
 
         CDocBuilder cDocBuilder = new CDocBuilder()

cdoc2-lib/src/main/java/ee/cyber/cdoc2/container/Tar.java

@@ -15,6 +15,8 @@
 import java.util.function.Function;
 
 import static ee.cyber.cdoc2.config.Cdoc2ConfigurationProperties.*;
+import static ee.cyber.cdoc2.util.LoggingUtil.censorFileName;
+import static ee.cyber.cdoc2.util.LoggingUtil.censorPathFileName;
 
 
 /**
@@ -40,7 +42,11 @@ private Tar() {
 
     static void addFileToTar(TarArchiveOutputStream outputStream, Path file, String entryName) throws IOException {
 
-        log.debug("Adding file {} as {}", file.toAbsolutePath(), entryName);
+        log.debug(
+            "Adding file {} as {}",
+            censorPathFileName(file.toAbsolutePath()),
+            censorFileName(entryName)
+        );
         if (Files.isRegularFile(file)) {
             TarArchiveEntry tarArchiveEntry = outputStream.createArchiveEntry(file.toFile(),
                     entryName);

cdoc2-lib/src/main/java/ee/cyber/cdoc2/container/TarDeflate.java

@@ -20,6 +20,8 @@
 import java.util.LinkedList;
 import java.util.List;
 
+import static ee.cyber.cdoc2.util.LoggingUtil.censorFileName;
+
 /**
  * AutoCloseable tarDeflate stream extractor. If any exception is thrown
  * during processing {@link #process(TarEntryProcessingDelegate)}, then close() deletes extracted files.
@@ -247,7 +249,11 @@ private boolean processTarEntry(
         boolean processed;
 
         if (tarArchiveEntry.isFile()) {
-            log.debug("Found: {} {}B", tarArchiveEntry.getName(), tarArchiveEntry.getSize());
+            log.debug(
+                "Found: {} {}B",
+                censorFileName(tarArchiveEntry.getName()),
+                tarArchiveEntry.getSize()
+            );
 
             File createdFile = delegate.onTarEntry(tarArchiveEntry);
             if (createdFile != null) {
@@ -269,7 +275,7 @@ private boolean processTarEntry(
 
             processed = delegate.onEndOfTarEntry();
 
-            log.debug("Transferred {} {}B", tarArchiveEntry.getName(), written);
+            log.debug("Transferred {} {}B", censorFileName(tarArchiveEntry.getName()), written);
 
         } else {
             throw Tar.logTarEntryIllegalTypeAndThrow(tarArchiveEntry.getName());

cdoc2-lib/src/main/java/ee/cyber/cdoc2/util/LoggingUtil.java

@@ -0,0 +1,86 @@
+package ee.cyber.cdoc2.util;
+
+import java.io.File;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
+
+
+/**
+ * Utility class containing methods used for logging
+ */
+public final class LoggingUtil {
+    private LoggingUtil() {
+        // utility class
+    }
+
+    /**
+     * Censors the file name for logs. E.g. "hello.txt" would be "xxxxx.txt".
+     *
+     * @param fileName filename
+     * @return The censored filename
+     */
+    public static String censorFileName(String fileName) {
+        if (fileName == null || fileName.isEmpty()) {
+            return fileName;
+        }
+
+        int lastDotIndex = fileName.lastIndexOf('.');
+
+        // No extension or dot is the first character (e.g. ".gitignore")
+        if (lastDotIndex <= 0) {
+            return "X".repeat(fileName.length());
+        }
+
+        String namePart = fileName.substring(0, lastDotIndex);
+        String extensionPart = fileName.substring(lastDotIndex);
+
+        return "X".repeat(namePart.length()) + extensionPart;
+    }
+
+    /**
+     * Censors the file path for logs. E.g. "abc/aaa/hello.txt" would be "abc/aaa/xxxxx.txt".
+     *
+     * @param path file path
+     * @return censored file path as string
+     */
+    public static String censorPathFileName(Path path) {
+        if (path == null) {
+            return null;
+        }
+
+        Path fileName = path.getFileName();
+        if (fileName == null) {
+            return path.toString();
+        }
+
+        String censoredFileName = censorFileName(fileName.toString());
+
+        Path parent = path.getParent();
+        if (parent == null) {
+            return censoredFileName;
+        }
+
+        return parent.resolve(censoredFileName).toString();
+    }
+
+    public static List<String> censorFileNames(File[] files) {
+        if (files == null) {
+            return null;
+        }
+
+        List<String> result = new ArrayList<>(files.length);
+
+        for (File file : files) {
+            if (file == null) {
+                result.add(null);
+                continue;
+            }
+
+            String censoredName = censorFileName(file.getName());
+            result.add(censoredName);
+        }
+
+        return result;
+    }
+}