Rename all occurrences of "passphrase" to "password"

core/init.go

@@ -14,8 +14,8 @@ import (
 )
 
 // LibmuttonInit creates the libmutton config structure based on user input.
-// rcwPassphrase and clientSpecificIniData can be left blank if not needed.
-func LibmuttonInit(inputCB func(prompt string) string, clientSpecificIniData [][3]string, rcwPassphrase []byte, preserveOldConfigDir bool) error {
+// rcwPassword and clientSpecificIniData can be left blank if not needed.
+func LibmuttonInit(inputCB func(prompt string) string, clientSpecificIniData [][3]string, rcwPassword []byte, preserveOldConfigDir bool) error {
 	r := strings.ToLower(inputCB("Configure SSH settings (for synchronization)? (Y/n)"))
 	if len(r) > 0 && r[0] == 'n' {
 		// initialize libmutton directories
@@ -35,7 +35,7 @@ func LibmuttonInit(inputCB func(prompt string) string, clientSpecificIniData [][
 	} else {
 		// ensure ssh key file exists (and is a file)
 		fallbackSSHKey := back.Home + global.PathSeparator + ".ssh" + global.PathSeparator + "id_ed25519"
-		sshKeyPath := cmp.Or(back.ExpandPathWithHome(inputCB(back.AnsiBold+"Note:"+back.AnsiReset+" Only key-based authentication is supported (keys may optionally be passphrase-protected).\n      The remote server must already be in your ~"+global.PathSeparator+".ssh"+global.PathSeparator+"known_hosts file.\n\nSSH private identity file path (falls back to \""+fallbackSSHKey+"\"):")), fallbackSSHKey)
+		sshKeyPath := cmp.Or(back.ExpandPathWithHome(inputCB(back.AnsiBold+"Note:"+back.AnsiReset+" Only key-based authentication is supported (keys may optionally be password-protected).\n      The remote server must already be in your ~"+global.PathSeparator+".ssh"+global.PathSeparator+"known_hosts file.\n\nSSH private identity file path (falls back to \""+fallbackSSHKey+"\"):")), fallbackSSHKey)
 		_, err := back.TargetIsFile(sshKeyPath, true)
 		if err != nil {
 			return errors.New("unable to find SSH identity file: " + err.Error())
@@ -84,8 +84,8 @@ func LibmuttonInit(inputCB func(prompt string) string, clientSpecificIniData [][
 		}
 	}
 	// generate rcw sanity check file (if requested)
-	if len(rcwPassphrase) > 0 {
-		err := RCWSanityCheckGen(rcwPassphrase)
+	if len(rcwPassword) > 0 {
+		err := RCWSanityCheckGen(rcwPassword)
 		if err != nil {
 			return err
 		}
@@ -94,8 +94,8 @@ func LibmuttonInit(inputCB func(prompt string) string, clientSpecificIniData [][
 }
 
 // RCWSanityCheckGen generates the RCW sanity check file for libmutton.
-func RCWSanityCheckGen(passphrase []byte) error {
-	err := wrappers.GenSanityCheck(global.ConfigDir+global.PathSeparator+"sanity.rcw", passphrase)
+func RCWSanityCheckGen(password []byte) error {
+	err := wrappers.GenSanityCheck(global.ConfigDir+global.PathSeparator+"sanity.rcw", password)
 	if err != nil {
 		return errors.New("unable to generate sanity check file: " + err.Error())
 	}

core/utilitiesMisc.go

@@ -21,14 +21,14 @@ func WriteEntry(targetLocation string, decBytes []byte) error {
 	return nil
 }
 
-// EntryRefresh re-encrypts all libmutton entries with a new passphrase
+// EntryRefresh re-encrypts all libmutton entries with a new password
 // and optimizes each entry to ensure they are as slim as possible.
 // This includes stripping trailing whitespace/newlines/carriage returns
 // from each field and running each note through ClampTrailingWhitespace
 // to ensure each note line is optimized as possible without breaking
 // Markdown formatting.
-// Be sure to verify passphrases before using as input for this function!!
-func EntryRefresh(oldRCWPassphrase, newRCWPassphrase []byte, removeOldDir bool) error {
+// Be sure to verify passwords before using as input for this function!!
+func EntryRefresh(oldRCWPassword, newRCWPassword []byte, removeOldDir bool) error {
 	// ensure global.EntryRoot+"-new" and global.EntryRoot-"old" do not exist
 	dirEnds := []string{"-new", "-old"}
 	for i, dirEnd := range dirEnds {
@@ -63,7 +63,7 @@ func EntryRefresh(oldRCWPassphrase, newRCWPassphrase []byte, removeOldDir bool)
 		if err != nil {
 			return errors.New("unable to open \"" + targetLocation + "\" for decryption: " + err.Error())
 		}
-		decBytes, err := wrappers.Decrypt(encBytes, oldRCWPassphrase)
+		decBytes, err := wrappers.Decrypt(encBytes, oldRCWPassword)
 		decryptedEntry := strings.Split(string(decBytes), "\n")
 		if err != nil {
 			return err
@@ -91,8 +91,8 @@ func EntryRefresh(oldRCWPassphrase, newRCWPassphrase []byte, removeOldDir bool)
 			decryptedEntry = append(fieldsMain, fieldsNote...)
 		}
 
-		// re-encrypt the entry with the new passphrase
-		encBytes = wrappers.Encrypt([]byte(strings.Join(decryptedEntry, "\n")), newRCWPassphrase)
+		// re-encrypt the entry with the new password
+		encBytes = wrappers.Encrypt([]byte(strings.Join(decryptedEntry, "\n")), newRCWPassword)
 
 		// write the entry to the new directory
 		err = os.WriteFile(global.EntryRoot+"-new"+strings.ReplaceAll(entryName, "/", global.PathSeparator), encBytes, 0600)
@@ -101,7 +101,7 @@ func EntryRefresh(oldRCWPassphrase, newRCWPassphrase []byte, removeOldDir bool)
 		}
 
 		// generate new sanity check file
-		err = RCWSanityCheckGen(newRCWPassphrase)
+		err = RCWSanityCheckGen(newRCWPassword)
 		if err != nil {
 			return err
 		}

crypt/rcw.go

@@ -14,15 +14,15 @@ import (
 )
 
 var Daemonize = true
-var RetryPassphrase = true
+var RetryPassword = true
 
-// RCWDArgument reads the passphrase from stdin and caches it via an RCW daemon.
+// RCWDArgument reads the password from stdin and caches it via an RCW daemon.
 func RCWDArgument() {
-	passphrase := back.ReadFromStdin()
-	if passphrase == "" {
+	password := back.ReadFromStdin()
+	if password == "" {
 		os.Exit(0)
 	}
-	daemon.Start([]byte(passphrase))
+	daemon.Start([]byte(password))
 }
 
 // DecryptFileToSlice decrypts an RCW wrapped file and returns the contents as a slice of (trimmed) strings.
@@ -34,14 +34,14 @@ func DecryptFileToSlice(targetLocation string) ([]string, error) {
 	}
 
 	// decrypt data using RCW daemon
-	passphrase := launchRCWDProcess()
-	if passphrase == nil {
+	password := launchRCWDProcess()
+	if password == nil {
 		// if daemon is already running, use it to decrypt the data
 		return strings.Split(string(daemon.GetDec(encBytes)), "\n"), nil
 	}
 	// if the daemon is not already running, use wrappers.Decrypt
 	// directly to avoid waiting for socket file creation
-	decBytes, err := wrappers.Decrypt(encBytes, passphrase)
+	decBytes, err := wrappers.Decrypt(encBytes, password)
 	if err != nil {
 		return nil, errors.New("unable to decrypt \"" + targetLocation + "\": " + err.Error())
 	}
@@ -50,43 +50,43 @@ func DecryptFileToSlice(targetLocation string) ([]string, error) {
 
 // EncryptBytes encrypts a byte slice using RCW and returns the encrypted data.
 func EncryptBytes(decBytes []byte) []byte {
-	passphrase := launchRCWDProcess()
-	if passphrase == nil {
+	password := launchRCWDProcess()
+	if password == nil {
 		// if daemon is already running, use it to encrypt the data
 		return daemon.GetEnc(decBytes)
 	}
 	// if the daemon is not already running, use wrappers.Encrypt
 	// directly to avoid waiting for socket file creation
-	return wrappers.Encrypt(decBytes, passphrase)
+	return wrappers.Encrypt(decBytes, password)
 }
 
-// launchRCWDProcess launches an RCW daemon to cache a passphrase.
+// launchRCWDProcess launches an RCW daemon to cache a password.
 // If the daemon is not already running OR if not running in daemonize mode,
-// it collects and returns the passphrase (otherwise returns nil).
+// it collects and returns the password (otherwise returns nil).
 func launchRCWDProcess() []byte {
 	if Daemonize && daemon.IsOpen() {
 		return nil
 	}
-	var passphrase []byte
-	if RetryPassphrase {
+	var password []byte
+	if RetryPassword {
 		for {
-			passphrase = global.GetPassphrase("RCW Passphrase:")
-			err := wrappers.RunSanityCheck(global.ConfigDir+global.PathSeparator+"sanity.rcw", passphrase)
+			password = global.GetPassword("RCW Password:")
+			err := wrappers.RunSanityCheck(global.ConfigDir+global.PathSeparator+"sanity.rcw", password)
 			if err == nil {
 				break
 			}
-			fmt.Println(back.AnsiError + "Incorrect passphrase" + back.AnsiReset)
+			fmt.Println(back.AnsiError + "Incorrect password" + back.AnsiReset)
 		}
 	} else {
 		// in this mode, it is up to the client to perform the sanity check
-		passphrase = global.GetPassphrase("RCW Passphrase:")
+		password = global.GetPassword("RCW Password:")
 	}
 
 	if Daemonize {
 		cmd := exec.Command(os.Args[0], "startrcwd")
-		_ = back.WriteToStdin(cmd, string(passphrase))
+		_ = back.WriteToStdin(cmd, string(password))
 		_ = cmd.Start()
 	}
 
-	return passphrase
+	return password
 }

global/1globals.go

@@ -3,7 +3,7 @@ package global
 type ByteInputFetcher func(prompt string) []byte
 
 var (
-	GetPassphrase ByteInputFetcher // Clients should set this to a function that fetches hidden input from the user
+	GetPassword ByteInputFetcher // Clients should set this to a function that fetches hidden input from the user
 )
 
 const (

syncclient/client.go

@@ -23,7 +23,7 @@ import (
 // offlineMode (whether the client is in offline mode).
 // sshIsWindows (whether the remote server is running Windows),
 // sshEntryRoot (the root directory for entries on the remote server),
-// Only supports key-based authentication (passphrases are supported for CLI-based implementations).
+// Only supports key-based authentication (passwords are supported for CLI-based implementations).
 func GetSSHClient() (*ssh.Client, bool, bool, string, error) {
 	// get SSH config info
 	sshUserConfig, err := cfg.ParseConfig([][2]string{{"LIBMUTTON", "offlineMode"}, {"LIBMUTTON", "sshUser"}, {"LIBMUTTON", "sshIP"}, {"LIBMUTTON", "sshPort"}, {"LIBMUTTON", "sshKey"}, {"LIBMUTTON", "sshKeyProtected"}, {"LIBMUTTON", "sshEntryRoot"}, {"LIBMUTTON", "sshIsWindows"}})
@@ -70,7 +70,7 @@ func GetSSHClient() (*ssh.Client, bool, bool, string, error) {
 	if keyFileProtected != "true" {
 		parsedKey, err = ssh.ParsePrivateKey(key)
 	} else {
-		parsedKey, err = ssh.ParsePrivateKeyWithPassphrase(key, global.GetPassphrase("Enter passphrase for your SSH keyfile:"))
+		parsedKey, err = ssh.ParsePrivateKeyWithPassphrase(key, global.GetPassword("Enter password for your SSH keyfile:"))
 	}
 	if err != nil {
 		return nil, false, false, "", errors.New("unable to parse private key: " + keyFile)

wiki/developers.md

@@ -16,12 +16,12 @@ These are as follows:
 - `termux`: Allows creating an Android binary that can interact with the Termux clipboard (for Android)
 
 ## Required Global Variable Manipulation
-- `global.GetPassphrase` must be set to allow for different types of clients (CLI, GUI, TUI) to prompt for the passphrase in the most appropriate way.
-- `crypt.Daemonize`, true by default, determines whether to make use of the RCW daemon for passphrase caching. This may be best to disable for interactive clients.
+- `global.GetPassword` must be set to allow for different types of clients (CLI, GUI, TUI) to prompt for the password in the most appropriate way.
+- `crypt.Daemonize`, true by default, determines whether to make use of the RCW daemon for password caching. This may be best to disable for interactive clients.
 
 ## Required Arguments
 - `clipclear`: Should be accepted by all non-interactive CLI libmutton implementations (not required for interactive GUI/TUI implementations). In order to clear the clipboard on a timer, non-interactive libmutton-based password managers call another instance of their executable with the `clipclear` argument (e.g. `mutn clipclear`) with the intended clipboard contents provided via STDIN. If after 30 seconds the clipboard contents have not changed, they are cleared. Please accept a `clipclear` argument that calls `core.ClipClearArgument()`.
-- `startrcwd`: Should be accepted by all libmutton implementations making use of the RCW daemon to cache passphrases. Please accept a `startrcwd` argument that calls `core.RCWDArgument()`.
+- `startrcwd`: Should be accepted by all libmutton implementations making use of the RCW daemon to cache passwords. Please accept a `startrcwd` argument that calls `core.RCWDArgument()`.
 
 ## Configuration
 libmutton-based password manager clients should all share the same INI configuration file.