Namespaces

Functions

bin2hex¶

package	Default
see	\ParagonIE_Sodium_Compat::bin2hex()
Throws	\SodiumException \TypeError

Arguments

$string

string

Response

string

« More »

compare¶

package	Default
see	\ParagonIE_Sodium_Compat::compare()
Throws	\SodiumException \TypeError

Arguments

$a

string

$b

string

Response

integer

« More »

crypto_aead_aes256gcm_decrypt¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_aead_aes256gcm_decrypt()

Arguments

$message

string

$assocData

string

$nonce

string

$key

string

Response

string|boolean

« More »

crypto_aead_aes256gcm_encrypt¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_aead_aes256gcm_encrypt()
Throws	\SodiumException \TypeError

Arguments

$message

string

$assocData

string

$nonce

string

$key

string

Response

string

« More »

crypto_aead_aes256gcm_is_available¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_aead_aes256gcm_is_available()

Response

boolean

« More »

crypto_aead_chacha20poly1305_decrypt¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_aead_chacha20poly1305_decrypt()

Arguments

$message

string

$assocData

string

$nonce

string

$key

string

Response

string|boolean

« More »

crypto_aead_chacha20poly1305_encrypt¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_aead_chacha20poly1305_encrypt()
Throws	\SodiumException \TypeError

Arguments

$message

string

$assocData

string

$nonce

string

$key

string

Response

string

« More »

crypto_aead_chacha20poly1305_ietf_decrypt¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_aead_chacha20poly1305_ietf_decrypt()

Arguments

$message

string

$assocData

string

$nonce

string

$key

string

Response

string|boolean

« More »

crypto_aead_chacha20poly1305_ietf_encrypt¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_aead_chacha20poly1305_ietf_encrypt()
Throws	\SodiumException \TypeError

Arguments

$message

string

$assocData

string

$nonce

string

$key

string

Response

string

« More »

crypto_auth¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_auth()
Throws	\SodiumException \TypeError

Arguments

$message

string

$key

string

Response

string

« More »

crypto_auth_verify¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_auth_verify()
Throws	\SodiumException \TypeError

Arguments

$mac

string

$message

string

$key

string

Response

boolean

« More »

crypto_box¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_box()
Throws	\SodiumException \TypeError

Arguments

$message

string

$nonce

string

$kp

string

Response

string

« More »

crypto_box_keypair¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_box_keypair()

Throws	\SodiumException \TypeError

Response

string

« More »

crypto_box_keypair_from_secretkey_and_publickey¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_box_keypair_from_secretkey_and_publickey()
Throws	\SodiumException \TypeError

Arguments

$sk

string

$pk

string

Response

string

« More »

crypto_box_open¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_box_open()

Arguments

$message

string

$nonce

string

$kp

string

Response

string|boolean

« More »

crypto_box_publickey¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_box_publickey()
Throws	\SodiumException \TypeError

Arguments

$keypair

string

Response

string

« More »

crypto_box_publickey_from_secretkey¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_box_publickey_from_secretkey()
Throws	\SodiumException \TypeError

Arguments

$sk

string

Response

string

« More »

crypto_box_seal¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_box_seal_open()
Throws	\SodiumException \TypeError

Arguments

$message

string

$publicKey

string

Response

string

« More »

crypto_box_seal_open¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_box_seal_open()

Arguments

$message

string

$kp

string

Response

string|boolean

« More »

crypto_box_secretkey¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_box_secretkey()
Throws	\SodiumException \TypeError

Arguments

$keypair

string

Response

string

« More »

crypto_generichash¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_generichash()
Throws	\SodiumException \TypeError

Arguments

$message

string

$key

string|null

$outLen

integer

Response

string

« More »

crypto_generichash_final¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_generichash_final()
Throws	\SodiumException \TypeError

Arguments

$ctx

string|null

$outputLength

integer

Response

string

« More »

crypto_generichash_init¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_generichash_init()
Throws	\SodiumException \TypeError

Arguments

$key

string|null

$outLen

integer

Response

string

« More »

crypto_generichash_update¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_generichash_update()
Throws	\SodiumException \TypeError

Arguments

$ctx

string|null

$message

string

« More »

crypto_kx¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_kx()
Throws	\SodiumException \TypeError

Arguments

$my_secret

string

$their_public

string

$client_public

string

$server_public

string

Response

string

