9 Commits
9 changed files with 115 additions and 90 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
MIT License
Copyright (c) 2025 Randall Winkhart
Copyright (c) 2025-2026 Randall Winkhart
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
+10 -7
View File
@@ -6,10 +6,12 @@ import (
"io"
"os"
"os/exec"
"github.com/rwinkhart/go-boilerplate/security"
)
// WriteToStdin is a utility function that writes a string to a command's stdin.
func WriteToStdin(cmd *exec.Cmd, input string) error {
// WriteToStdin is a utility function that writes a byte slice to a command's stdin.
func WriteToStdinAndZeroizeInput(cmd *exec.Cmd, input []byte) error {
stdin, err := cmd.StdinPipe()
if err != nil {
return errors.New("unable to access stdin for system command: " + err.Error())
@@ -18,16 +20,17 @@ func WriteToStdin(cmd *exec.Cmd, input string) error {
defer func(stdin io.WriteCloser) {
_ = stdin.Close() // error ignored; if stdin could be accessed, it can probably be closed
}(stdin)
_, _ = io.WriteString(stdin, input)
_, _ = stdin.Write(input)
security.ZeroizeBytes(input)
}()
return nil
}
// ReadFromStdin is a utility function that reads a string from stdin.
func ReadFromStdin() string {
// ReadFromStdin is a utility function that reads a byte slice from stdin.
func ReadFromStdin() []byte {
scanner := bufio.NewScanner(os.Stdin)
if scanner.Scan() {
return scanner.Text()
return scanner.Bytes()
}
return ""
return nil
}
-58
View File
@@ -1,58 +0,0 @@
package front
import (
"bufio"
"fmt"
"os"
"strings"
"golang.org/x/term"
)
// Input prompts the user for input and returns the input as a string.
func Input(prompt string) string {
fmt.Print("\n" + prompt + " ")
reader := bufio.NewReader(os.Stdin)
userInput, _ := reader.ReadString('\n')
return strings.TrimRight(userInput, "\n\r ") // remove trailing newlines, carriage returns, and spaces
}
// InputHidden prompts the user for input and returns the input as a byte array, hiding the input from the terminal.
func InputHidden(prompt string) []byte {
fmt.Print("\n" + prompt + " ")
byteInput, _ := term.ReadPassword(int(os.Stdin.Fd()))
fmt.Println()
return byteInput
}
// InputBinary prompts the user with a yes/no question and returns the response as a boolean.
func InputBinary(prompt string) bool {
reader := bufio.NewReader(os.Stdin)
fmt.Print("\n" + prompt + " (y/N) ")
char, _, _ := reader.ReadRune()
if char == 'y' || char == 'Y' {
return true
}
return false
}
// InputInt prompts the user for input and returns the input as an integer.
// A negative min/max value will disable the respective limit.
func InputInt(prompt string, min, max int) int {
for {
fmt.Print("\n" + prompt + " ")
var userInput int
_, err := fmt.Scanln(&userInput)
if err == nil && (userInput >= min || min < 0) && (userInput <= max || max < 0) {
return userInput
}
}
}
// InputMenuGen prompts the user with a menu and returns the user's choice as an integer.
func InputMenuGen(prompt string, options []string) int {
for i, option := range options {
fmt.Printf("%d. %s\n", i+1, option)
}
return InputInt(prompt, 1, len(options))
}
+43
View File
@@ -0,0 +1,43 @@
package front
import (
"bufio"
"fmt"
"os"
"strings"
)
// Input prompts the user for input and
// returns the input as a string.
func Input(prompt string) string {
fmt.Print(prompt + " ")
reader := bufio.NewReader(os.Stdin)
userInput, _ := reader.ReadString('\n')
return strings.TrimRight(userInput, "\n\r ") // remove trailing newlines, carriage returns, and spaces
}
// InputBinary prompts the user with a yes/no
// question and returns the response as a boolean.
func InputBinary(prompt string) bool {
reader := bufio.NewReader(os.Stdin)
fmt.Print(prompt + " (y/N) ")
char, _, _ := reader.ReadRune()
if char == 'y' || char == 'Y' {
return true
}
return false
}
// InputInt prompts the user for input and returns the input as an integer.
// A negative min/max value will disable the respective limit.
func InputInt(prompt string, min, max int) int {
for {
fmt.Print(prompt + " ")
var userInput int
_, err := fmt.Scanln(&userInput)
if err == nil && (userInput >= min || min < 0) && (userInput <= max || max < 0) {
return userInput
}
fmt.Println()
}
}
+26
View File
@@ -0,0 +1,26 @@
package front
import (
"fmt"
"os"
"golang.org/x/term"
)
// InputMenuGen prompts the user with a menu
// and returns the user's choice as an integer.
func InputMenuGen(prompt string, options []string) int {
for i, option := range options {
fmt.Printf("%d. %s\n", i+1, option)
}
return InputInt("\n"+prompt, 1, len(options))
}
// InputSecret prompts the user for input and returns the
// input as a byte array, hiding the input from the terminal.
func InputSecret(prompt string) []byte {
fmt.Print(prompt + " ")
byteInput, _ := term.ReadPassword(int(os.Stdin.Fd()))
fmt.Println()
return byteInput
}
+3 -3
View File
@@ -1,7 +1,7 @@
module github.com/rwinkhart/go-boilerplate
go 1.25.5
go 1.25.7
require golang.org/x/term v0.38.0
require golang.org/x/term v0.40.0
require golang.org/x/sys v0.39.0 // indirect
require golang.org/x/sys v0.41.0 // indirect
+4 -4
View File
@@ -1,4 +1,4 @@
golang.org/x/sys v0.39.0 h1:CvCKL8MeisomCi6qNZ+wbb0DN9E5AATixKsvNtMoMFk=
golang.org/x/sys v0.39.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
golang.org/x/term v0.38.0 h1:PQ5pkm/rLO6HnxFR7N2lJHOZX6Kez5Y1gDSJla6jo7Q=
golang.org/x/term v0.38.0/go.mod h1:bSEAKrOT1W+VSu9TSCMtoGEOUcKxOKgl3LE5QEF/xVg=
golang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k=
golang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
golang.org/x/term v0.40.0 h1:36e4zGLqU4yhjlmxEaagx2KuYbJq3EwY8K943ZsHcvg=
golang.org/x/term v0.40.0/go.mod h1:w2P8uVp06p2iyKKuvXIm7N/y0UCRt3UfJTfZ7oOpglM=
+17 -17
View File
@@ -1,20 +1,20 @@
package stringy
package security
import (
"bytes"
"crypto/rand"
"fmt"
"math"
"math/big"
"strings"
)
// StringGen generates a random string of a specified length and complexity.
// Requires: complexity (minimum percentage of special characters to be returned in the generated string; set to 0 to generate a simple string),
// BytesGen generates a random byte slice of a specified length and complexity.
// Requires: complexity (minimum percentage of special characters to be returned in the generated output; set to 0 for a "simple" result),
// complexCharsetLevel (1 = safe for filenames, 2 = safe for most password entries, 3 = safe only for well-made password entries)
func StringGen(length int, complexity float64, complexCharsetLevel uint8) string {
var actualSpecialChars int // track the number of special characters in the generated string
func BytesGen(length int, complexity float64, complexCharsetLevel uint8) []byte {
var actualSpecialChars int // track the number of special characters in the generated output
var minSpecialChars int // track the minimum number of special characters to accept
var extendedCharset string // additions to character set used for complex strings
var extendedCharset string // additions to character set used for complex outputs
charset := "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789" // default character set used for all strings
const extendedCharsetFiles = "!#$%&+,-.;=@_~^()[]{}`'" // additional special characters for complex strings (safe in file names)
@@ -34,34 +34,34 @@ func StringGen(length int, complexity float64, complexCharsetLevel uint8) string
charset += extendedCharset
}
// loop until a string of the desired complexity is generated
// loop until a byte slice of the desired complexity is generated
for {
// generate a random string
// generate a random output
result := make([]byte, length)
for i := range result {
val, _ := rand.Int(rand.Reader, big.NewInt(int64(len(charset))))
result[i] = charset[val.Int64()]
}
// return early if the string is not complex
// return early if the desired output is not complex
if complexity <= 0 {
return string(result)
return result
}
// count the number of special characters in the generated string
for _, char := range string(result) {
if strings.ContainsRune(extendedCharset, char) {
// count the number of special characters in the generated output
for i := range result {
if bytes.Contains([]byte(extendedCharset), []byte{result[i]}) {
actualSpecialChars++
}
}
// return the generated string if it contains enough special characters
// return the generated output if it contains enough special characters
if actualSpecialChars >= minSpecialChars {
return string(result)
return result
}
// reset special character counter
fmt.Println("Regenerating string until desired complexity is achieved...")
fmt.Println("Regenerating output until desired complexity is achieved...")
actualSpecialChars = 0
}
}
+11
View File
@@ -0,0 +1,11 @@
package security
// ZeroizeBytes overwrites all
// bytes in a slice with zeros.
//
//go:noinline
func ZeroizeBytes(input []byte) {
for i := range input {
input[i] = 0
}
}