Sodium | PHP Jetbrains phpstorm-stubs

Functions

add(string $left, string $right)

Add the right operand to the left

at line 740

string

bin2hex(string $binary)

Convert to hex without side-chanels

at line 698

int

compare(string $left, string $right)

Compare two strings in constant time

at line 709

string

crypto_aead_aes256gcm_decrypt(string $msg, string $nonce, string $key, string $ad = '')

Authenticated Encryption with Associated Data (decrypt) AES-256-GCM

at line 80

string

crypto_aead_aes256gcm_encrypt(string $msg, string $nonce, string $key, string $ad = '')

Authenticated Encryption with Associated Data (encrypt) AES-256-GCM

at line 97

bool

crypto_aead_aes256gcm_is_available()

Can you access AES-256-GCM? This is only available if you have supported hardware.

at line 68

string

crypto_aead_chacha20poly1305_decrypt(string $msg, string $nonce, string $key, string $ad = '')

Authenticated Encryption with Associated Data (decrypt) ChaCha20 + Poly1305

at line 114

string

crypto_aead_chacha20poly1305_encrypt(string $msg, string $nonce, string $key, string $ad = '')

Authenticated Encryption with Associated Data (encrypt) ChaCha20 + Poly1305

at line 131

string

crypto_auth(string $msg, string $key)

Secret-key message authentication HMAC SHA-512/256

at line 146

bool

crypto_auth_verify(string $mac, string $msg, string $key)

Secret-key message verification HMAC SHA-512/256

at line 160

string

crypto_box(string $msg, string $nonce, string $keypair)

Public-key authenticated encryption (encrypt) X25519 + Xsalsa20 + Poly1305

at line 175

string

crypto_box_keypair()

Generate an X25519 keypair for use with the crypto_box API

at line 186

string

crypto_box_keypair_from_secretkey_and_publickey(string $secretkey, string $publickey)

Create an X25519 keypair from an X25519 secret key and X25519 public key

at line 205

string

crypto_box_open(string $msg, string $nonce, string $keypair)

Public-key authenticated encryption (decrypt) X25519 + Xsalsa20 + Poly1305

at line 219

string

crypto_box_publickey(string $keypair)

Get an X25519 public key from an X25519 keypair

at line 231

string

crypto_box_publickey_from_secretkey(string $secretkey)

Derive an X25519 public key from an X25519 secret key

at line 241

string

crypto_box_seal(string $message, string $publickey)

Anonymous public-key encryption (encrypt) X25519 + Xsalsa20 + Poly1305 + BLAKE2b

at line 253

string

crypto_box_seal_open(string $encrypted, string $keypair)

Anonymous public-key encryption (decrypt) X25519 + Xsalsa20 + Poly1305 + BLAKE2b

at line 266

string

crypto_box_secretkey(string $keypair)

Extract the X25519 secret key from an X25519 keypair

at line 277

string

crypto_box_seed_keypair(string $seed)

Derive an X25519 keypair for use with the crypto_box API from a seed

at line 194

string

crypto_generichash(string $input, string $key = '', int $length = 32)

Fast and secure cryptographic hash

at line 306

string

crypto_generichash_final(string $state, int $length = 32)

Get the final hash BLAKE2b

at line 346

string

crypto_generichash_init(string $key = '', int $length = 32)

Create a new hash state (e.g. to use for streams) BLAKE2b

at line 320

bool

crypto_generichash_update(string $hashState, string $append)

Update the hash state with some data BLAKE2b

at line 333

string

crypto_kx(string $secretkey, string $publickey, string $client_publickey, string $server_publickey)

Elliptic Curve Diffie Hellman Key Exchange X25519

at line 291

string

crypto_pwhash(int $out_len, string $passwd, string $salt, int $opslimit, int $memlimit)

Secure password-based key derivation function Argon2i

at line 362

string

crypto_pwhash_scryptsalsa208sha256(int $out_len, string $passwd, string $salt, int $opslimit, int $memlimit)

