Index

API symbols

bin2hex:

• sodium: bin2hex(data: string): string

crypto_aead_aes256gcm_abytes:

• sodium_sizes: crypto_aead_aes256gcm_abytes(): cint

crypto_aead_aes256gcm_keybytes:

• sodium_sizes: crypto_aead_aes256gcm_keybytes(): cint

crypto_aead_aes256gcm_npubbytes:

• sodium_sizes: crypto_aead_aes256gcm_npubbytes(): cint

crypto_aead_aes256gcm_nsecbytes:

• sodium_sizes: crypto_aead_aes256gcm_nsecbytes(): cint

crypto_aead_aes256gcm_statebytes:

• sodium_sizes: crypto_aead_aes256gcm_statebytes(): cint

crypto_aead_chacha20poly1305_abytes:

• sodium_sizes: crypto_aead_chacha20poly1305_abytes(): cint

crypto_aead_chacha20poly1305_ietf_npubbytes:

• sodium_sizes: crypto_aead_chacha20poly1305_ietf_npubbytes(): cint

crypto_aead_chacha20poly1305_keybytes:

• sodium_sizes: crypto_aead_chacha20poly1305_keybytes(): cint

crypto_aead_chacha20poly1305_npubbytes:

• sodium_sizes: crypto_aead_chacha20poly1305_npubbytes(): cint

crypto_aead_chacha20poly1305_nsecbytes:

• sodium_sizes: crypto_aead_chacha20poly1305_nsecbytes(): cint

crypto_auth:

• sodium: crypto_auth(message, key: string): string

crypto_auth_bytes:

• sodium_sizes: crypto_auth_bytes(): cint

crypto_auth_hmacsha256:

• sodium: crypto_auth_hmacsha256(message, key: string): string

crypto_auth_hmacsha256_bytes:

• sodium_sizes: crypto_auth_hmacsha256_bytes(): cint

crypto_auth_hmacsha256_keybytes:

• sodium_sizes: crypto_auth_hmacsha256_keybytes(): cint

crypto_auth_hmacsha256_statebytes:

• sodium_sizes: crypto_auth_hmacsha256_statebytes(): cint

crypto_auth_hmacsha256_verify:

• sodium: crypto_auth_hmacsha256_verify(mac, message, key: string): bool

crypto_auth_hmacsha512256_bytes:

• sodium_sizes: crypto_auth_hmacsha512256_bytes(): cint

crypto_auth_hmacsha512256_keybytes:

• sodium_sizes: crypto_auth_hmacsha512256_keybytes(): cint

crypto_auth_hmacsha512256_statebytes:

• sodium_sizes: crypto_auth_hmacsha512256_statebytes(): cint

crypto_auth_hmacsha512_bytes:

• sodium_sizes: crypto_auth_hmacsha512_bytes(): cint

crypto_auth_hmacsha512_keybytes:

• sodium_sizes: crypto_auth_hmacsha512_keybytes(): cint

crypto_auth_hmacsha512_statebytes:

• sodium_sizes: crypto_auth_hmacsha512_statebytes(): cint

crypto_auth_keybytes:

• sodium_sizes: crypto_auth_keybytes(): cint

crypto_auth_verify:

• sodium: crypto_auth_verify(mac, message, key: string): bool

crypto_box_beforenmbytes:

• sodium_sizes: crypto_box_beforenmbytes(): cint

crypto_box_boxzerobytes:

• sodium_sizes: crypto_box_boxzerobytes(): cint

crypto_box_curve25519xsalsa20poly1305_beforenmbytes:

• sodium_sizes: crypto_box_curve25519xsalsa20poly1305_beforenmbytes(): cint

crypto_box_curve25519xsalsa20poly1305_boxzerobytes:

• sodium_sizes: crypto_box_curve25519xsalsa20poly1305_boxzerobytes(): cint

crypto_box_curve25519xsalsa20poly1305_macbytes:

• sodium_sizes: crypto_box_curve25519xsalsa20poly1305_macbytes(): cint

crypto_box_curve25519xsalsa20poly1305_noncebytes:

• sodium_sizes: crypto_box_curve25519xsalsa20poly1305_noncebytes(): cint

