From 530fde8f11f12926daac68e35cb0d56cf83ac135 Mon Sep 17 00:00:00 2001
From: Randall Winkhart <idgr@tutanota.com>
Date: Thu, 18 Jul 2024 17:04:48 -0400
Subject: [PATCH] Improve StringGen to allow creating file name-safe complex
 strings; remove in-code references to future additions

---
 docs/man                     |  1 -
 mutn.go                      |  6 +++---
 src/backend/utilitiesMisc.go | 15 +++++++++++----
 src/cli/add.go               |  5 +++--
 src/cli/edit.go              |  2 +-
 src/cli/init.go              |  2 +-
 src/cli/printInfo.go         |  1 -
 src/sync/init.go             |  5 +++--
 8 files changed, 22 insertions(+), 15 deletions(-)

diff --git a/docs/man b/docs/man
index 6d83b12..eaf9573 100644
--- a/docs/man
+++ b/docs/man
@@ -47,7 +47,6 @@ Manually synchronizing entries with the server:
  help                   Bring up the help menu
  version                Display version and license information
  init                   Set up MUTN (generates libmutton.ini)
- tweak                  Change configuration options (NOT YET IMPLEMENTED)
  copy                   Copy details of an entry to your clipboard
  edit                   Edit an existing entry
  gen                    Generate a new password