« More »

crypto_pwhash¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_pwhash()
Throws	\SodiumException \TypeError

Arguments

$outlen

integer

$passwd

string

$salt

string

$opslimit

integer

$memlimit

integer

Response

string

« More »

crypto_pwhash_scryptsalsa208sha256¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_pwhash_scryptsalsa208sha256()
Throws	\SodiumException \TypeError

Arguments

$outlen

integer

$passwd

string

$salt

string

$opslimit

integer

$memlimit

integer

Response

string

« More »

crypto_pwhash_scryptsalsa208sha256_str¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_pwhash_scryptsalsa208sha256_str()
Throws	\SodiumException \TypeError

Arguments

$passwd

string

$opslimit

integer

$memlimit

integer

Response

string

« More »

crypto_pwhash_scryptsalsa208sha256_str_verify¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_pwhash_scryptsalsa208sha256_str_verify()
Throws	\SodiumException \TypeError

Arguments

$passwd

string

$hash

string

Response

boolean

« More »

crypto_pwhash_str¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_pwhash_str()
Throws	\SodiumException \TypeError

Arguments

$passwd

string

$opslimit

integer

$memlimit

integer

Response

string

« More »

crypto_pwhash_str_verify¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_pwhash_str_verify()
Throws	\SodiumException \TypeError

Arguments

$passwd

string

$hash

string

Response

boolean

« More »

crypto_scalarmult¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_scalarmult()
Throws	\SodiumException \TypeError

Arguments

$n

string

$p

string

Response

string

« More »

crypto_scalarmult_base¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_scalarmult_base()
Throws	\SodiumException \TypeError

Arguments

$n

string

Response

string

« More »

crypto_secretbox¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_secretbox()
Throws	\SodiumException \TypeError

Arguments

$message

string

$nonce

string

$key

string

Response

string

« More »

crypto_secretbox_open¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_secretbox_open()

Arguments

$message

string

$nonce

string

$key

string

Response

string|boolean

« More »

crypto_shorthash¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_shorthash()
Throws	\SodiumException \TypeError

Arguments

$message

string

$key

string

Response

string

« More »

crypto_sign¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_sign()
Throws	\SodiumException \TypeError

Arguments

$message

string

$sk

string

Response

string

« More »

crypto_sign_detached¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_sign_detached()
Throws	\SodiumException \TypeError

Arguments

$message

string

$sk

string

Response

string

« More »

crypto_sign_ed25519_pk_to_curve25519¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_sign_ed25519_pk_to_curve25519()
Throws	\SodiumException \TypeError

Arguments

$pk

string

Response

string

« More »

crypto_sign_ed25519_sk_to_curve25519¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_sign_ed25519_sk_to_curve25519()
Throws	\SodiumException \TypeError

Arguments

$sk

string

Response

string

« More »

crypto_sign_keypair¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_sign_keypair()

Throws	\SodiumException \TypeError

Response

string

« More »

crypto_sign_open¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_sign_open()

Arguments

$signedMessage

string

$pk

string

Response

string|boolean

« More »

crypto_sign_publickey¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_sign_publickey()
Throws	\SodiumException \TypeError

Arguments

$keypair

string

Response

string

« More »

crypto_sign_publickey_from_secretkey¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_sign_publickey_from_secretkey()
Throws	\SodiumException \TypeError

Arguments

$sk

string

Response

string

« More »

crypto_sign_secretkey¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_sign_secretkey()
Throws	\SodiumException \TypeError

Arguments

$keypair

string

Response

string

« More »

crypto_sign_seed_keypair¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_sign_seed_keypair()
Throws	\SodiumException \TypeError

Arguments

$seed

string

Response

string

« More »

crypto_sign_verify_detached¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_sign_verify_detached()
Throws	\SodiumException \TypeError

Arguments

$signature

string

$message

string

$pk

string

Response

boolean

« More »

crypto_stream¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_stream()
Throws	\SodiumException \TypeError

Arguments

$len

integer

$nonce

string

$key

string

Response

string

« More »

crypto_stream_xor¶

package	Default
see	\ParagonIE_Sodium_Compat::crypto_stream_xor()
Throws	\SodiumException \TypeError

Arguments

$message

string

$nonce

string

$key

string

Response

string

« More »

hex2bin¶

package	Default
see	\ParagonIE_Sodium_Compat::hex2bin()
Throws	\SodiumException \TypeError

