Documentation
¶
Overview ¶
Package utils provides utility functions for the application.
Index ¶
- func CheckASCIIString(str string) bool
- func CheckAreArraysEqual(a, b []string) bool
- func CheckAreMapsEqual(a, b map[string]int) bool
- func CheckHexString(s string) bool
- func CombineMaps(maps ...map[string]int) map[string]int
- func ConvertMultiByteCharToIteratingRule(index int, str string) string
- func ConvertMultiByteCharToRule(str string) string
- func GenerateNGrams(text string, n int) []string
- func GeneratePassphrase(text string, n int) []string
- func GetFilesInDirectory(dir string) ([]string, error)
- func GetMemoryUsage() float64
- func IncrementIteratingRuleCall(s string) string
- func IsFileSystemDirectory(path string) bool
- func IsValidFile(path string) bool
- func LoadStdinToMap(scanner models.Scanner) (map[string]int, error)
- func ReadFilesToMap(fs models.FileSystem, filenames []string) map[string]int
- func ReverseString(s string) string
- func SplitBySeparatorString(s string, sep string) []string
- func TrackLoadTime(done <-chan bool, work string)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckASCIIString ¶
CheckASCIIString checks to see if a string only contains ascii characters.
Args:
str (string): Input string to check
Returns:
(bool): If the string only contained ASCII characters
func CheckAreArraysEqual ¶
CheckAreArraysEqual checks if two arrays are equal by comparing the length of the arrays and the values of the elements in the arrays. If the arrays are equal, the function returns true, otherwise it returns false.
Args: a ([]string): The first array to compare b ([]string): The second array to compare
Returns: bool: True if the arrays are equal, false otherwise
func CheckAreMapsEqual ¶
CheckAreMapsEqual checks if two maps are equal by comparing the length of the maps and the values of the keys in the maps. If the maps are equal, the function returns true, otherwise it returns false.
Args:
a (map[string]int): The first map to compare b (map[string]int): The second map to compare
Returns:
bool: True if the maps are equal, false otherwise
func CheckHexString ¶
CheckHexString is used to identify plaintext in the $HEX[...] format
Args:
s (str): The string to be evaluated
Returns:
(bool): Returns true if it matches and false if it did not
func CombineMaps ¶
CombineMaps combines any number of maps into a single map combining values for common keys and returning a new map
Args: maps ([]map[string]int): The maps to combine
Returns: map[string]int: A new map combining the values of the input maps
func ConvertMultiByteCharToIteratingRule ¶
ConvertMultiByteCharToIteratingRule converts non-ascii characters to a hashcat valid format for rule.CharToIteratingRule functions.
Args:
index (int): Index to start the iteration str (string): Input string to transform
Returns:
returnStr (string): Converted string
func ConvertMultiByteCharToRule ¶
ConvertMultiByteCharToRule converts non-ascii characters to a hashcat valid format for rule.CharToRule functions.
Args:
str (string): Input string to transform
Returns:
returnStr (string): Converted string
func GenerateNGrams ¶
GenerateNGrams generates n-grams from a string of text and returns a slice of n-grams
Args: text (string): The text to generate n-grams from n (int): The number of words in each n-gram
Returns: []string: A slice of n-grams
func GeneratePassphrase ¶
GeneratePassphrase generates a passphrase from a string of text and returns a slice of passphrases
Args: text (string): The text to generate passphrases from n (int): The number of words in the passphrase
Returns: []string: A slice of passphrases
func GetFilesInDirectory ¶
GetFilesInDirectory returns a slice of files in a directory by reading the directory and appending the files to a slice if they are not directories
Args: dir (string): The directory to read
Returns: []string: A slice of files in the directory
func GetMemoryUsage ¶
func GetMemoryUsage() float64
GetMemoryUsage returns the current memory usage in megabytes
func IncrementIteratingRuleCall ¶
IncrementIteratingRuleCall increments the last character of a string for rules.CharToIteratingRules functions
For example, "i4" will be incremented to "i5", "iA" will be incremented to "IB"
Args:
s (string): Input string to increment
Returns:
output (string): Incremented string
func IsFileSystemDirectory ¶
IsFileSystemDirectory checks to see if a string is a valid file system directory by checking if the path exists and if it is a directory
Args:
path (string): The path to check
Returns:
bool: True if the path is a directory, false otherwise
func IsValidFile ¶
IsValidFile checks if a file exists and is not a directory by checking if the file exists
Args: path (string): The path to the file
Returns: bool: True if the file is valid, false otherwise
func LoadStdinToMap ¶
LoadStdinToMap reads the contents of stdin and returns a map[string]int where the key is the line and the value is the frequency of the line in the input
Args:
scanner (models.Scanner): The scanner to read from stdin
Returns:
map[string]int: A map of lines from stdin error: An error if one occurred
func ReadFilesToMap ¶
func ReadFilesToMap(fs models.FileSystem, filenames []string) map[string]int
ReadFilesToMap reads the contents of the multiple files and returns a map of words
Args:
fs (FileSystem): The filesystem to read the files from (used for testing) filenames ([]string): The names of the files to read
Returns:
(map[string]int): A map of words from the files
func ReverseString ¶
ReverseString will return a string in reverse
Args:
str (string): Input string to transform
Returns:
(string): Transformed string
func SplitBySeparatorString ¶
SplitBySeparatorString splits a string by a separator string and returns a slice with the separator string included
Args:
s (string): The string to split sep (string): The separator string
Returns:
[]string: A slice of strings with the separator string included
func TrackLoadTime ¶
TrackLoadTime tracks the time it takes to load the input and prints the time
Args: done (chan bool): channel to use to track tasks work (string): string used in status printing
Returns: None
Types ¶
This section is empty.
Source Files