Merge remote-tracking branch 'origin/main'

Author: tcpiplab

README.md

@@ -60,6 +60,9 @@ Waiting for 60 seconds before clearing the clipboard.
         Where n is the length of the password.
         Length must be the last argument.
 
+  -hex
+    	./passwordgen --hex
+    	
   -interactive
         ./passwordgen --interactive[=false]
         (default true)
@@ -194,6 +197,33 @@ PS C:\Users\somebody\Downloads> .\passwordgen-v1.3.0-windows-amd64.exe -passphra
 └────┴───────────────────────────────────────────────┘
 ```
 
+## Hexadecimal PINs
+
+Hex pins may be 4 or more characters long.
+
+```shell
+passwordgen --hex 4
+┌───┬──────┐
+│ 0 │ FC70 │
+├───┼──────┤
+│ 1 │ DA10 │
+├───┼──────┤
+│ 2 │ 2DB6 │
+├───┼──────┤
+│ 3 │ C314 │
+├───┼──────┤
+│ 4 │ D186 │
+├───┼──────┤
+│ 5 │ 5139 │
+├───┼──────┤
+│ 6 │ D760 │
+├───┼──────┤
+│ 7 │ 5B32 │
+├───┼──────┤
+│ 8 │ 48F4 │
+└───┴──────┘
+```
+
 # Building releases for multiple platforms
 
 ```shell

inputHandlers.go

