gohash

package module
v0.0.0-...-4aaf49e Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 11, 2024 License: MIT Imports: 52 Imported by: 0

README

About

GoDoc

Command line tools and library to work with hashes and various encodings.

Compatibility: All platforms supported by go, notably Linux, macOS and Windows.

Commands

coder encode / decode pipes or files between various encodings

hasher calculate hashes from stdin or files

findhash search for plaintext matching known hashes

Install everything

See Releases for binary packages for macOS and Windows. To compile from source with the go toolchain:

go get -u github.com/martinlindhe/gohash/...

Library example

import "github.com/martinlindhe/gohash"

func ExampleNewCalculator() {
	r := strings.NewReader("hello world")
	calc := NewCalculator(r)
	h, _ := calc.Sum("sha1")
	fmt.Printf("%x", h)
	// Output: 2aae6c35c94fcfb415dbe95f408b9ce91ee846ed
}

Hash algorithms

Set algo with hasher <id>, list all supported hashes with hasher --list-hashes

id Algorithm key size key size year
adler32 Adler-32 32 bit 4 byte 1995
blake224 BLAKE-224 224 bit 28 byte 2008
blake256 BLAKE-256 256 bit 32 byte 2008
blake384 BLAKE-384 384 bit 48 byte 2008
blake512 BLAKE-512 512 bit 64 byte 2008
blake2b-512 BLAKE2b-512 512 bit 64 byte 2012
blake2s-256 BLAKE2s-256 256 bit 32 byte 2012
blake3 BLAKE3 256 bit 32 byte 2020
crc8-atm Crc-8 (ATM) 8 bit 1 byte ?
crc16-ccitt Crc-16 (CCITT) 16 bit 2 byte ?
crc16-ccitt-false Crc-16 (CCITT-False) 16 bit 2 byte ?
crc16-ibm Crc-16 (IBM) 16 bit 2 byte ?
crc16-scsi Crc-16 (SCSI) 16 bit 2 byte ?
crc24-openpgp Crc-24 (OpenPGP) 24 bit 3 byte ?
crc32-ieee Crc-32 (IEEE) 32 bit 4 byte ?
crc32-castagnoli Crc-32 (Castagnoli) 32 bit 4 byte ?
crc32-koopman Crc-32 (Koopman) 32 bit 4 byte ?
crc64-iso Crc-64 (ISO) 64 bit 8 byte ?
crc64-ecma Crc-64 (ECMA) 64 bit 8 byte ?
fnv1-32 FNV-1-32 32 bit 4 byte 1991
fnv1a-32 FNV-1a-32 32 bit 4 byte 1991
fnv1-64 FNV-1-64 64 bit 8 byte 1991
fnv1a-64 FNV-1a-64 64 bit 8 byte 1991
gost94 GOST R 34.11-94 256 bit 32 byte 1994
gost94-cryptopro GOST R 34.11-94 CryptoPro 256 bit 32 byte 2006
md2 MD2 128 bit 16 byte 1989
md4 MD4 128 bit 16 byte 1990
md5 MD5 128 bit 16 byte 1992
ripemd160 RIPEMD-160 160 bit 20 byte 1996
sha1 SHA1 160 bit 20 byte 1995
sha224 SHA2-224 224 bit 28 byte 2001
sha256 SHA2-256 256 bit 32 byte 2001
sha384 SHA2-384 384 bit 48 byte 2001
sha512 SHA2-512 512 bit 64 byte 2001
sha512-224 SHA2-512/224 224 bit 28 byte 2001
sha512-256 SHA2-512/256 256 bit 32 byte 2001
sha3-224 SHA3-224 224 bit 28 byte 2015
sha3-256 SHA3-256 256 bit 32 byte 2015
sha3-384 SHA3-384 384 bit 48 byte 2015
sha3-512 SHA3-512 512 bit 64 byte 2015
shake128-256 SHA3-SHAKE128 256 bit 32 byte 2015
shake256-512 SHA3-SHAKE256 512 bit 64 byte 2015
siphash-2-4 SipHash-2-4 64 bit 8 byte 2012
skein512-256 Skein-512-256 256 bit 32 byte 2008?
skein512-512 Skein-512-512 512 bit 64 byte 2008?
streebog-256 GOST R 34.11-2012-256 256 bit 32 byte 2012
streebog-512 GOST R 34.11-2012-512 512 bit 64 byte 2012
tiger192 Tiger 192 bit 24 byte 1996
whirlpool Whirlpool 512 bit 64 byte 2000
xxh64 xxHash 64 64 bit 4 byte 2012

Binary-to-text encodings

Set algo with hasher --encoding=<id>, list all supported encodings with hasher --list-encodings

