GI.GLib.Structs.Hmac

An opaque structure representing a HMAC operation. To create a new GHmac, use g_hmac_new(). To free a GHmac, use hmacUnref.

Exported types

newtype Hmac

Constructors

Hmac (ManagedPtr Hmac)

Instances

WrappedPtr Hmac

Methods

wrappedPtrCalloc :: IO (Ptr Hmac)

wrappedPtrCopy :: Hmac -> IO Hmac

wrappedPtrFree :: Maybe (FunPtr (Ptr Hmac -> IO ()))

((~) * info (ResolveHmacMethod t Hmac), MethodInfo * info Hmac p) => IsLabel t (Hmac -> p)

Methods

fromLabel :: Proxy# Symbol t -> Hmac -> p

((~) * info (ResolveHmacMethod t Hmac), MethodInfo * info Hmac p) => IsLabelProxy t (Hmac -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Hmac -> p

HasAttributeList * Hmac

((~) * signature (ByteString -> m ()), MonadIO m) => MethodInfo * HmacUpdateMethodInfo Hmac signature

Methods

overloadedMethod :: MethodProxy HmacUpdateMethodInfo Hmac -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * HmacUnrefMethodInfo Hmac signature

Methods

overloadedMethod :: MethodProxy HmacUnrefMethodInfo Hmac -> signature -> s

((~) * signature (m Text), MonadIO m) => MethodInfo * HmacGetStringMethodInfo Hmac signature

Methods

overloadedMethod :: MethodProxy HmacGetStringMethodInfo Hmac -> signature -> s

((~) * signature (Word8 -> Word64 -> m ()), MonadIO m) => MethodInfo * HmacGetDigestMethodInfo Hmac signature

Methods

overloadedMethod :: MethodProxy HmacGetDigestMethodInfo Hmac -> signature -> s

type AttributeList Hmac

type AttributeList Hmac

noHmac :: Maybe Hmac

Methods

getDigest

data HmacGetDigestMethodInfo

Instances

((~) * signature (Word8 -> Word64 -> m ()), MonadIO m) => MethodInfo * HmacGetDigestMethodInfo Hmac signature

Methods

overloadedMethod :: MethodProxy HmacGetDigestMethodInfo Hmac -> signature -> s

hmacGetDigest

Arguments

:: (HasCallStack, MonadIO m)

=> Hmac

hmac: a Hmac

-> Word8

buffer: output buffer

-> Word64

digestLen: an inout parameter. The caller initializes it to the size of buffer. After the call it contains the length of the digest

-> m ()

Gets the digest from checksum as a raw binary array and places it into buffer. The size of the digest depends on the type of checksum.

Once this function has been called, the Hmac is closed and can no longer be updated with checksumUpdate.

Since: 2.30

getString

data HmacGetStringMethodInfo

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * HmacGetStringMethodInfo Hmac signature

Methods

overloadedMethod :: MethodProxy HmacGetStringMethodInfo Hmac -> signature -> s

hmacGetString

Arguments

:: (HasCallStack, MonadIO m)

=> Hmac

hmac: a Hmac

-> m Text

Returns: the hexadecimal representation of the HMAC. The returned string is owned by the HMAC and should not be modified or freed.

Gets the HMAC as an hexadecimal string.

Once this function has been called the Hmac can no longer be updated with hmacUpdate.

The hexadecimal characters will be lower case.

Since: 2.30

unref

data HmacUnrefMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * HmacUnrefMethodInfo Hmac signature

Methods

overloadedMethod :: MethodProxy HmacUnrefMethodInfo Hmac -> signature -> s

hmacUnref

Arguments

:: (HasCallStack, MonadIO m)

=> Hmac

hmac: a Hmac

-> m ()

Atomically decrements the reference count of hmac by one.

If the reference count drops to 0, all keys and values will be destroyed, and all memory allocated by the hash table is released. This function is MT-safe and may be called from any thread. Frees the memory allocated for hmac.

Since: 2.30

update

data HmacUpdateMethodInfo

Instances

((~) * signature (ByteString -> m ()), MonadIO m) => MethodInfo * HmacUpdateMethodInfo Hmac signature

Methods

overloadedMethod :: MethodProxy HmacUpdateMethodInfo Hmac -> signature -> s

hmacUpdate

Arguments

:: (HasCallStack, MonadIO m)

=> Hmac

hmac: a Hmac

-> ByteString

data: buffer used to compute the checksum

-> m ()

Feeds data into an existing Hmac.

The HMAC must still be open, that is hmacGetString or hmacGetDigest must not have been called on hmac.

Since: 2.30