crypto

Documentation

Index

• func CalcChecksums(reader io.Reader, checksumType ...Algorithm) (map[Algorithm]string, error)
• func CalcChecksumsBytes(reader io.Reader, checksumType ...Algorithm) (map[Algorithm][]byte, error)
• func Decrypt(formattedCipherText, key, keyId string) (string, error)
• func Encrypt(text, key, keyId string) (string, error)
• func GenerateKeyId(key string) (string, error)
• func GenerateRandomKeyString(keySize int) (string, error)
• func GetFileChecksums(filePath string, checksumType ...Algorithm) (checksums map[Algorithm]string, err error)
• func IsTextEncrypted(formattedCipherText, key, keyId string) (bool, error)
• type Algorithm
• type Checksum
  • func CalcChecksumDetails(filePath string) (checksum Checksum, err error)
  • func (c *Checksum) IsEmpty() bool
  • func (c *Checksum) IsEqual(other Checksum) (bool, error)
• type FileDetails
  • func GetFileDetails(filePath string, includeChecksums bool) (details *FileDetails, err error)

Functions

func CalcChecksums

func CalcChecksums(reader io.Reader, checksumType ...Algorithm) (map[Algorithm]string, error)

CalcChecksums calculates all hashes at once using AsyncMultiWriter. The file is therefore read only once.

func CalcChecksumsBytes

func CalcChecksumsBytes(reader io.Reader, checksumType ...Algorithm) (map[Algorithm][]byte, error)

CalcChecksumsBytes calculates hashes like `CalcChecksums`, returns result as bytes

func Decrypt

func Decrypt(formattedCipherText, key, keyId string) (string, error)

func Encrypt

func Encrypt(text, key, keyId string) (string, error)

format encrypted text , keyId is first 6 chars of hashed(sha256) signing key {{key-id}}${{algo}}${{encrypted-value}} example: e67gef$aes256$adsad321424324fdsdfs3Rddi90oP34xV

func GenerateKeyId

func GenerateKeyId(key string) (string, error)

keyId is first 6 chars of hashed(sha256) signing key

func GenerateRandomKeyString

func GenerateRandomKeyString(keySize int) (string, error)

func GetFileChecksums

func GetFileChecksums(filePath string, checksumType ...Algorithm) (checksums map[Algorithm]string, err error)

func IsTextEncrypted

func IsTextEncrypted(formattedCipherText, key, keyId string) (bool, error)

Types

type Algorithm

type Algorithm int

const (
	MD5 Algorithm = iota
	SHA1
	SHA256
)

type Checksum

type Checksum struct {
	Sha1   string `json:"sha1,omitempty"`
	Md5    string `json:"md5,omitempty"`
	Sha256 string `json:"sha256,omitempty"`
}

func CalcChecksumDetails

func CalcChecksumDetails(filePath string) (checksum Checksum, err error)

func (*Checksum) IsEmpty

func (c *Checksum) IsEmpty() bool

func (*Checksum) IsEqual

func (c *Checksum) IsEqual(other Checksum) (bool, error)

If the 'other' checksum matches the current one, return true. 'other' checksum may contain regex values for sha1, sha256 and md5.

type FileDetails

type FileDetails struct {
	Checksum Checksum
	Size     int64
}

func GetFileDetails

func GetFileDetails(filePath string, includeChecksums bool) (details *FileDetails, err error)