Data.SecureMem

Documentation

data SecureMem

SecureMem is a memory chunk which have the properties of:

• Being scrubbed after its goes out of scope. * A Show instance that doesn't actually show any content * A Eq instance that is constant time

Instances

Eq SecureMem

Show SecureMem

Monoid SecureMem

Byteable SecureMem

ToSecureMem SecureMem

secureMemGetSize :: SecureMem -> Int

Return the size of the memory allocated by this secure mem.

secureMemCopy :: SecureMem -> IO SecureMem

class ToSecureMem a where

Types that can be converted to a secure mem object.

Methods

toSecureMem :: a -> SecureMem

Instances

ToSecureMem ByteString

ToSecureMem SecureMem

Allocation and early termination

allocateSecureMem :: Int -> IO SecureMem

Allocate a new SecureMem

The memory is allocated on the haskell heap, and will be scrubed before being released.

createSecureMem :: Int -> (Ptr Word8 -> IO ()) -> IO SecureMem

Create a new secure mem and running an initializer function

unsafeCreateSecureMem :: Int -> (Ptr Word8 -> IO ()) -> SecureMem

Create a new secure mem using inline perform IO to create a pure result.

finalizeSecureMem :: SecureMem -> IO ()

Finalize a SecureMem early

Pointers manipulation

withSecureMemPtr :: SecureMem -> (Ptr Word8 -> IO b) -> IO b

This is a way to look at the pointer living inside a foreign object. This function takes a function which is applied to that pointer. The resulting IO action is then executed

this is similary to withForeignPtr for a ForeignPtr

withSecureMemPtrSz :: SecureMem -> (Int -> Ptr Word8 -> IO b) -> IO b

similar to withSecureMem but also include the size of the pointed memory.

withSecureMemCopy :: SecureMem -> (Ptr Word8 -> IO ()) -> IO SecureMem

convertion

secureMemFromByteString :: ByteString -> SecureMem

Create a SecureMem from a bytestring