wneessen/apg-go
1
1
Fork 0
mirror of https://github.com/wneessen/apg-go.git synced 2024-09-19 03:12:47 +02:00
Code Issues Projects Releases Packages Wiki Activity

Improve code readability by refactoring variable names

Browse source 
Several variable names have been changed in 'random.go' to improve overall readability and code comprehension. Additionally, a typo was fixed and a new constant was introduced for the maximum value of Int32, to replace previously hard-coded values. The adjustments not only make the code more digestible, but also adhere to good coding practices.
This commit is contained in:
Winni Neessen 2024-03-07 23:22:28 +01:00
parent 8f8e439f56
commit e17da1a2c9
Signed by: wneessen
GPG key ID: 5F3AF39B820C119D
3 changed files with 92 additions and 82 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
mode.go
View file

@ -88,7 +88,6 @@ func ModesFromFlags(ms string) ModeMask {
}
return mm
}
// String satisfies the fmt.Stringer interface for the Mode type

45
mode_test.go
View file

@ -45,30 +45,43 @@ func TestModesFromFlags(t *testing.T) {
ms string
mode []Mode
}{
{"ModeComplex", "C", []Mode{ModeLowerCase, ModeNumeric, ModeSpecial,
ModeUpperCase}},
{"ModeComplex", "C", []Mode{
ModeLowerCase, ModeNumeric, ModeSpecial,
ModeUpperCase,
}},
{"ModeHumanReadable", "H", []Mode{ModeHumanReadable}},
{"ModeLowerCase", "L", []Mode{ModeLowerCase}},
{"ModeNumeric", "N", []Mode{ModeNumeric}},
{"ModeUpperCase", "U", []Mode{ModeUpperCase}},
{"ModeSpecial", "S", []Mode{ModeSpecial}},
{"ModeLowerSpecialUpper", "LSUH", []Mode{ModeHumanReadable,
ModeLowerCase, ModeSpecial, ModeUpperCase}},
{"ModeComplexNoHumanReadable", "Ch", []Mode{ModeLowerCase,
ModeNumeric, ModeSpecial, ModeUpperCase}},
{"ModeComplexNoLower", "Cl", []Mode{ModeNumeric, ModeSpecial,
ModeUpperCase}},
{"ModeComplexNoNumber", "Cn", []Mode{ModeLowerCase, ModeSpecial,
ModeUpperCase}},
{"ModeComplexNoSpecial", "Cs", []Mode{ModeLowerCase, ModeNumeric,
ModeUpperCase}},
{"ModeComplexNoUpper", "Cu", []Mode{ModeLowerCase, ModeNumeric,
ModeSpecial}},
{"ModeLowerSpecialUpper", "LSUH", []Mode{
ModeHumanReadable,
ModeLowerCase, ModeSpecial, ModeUpperCase,
}},
{"ModeComplexNoHumanReadable", "Ch", []Mode{
ModeLowerCase,
ModeNumeric, ModeSpecial, ModeUpperCase,
}},
{"ModeComplexNoLower", "Cl", []Mode{
ModeNumeric, ModeSpecial,
ModeUpperCase,
}},
{"ModeComplexNoNumber", "Cn", []Mode{
ModeLowerCase, ModeSpecial,
ModeUpperCase,
}},
{"ModeComplexNoSpecial", "Cs", []Mode{
ModeLowerCase, ModeNumeric,
ModeUpperCase,
}},
{"ModeComplexNoUpper", "Cu", []Mode{
ModeLowerCase, ModeNumeric,
ModeSpecial,
}},
}
for _, tc := range tt {
t.Run(tc.name, func(t *testing.T) {
var mm ModeMask
mm = ModesFromFlags(tc.ms)
mm := ModesFromFlags(tc.ms)
for _, tm := range tc.mode {
if !MaskHasMode(mm, tm) {
t.Errorf("ModesFromFlags() failed, expected mode %q not found",

128
random.go
View file

@ -119,146 +119,146 @@ func (g *Generator) RandomStringFromCharRange(length int64, charRange string) (s
if len(charRange) < 1 {
return "", ErrInvalidCharRange
}
rs := strings.Builder{}
randString := strings.Builder{}
// As long as the length is smaller than the max. int32 value let's grow
// the string builder to the actual size, so we need less allocations
if length <= maxInt32 {
rs.Grow(int(length))
randString.Grow(int(length))
}
charRangeLength := len(charRange)
rp := make([]byte, 8)
_, err := rand.Read(rp)
randPool := make([]byte, 8)
_, err := rand.Read(randPool)
if err != nil {
return rs.String(), err
return randString.String(), err
}
for i, c, r := length-1, binary.BigEndian.Uint64(rp), letterIdxMax; i >= 0; {
if r == 0 {
_, err = rand.Read(rp)
for idx, char, rest := length-1, binary.BigEndian.Uint64(randPool), letterIdxMax; idx >= 0; {
if rest == 0 {
_, err = rand.Read(randPool)
if err != nil {
return rs.String(), err
return randString.String(), err
}
c, r = binary.BigEndian.Uint64(rp), letterIdxMax
char, rest = binary.BigEndian.Uint64(randPool), letterIdxMax
}
if idx := int(c & letterIdxMask); idx < charRangeLength {
rs.WriteByte(charRange[idx])
i--
if i := int(char & letterIdxMask); i < charRangeLength {
randString.WriteByte(charRange[i])
idx--
}
c >>= letterIdxBits
r--
char >>= letterIdxBits
rest--
}
return rs.String(), nil
return randString.String(), nil
}
// GetCharRangeFromConfig checks the Mode from the Config and returns a
// list of all possible characters that are supported by these Mode
func (g *Generator) GetCharRangeFromConfig() string {
cr := strings.Builder{}
charRange := strings.Builder{}
if MaskHasMode(g.config.Mode, ModeLowerCase) {
switch MaskHasMode(g.config.Mode, ModeHumanReadable) {
case true:
cr.WriteString(CharRangeAlphaLowerHuman)
charRange.WriteString(CharRangeAlphaLowerHuman)
default:
cr.WriteString(CharRangeAlphaLower)
charRange.WriteString(CharRangeAlphaLower)
}
}
if MaskHasMode(g.config.Mode, ModeNumeric) {
switch MaskHasMode(g.config.Mode, ModeHumanReadable) {
case true:
cr.WriteString(CharRangeNumericHuman)
charRange.WriteString(CharRangeNumericHuman)
default:
cr.WriteString(CharRangeNumeric)
charRange.WriteString(CharRangeNumeric)
}
}
if MaskHasMode(g.config.Mode, ModeSpecial) {
switch MaskHasMode(g.config.Mode, ModeHumanReadable) {
case true:
cr.WriteString(CharRangeSpecialHuman)
charRange.WriteString(CharRangeSpecialHuman)
default:
cr.WriteString(CharRangeSpecial)
charRange.WriteString(CharRangeSpecial)
}
}
if MaskHasMode(g.config.Mode, ModeUpperCase) {
switch MaskHasMode(g.config.Mode, ModeHumanReadable) {
case true:
cr.WriteString(CharRangeAlphaUpperHuman)
charRange.WriteString(CharRangeAlphaUpperHuman)
default:
cr.WriteString(CharRangeAlphaUpper)
charRange.WriteString(CharRangeAlphaUpper)
}
}
return cr.String()
return charRange.String()
}
func (g *Generator) checkMinimumRequirements(pw string) bool {
func (g *Generator) checkMinimumRequirements(password string) bool {
ok := true
if g.config.MinLowerCase > 0 {
var cr string
var charRange string
switch MaskHasMode(g.config.Mode, ModeHumanReadable) {
case true:
cr = CharRangeAlphaLowerHuman
charRange = CharRangeAlphaLowerHuman
default:
cr = CharRangeAlphaLower
charRange = CharRangeAlphaLower
}
m := 0
for _, c := range cr {
m += strings.Count(pw, string(c))
count := 0
for _, char := range charRange {
count += strings.Count(password, string(char))
}
if int64(m) < g.config.MinLowerCase {
if int64(count) < g.config.MinLowerCase {
ok = false
}
}
if g.config.MinNumeric > 0 {
var cr string
var charRange string
switch MaskHasMode(g.config.Mode, ModeHumanReadable) {
case true:
cr = CharRangeNumericHuman
charRange = CharRangeNumericHuman
default:
cr = CharRangeNumeric
charRange = CharRangeNumeric
}
m := 0
for _, c := range cr {
m += strings.Count(pw, string(c))
count := 0
for _, char := range charRange {
count += strings.Count(password, string(char))
}
if int64(m) < g.config.MinNumeric {
if int64(count) < g.config.MinNumeric {
ok = false
}
}
if g.config.MinSpecial > 0 {
var cr string
var charRange string
switch MaskHasMode(g.config.Mode, ModeHumanReadable) {
case true:
cr = CharRangeSpecialHuman
charRange = CharRangeSpecialHuman
default:
cr = CharRangeSpecial
charRange = CharRangeSpecial
}
m := 0
for _, c := range cr {
m += strings.Count(pw, string(c))
count := 0
for _, char := range charRange {
count += strings.Count(password, string(char))
}
if int64(m) < g.config.MinSpecial {
if int64(count) < g.config.MinSpecial {
ok = false
}
}
if g.config.MinUpperCase > 0 {
var cr string
var charRange string
switch MaskHasMode(g.config.Mode, ModeHumanReadable) {
case true:
cr = CharRangeAlphaUpperHuman
charRange = CharRangeAlphaUpperHuman
default:
cr = CharRangeAlphaUpper
charRange = CharRangeAlphaUpper
}
m := 0
for _, c := range cr {
m += strings.Count(pw, string(c))
count := 0
for _, char := range charRange {
count += strings.Count(password, string(char))
}
if int64(m) < g.config.MinUpperCase {
if int64(count) < g.config.MinUpperCase {
ok = false
}
}
@ -268,31 +268,29 @@ func (g *Generator) checkMinimumRequirements(pw string) bool {
// generateCoinFlip is executed when Generate() is called with Algorithm set
// to AlgoCoinFlip
func (g *Generator) generateCoinFlip() (string, error) {
switch g.CoinFlipBool() {
case true:
if g.CoinFlipBool() {
return "Heads", nil
default:
return "Tails", nil
}
return "Tails", nil
}
// generateRandom is executed when Generate() is called with Algorithm set
// to AlgoRandmom
func (g *Generator) generateRandom() (string, error) {
l, err := g.GetPasswordLength()
length, err := g.GetPasswordLength()
if err != nil {
return "", fmt.Errorf("failed to calculate password length: %w", err)
}
cr := g.GetCharRangeFromConfig()
var pw string
charRange := g.GetCharRangeFromConfig()
var password string
var ok bool
for !ok {
pw, err = g.RandomStringFromCharRange(l, cr)
password, err = g.RandomStringFromCharRange(length, charRange)
if err != nil {
return "", err
}
ok = g.checkMinimumRequirements(pw)
ok = g.checkMinimumRequirements(password)
}
return pw, nil
return password, nil
}