crypto_box_curve25519xsalsa20poly1305_publickeybytes:

• sodium_sizes: crypto_box_curve25519xsalsa20poly1305_publickeybytes(): cint

crypto_box_curve25519xsalsa20poly1305_secretkeybytes:

• sodium_sizes: crypto_box_curve25519xsalsa20poly1305_secretkeybytes(): cint

crypto_box_curve25519xsalsa20poly1305_seedbytes:

• sodium_sizes: crypto_box_curve25519xsalsa20poly1305_seedbytes(): cint

crypto_box_curve25519xsalsa20poly1305_zerobytes:

• sodium_sizes: crypto_box_curve25519xsalsa20poly1305_zerobytes(): cint

crypto_box_easy:

• sodium: crypto_box_easy(message, nonce: string; public_key: CryptoBoxPublicKey; secret_key: CryptoBoxSecretKey): string

crypto_box_keypair:

• sodium: crypto_box_keypair(): (CryptoBoxPublicKey, CryptoBoxSecretKey)

crypto_box_macbytes:

• sodium_sizes: crypto_box_macbytes(): cint

crypto_box_noncebytes:

• sodium_sizes: crypto_box_noncebytes(): cint

crypto_box_open_easy:

• sodium: crypto_box_open_easy(ciphertext, nonce: string; public_key: CryptoBoxPublicKey; secret_key: CryptoBoxSecretKey): string

crypto_box_publickeybytes:

• sodium_sizes: crypto_box_publickeybytes(): cint

crypto_box_seal:

• sodium: crypto_box_seal(message: string; public_key: CryptoBoxPublicKey): string

crypto_box_sealbytes:

• sodium_sizes: crypto_box_sealbytes(): cint

crypto_box_seal_open:

• sodium: crypto_box_seal_open(ciphertext: string; public_key: CryptoBoxPublicKey; secret_key: CryptoBoxSecretKey): string

crypto_box_secretkeybytes:

• sodium_sizes: crypto_box_secretkeybytes(): cint

crypto_box_seedbytes:

• sodium_sizes: crypto_box_seedbytes(): cint

crypto_box_zerobytes:

• sodium_sizes: crypto_box_zerobytes(): cint

crypto_core_hsalsa20_constbytes:

• sodium_sizes: crypto_core_hsalsa20_constbytes(): cint

crypto_core_hsalsa20_inputbytes:

• sodium_sizes: crypto_core_hsalsa20_inputbytes(): cint

crypto_core_hsalsa20_keybytes:

• sodium_sizes: crypto_core_hsalsa20_keybytes(): cint

crypto_core_hsalsa20_outputbytes:

• sodium_sizes: crypto_core_hsalsa20_outputbytes(): cint

crypto_core_salsa2012_constbytes:

• sodium_sizes: crypto_core_salsa2012_constbytes(): cint

crypto_core_salsa2012_inputbytes:

• sodium_sizes: crypto_core_salsa2012_inputbytes(): cint

crypto_core_salsa2012_keybytes:

• sodium_sizes: crypto_core_salsa2012_keybytes(): cint

crypto_core_salsa2012_outputbytes:

• sodium_sizes: crypto_core_salsa2012_outputbytes(): cint

crypto_core_salsa208_constbytes:

• sodium_sizes: crypto_core_salsa208_constbytes(): cint

crypto_core_salsa208_inputbytes:

• sodium_sizes: crypto_core_salsa208_inputbytes(): cint

crypto_core_salsa208_keybytes:

• sodium_sizes: crypto_core_salsa208_keybytes(): cint

crypto_core_salsa208_outputbytes:

• sodium_sizes: crypto_core_salsa208_outputbytes(): cint

crypto_core_salsa20_constbytes:

• sodium_sizes: crypto_core_salsa20_constbytes(): cint

crypto_core_salsa20_inputbytes:

• sodium_sizes: crypto_core_salsa20_inputbytes(): cint

crypto_core_salsa20_keybytes:

• sodium_sizes: crypto_core_salsa20_keybytes(): cint

crypto_core_salsa20_outputbytes:

