mirror of
https://github.com/wneessen/apg-go.git
synced 2024-09-12 00:12:47 +02:00
Winni Neessen
79f921f9ad
This commit introduces the .gitignore configuration file and adds SPDX headers to several files including test and documentation files. The headers provide license information in a standardized format which can be easily picked up by automated tools for license compliance checks. Additionally, it deleted a .idea/.gitignore file, which is a project specific IDE configuration file not necessary for the repository. It also introduced a README.md file providing more insightful information about the project.
142 lines
3 KiB
Go
142 lines
3 KiB
Go
// SPDX-FileCopyrightText: 2021-2024 Winni Neessen <wn@neessen.dev>
|
|
//
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package apg
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
)
|
|
|
|
var (
|
|
symbNumNames = map[byte]string{
|
|
'1': "ONE",
|
|
'2': "TWO",
|
|
'3': "THREE",
|
|
'4': "FOUR",
|
|
'5': "FIVE",
|
|
'6': "SIX",
|
|
'7': "SEVEN",
|
|
'8': "EIGHT",
|
|
'9': "NINE",
|
|
'0': "ZERO",
|
|
33: "EXCLAMATION_POINT",
|
|
34: "QUOTATION_MARK",
|
|
35: "CROSSHATCH",
|
|
36: "DOLLAR_SIGN",
|
|
37: "PERCENT_SIGN",
|
|
38: "AMPERSAND",
|
|
39: "APOSTROPHE",
|
|
40: "LEFT_PARENTHESIS",
|
|
41: "RIGHT_PARENTHESIS",
|
|
42: "ASTERISK",
|
|
43: "PLUS_SIGN",
|
|
44: "COMMA",
|
|
45: "HYPHEN",
|
|
46: "PERIOD",
|
|
47: "SLASH",
|
|
58: "COLON",
|
|
59: "SEMICOLON",
|
|
60: "LESS_THAN",
|
|
61: "EQUAL_SIGN",
|
|
62: "GREATER_THAN",
|
|
63: "QUESTION_MARK",
|
|
64: "AT_SIGN",
|
|
91: "LEFT_BRACKET",
|
|
92: "BACKSLASH",
|
|
93: "RIGHT_BRACKET",
|
|
94: "CIRCUMFLEX",
|
|
95: "UNDERSCORE",
|
|
96: "GRAVE",
|
|
123: "LEFT_BRACE",
|
|
124: "VERTICAL_BAR",
|
|
125: "RIGHT_BRACE",
|
|
126: "TILDE",
|
|
}
|
|
alphabetNames = map[byte]string{
|
|
'A': "Alfa",
|
|
'B': "Bravo",
|
|
'C': "Charlie",
|
|
'D': "Delta",
|
|
'E': "Echo",
|
|
'F': "Foxtrot",
|
|
'G': "Golf",
|
|
'H': "Hotel",
|
|
'I': "India",
|
|
'J': "Juliett",
|
|
'K': "Kilo",
|
|
'L': "Lima",
|
|
'M': "Mike",
|
|
'N': "November",
|
|
'O': "Oscar",
|
|
'P': "Papa",
|
|
'Q': "Quebec",
|
|
'R': "Romeo",
|
|
'S': "Sierra",
|
|
'T': "Tango",
|
|
'U': "Uniform",
|
|
'V': "Victor",
|
|
'W': "Whiskey",
|
|
'X': "X_ray",
|
|
'Y': "Yankee",
|
|
'Z': "Zulu",
|
|
}
|
|
)
|
|
|
|
// Spell returns a given string as spelled english phonetic alphabet string
|
|
func Spell(input string) (string, error) {
|
|
var returnString []string
|
|
for _, curChar := range input {
|
|
curSpellString, err := ConvertByteToWord(byte(curChar))
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
returnString = append(returnString, curSpellString)
|
|
}
|
|
return strings.Join(returnString, "/"), nil
|
|
}
|
|
|
|
// Pronounce returns last generated pronounceable password as spelled syllables string
|
|
func (g *Generator) Pronounce() (string, error) {
|
|
var returnString []string
|
|
for _, syllable := range g.syllables {
|
|
isKoremutake := false
|
|
for _, x := range KoremutakeSyllables {
|
|
if x == strings.ToLower(syllable) {
|
|
isKoremutake = true
|
|
}
|
|
}
|
|
|
|
if isKoremutake {
|
|
returnString = append(returnString, syllable)
|
|
continue
|
|
}
|
|
|
|
curSpellString, err := ConvertByteToWord(syllable[0])
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
returnString = append(returnString, curSpellString)
|
|
}
|
|
return strings.Join(returnString, "-"), nil
|
|
}
|
|
|
|
// ConvertByteToWord converts a given ASCII byte into the corresponding spelled version
|
|
// of the english phonetic alphabet
|
|
func ConvertByteToWord(charByte byte) (string, error) {
|
|
var returnString string
|
|
switch {
|
|
case charByte > 64 && charByte < 91:
|
|
returnString = alphabetNames[charByte]
|
|
case charByte > 96 && charByte < 123:
|
|
returnString = strings.ToLower(alphabetNames[charByte-32])
|
|
default:
|
|
returnString = symbNumNames[charByte]
|
|
}
|
|
|
|
if returnString == "" {
|
|
return "", fmt.Errorf("failed to convert given byte to word: %s is unsupported", string(charByte))
|
|
}
|
|
return returnString, nil
|
|
}
|