Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Crypto.Libsodium

Contents

Initialization
MLocked memory management
MLocked bytes
Hashing

Synopsis

sodiumInit :: IO ()
data MLockedForeignPtr a
withMLockedForeignPtr :: forall a b. MLockedForeignPtr a -> (Ptr a -> IO b) -> IO b
allocMLockedForeignPtr :: Storable a => IO (MLockedForeignPtr a)
finalizeMLockedForeignPtr :: forall a. MLockedForeignPtr a -> IO ()
traceMLockedForeignPtr :: (Storable a, Show a) => MLockedForeignPtr a -> IO ()
data MLockedSizedBytes n
mlsbZero :: forall n. KnownNat n => MLockedSizedBytes n
mlsbFromByteString :: forall n. KnownNat n => ByteString -> MLockedSizedBytes n
mlsbFromByteStringCheck :: forall n. KnownNat n => ByteString -> Maybe (MLockedSizedBytes n)
mlsbToByteString :: forall n. KnownNat n => MLockedSizedBytes n -> ByteString
mlsbFinalize :: MLockedSizedBytes n -> IO ()
class HashAlgorithm h => SodiumHashAlgorithm h where
- naclDigestPtr :: proxy h -> Ptr a -> Int -> IO (MLockedSizedBytes (SizeHash h))
digestMLockedStorable :: forall h a proxy. (SodiumHashAlgorithm h, Storable a) => proxy h -> Ptr a -> MLockedSizedBytes (SizeHash h)
digestMLockedBS :: forall h proxy. SodiumHashAlgorithm h => proxy h -> ByteString -> MLockedSizedBytes (SizeHash h)
expandHash :: forall h proxy. SodiumHashAlgorithm h => proxy h -> MLockedSizedBytes (SizeHash h) -> (MLockedSizedBytes (SizeHash h), MLockedSizedBytes (SizeHash h))

Initialization

sodiumInit :: IO () Source #

MLocked memory management

data MLockedForeignPtr a Source #

Foreign pointer to securely allocated memory.

Instances

Instances details

NoThunks (MLockedForeignPtr a) Source #
Instance details Defined in Cardano.Crypto.Libsodium.Memory.Internal Methods noThunks :: Context -> MLockedForeignPtr a -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> MLockedForeignPtr a -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy (MLockedForeignPtr a) -> String Source #

withMLockedForeignPtr :: forall a b. MLockedForeignPtr a -> (Ptr a -> IO b) -> IO b Source #

allocMLockedForeignPtr :: Storable a => IO (MLockedForeignPtr a) Source #

Allocate secure memory using c_sodium_malloc.

https://libsodium.gitbook.io/doc/memory_management

finalizeMLockedForeignPtr :: forall a. MLockedForeignPtr a -> IO () Source #

traceMLockedForeignPtr :: (Storable a, Show a) => MLockedForeignPtr a -> IO () Source #

Deprecated: Don't leave traceMLockedForeignPtr in production

MLocked bytes

data MLockedSizedBytes n Source #

Instances

Instances details

KnownNat n => Show (MLockedSizedBytes n) Source #
Instance details Defined in Cardano.Crypto.Libsodium.MLockedBytes.Internal Methods showsPrec :: Int -> MLockedSizedBytes n -> ShowS Source # show :: MLockedSizedBytes n -> String Source # showList :: [MLockedSizedBytes n] -> ShowS Source #
NFData (MLockedSizedBytes n) Source #
Instance details Defined in Cardano.Crypto.Libsodium.MLockedBytes.Internal Methods rnf :: MLockedSizedBytes n -> () Source #
KnownNat n => Eq (MLockedSizedBytes n) Source #
Instance details Defined in Cardano.Crypto.Libsodium.MLockedBytes.Internal Methods (==) :: MLockedSizedBytes n -> MLockedSizedBytes n -> Bool Source # (/=) :: MLockedSizedBytes n -> MLockedSizedBytes n -> Bool Source #
KnownNat n => Ord (MLockedSizedBytes n) Source #
Instance details Defined in Cardano.Crypto.Libsodium.MLockedBytes.Internal Methods compare :: MLockedSizedBytes n -> MLockedSizedBytes n -> Ordering Source # (<) :: MLockedSizedBytes n -> MLockedSizedBytes n -> Bool Source # (<=) :: MLockedSizedBytes n -> MLockedSizedBytes n -> Bool Source # (>) :: MLockedSizedBytes n -> MLockedSizedBytes n -> Bool Source # (>=) :: MLockedSizedBytes n -> MLockedSizedBytes n -> Bool Source # max :: MLockedSizedBytes n -> MLockedSizedBytes n -> MLockedSizedBytes n Source # min :: MLockedSizedBytes n -> MLockedSizedBytes n -> MLockedSizedBytes n Source #
NoThunks (MLockedSizedBytes n) Source #
Instance details Defined in Cardano.Crypto.Libsodium.MLockedBytes.Internal Methods noThunks :: Context -> MLockedSizedBytes n -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> MLockedSizedBytes n -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy (MLockedSizedBytes n) -> String Source #

mlsbZero :: forall n. KnownNat n => MLockedSizedBytes n Source #

Note: this doesn't need to allocate mlocked memory, but we do that for consistency

mlsbFromByteString :: forall n. KnownNat n => ByteString -> MLockedSizedBytes n Source #

mlsbFromByteStringCheck :: forall n. KnownNat n => ByteString -> Maybe (MLockedSizedBytes n) Source #

mlsbToByteString :: forall n. KnownNat n => MLockedSizedBytes n -> ByteString Source #

Note: the resulting ByteString will still refer to secure memory, but the types don't prevent it from be exposed.

mlsbFinalize :: MLockedSizedBytes n -> IO () Source #

Calls finalizeMLockedForeignPtr on underlying pointer. This function invalidates argument.

Hashing

class HashAlgorithm h => SodiumHashAlgorithm h where Source #

Methods

naclDigestPtr Source #

Arguments

:: proxy h
-> Ptr a	input
-> Int	input length
-> IO (MLockedSizedBytes (SizeHash h))

Instances

Instances details

SodiumHashAlgorithm Blake2b_256 Source #
Instance details Defined in Cardano.Crypto.Libsodium.Hash Methods naclDigestPtr :: proxy Blake2b_256 -> Ptr a -> Int -> IO (MLockedSizedBytes (SizeHash Blake2b_256)) Source #
SodiumHashAlgorithm SHA256 Source #
Instance details Defined in Cardano.Crypto.Libsodium.Hash Methods naclDigestPtr :: proxy SHA256 -> Ptr a -> Int -> IO (MLockedSizedBytes (SizeHash SHA256)) Source #

digestMLockedStorable :: forall h a proxy. (SodiumHashAlgorithm h, Storable a) => proxy h -> Ptr a -> MLockedSizedBytes (SizeHash h) Source #

digestMLockedBS :: forall h proxy. SodiumHashAlgorithm h => proxy h -> ByteString -> MLockedSizedBytes (SizeHash h) Source #

expandHash :: forall h proxy. SodiumHashAlgorithm h => proxy h -> MLockedSizedBytes (SizeHash h) -> (MLockedSizedBytes (SizeHash h), MLockedSizedBytes (SizeHash h)) Source #