• sodium_sizes: crypto_core_salsa20_outputbytes(): cint

crypto_generichash:

• sodium: crypto_generichash(data: string; hashlen: int = crypto_generichash_bytes().int; key: string = ""): string

crypto_generichash_blake2b_bytes:

• sodium_sizes: crypto_generichash_blake2b_bytes(): cint

crypto_generichash_blake2b_bytes_max:

• sodium_sizes: crypto_generichash_blake2b_bytes_max(): cint

crypto_generichash_blake2b_bytes_min:

• sodium_sizes: crypto_generichash_blake2b_bytes_min(): cint

crypto_generichash_blake2b_keybytes:

• sodium_sizes: crypto_generichash_blake2b_keybytes(): cint

crypto_generichash_blake2b_keybytes_max:

• sodium_sizes: crypto_generichash_blake2b_keybytes_max(): cint

crypto_generichash_blake2b_keybytes_min:

• sodium_sizes: crypto_generichash_blake2b_keybytes_min(): cint

crypto_generichash_blake2b_personalbytes:

• sodium_sizes: crypto_generichash_blake2b_personalbytes(): cint

crypto_generichash_blake2b_saltbytes:

• sodium_sizes: crypto_generichash_blake2b_saltbytes(): cint

crypto_generichash_bytes:

• sodium_sizes: crypto_generichash_bytes(): cint

crypto_generichash_bytes_max:

• sodium_sizes: crypto_generichash_bytes_max(): cint

crypto_generichash_bytes_min:

• sodium_sizes: crypto_generichash_bytes_min(): cint

crypto_generichash_keybytes:

• sodium_sizes: crypto_generichash_keybytes(): cint

crypto_generichash_keybytes_max:

• sodium_sizes: crypto_generichash_keybytes_max(): cint

crypto_generichash_keybytes_min:

• sodium_sizes: crypto_generichash_keybytes_min(): cint

crypto_generichash_statebytes:

• sodium_sizes: crypto_generichash_statebytes(): cint

crypto_hash_bytes:

• sodium_sizes: crypto_hash_bytes(): cint

crypto_hash_sha256_bytes:

• sodium_sizes: crypto_hash_sha256_bytes(): cint

crypto_hash_sha256_statebytes:

• sodium_sizes: crypto_hash_sha256_statebytes(): cint

crypto_hash_sha512_bytes:

• sodium_sizes: crypto_hash_sha512_bytes(): cint

crypto_hash_sha512_statebytes:

• sodium_sizes: crypto_hash_sha512_statebytes(): cint

crypto_onetimeauth:

• sodium: crypto_onetimeauth(message, key: string): string

crypto_onetimeauth_bytes:

• sodium_sizes: crypto_onetimeauth_bytes(): cint

crypto_onetimeauth_keybytes:

• sodium_sizes: crypto_onetimeauth_keybytes(): cint

crypto_onetimeauth_poly1305_bytes:

• sodium_sizes: crypto_onetimeauth_poly1305_bytes(): cint

crypto_onetimeauth_poly1305_keybytes:

• sodium_sizes: crypto_onetimeauth_poly1305_keybytes(): cint

crypto_onetimeauth_statebytes:

• sodium_sizes: crypto_onetimeauth_statebytes(): cint

crypto_onetimeauth_verify:

• sodium: crypto_onetimeauth_verify(tok, message, key: string): bool

crypto_pwhash_scryptsalsa208sha256_saltbytes:

• sodium_sizes: crypto_pwhash_scryptsalsa208sha256_saltbytes(): cint

crypto_pwhash_scryptsalsa208sha256_strbytes:

• sodium_sizes: crypto_pwhash_scryptsalsa208sha256_strbytes(): cint

crypto_scalarmult:

• sodium: crypto_scalarmult(secret_key, public_key: string): string

crypto_scalarmult_base:

• sodium: crypto_scalarmult_base(secret_key: string): string

crypto_scalarmult_bytes:

• sodium_sizes: crypto_scalarmult_bytes(): cint

crypto_scalarmult_curve25519_bytes:

• sodium_sizes: crypto_scalarmult_curve25519_bytes(): cint