Arguments

$string

string

Response

string

« More »

memcmp¶

package	Default
see	\ParagonIE_Sodium_Compat::memcmp()
Throws	\SodiumException \TypeError

Arguments

$a

string

$b

string

Response

integer

« More »

memzero¶

package	Default
see	\ParagonIE_Sodium_Compat::memzero()
psalm-suppress	MissingParamType MissingReturnType ReferenceConstraintViolation
Throws	\SodiumException \TypeError

Arguments

$str

string

« More »

randombytes_buf¶

package	Default
see	\ParagonIE_Sodium_Compat::randombytes_buf()
Throws	\TypeError

Arguments

$amount

integer

Response

string

« More »

randombytes_random16¶

package	Default
see	\ParagonIE_Sodium_Compat::randombytes_random16()

Response

integer

« More »

randombytes_uniform¶

package	Default
see	\ParagonIE_Sodium_Compat::randombytes_uniform()
Throws	\SodiumException \Error

Arguments

$upperLimit

integer

Response

integer

« More »

Constants

CRYPTO_AEAD_AES256GCM_KEYBYTES¶

« More »

CRYPTO_AEAD_AES256GCM_NSECBYTES¶

« More »

CRYPTO_AEAD_AES256GCM_NPUBBYTES¶

« More »

CRYPTO_AEAD_AES256GCM_ABYTES¶

« More »

CRYPTO_AEAD_CHACHA20POLY1305_KEYBYTES¶

« More »

CRYPTO_AEAD_CHACHA20POLY1305_NSECBYTES¶

« More »

CRYPTO_AEAD_CHACHA20POLY1305_NPUBBYTES¶

« More »

CRYPTO_AEAD_CHACHA20POLY1305_ABYTES¶

« More »

CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES¶

« More »

CRYPTO_AEAD_CHACHA20POLY1305_IETF_NSECBYTES¶

« More »

CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES¶

« More »

CRYPTO_AEAD_CHACHA20POLY1305_IETF_ABYTES¶

« More »

CRYPTO_AUTH_BYTES¶

« More »

CRYPTO_AUTH_KEYBYTES¶

« More »

CRYPTO_BOX_SEALBYTES¶

« More »

CRYPTO_BOX_SECRETKEYBYTES¶

« More »

CRYPTO_BOX_PUBLICKEYBYTES¶

« More »

CRYPTO_BOX_KEYPAIRBYTES¶

« More »

CRYPTO_BOX_MACBYTES¶

« More »

CRYPTO_BOX_NONCEBYTES¶

« More »

CRYPTO_BOX_SEEDBYTES¶

« More »

CRYPTO_KX_BYTES¶

« More »

CRYPTO_KX_SEEDBYTES¶

« More »

CRYPTO_KX_PUBLICKEYBYTES¶

« More »

CRYPTO_KX_SECRETKEYBYTES¶

« More »

CRYPTO_GENERICHASH_BYTES¶

« More »

CRYPTO_GENERICHASH_BYTES_MIN¶

« More »

CRYPTO_GENERICHASH_BYTES_MAX¶

« More »

CRYPTO_GENERICHASH_KEYBYTES¶

« More »

CRYPTO_GENERICHASH_KEYBYTES_MIN¶

« More »

CRYPTO_GENERICHASH_KEYBYTES_MAX¶

« More »

CRYPTO_SCALARMULT_BYTES¶

« More »

CRYPTO_SCALARMULT_SCALARBYTES¶

« More »

CRYPTO_SHORTHASH_BYTES¶

« More »

CRYPTO_SHORTHASH_KEYBYTES¶

« More »

CRYPTO_SECRETBOX_KEYBYTES¶

« More »

CRYPTO_SECRETBOX_MACBYTES¶

« More »

CRYPTO_SECRETBOX_NONCEBYTES¶

« More »

CRYPTO_SIGN_BYTES¶

« More »

CRYPTO_SIGN_SEEDBYTES¶

« More »

CRYPTO_SIGN_PUBLICKEYBYTES¶

« More »

CRYPTO_SIGN_SECRETKEYBYTES¶

« More »

CRYPTO_SIGN_KEYPAIRBYTES¶

« More »

CRYPTO_STREAM_KEYBYTES¶

« More »

CRYPTO_STREAM_NONCEBYTES¶

« More »