@@ -16,6 +16,7 @@ func argsHandler() (
 	help *bool,
 	passPhrases *bool,
 	memorable *bool,
+	randomHex *bool,
 ) {
 	help = flag.Bool(
 		"help",
@@ -25,7 +26,7 @@ func argsHandler() (
 
 	if *help {
 		flag.Usage()
-		return nil, nil, nil, nil, nil, nil, nil, nil
+		return nil, nil, nil, nil, nil, nil, nil, nil, nil
 	}
 
 	// Interactive mode is the default
@@ -64,15 +65,20 @@ func argsHandler() (
 		false,
 		"./passwordgen --memorable\n")
 
+	randomHex = flag.Bool(
+		"hex",
+		false,
+		"./passwordgen --hex\n")
+
 	flag.Parse()
 
 	// For now the length is mandatory and must be the last arg
 	if len(os.Args) < 2 {
 
 		color.HiRed("\nPlease provide a password length as the last argument\nOr -h for help.\n")
-		return nil, nil, nil, nil, nil, nil, nil, nil
+		return nil, nil, nil, nil, nil, nil, nil, nil, nil
 	}
-	return interactive, erase, randomPasswords, wordChains, mixedPasswords, nil, passPhrases, memorable
+	return interactive, erase, randomPasswords, wordChains, mixedPasswords, nil, passPhrases, memorable, randomHex
 }
 
 func ifInteractive(interactive *bool, rows int) bool {

passwordUtils.go

@@ -9,10 +9,20 @@ import (
 	"time"
 )
 
-func randStringPassword(lengthOfRandString int) string {
+func randStringPassword(lengthOfRandString int, hexOnly bool) string {
+
+	var allowedCharacters []int32
 
 	// Set allowed characters
-	var allowedCharacters = []int32("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#^&*()[]{}%")
+	if !hexOnly {
+
+		allowedCharacters = []int32("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789!@#^&*()[]{}%")
+
+	} else {
+
+		allowedCharacters = []int32("ABCDEF0123456789")
+
+	}
 
 	// Make a list of type int32 of the length the user requested their passwords should be
 	listOfInt32Characters := make([]int32, lengthOfRandString)

passwordUtils_test.go

@@ -15,7 +15,7 @@ func TestRandStringPassword(t *testing.T) {
 	//rand.Seed(time.Now().UnixNano())
 
 	// Call the function to generate a random password string
-	password := randStringPassword(passwordLength)
+	password := randStringPassword(passwordLength, false)
 
 	// Check if the length of the generated password matches the expected length
 	assert.Equal(t, passwordLength, len(password))

passwordgen

@@ -34,7 +34,7 @@ func main() {
 
 	OS = detectOS()
 
-	interactive, erase, randomPasswords, wordChains, mixedPasswords, _, passPhrases, memorable := argsHandler()
+	interactive, erase, randomPasswords, wordChains, mixedPasswords, _, passPhrases, memorable, randomHex := argsHandler()
 	//if *done {
 	//	return
 	//}
@@ -47,7 +47,7 @@ func main() {
 
 		// Check for password length and return errors if needed
 		// For now the length is mandatory and must be the last arg
-		if checkPasswordLength(requestedPasswordLength) {
+		if checkPasswordLength(requestedPasswordLength, randomHex) {
 			return
 		}
 	}
@@ -87,18 +87,22 @@ func main() {
 
 		*randomPasswords = false
 	}
+	if *randomHex {
+
+		*randomPasswords = false
+	}
 
 	arrayPasswords := make([]string, rows)
 
 	if OS == "darwin" || OS == "linux" || OS == "unix" {
 
 		// Fill the screen with passwords
-		arrayPasswords = printPasswordTableUnix(arrayPasswords, *randomPasswords, *wordChains, *mixedPasswords, *passPhrases, *memorable)
+		arrayPasswords = printPasswordTableUnix(arrayPasswords, *randomPasswords, *wordChains, *mixedPasswords, *passPhrases, *memorable, *randomHex)
 
 	} else if OS == "windows" {
 
 		// Fill the screen with passwords
-		arrayPasswords = printPasswordTableUnix(arrayPasswords, *randomPasswords, *wordChains, *mixedPasswords, *passPhrases, *memorable)
+		arrayPasswords = printPasswordTableUnix(arrayPasswords, *randomPasswords, *wordChains, *mixedPasswords, *passPhrases, *memorable, *randomHex)
 		//arrayPasswords = printPasswordTableWindows(
 		//	rows,
 		//	requestedPasswordLength,

passwordgen.go

@@ -175,7 +175,7 @@ func printPasswordTableWindows(
 // - requestedPasswordLength: an int specifying the length of each password to generate
 // - arrayPasswords: a slice of strings representing the passwords to be populated
 // Returns: nothing
-func printPasswordTableUnix(arrayPasswords []string, randomPasswords bool, wordChains bool, mixedPasswords bool, passPhrases bool, memorable bool) []string {
+func printPasswordTableUnix(arrayPasswords []string, randomPasswords bool, wordChains bool, mixedPasswords bool, passPhrases bool, memorable bool, randomHex bool) []string {
 
 	if passPhrases {
 
@@ -196,6 +196,11 @@ func printPasswordTableUnix(arrayPasswords []string, randomPasswords bool, wordC
 	} else if memorable {
 
 		arrayPasswords = printMemorableTable()
+
+	} else if randomHex {
+
+		arrayPasswords = printRandomHexTable()
+
 	}
 
 	return arrayPasswords
@@ -447,7 +452,7 @@ func printRandomPasswordsTable() []string {
 	// Loop through the console screen height and print a table of random passwords
 	for i := 0; i < (consoleHeight/2)-1; i++ {
 
-		randomPasswordNoColor := randStringPassword(requestedPasswordLength)
+		randomPasswordNoColor := randStringPassword(requestedPasswordLength, false)
 
 		// Colorize the random password that we're saving to the array
 		// The following works on all platforms but no color renders on Windows
@@ -515,3 +520,49 @@ func printMemorableTable() []string {
 	// clipboard functions if we're in interactive mode.
 	return arrayOfMemorablePasswords
 }
+
+func printRandomHexTable() []string {
+	// TODO this function could be combined with printRandomPasswordTable() in some way
+
+	var consoleHeight int
+
+	// Set the console height
+	consoleHeight = funcName(consoleHeight)
+
+	// Instantiate a new table writer object
+	tableWriter := table.NewWriter()
+	tableWriter.SetOutputMirror(os.Stdout)
+
+	// Create a new empty array with the same length as the original array
+	// This avoids leftover empty array elements causing clipboard copy
+	// failures later on.
+	arrayOfRandomHex := make([]string, consoleHeight/2)
+
+	// Loop through the console screen height and print a table of random hex passwords
+	for i := 0; i < (consoleHeight/2)-1; i++ {
+
+		// TODO: Call a new function for randStringHex() here
+		randomHexNoColor := randStringPassword(requestedPasswordLength, true)
+
+		// Colorize the random hex passwords that we're saving to the array
+		// The following works on all platforms but no color renders on Windows
+		randomHexColorized := colorizeCharactersUnix(randomHexNoColor, false)
+
+		// Append the random hex password to the array to be used by the clipboard if in interactive mode
+		arrayOfRandomHex[i] = randomHexNoColor
+
+		// Prepare color for the index number
+		red := color.New(color.FgHiRed).SprintfFunc()
+
+		// Print the index number and current element of the array
+		tableWriter.AppendRow([]interface{}{red("%d", i), randomHexColorized})
+
+		tableWriter.AppendSeparator()
+	}
+	tableWriter.SetStyle(table.StyleLight)
+	tableWriter.Render()
+
+	// Return the array because it's needed for the
+	// clipboard functions if we're in interactive mode.
+	return arrayOfRandomHex
+}

printUtils.go

@@ -111,14 +111,25 @@ func detectOS() string {
 //
 //	Returns:
 //	  - a boolean value indicating if the password length is valid or not
-func checkPasswordLength(requestedPasswordLength int) bool {
+func checkPasswordLength(requestedPasswordLength int, randomHex *bool) bool {
 
-	// Convert requestedPasswordLength to an integer if needed
-	if int(requestedPasswordLength) < 8 {
+	if *randomHex {
 
-		color.HiRed("\nPassword length must be 8 or longer.\n\n")
-		return true
+		if int(requestedPasswordLength) < 4 {
+
+			color.HiRed("\nHex PIN length must be 4 or longer.\n\n")
+			return true
+		}
+
+	} else if !*randomHex {
+
+		if int(requestedPasswordLength) < 8 {
+
+			color.HiRed("\nPassword length must be 8 or longer.\n\n")
+			return true
+		}
 	}
+
 	//else if int(requestedPasswordLength) > 255 {
 	//	// Use passwordLength as an integer
 	//	requestedPasswordLength = 10