crypto_scalarmult_curve25519_scalarbytes:

• sodium_sizes: crypto_scalarmult_curve25519_scalarbytes(): cint

crypto_scalarmult_scalarbytes:

• sodium_sizes: crypto_scalarmult_scalarbytes(): cint

crypto_secretbox_boxzerobytes:

• sodium_sizes: crypto_secretbox_boxzerobytes(): cint

crypto_secretbox_easy:

• sodium: crypto_secretbox_easy(key: string; msg: string): string

crypto_secretbox_keybytes:

• sodium_sizes: crypto_secretbox_keybytes(): cint

crypto_secretbox_keygen:

• sodium: crypto_secretbox_keygen(): string

crypto_secretbox_macbytes:

• sodium_sizes: crypto_secretbox_macbytes(): cint

crypto_secretbox_noncebytes:

• sodium_sizes: crypto_secretbox_noncebytes(): cint

crypto_secretbox_open_easy:

• sodium: crypto_secretbox_open_easy(key: string; bulk: string): string

crypto_secretbox_xsalsa20poly1305_boxzerobytes:

• sodium_sizes: crypto_secretbox_xsalsa20poly1305_boxzerobytes(): cint

crypto_secretbox_xsalsa20poly1305_keybytes:

• sodium_sizes: crypto_secretbox_xsalsa20poly1305_keybytes(): cint

crypto_secretbox_xsalsa20poly1305_macbytes:

• sodium_sizes: crypto_secretbox_xsalsa20poly1305_macbytes(): cint

crypto_secretbox_xsalsa20poly1305_noncebytes:

• sodium_sizes: crypto_secretbox_xsalsa20poly1305_noncebytes(): cint

crypto_secretbox_xsalsa20poly1305_zerobytes:

• sodium_sizes: crypto_secretbox_xsalsa20poly1305_zerobytes(): cint

crypto_secretbox_zerobytes:

• sodium_sizes: crypto_secretbox_zerobytes(): cint

crypto_shorthash:

• sodium: crypto_shorthash(data: string; key: ShortHashKey): string

crypto_shorthash_bytes:

• sodium_sizes: crypto_shorthash_bytes(): cint

crypto_shorthash_keybytes:

• sodium_sizes: crypto_shorthash_keybytes(): cint

crypto_shorthash_siphash24_bytes:

• sodium_sizes: crypto_shorthash_siphash24_bytes(): cint

crypto_shorthash_siphash24_keybytes:

• sodium_sizes: crypto_shorthash_siphash24_keybytes(): cint

crypto_sign_bytes:

• sodium_sizes: crypto_sign_bytes(): cint

crypto_sign_detached:

• sodium: crypto_sign_detached(secret_key: SecretKey; message: string): string

crypto_sign_ed25519_bytes:

• sodium_sizes: crypto_sign_ed25519_bytes(): cint

crypto_sign_ed25519_publickeybytes:

• sodium_sizes: crypto_sign_ed25519_publickeybytes(): cint

crypto_sign_ed25519_secretkeybytes:

• sodium_sizes: crypto_sign_ed25519_secretkeybytes(): cint

crypto_sign_ed25519_seedbytes:

• sodium_sizes: crypto_sign_ed25519_seedbytes(): cint

crypto_sign_ed25519_sk_to_pk:

• sodium: crypto_sign_ed25519_sk_to_pk(secret_key: SecretKey): PublicKey

crypto_sign_ed25519_sk_to_seed:

• sodium: crypto_sign_ed25519_sk_to_seed(secret_key: SecretKey): string

crypto_sign_keypair:

• sodium: crypto_sign_keypair(): (PublicKey, SecretKey)

crypto_sign_publickeybytes:

• sodium_sizes: crypto_sign_publickeybytes(): cint

crypto_sign_secretkeybytes:

• sodium_sizes: crypto_sign_secretkeybytes(): cint

crypto_sign_seedbytes:

• sodium_sizes: crypto_sign_seedbytes(): cint

crypto_sign_seed_keypair:

• sodium: crypto_sign_seed_keypair(seed: string): (PublicKey, SecretKey)

