System.Nix.Hash

Documentation

data Digest (a :: HashAlgorithm)

The result of running a HashAlgorithm.

Instances

Eq (Digest a)

Defined in System.Nix.Internal.Hash

Methods

(==) :: Digest a -> Digest a -> Bool

(/=) :: Digest a -> Digest a -> Bool

Ord (Digest a)

Defined in System.Nix.Internal.Hash

Methods

compare :: Digest a -> Digest a -> Ordering

(<) :: Digest a -> Digest a -> Bool

(<=) :: Digest a -> Digest a -> Bool

(>) :: Digest a -> Digest a -> Bool

(>=) :: Digest a -> Digest a -> Bool

max :: Digest a -> Digest a -> Digest a

min :: Digest a -> Digest a -> Digest a

Show (Digest a)

Defined in System.Nix.Internal.Hash

Methods

showsPrec :: Int -> Digest a -> ShowS

show :: Digest a -> String

showList :: [Digest a] -> ShowS

Hashable (Digest a)

Defined in System.Nix.Internal.Hash

Methods

hashWithSalt :: Int -> Digest a -> Int

hash :: Digest a -> Int

data HashAlgorithm

The universe of supported hash algorithms.

Currently only intended for use at the type level.

Constructors

MD5

SHA1

SHA256

SHA512

Truncated Nat HashAlgorithm

The hash algorithm obtained by truncating the result of the input HashAlgorithm to the given number of bytes. See truncateDigest for a description of the truncation algorithm.

class ValidAlgo (a :: HashAlgorithm) where

The primitive interface for incremental hashing for a given HashAlgorithm. Every HashAlgorithm should have an instance.

Associated Types

type AlgoCtx a

The incremental state for constructing a hash.

Methods

initialize :: AlgoCtx a

Start building a new hash.

update :: AlgoCtx a -> ByteString -> AlgoCtx a

Append a ByteString to the overall contents to be hashed.

finalize :: AlgoCtx a -> Digest a

Finish hashing and generate the output.

Instances

ValidAlgo 'MD5

Uses Crypto.Hash.MD5 from cryptohash-md5.

Defined in System.Nix.Internal.Hash

Associated Types

type AlgoCtx 'MD5

Methods

initialize :: AlgoCtx 'MD5

update :: AlgoCtx 'MD5 -> ByteString -> AlgoCtx 'MD5

finalize :: AlgoCtx 'MD5 -> Digest 'MD5

ValidAlgo 'SHA1

Uses Crypto.Hash.SHA1 from cryptohash-sha1.

Defined in System.Nix.Internal.Hash

Associated Types

type AlgoCtx 'SHA1

Methods

initialize :: AlgoCtx 'SHA1

update :: AlgoCtx 'SHA1 -> ByteString -> AlgoCtx 'SHA1

finalize :: AlgoCtx 'SHA1 -> Digest 'SHA1

ValidAlgo 'SHA256

Uses Crypto.Hash.SHA256 from cryptohash-sha256.

Defined in System.Nix.Internal.Hash

Associated Types

type AlgoCtx 'SHA256

Methods

initialize :: AlgoCtx 'SHA256

update :: AlgoCtx 'SHA256 -> ByteString -> AlgoCtx 'SHA256

finalize :: AlgoCtx 'SHA256 -> Digest 'SHA256

ValidAlgo 'SHA512

Uses Crypto.Hash.SHA512 from cryptohash-sha512.

Defined in System.Nix.Internal.Hash

Associated Types

type AlgoCtx 'SHA512

Methods

initialize :: AlgoCtx 'SHA512

update :: AlgoCtx 'SHA512 -> ByteString -> AlgoCtx 'SHA512

finalize :: AlgoCtx 'SHA512 -> Digest 'SHA512

(ValidAlgo a, KnownNat n) => ValidAlgo ('Truncated n a)

Reuses the underlying ValidAlgo instance, but does a truncateDigest at the end.

Defined in System.Nix.Internal.Hash

Associated Types

type AlgoCtx ('Truncated n a)

Methods

initialize :: AlgoCtx ('Truncated n a)

update :: AlgoCtx ('Truncated n a) -> ByteString -> AlgoCtx ('Truncated n a)

finalize :: AlgoCtx ('Truncated n a) -> Digest ('Truncated n a)

class ValidAlgo a => NamedAlgo (a :: HashAlgorithm) where

A HashAlgorithm with a canonical name, for serialization purposes (e.g. SRI hashes)

Methods

algoName :: Text

hashSize :: Int

Instances

NamedAlgo 'MD5

Defined in System.Nix.Internal.Hash

Methods

algoName :: Text

hashSize :: Int

NamedAlgo 'SHA1

Defined in System.Nix.Internal.Hash

Methods

algoName :: Text

hashSize :: Int

NamedAlgo 'SHA256

Defined in System.Nix.Internal.Hash

Methods

algoName :: Text

hashSize :: Int

NamedAlgo 'SHA512

Defined in System.Nix.Internal.Hash

Methods

algoName :: Text

hashSize :: Int

data SomeNamedDigest

A digest whose NamedAlgo is not known at compile time.

Constructors

forall a.NamedAlgo a => SomeDigest (Digest a)

Instances

Show SomeNamedDigest

Defined in System.Nix.Internal.Hash

Methods

showsPrec :: Int -> SomeNamedDigest -> ShowS

show :: SomeNamedDigest -> String

showList :: [SomeNamedDigest] -> ShowS

hash :: forall a. ValidAlgo a => ByteString -> Digest a

Hash an entire (strict) ByteString as a single call.

For example: > let d = hash "Hello, sha-256!" :: Digest SHA256 or > :set -XTypeApplications > let d = hash @SHA256 "Hello, sha-256!"

hashLazy :: forall a. ValidAlgo a => ByteString -> Digest a

Hash an entire (lazy) ByteString as a single call.

Use is the same as for hash. This runs in constant space, but forces the entire bytestring.

mkNamedDigest :: Text -> Text -> Either String SomeNamedDigest

data BaseEncoding

Constructors to indicate the base encodings

Constructors

Base16

Base32

Base64

^ Nix has a special map of Base32 encoding

encodeInBase :: BaseEncoding -> Digest a -> Text

Take BaseEncoding type of the output -> take the Digeest as input -> encode Digest

decodeBase :: BaseEncoding -> Text -> Either String (Digest a)

Take BaseEncoding type of the input -> take the input itself -> decodeBase into Digest