diff --git a/mutn.go b/mutn.go
index a4447ae..e658f7a 100644
--- a/mutn.go
+++ b/mutn.go
@@ -2,11 +2,12 @@ package main
 
 import (
 	"fmt"
+	"os"
+	"strings"
+
 	"github.com/rwinkhart/MUTN/src/backend"
 	"github.com/rwinkhart/MUTN/src/cli"
 	"github.com/rwinkhart/MUTN/src/sync"
-	"os"
-	"strings"
 )
 
 func main() {
@@ -165,7 +166,6 @@ func main() {
 			case "tweak":
 				fmt.Println(backend.AnsiError + "\"tweak\" is not yet implemented" + backend.AnsiReset)
 				os.Exit(0)
-				// TODO backend.Tweak()
 			case "copy":
 				cli.HelpCopy()
 			case "edit":
diff --git a/src/backend/utilitiesMisc.go b/src/backend/utilitiesMisc.go
index 9359eb6..4fec3f7 100644
--- a/src/backend/utilitiesMisc.go
+++ b/src/backend/utilitiesMisc.go
@@ -11,8 +11,6 @@ import (
 	"strings"
 )
 
-const extendedCharset = "!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
-
 // TargetIsFile TargetStatusCheck checks if the targetLocation is a file, directory, or is inaccessible
 // failCondition: 0 = fail on inaccessible, 1 = fail on inaccessible/file, 2 = fail on inaccessible/directory
 // returns: isFile, isAccessible
@@ -88,15 +86,24 @@ func RemoveTrailingEmptyStrings(slice []string) []string {
 }
 
 // StringGen generates a random string of a specified length and complexity
+// safeForFileName: if true, the generated string will only contain special characters that are safe for file names (only impacts complex strings)
 // complexity: minimum percentage of special characters to be returned in the generated string (only impacts complex strings)
-func StringGen(length int, complex bool, complexity float64) string {
+func StringGen(length int, complex bool, complexity float64, safeForFileName bool) string {
 	var actualSpecialChars int // track the number of special characters in the generated string
 	var minSpecialChars int    // track the minimum number of special characters to accept
+	var extendedCharset string // additions to character set used for complex strings
 
 	charset := "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789" // default character set used for all strings
+	const extendedCharsetFiles = "!#$%&'()+,-.;=@[]^_`{}~"                      // additional special characters for complex strings (safe in file names)
+	const extendedCharsetPassword = "\"*:><?/\\|"                               // additional special characters for complex strings (NOT safe in file names)
 	if complex {
 		minSpecialChars = int(math.Round(float64(length) * complexity)) // determine minimum number of special characters to accept
-		charset = charset + extendedCharset
+		if !safeForFileName {
+			extendedCharset = extendedCharsetFiles + extendedCharsetPassword
+		} else {
+			extendedCharset = extendedCharsetFiles
+		}
+		charset += extendedCharset
 	}
 
 	// loop until a string of the desired complexity is generated
diff --git a/src/cli/add.go b/src/cli/add.go
index 1952fac..ef28adf 100644
--- a/src/cli/add.go
+++ b/src/cli/add.go
@@ -2,8 +2,9 @@ package cli
 
 import (
 	"fmt"
-	"github.com/rwinkhart/MUTN/src/backend"
 	"os"
+
+	"github.com/rwinkhart/MUTN/src/backend"
 )
 
 // AddEntry creates a new entry at targetLocation by taking user input via CLI prompts
@@ -25,7 +26,7 @@ func AddEntry(targetLocation string, hideSecrets bool, entryType uint8) {
 		if entryType == 0 {
 			password = inputHidden("Password:")
 		} else {
-			password = backend.StringGen(inputInt("Password length:", -1), inputBinary("Generate a complex (special characters) password?"), 0.2)
+			password = backend.StringGen(inputInt("Password length:", -1), inputBinary("Generate a complex (special characters) password?"), 0.2, false)
 		}
 
 		totp := inputHidden("TOTP secret:")
diff --git a/src/cli/edit.go b/src/cli/edit.go
index 7e94ef8..32ecbee 100644
--- a/src/cli/edit.go
+++ b/src/cli/edit.go
@@ -60,7 +60,7 @@ func GenUpdate(targetLocation string, hideSecrets bool) {
 	unencryptedEntry := backend.GetOldEntryData(targetLocation, 0)
 
 	// generate a new password
-	unencryptedEntry[0] = backend.StringGen(inputInt("Password length:", -1), inputBinary("Generate a complex (special characters) password?"), 0.2)
+	unencryptedEntry[0] = backend.StringGen(inputInt("Password length:", -1), inputBinary("Generate a complex (special characters) password?"), 0.2, false)
 
 	// write and preview the modified entry
 	writeEntryCLI(targetLocation, unencryptedEntry, hideSecrets)
diff --git a/src/cli/init.go b/src/cli/init.go
index e3beca8..4a378c2 100644
--- a/src/cli/init.go
+++ b/src/cli/init.go
@@ -38,7 +38,7 @@ func TempInitCli() {
 		sshUser := input("Remote SSH username:")
 		sshPort := input("Remote SSH port:")
 		sshIP := input("Remote SSH IP/domain:")
-		sshKey := expandPathWithHome(input("SSH private identity file path:")) // TODO implement generator and selector
+		sshKey := expandPathWithHome(input("SSH private identity file path:"))
 		sshKeyProtected := inputBinary("Is the identity file password-protected?")
 
 		// initialize libmutton directories
diff --git a/src/cli/printInfo.go b/src/cli/printInfo.go
index b6ef47c..66e4c96 100644
--- a/src/cli/printInfo.go
+++ b/src/cli/printInfo.go
@@ -24,7 +24,6 @@ This program comes with absolutely no warranty; type "mutn version" for details.
  help                    Bring up this menu
  version                 Display version and license information
  init                    Set up MUTN (generates libmutton.ini)
- tweak                   Change configuration options (NOT YET IMPLEMENTED)
  copy                    Copy details of an entry to your clipboard
  edit                    Edit an existing entry
  gen                     Generate a new password
diff --git a/src/sync/init.go b/src/sync/init.go
index 2e77484..88e2e78 100644
--- a/src/sync/init.go
+++ b/src/sync/init.go
@@ -2,12 +2,13 @@ package sync
 
 import (
 	"fmt"
-	"github.com/rwinkhart/MUTN/src/backend"
 	"math/rand"
 	"os"
 	"strconv"
 	"strings"
 	"time"
+
+	"github.com/rwinkhart/MUTN/src/backend"
 )
 
 // DeviceIDGen generates a new client device ID and registers it with the server
@@ -16,7 +17,7 @@ import (
 // returns the remote EntryRoot and OS type (OS type is a bool: backend.IsWindows)
 func DeviceIDGen() (string, string) {
 	deviceIDPrefix, _ := os.Hostname()
-	deviceIDSuffix := backend.StringGen(rand.Intn(32)+48, false, 0) + "-" + strconv.FormatInt(time.Now().Unix(), 10) // TODO consider using complex string generator and removing unsafe characters manually
+	deviceIDSuffix := backend.StringGen(rand.Intn(32)+48, true, 0.2, true) + "-" + strconv.FormatInt(time.Now().Unix(), 10)
 	deviceID := deviceIDPrefix + "-" + deviceIDSuffix
 	_, err := os.Create(backend.ConfigDir + backend.PathSeparator + "devices" + backend.PathSeparator + deviceID) // TODO remove existing device ID file if it exists (from both client and server)
 	if err != nil {