Redact launcher friend names from FactoryGame.log (#234)

Author: budak7273

backend/app/debug_info.go

@@ -9,6 +9,7 @@ import (
 	"log/slog"
 	"os"
 	"path/filepath"
+	"regexp"
 	"runtime"
 	"strings"
 	"time"
@@ -47,7 +48,9 @@ func addDefaultFactoryGameLog(writer *zip.Writer) error {
 	if err != nil {
 		return fmt.Errorf("failed to get user cache dir: %w", err)
 	}
-	err = utils.AddFileToZip(writer, filepath.Join(cacheDir, "FactoryGame", "Saved", "Logs", "FactoryGame.log"), "FactoryGame.log")
+	defaultLogPath := filepath.Join(cacheDir, "FactoryGame", "Saved", "Logs", "FactoryGame.log")
+	// Default log will always be on the local disk, if it exists
+	bytes, err := os.ReadFile(defaultLogPath)
 	if err != nil {
 		if errors.Is(err, os.ErrNotExist) {
 			if runtime.GOOS != "windows" {
@@ -57,59 +60,80 @@ func addDefaultFactoryGameLog(writer *zip.Writer) error {
 			}
 			return fmt.Errorf("log does not exist")
 		}
-		return fmt.Errorf("failed to add FactoryGame.log to zip: %w", err)
+		return fmt.Errorf("failed to read default FactoryGame.log: %w", err)
+	}
+	err = addLogFromBytes(writer, bytes, "FactoryGame.log")
+	if err != nil {
+		return fmt.Errorf("failed to add default FactoryGame.log to zip: %w", err)
+	}
+	return nil
+}
+
+func redactLogBytes(bytes []byte) []byte {
+	// Prevent leaking of Steam/Epic friend nicknames in submitted logs
+	re := regexp.MustCompile(`(Added friend with nickname ').*(' on online context)`)
+	return re.ReplaceAll(bytes, []byte("${1}REDACTED${2}"))
+}
+
+func addLogFromBytes(writer *zip.Writer, bytes []byte, zipFileName string) error {
+	redactedBytes := redactLogBytes(bytes)
+
+	logFile, err := writer.Create(zipFileName)
+	if err != nil {
+		return fmt.Errorf("failed to create log file in zip: %w", err)
+	}
+
+	_, err = logFile.Write(redactedBytes)
+	if err != nil {
+		return fmt.Errorf("failed to write log file to zip: %w", err)
 	}
 	return nil
 }
 
 func addInstallFactoryGameLog(writer *zip.Writer, install *common.Installation) error {
 	logPath := filepath.Join(install.SavedPath, "Logs", "FactoryGame.log")
+	// Install-specific logs could be on remote disks
 	d, err := ficsitcli.FicsitCLI.GetInstallation(install.Path).GetDisk()
 	if err != nil {
 		return fmt.Errorf("failed to get disk for installation: %w", err)
 	}
+
 	logExists, err := d.Exists(logPath)
 	if err != nil {
 		return fmt.Errorf("failed to check if log exists: %w", err)
 	}
 	if !logExists {
 		return fmt.Errorf("log does not exist")
 	}
+
 	bytes, err := d.Read(logPath)
 	if err != nil {
 		return fmt.Errorf("failed to read log file: %w", err)
 	}
-	logFile, err := writer.Create(getLogNameForInstall(install))
-	if err != nil {
-		return fmt.Errorf("failed to create log file in zip: %w", err)
-	}
-	_, err = logFile.Write(bytes)
-	if err != nil {
-		return fmt.Errorf("failed to write log file to zip: %w", err)
-	}
-	return nil
+	return addLogFromBytes(writer, bytes, getLogNameForInstall(install))
 }
 
 func addFactoryGameLogs(writer *zip.Writer) {
 	err := addDefaultFactoryGameLog(writer)
 	if err != nil {
 		slog.Warn("failed to add default FactoryGame.log to debuginfo zip", slog.Any("error", err))
 	}
-	for _, meta := range ficsitcli.FicsitCLI.GetInstallationsMetadata() {
-		if meta.Info == nil {
+	for _, installMeta := range ficsitcli.FicsitCLI.GetInstallationsMetadata() {
+		if installMeta.Info == nil {
 			continue
 		}
 
-		err := addInstallFactoryGameLog(writer, meta.Info)
+		err := addInstallFactoryGameLog(writer, installMeta.Info)
 		if err != nil {
-			slog.Warn("failed to add FactoryGame.log to debuginfo zip", slog.String("path", meta.Info.Path), slog.Any("error", err))
+			slog.Warn("failed to add FactoryGame.log to debuginfo zip", slog.String("path", installMeta.Info.Path), slog.Any("error", err))
 		}
 	}
 }
 
 func getLogNameForInstall(install *common.Installation) string {
 	hash := sha256.Sum256([]byte(install.Path))
-	return fmt.Sprintf("FactoryGame_%s.log", hex.EncodeToString(hash[:])[:8])
+	first8 := hex.EncodeToString(hash[:])[:8]
+	return fmt.Sprintf("FactoryGame_%s_%s_%s_%s.log", first8, install.Location, install.Branch, install.Type)
 }
 
 func addMetadata(writer *zip.Writer) error {