Modulelibsodium-bindings-0.0.1.1Haskell2010

LibSodium.Bindings.Utils

These are bindings to some of libsodium's utils.h. Included are Hex and Base64 encoding/decoding functions along with a constant-time memcmp for handling secret data.

7 values

Packagelibsodium-bindings-0.0.1.1
Exports7
LanguageHaskell2010
LicenceBSD-3-Clause
SourceUtils.hs

Low-level binding

3 declarations

valuesodiumMemcmp

:: Ptr CUChar
First pointer to some secret data.
-> Ptr CUChar
Second pointer to some secret data. Must be the same length as the first pointer.
-> CSize
The length of bytes that pointed to by both previous arguments.
-> IO CInt
0 if successful, -1 on failure.

Constant-time comparison function.

This function is not a lexicographic comparator and should be never used for this purpose. It should only be used when comparing two pieces of secret data, such as keys or authentication tags.

valuesodiumBin2Hex

:: CString
hex, The output buffer.
-> CSize
hex_len, The maximum number of bytes this function is allowed to write to the output buffer. Must be at least bin_len * 2 + 1 bytes long.
-> Ptr CUChar
bin, The input buffer.
-> CSize
bin_len, The length of the input buffer.
-> IO CString
The return string, terminated with a null byte.

Encode bytes to a hexidecimal string. Constant-time.

valuesodiumBin2Base64

:: CString
b64, The output buffer.
-> CSize
b64_maxlen, The maximum length of the output buffer. Choosing a correct size is not straightforward and depends on the variant. The sodium_base64_ENCODED_LEN(BIN_LEN, VARIANT) macro computes the minimum amount of bytes needed to encode BIN_LEN bytes with a chosen VARIANT.
-> Ptr CUChar
bin, The input buffer.
-> CSize
bin_len, The length of the input buffer.
-> CInt
variant, Which Base64 variant to use. None of the variants provide any encryption.
-> IO CString
The returned Base64 string, terminated with a null byte.

Encode bytes to a Base64 string. Constant-time.

Constants

4 declarations

valuesodiumBase64VariantOriginal :: CInt

The original variant of Base64 with padding. This ensures that the length of the encoded data will always be a multiple of four bytes.

valuesodiumBase64VariantOriginalNoPadding :: CInt

The original variant of Base64. No variant offers any security advantages over the other.

valuesodiumBase64VariantURLSafe :: CInt

The URL-safe variant of Base64 with padding.

valuesodiumBase64VariantURLSafeNoPadding :: CInt

The URL-safe variant of Base64. This is the same as the original variant, except + and / are replaced with - and _.