id Algorithm
ascii85 Ascii-85
base32 Base-32
base36 Base-36
base58 Base-58
base64 Base-64
base91 Base-91
bubblebabble Bubble Babble
binary Binary "1010"
decimal Decimal "13 0 99"
hex Hex "3f997a"
hexup Hex "3F997A"
octal Octal "0129 0226 0120"
uu Uuencoded "%:&5L;&"
z85 Z85

License

Under MIT

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func AvailableEncodings 

func AvailableEncodings() []string

AvailableEncodings returns the available encoding id's

func AvailableHashes 

func AvailableHashes() []string

AvailableHashes returns the available hash id's

func RecodeInput 

func RecodeInput(encodings []string, r io.Reader, decode bool, verbose bool) ([]byte, error)

RecodeInput processes input `data` according to encodings, used by cmd/coder

Types

type AppInputData 

type AppInputData struct {
	Reader io.Reader
	IsPipe bool
}

AppInputData is the captured input to the app, either from a pipe or a file

func ReadPipeOrFile 

func ReadPipeOrFile(fileName string) (*AppInputData, error)

ReadPipeOrFile reads from stdin if pipe exists, else from provided file

type Calculator 

type Calculator struct {
	// contains filtered or unexported fields
}

Calculator is used to calculate hash of input cleartext

func NewCalculator 

func NewCalculator(reader io.Reader) *Calculator

NewCalculator creates a new Calculator

Example 
r := strings.NewReader("hello world")
calc := NewCalculator(r)
h, _ := calc.Sum("sha1")
fmt.Printf("%x", h)

Output:

2aae6c35c94fcfb415dbe95f408b9ce91ee846ed

func (*Calculator) Sum 

func (c *Calculator) Sum(algo string) ([]byte, error)

Sum returns the checksum

type Coder 

type Coder struct {
	// contains filtered or unexported fields
}

Coder is used to encode and decode various binary-to-text encodings

func NewCoder 

func NewCoder(encoding string) *Coder

NewCoder creates a new Coder

func (*Coder) Decode 

func (c *Coder) Decode(r io.Reader) ([]byte, error)

Decode decodes `r` from some encoding

func (*Coder) Encode 

func (c *Coder) Encode(r io.Reader) ([]byte, error)

Encode encodes `r` into some encoding

type Dictionary 

type Dictionary struct {
	// contains filtered or unexported fields
}

Dictionary is used to find cleartext for checksum in `expected`, using dictionary and any algorithm with matching bitsize

func NewDictionary 

func NewDictionary(dictFileName string) (*Dictionary, error)

NewDictionary creates a new Dictionary

func (*Dictionary) ExpectedHash 

func (d *Dictionary) ExpectedHash(expected string)

ExpectedHash sets the expected hash

func (*Dictionary) Find 

func (d *Dictionary) Find() (string, string, error)

Find searches for a cleartext for expected hash

func (*Dictionary) Prefix 

func (d *Dictionary) Prefix(s string)

Prefix sets a fixed prefix

func (*Dictionary) Suffix 

func (d *Dictionary) Suffix(s string)

Suffix sets a fixed suffix

type Hasher 

type Hasher struct {
	// contains filtered or unexported fields
}

Hasher is used to find cleartext for checksum in `expected`, using algorithm in `algo`

func NewHasher 

func NewHasher() *Hasher

NewHasher returns a new Hasher

func (*Hasher) Algo 

func (h *Hasher) Algo(algo string)

Algo sets the hash algorithm ("sha1", "sha512")

func (*Hasher) AllowedKeys 

func (h *Hasher) AllowedKeys(s string)

AllowedKeys sets the allowed keys

func (*Hasher) ExpectedHash 

func (h *Hasher) ExpectedHash(expected string)

ExpectedHash sets the expected hash

func (*Hasher) FindRandom 

func (h *Hasher) FindRandom() (string, error)

FindRandom uses random brute force to attempt to find by luck

func (*Hasher) FindSequential 

func (h *Hasher) FindSequential() (string, error)

FindSequential calcs all possible combinations of keys of given length

func (*Hasher) GetAllowedKeys 

func (h *Hasher) GetAllowedKeys() string

GetAllowedKeys returns the allowed keys

func (*Hasher) Length 

func (h *Hasher) Length(len int)

Length sets the length of key to find

func (*Hasher) MaxLength 

func (h *Hasher) MaxLength(len int)

MaxLength sets max length of key to find

func (*Hasher) MinLength 

func (h *Hasher) MinLength(len int)

MinLength sets min length of key to find

func (*Hasher) Prefix 

func (h *Hasher) Prefix(s string)

Prefix sets a fixed prefix

func (*Hasher) Reverse 

func (h *Hasher) Reverse(b bool)

Reverse sets wether to do sequential find in reverse order

func (*Hasher) Suffix 

func (h *Hasher) Suffix(s string)

Suffix sets a fixed suffix

Source Files

View all Source files

Directories

Path Synopsis
cmd
coder
findhash
hasher

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.