Skip to content
Discord Luau

Sys

Raw FFI bindings for libsodium. Loads the shared library and exposes the complete C API as a typed Luau interface. Prefer the higher-level modules in Sodium over calling lib directly.

Summary

Properties

Sys.lib :: LibSys.aes256gcm :: { KEY_BYTES: number, NONCE_BYTES: number, TAG_BYTES: number }Sys.chacha20poly1305 :: { KEY_BYTES: number, NONCE_BYTES: number, TAG_BYTES: number }Sys.xchacha20poly1305 :: { KEY_BYTES: number, NONCE_BYTES: number, TAG_BYTES: number }Sys.secretbox :: { KEY_BYTES: number, NONCE_BYTES: number, MAC_BYTES: number }Sys.box :: { PUBLIC_KEY_BYTES: number, SECRET_KEY_BYTES: number, NONCE_BYTES: number, MAC_BYTES: number, BEFORENM_BYTES: number }Sys.sign :: { PUBLIC_KEY_BYTES: number, SECRET_KEY_BYTES: number, BYTES: number }Sys.generichash :: { BYTES: number, BYTES_MIN: number, BYTES_MAX: number, KEY_BYTES: number, KEY_BYTES_MIN: number, KEY_BYTES_MAX: number }Sys.hash :: { SHA256_BYTES: number, SHA512_BYTES: number }Sys.auth :: { BYTES: number, KEY_BYTES: number }Sys.kdf :: { BYTES_MIN: number, BYTES_MAX: number, CONTEXT_BYTES: number, KEY_BYTES: number }Sys.pwhash :: { BYTES_MIN: number, BYTES_MAX: number, SALT_BYTES: number, STR_BYTES: number, ALG_ARGON2ID13: number, OPSLIMIT_INTERACTIVE: number, MEMLIMIT_INTERACTIVE: number, OPSLIMIT_MODERATE: number, MEMLIMIT_MODERATE: number, OPSLIMIT_SENSITIVE: number, MEMLIMIT_SENSITIVE: number }Sys.base64 :: { VARIANT_ORIGINAL: number, VARIANT_ORIGINAL_NO_PADDING: number, VARIANT_URLSAFE: number, VARIANT_URLSAFE_NO_PADDING: number }

Properties

Section titled “Properties”

lib

Section titled “lib”
Sys.lib  :: Lib

The loaded libsodium FFI library handle. All libsodium functions are called through this.

aes256gcm

Section titled “aes256gcm”
Sys.aes256gcm  :: {
KEY_BYTES: number,
NONCE_BYTES: number,
TAG_BYTES: number,
}

chacha20poly1305

Section titled “chacha20poly1305”
Sys.chacha20poly1305  :: {
KEY_BYTES: number,
NONCE_BYTES: number,
TAG_BYTES: number,
}

xchacha20poly1305

Section titled “xchacha20poly1305”
Sys.xchacha20poly1305  :: {
KEY_BYTES: number,
NONCE_BYTES: number,
TAG_BYTES: number,
}

secretbox

Section titled “secretbox”
Sys.secretbox  :: {
KEY_BYTES: number,
NONCE_BYTES: number,
MAC_BYTES: number,
}

box

Section titled “box”
Sys.box  :: {
PUBLIC_KEY_BYTES: number,
SECRET_KEY_BYTES: number,
NONCE_BYTES: number,
MAC_BYTES: number,
BEFORENM_BYTES: number,
}

sign

Section titled “sign”
Sys.sign  :: {
PUBLIC_KEY_BYTES: number,
SECRET_KEY_BYTES: number,
BYTES: number,
}

generichash

Section titled “generichash”
Sys.generichash  :: {
BYTES: number,
BYTES_MIN: number,
BYTES_MAX: number,
KEY_BYTES: number,
KEY_BYTES_MIN: number,
KEY_BYTES_MAX: number,
}

hash

Section titled “hash”
Sys.hash  :: {
SHA256_BYTES: number,
SHA512_BYTES: number,
}

auth

Section titled “auth”
Sys.auth  :: {
BYTES: number,
KEY_BYTES: number,
}

kdf

Section titled “kdf”
Sys.kdf  :: {
BYTES_MIN: number,
BYTES_MAX: number,
CONTEXT_BYTES: number,
KEY_BYTES: number,
}

pwhash

Section titled “pwhash”
Sys.pwhash  :: {
BYTES_MIN: number,
BYTES_MAX: number,
SALT_BYTES: number,
STR_BYTES: number,
ALG_ARGON2ID13: number,
OPSLIMIT_INTERACTIVE: number,
MEMLIMIT_INTERACTIVE: number,
OPSLIMIT_MODERATE: number,
MEMLIMIT_MODERATE: number,
OPSLIMIT_SENSITIVE: number,
MEMLIMIT_SENSITIVE: number,
}

base64

Section titled “base64”
Sys.base64  :: {
VARIANT_ORIGINAL: number,
VARIANT_ORIGINAL_NO_PADDING: number,
VARIANT_URLSAFE: number,
VARIANT_URLSAFE_NO_PADDING: number,
}