Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Crypto.Libsodium.MLockedBytes

Synopsis

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
mlsbUseAsCPtr :: MLockedSizedBytes n -> (Ptr Word8 -> IO r) -> IO r
mlsbUseAsSizedPtr :: MLockedSizedBytes n -> (SizedPtr n -> IO r) -> IO r
mlsbFinalize :: MLockedSizedBytes n -> IO ()

Documentation

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.

mlsbUseAsCPtr :: MLockedSizedBytes n -> (Ptr Word8 -> IO r) -> IO r Source #

mlsbUseAsSizedPtr :: MLockedSizedBytes n -> (SizedPtr n -> IO r) -> IO r Source #

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

Calls finalizeMLockedForeignPtr on underlying pointer. This function invalidates argument.