Secure password-based key derivation function Scrypt

at line 409

string

crypto_pwhash_scryptsalsa208sha256_str(string $passwd, int $opslimit, int $memlimit)

Get a formatted password hash (for storage) Scrypt

at line 426

bool

crypto_pwhash_scryptsalsa208sha256_str_verify(string $hash, string $passwd)

Verify a password against a hash Scrypt

at line 440

string

crypto_pwhash_str(string $passwd, int $opslimit, int $memlimit)

Get a formatted password hash (for storage) Argon2i

at line 379

bool

crypto_pwhash_str_verify(string $hash, string $passwd)

Verify a password against a hash Argon2i

at line 393

string

crypto_scalarmult(string $ecdhA, string $ecdhB)

Elliptic Curve Diffie Hellman over Curve25519 X25519

at line 453

string

crypto_scalarmult_base(string $sk)

Scalar multiplication of the base point and your key

at line 789

string

crypto_secretbox(string $plaintext, string $nonce, string $key)

Authenticated secret-key encryption (encrypt) Xsals20 + Poly1305

at line 467

string

crypto_secretbox_open(string $ciphertext, string $nonce, string $key)

Authenticated secret-key encryption (decrypt) Xsals20 + Poly1305

at line 482

string

crypto_shorthash(string $message, string $key)

A short keyed hash suitable for data structures SipHash-2-4

at line 496

string

crypto_sign(string $message, string $secretkey)

Digital Signature Ed25519

at line 509

string

crypto_sign_detached(string $message, string $secretkey)

Digital Signature (detached) Ed25519

at line 522

string

crypto_sign_ed25519_pk_to_curve25519(string $sign_pk)

Convert an Ed25519 public key to an X25519 public key

at line 533

string

crypto_sign_ed25519_sk_to_curve25519(string $sign_sk)

Convert an Ed25519 secret key to an X25519 secret key

at line 543

string

crypto_sign_keypair()

Generate an Ed25519 keypair for use with the crypto_sign API

at line 552

string

crypto_sign_keypair_from_secretkey_and_publickey(string $secretkey, string $publickey)

Create an Ed25519 keypair from an Ed25519 secret key + Ed25519 public key

at line 561

string

crypto_sign_open(string $signed_message, string $publickey)

Verify a signed message and return the plaintext

at line 573

string

crypto_sign_publickey(string $keypair)

Get the public key from an Ed25519 keypair

at line 584

string

crypto_sign_publickey_from_secretkey(string $secretkey)

Derive an Ed25519 public key from an Ed25519 secret key

at line 604

string

crypto_sign_secretkey(string $keypair)

Get the secret key from an Ed25519 keypair

at line 594

string

crypto_sign_seed_keypair(string $seed)

Derive an Ed25519 keypair for use with the crypto_sign API from a seed

at line 614

bool

crypto_sign_verify_detached(string $signature, string $msg, string $publickey)

Verify a detached signature

at line 626

string

crypto_stream(int $length, string $nonce, string $key)

Create a keystream from a key and nonce Xsalsa20

at line 641

string

crypto_stream_xor(string $plaintext, string $nonce, string $key)

Encrypt a message using a stream cipher Xsalsa20

at line 656

string

hex2bin(string $hex)

Convert from hex without side-chanels

at line 720

string

increment(string $nonce)

Increment a string in little-endian

at line 730

int

library_version_major()

Get the true major version of libsodium

at line 749

int

library_version_minor()

Get the true minor version of libsodium

at line 755

int

memcmp(string $left, string $right)

Compare two strings in constant time

at line 764

memzero(string $target)

Wipe a buffer

at line 774

string

randombytes_buf(int $length)

Generate a string of random bytes /dev/urandom

at line 669

int

randombytes_random16()

Generate a 16-bit integer /dev/urandom

at line 679

int

randombytes_uniform(int $upperBoundNonInclusive)

Generate an unbiased random integer between 0 and a specified value /dev/urandom

at line 688

string

version_string()

Get the version string

at line 781