hashing

Documentation

Overview

Package hashing provides utilities for calculating hashes.

Index

• Constants
• func CalculateHash(text, htype string) string
• func CalculateMD5Hash(text string) string
• func CalculateStringHash(hashingAlgo IHash, text string) string
• func HasLikelyHexHashStringEntropy(str string) bool
• func IsLikelyHexHashString(str string) bool
• type IHash
  • func NewBespokeHashingAlgorithm(algorithm hash.Hash) (IHash, error)
  • func NewHashingAlgorithm(htype string) (IHash, error)

Constants

const (
	HashMd5       = "MD5"
	HashSha256    = "SHA256"
	HashSha1      = "SHA1"
	HashMurmur    = "Murmur"
	HashXXHash    = "xxhash"     // https://github.com/OneOfOne/xxhash
	HashBlake2256 = "blake2b256" // https://www.blake2.net/
)

Functions

func CalculateHash

func CalculateHash(text, htype string) string

CalculateHash calculates the hash of some text using the requested htype hashing algorithm.

func CalculateMD5Hash

func CalculateMD5Hash(text string) string

func CalculateStringHash

func CalculateStringHash(hashingAlgo IHash, text string) string

CalculateStringHash returns the hash of some text using a particular hashing algorithm

func HasLikelyHexHashStringEntropy

func HasLikelyHexHashStringEntropy(str string) bool

HasLikelyHexHashStringEntropy states whether a string has an entropy which may entail it is a hexadecimal hash This is based on the work done by `detect-secrets` https://github.com/Yelp/detect-secrets/blob/2fc0e31f067af98d97ad0f507dac032c9506f667/detect_secrets/plugins/high_entropy_strings.py#L150

func IsLikelyHexHashString

func IsLikelyHexHashString(str string) bool

IsLikelyHexHashString determines whether the string is likely to be a hexadecimal hash or not.

Types

type IHash

type IHash interface {
	Calculate(reader io.Reader) (string, error)
	CalculateWithContext(ctx context.Context, reader io.Reader) (string, error)
	GetType() string
}

IHash defines a hashing algorithm.

func NewBespokeHashingAlgorithm

func NewBespokeHashingAlgorithm(algorithm hash.Hash) (IHash, error)

NewBespokeHashingAlgorithm defines a bespoke hashing algorithm

func NewHashingAlgorithm

func NewHashingAlgorithm(htype string) (IHash, error)