cardano-crypto-class-2.0.0.0.0.0.0.2: Type classes abstracting over cryptography primitives for Cardano

Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Crypto.Libsodium.Memory.Internal

Contents

High-level memory management
Low-level memory function

Synopsis

newtype MLockedForeignPtr a = SFP {
- _unwrapMLockedForeignPtr :: ForeignPtr 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 ()
mlockedAlloca :: forall a b. CSize -> (Ptr a -> IO b) -> IO b
mlockedAllocaSized :: forall n b. KnownNat n => (SizedPtr n -> IO b) -> IO b
sodiumMalloc :: CSize -> IO (Ptr a)
sodiumFree :: Ptr a -> IO ()

High-level memory management

newtype MLockedForeignPtr a Source #

Foreign pointer to securely allocated memory.

Constructors

SFP
Fields _unwrapMLockedForeignPtr :: ForeignPtr a

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

Low-level memory function

mlockedAlloca :: forall a b. CSize -> (Ptr a -> IO b) -> IO b Source #

mlockedAllocaSized :: forall n b. KnownNat n => (SizedPtr n -> IO b) -> IO b Source #

sodiumMalloc :: CSize -> IO (Ptr a) Source #

sodiumFree :: Ptr a -> IO () Source #