crypto_sign_verify_detached:

• sodium: crypto_sign_verify_detached(public_key: PublicKey; message, signature: string)

crypto_stream:

• sodium: crypto_stream(nonce, key: string; length: int): string

crypto_stream_chacha20_ietf_noncebytes:

• sodium_sizes: crypto_stream_chacha20_ietf_noncebytes(): cint

crypto_stream_chacha20_keybytes:

• sodium_sizes: crypto_stream_chacha20_keybytes(): cint

crypto_stream_chacha20_noncebytes:

• sodium_sizes: crypto_stream_chacha20_noncebytes(): cint

crypto_stream_keybytes:

• sodium_sizes: crypto_stream_keybytes(): cint

crypto_stream_keygen:

• sodium: crypto_stream_keygen(): string

crypto_stream_noncebytes:

• sodium_sizes: crypto_stream_noncebytes(): cint

crypto_stream_salsa20:

• sodium: crypto_stream_salsa20(nonce, key: string; length: int): string

crypto_stream_salsa2012_keybytes:

• sodium_sizes: crypto_stream_salsa2012_keybytes(): cint

crypto_stream_salsa2012_noncebytes:

• sodium_sizes: crypto_stream_salsa2012_noncebytes(): cint

crypto_stream_salsa208_keybytes:

• sodium_sizes: crypto_stream_salsa208_keybytes(): cint

crypto_stream_salsa208_noncebytes:

• sodium_sizes: crypto_stream_salsa208_noncebytes(): cint

crypto_stream_salsa20_keybytes:

• sodium_sizes: crypto_stream_salsa20_keybytes(): cint

crypto_stream_salsa20_keygen:

• sodium: crypto_stream_salsa20_keygen(): string

crypto_stream_salsa20_noncebytes:

• sodium_sizes: crypto_stream_salsa20_noncebytes(): cint

crypto_stream_salsa20_xor:

• sodium: crypto_stream_salsa20_xor(nonce, key, msg: string): string

crypto_stream_salsa20_xor_ic:

• sodium: crypto_stream_salsa20_xor_ic(nonce, key, msg: string; ic: uint): string

crypto_stream_xor:

• sodium: crypto_stream_xor(nonce, key, msg: string): string

crypto_stream_xsalsa20_keybytes:

• sodium_sizes: crypto_stream_xsalsa20_keybytes(): cint

crypto_stream_xsalsa20_noncebytes:

• sodium_sizes: crypto_stream_xsalsa20_noncebytes(): cint

crypto_verify_16_bytes:

• sodium_sizes: crypto_verify_16_bytes(): cint

crypto_verify_32_bytes:

• sodium_sizes: crypto_verify_32_bytes(): cint

crypto_verify_64_bytes:

• sodium_sizes: crypto_verify_64_bytes(): cint

finalize:

• sodium: finalize(self: GenericHash): string
• sodium: finalize(self: HMACSHA256State): string

generate_key_for_short_hash:

• sodium: generate_key_for_short_hash(): ShortHashKey

GenericHash:

• sodium: GenericHash

hex2bin:

• sodium: hex2bin(data: string; ignore = ""): string

HMACSHA256State:

• sodium: HMACSHA256State

is_zero:

• sodium: is_zero(data: string): bool

libsodium_fn:

• sodium: libsodium_fn
• sodium_sizes: libsodium_fn

memcmp:

• sodium: memcmp(a, b: string): bool

new_crypto_auth_hmacsha256:

• sodium: new_crypto_auth_hmacsha256(key: string): HMACSHA256State

new_generic_hash:

• sodium: new_generic_hash(key: string; out_len: int = crypto_generichash_bytes().int): GenericHash

randombytes:

• sodium: randombytes(size: int): string

randombytes_stir:

• sodium: randombytes_stir()

sign_message:

• sodium: sign_message(key, message: string): string

SodiumError:

• sodium: SodiumError

update:

• sodium: update(self: GenericHash; data: string)
• sodium: update(self: HMACSHA256State; data: string)

verify_message:

• sodium: verify_message(key: string; msg: string; signature: string)

zeroed:

• sodium: zeroed(length: int): untyped