Sid Gifari File Manager
🏠 Root
/
home
/
genremedia08
/
musicjukebox.overlookedtracks.com
/
vendor
/
jetbrains
/
phpstorm-stubs
/
sodium
/
Editing: sodium.php
<?php use JetBrains\PhpStorm\Internal\LanguageLevelTypeAware; use JetBrains\PhpStorm\Internal\PhpStormStubsElementAvailable; const SODIUM_CRYPTO_AEAD_AES256GCM_KEYBYTES = 32; const SODIUM_CRYPTO_AEAD_AES256GCM_NSECBYTES = 0; const SODIUM_CRYPTO_AEAD_AES256GCM_NPUBBYTES = 12; const SODIUM_CRYPTO_AEAD_AES256GCM_ABYTES = 16; const SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_KEYBYTES = 32; const SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_NSECBYTES = 0; const SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_NPUBBYTES = 8; const SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_ABYTES = 16; const SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_KEYBYTES = 32; const SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NSECBYTES = 0; const SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_NPUBBYTES = 12; const SODIUM_CRYPTO_AEAD_CHACHA20POLY1305_IETF_ABYTES = 16; const SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_KEYBYTES = 32; const SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NSECBYTES = 0; const SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_NPUBBYTES = 24; const SODIUM_CRYPTO_AEAD_XCHACHA20POLY1305_IETF_ABYTES = 16; const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_ABYTES = 17; const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES = 24; const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTES = 32; const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_MESSAGEBYTES_MAX = 274877906816; const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE = 0; const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_PUSH = 1; const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_REKEY = 2; const SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL = 3; const SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13 = 2; const SODIUM_BASE64_VARIANT_ORIGINAL = 1; const SODIUM_BASE64_VARIANT_ORIGINAL_NO_PADDING = 3; const SODIUM_BASE64_VARIANT_URLSAFE = 5; const SODIUM_BASE64_VARIANT_URLSAFE_NO_PADDING = 7; const SODIUM_CRYPTO_AUTH_BYTES = 32; const SODIUM_CRYPTO_AUTH_KEYBYTES = 32; const SODIUM_CRYPTO_BOX_SEALBYTES = 48; const SODIUM_CRYPTO_BOX_SECRETKEYBYTES = 32; const SODIUM_CRYPTO_BOX_PUBLICKEYBYTES = 32; const SODIUM_CRYPTO_BOX_KEYPAIRBYTES = 64; const SODIUM_CRYPTO_BOX_MACBYTES = 16; const SODIUM_CRYPTO_BOX_NONCEBYTES = 24; const SODIUM_CRYPTO_BOX_SEEDBYTES = 32; const SODIUM_CRYPTO_KX_BYTES = 32; const SODIUM_CRYPTO_KX_PUBLICKEYBYTES = 32; const SODIUM_CRYPTO_KX_SECRETKEYBYTES = 32; const SODIUM_CRYPTO_GENERICHASH_BYTES = 32; const SODIUM_CRYPTO_GENERICHASH_BYTES_MIN = 16; const SODIUM_CRYPTO_GENERICHASH_BYTES_MAX = 64; const SODIUM_CRYPTO_GENERICHASH_KEYBYTES = 32; const SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MIN = 16; const SODIUM_CRYPTO_GENERICHASH_KEYBYTES_MAX = 64; const SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_SALTBYTES = 32; const SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_STRPREFIX = '$7$'; const SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_OPSLIMIT_INTERACTIVE = 524288; const SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_MEMLIMIT_INTERACTIVE = 16777216; const SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_OPSLIMIT_SENSITIVE = 33554432; const SODIUM_CRYPTO_PWHASH_SCRYPTSALSA208SHA256_MEMLIMIT_SENSITIVE = 1073741824; const SODIUM_CRYPTO_SCALARMULT_BYTES = 32; const SODIUM_CRYPTO_SCALARMULT_SCALARBYTES = 32; const SODIUM_CRYPTO_SHORTHASH_BYTES = 8; const SODIUM_CRYPTO_SHORTHASH_KEYBYTES = 16; const SODIUM_CRYPTO_SECRETBOX_KEYBYTES = 32; const SODIUM_CRYPTO_SECRETBOX_MACBYTES = 16; const SODIUM_CRYPTO_SECRETBOX_NONCEBYTES = 24; const SODIUM_CRYPTO_SIGN_BYTES = 64; const SODIUM_CRYPTO_SIGN_SEEDBYTES = 32; const SODIUM_CRYPTO_SIGN_PUBLICKEYBYTES = 32; const SODIUM_CRYPTO_SIGN_SECRETKEYBYTES = 64; const SODIUM_CRYPTO_SIGN_KEYPAIRBYTES = 96; const SODIUM_CRYPTO_STREAM_KEYBYTES = 32; const SODIUM_CRYPTO_STREAM_NONCEBYTES = 24; const SODIUM_CRYPTO_PWHASH_OPSLIMIT_INTERACTIVE = 2; const SODIUM_CRYPTO_PWHASH_MEMLIMIT_INTERACTIVE = 67108864; const SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE = 3; const SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE = 268435456; const SODIUM_CRYPTO_PWHASH_OPSLIMIT_SENSITIVE = 4; const SODIUM_CRYPTO_PWHASH_MEMLIMIT_SENSITIVE = 1073741824; const SODIUM_LIBRARY_VERSION = "1.0.18"; const SODIUM_LIBRARY_MAJOR_VERSION = 10; const SODIUM_LIBRARY_MINOR_VERSION = 3; const SODIUM_CRYPTO_KDF_BYTES_MIN = 16; const SODIUM_CRYPTO_KDF_BYTES_MAX = 64; const SODIUM_CRYPTO_KDF_CONTEXTBYTES = 8; const SODIUM_CRYPTO_KDF_KEYBYTES = 32; const SODIUM_CRYPTO_KX_SEEDBYTES = 32; const SODIUM_CRYPTO_KX_SESSIONKEYBYTES = 32; const SODIUM_CRYPTO_KX_KEYPAIRBYTES = 64; const SODIUM_CRYPTO_PWHASH_ALG_ARGON2I13 = 1; const SODIUM_CRYPTO_PWHASH_ALG_DEFAULT = 2; const SODIUM_CRYPTO_PWHASH_SALTBYTES = 16; const SODIUM_CRYPTO_PWHASH_STRPREFIX = '$argon2id$'; const SODIUM_CRYPTO_STREAM_XCHACHA20_NONCEBYTES = 24; const SODIUM_CRYPTO_STREAM_XCHACHA20_KEYBYTES = 32; const SODIUM_CRYPTO_SCALARMULT_RISTRETTO255_BYTES = 32; const SODIUM_CRYPTO_SCALARMULT_RISTRETTO255_SCALARBYTES = 32; const SODIUM_CRYPTO_CORE_RISTRETTO255_BYTES = 32; const SODIUM_CRYPTO_CORE_RISTRETTO255_HASHBYTES = 64; const SODIUM_CRYPTO_CORE_RISTRETTO255_SCALARBYTES = 32; const SODIUM_CRYPTO_CORE_RISTRETTO255_NONREDUCEDSCALARBYTES = 64; #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_core_ristretto255_add(string $p, string $q): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_core_ristretto255_from_hash(string $s): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_core_ristretto255_is_valid_point(string $s): bool {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_core_ristretto255_random(): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_core_ristretto255_scalar_add(string $x, string $y): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_core_ristretto255_scalar_complement(string $s): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_core_ristretto255_scalar_invert(string $s): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_core_ristretto255_scalar_mul(string $x, string $y): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_core_ristretto255_scalar_negate(string $s): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_core_ristretto255_scalar_reduce(string $s): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_core_ristretto255_scalar_sub(string $x, string $y): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_core_ristretto255_scalar_random(): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_core_ristretto255_sub(string $p, string $q): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_scalarmult_ristretto255(string $n, string $p): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_scalarmult_ristretto255_base(string $n): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_stream_xchacha20(int $length, string $nonce, string $key): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_stream_xchacha20_xor(string $message, string $nonce, string $key): string {} #[PhpStormStubsElementAvailable('8.1')] function sodium_crypto_stream_xchacha20_keygen(): string {} /** * Can you access AES-256-GCM? This is only available if you have supported * hardware. * @link https://www.php.net/manual/en/function.sodium-crypto-aead-aes256gcm-is-available * @return bool * @since 7.2 */ function sodium_crypto_aead_aes256gcm_is_available(): bool {} /** * Authenticated Encryption with Associated Data (decrypt) * AES-256-GCM * @link https://www.php.net/manual/en/function.sodium-crypto-aead-aes256gcm-decrypt.php * @param string $ciphertext encrypted message * @param string $additional_data additional data * @param string $nonce * @param string $key * @return string|false * @throws SodiumException * @since 7.2 */ function sodium_crypto_aead_aes256gcm_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string|false {} /** * Authenticated Encryption with Associated Data (encrypt) * AES-256-GCM * @link https://www.php.net/manual/en/function.sodium-crypto-aead-aes256gcm-encrypt.php * @param string $message plaintext message * @param string $additional_data * @param string $nonce * @param string $key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_aead_aes256gcm_encrypt(string $message, string $additional_data, string $nonce, string $key): string {} /** * Authenticated Encryption with Associated Data (decrypt) * ChaCha20 + Poly1305 * @link https://www.php.net/manual/en/function.sodium-crypto-aead-chacha20poly1305-decrypt.php * @param string $ciphertext encrypted message * @param string $additional_data additional data * @param string $nonce * @param string $key * @return string|false * @throws SodiumException * @since 7.2 */ function sodium_crypto_aead_chacha20poly1305_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string|false {} /** * Authenticated Encryption with Associated Data (encrypt) * ChaCha20 + Poly1305 * @link https://www.php.net/manual/en/function.sodium-crypto-aead-chacha20poly1305-encrypt.php * @param string $message plaintext message * @param string $additional_data additional data * @param string $nonce * @param string $key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_aead_chacha20poly1305_encrypt(string $message, string $additional_data, string $nonce, string $key): string {} /** * Authenticated Encryption with Associated Data (decrypt) * ChaCha20 + Poly1305 (IETF version) * @link https://www.php.net/manual/en/function.sodium-crypto-aead-chacha20poly1305-ietf-decrypt.php * @param string $ciphertext encrypted message * @param string $additional_data additional data * @param string $nonce * @param string $key * @return string|false * @throws SodiumException * @since 7.2 */ function sodium_crypto_aead_chacha20poly1305_ietf_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string|false {} /** * Authenticated Encryption with Associated Data (encrypt) * ChaCha20 + Poly1305 (IETF version) * @link https://www.php.net/manual/en/function.sodium-crypto-aead-chacha20poly1305-ietf-encrypt.php * @param string $message plaintext message * @param string $additional_data additional data * @param string $nonce * @param string $key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_aead_chacha20poly1305_ietf_encrypt( string $message, string $additional_data, string $nonce, string $key ): string {} /** * Secret-key message authentication * HMAC SHA-512/256 * @link https://www.php.net/manual/en/function.sodium-crypto-auth.php * @param string $message * @param string $key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_auth( string $message, string $key ): string {} /** * Get random bytes for key * @link https://php.net/manual/en/function.sodium-crypto-auth-keygen.php * @return string * @since 7.2 */ function sodium_crypto_auth_keygen(): string {} /** * @link https://php.net/manual/en/function.sodium-crypto-kx-keypair.php * @since 7.2 * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_kx_keypair(): string {} /** * @link https://php.net/manual/en/function.sodium-crypto-kx-publickey.php * @since 7.2 * @param string $key_pair * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_kx_publickey(string $key_pair): string {} /** * @link https://php.net/manual/en/function.sodium-crypto-kx-secretkey.php * @param string $key_pair * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_kx_secretkey(string $key_pair): string {} /** * @link https://php.net/manual/en/function.sodium-crypto-kx-seed-keypair.php * @since 7.2 * @param string $seed * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_kx_seed_keypair(string $seed): string {} /** * @link https://php.net/manual/en/function.sodium-crypto-kx-server-session-keys.php * @since 7.2 * @param string $server_key_pair * @param string $client_key * @return string[] * @throws SodiumException * @since 7.2 */ function sodium_crypto_kx_server_session_keys(string $server_key_pair, string $client_key): array {} /** * Get random bytes for key * @link https://php.net/manual/en/function.sodium-crypto-generichash-keygen.php * @return string * @since 7.2 */ function sodium_crypto_generichash_keygen(): string {} /** * @link https://php.net/manual/en/function.sodium-crypto-kx-client-session-keys.php * @param string $client_key_pair * @param string $server_key * @return string[] * @throws SodiumException * @since 7.2 */ function sodium_crypto_kx_client_session_keys(string $client_key_pair, string $server_key): array {} /** * @link https://www.php.net/manual/en/function.sodium-crypto-kdf-derive-from-key.php * @param int $subkey_length * @param int $subkey_id * @param string $context * @param string $key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_kdf_derive_from_key(int $subkey_length, int $subkey_id, string $context, string $key): string {} /** * Get random bytes for key * @link https://php.net/manual/en/function.sodium-crypto-kdf-keygen.php * @since 7.2 * @return string */ function sodium_crypto_kdf_keygen(): string {} /** * Get random bytes for key * @link https://php.net/manual/en/function.sodium-crypto-shorthash-keygen.php * @since 7.2 * @return string */ function sodium_crypto_shorthash_keygen(): string {} /** * Get random bytes for key * @link https://php.net/manual/en/function.sodium-crypto-stream-keygen.php * @since 7.2 * @return string */ function sodium_crypto_stream_keygen(): string {} /** * Add padding data * @link https://php.net/manual/en/function.sodium-pad.php * @param string $string * @param int $block_size * @return string * @throws SodiumException * @since 7.2 */ function sodium_pad(string $string, int $block_size): string {} /** * Remove padding data * @link https://php.net/manual/en/function.sodium-unpad.php * @param string $string * @param int $block_size * @return string * @throws SodiumException * @since 7.2 */ function sodium_unpad(string $string, int $block_size): string {} /** * Secret-key message verification * HMAC SHA-512/256 * @link https://www.php.net/manual/en/function.sodium-crypto-auth-verify.php * @param string $mac * @param string $message * @param string $key * @return bool * @throws SodiumException * @since 7.2 */ function sodium_crypto_auth_verify(string $mac, string $message, string $key): bool {} /** * Public-key authenticated encryption (encrypt) * X25519 + Xsalsa20 + Poly1305 * @link https://www.php.net/manual/en/function.sodium-crypto-box.php * @param string $message * @param string $nonce * @param string $key_pair * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_box(string $message, string $nonce, string $key_pair): string {} /** * Generate an X25519 keypair for use with the sodium_crypto_box API * @link https://www.php.net/manual/en/function.sodium-crypto-box-keypair.php * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_box_keypair(): string {} /** * Derive an X25519 keypair for use with the sodium_crypto_box API from a seed * @link https://www.php.net/manual/en/function.sodium-crypto-box-seed-keypair.php * @param string $seed * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_box_seed_keypair(string $seed): string {} /** * Create an X25519 keypair from an X25519 secret key and X25519 public key * @link https://www.php.net/manual/en/function.sodium-crypto-box-keypair-from-secretkey-and-publickey.php * @param string $secret_key * @param string $public_key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_box_keypair_from_secretkey_and_publickey(string $secret_key, string $public_key): string {} /** * Public-key authenticated encryption (decrypt) * X25519 + Xsalsa20 + Poly1305 * @link https://www.php.net/manual/en/function.sodium-crypto-box-open.php * @param string $ciphertext * @param string $nonce * @param string $key_pair * @return string|false * @throws SodiumException * @since 7.2 */ function sodium_crypto_box_open(string $ciphertext, string $nonce, string $key_pair): string|false {} /** * Get an X25519 public key from an X25519 keypair * @link https://www.php.net/manual/en/function.sodium-crypto-box-publickey.php * @param string $key_pair * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_box_publickey(string $key_pair): string {} /** * Derive an X25519 public key from an X25519 secret key * @link https://www.php.net/manual/en/function.sodium-crypto-box-publickey-from-secretkey.php * @param string $secret_key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_box_publickey_from_secretkey(string $secret_key): string {} /** * Anonymous public-key encryption (encrypt) * X25519 + Xsalsa20 + Poly1305 + BLAKE2b * @link https://www.php.net/manual/en/function.sodium-crypto-box-seal.php * @param string $message * @param string $public_key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_box_seal(string $message, string $public_key): string {} /** * Anonymous public-key encryption (decrypt) * X25519 + Xsalsa20 + Poly1305 + BLAKE2b * @link https://www.php.net/manual/en/function.sodium-crypto-box-seal-open.php * @param string $ciphertext * @param string $key_pair * @return string|false * @throws SodiumException * @since 7.2 */ function sodium_crypto_box_seal_open(string $ciphertext, string $key_pair): string|false {} /** * Extract the X25519 secret key from an X25519 keypair * @link https://www.php.net/manual/en/function.sodium-crypto-box-secretkey.php * @param string $key_pair * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_box_secretkey(string $key_pair): string {} /** * Elliptic Curve Diffie Hellman Key Exchange * X25519 * @param string $secret_key * @param string $public_key * @param string $client_publickey * @param string $server_publickey * @return string * @since 7.2 */ function sodium_crypto_kx( string $secret_key, string $public_key, string $client_publickey, string $server_publickey ): string {} /** * Fast and secure cryptographic hash * @link https://www.php.net/manual/en/function.sodium-crypto-generichash.php * @param string $message * @param string $key * @param int $length * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_generichash(string $message, string $key = '', int $length = 32): string {} /** * Create a new hash state (e.g. to use for streams) * BLAKE2b * @link https://www.php.net/manual/en/function.sodium-crypto-generichash-init.php * @param string $key * @param int $length * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_generichash_init( string $key = '', int $length = 32 ): string {} /** * Update the hash state with some data * BLAKE2b * @link https://www.php.net/manual/en/function.sodium-crypto-generichash-update.php * @param string &$state * @param string $message * @return bool * @throws SodiumException * @since 7.2 */ #[LanguageLevelTypeAware(['8.2' => 'true'], default: 'bool')] function sodium_crypto_generichash_update(string &$state, string $message): bool {} /** * Get the final hash * BLAKE2b * @link https://www.php.net/manual/en/function.sodium-crypto-generichash-final.php * @param string &$state * @param int $length * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_generichash_final( string &$state, int $length = 32 ): string {} /** * Secure password-based key derivation function * Argon2i * @link https://www.php.net/manual/en/function.sodium-crypto-pwhash.php * @param int $length * @param string $password * @param string $salt * @param int $opslimit * @param int $memlimit * @param int $algo [optional] * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_pwhash(int $length, string $password, string $salt, int $opslimit, int $memlimit, int $algo = SODIUM_CRYPTO_PWHASH_ALG_DEFAULT): string {} /** * Get a formatted password hash (for storage) * Argon2i * @link https://www.php.net/manual/en/function.sodium-crypto-pwhash-str.php * @param string $password * @param int $opslimit * @param int $memlimit * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_pwhash_str(string $password, int $opslimit, int $memlimit): string {} /** * Verify a password against a hash * Argon2i * @link https://www.php.net/manual/en/function.sodium-crypto-pwhash-str-verify.php * @param string $hash * @param string $password * @return bool * @throws SodiumException * @since 7.2 */ function sodium_crypto_pwhash_str_verify(string $hash, string $password): bool {} /** * Secure password-based key derivation function * Scrypt * @link https://www.php.net/manual/en/function.sodium-crypto-pwhash-scryptsalsa208sha256.php * @param int $length * @param string $password * @param string $salt * @param int $opslimit * @param int $memlimit * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_pwhash_scryptsalsa208sha256( int $length, string $password, string $salt, int $opslimit, int $memlimit, #[PhpStormStubsElementAvailable(from: '7.2', to: '7.4')] $alg = null ): string {} /** * Get a formatted password hash (for storage) * Scrypt * @link https://www.php.net/manual/en/function.sodium-crypto-pwhash-scryptsalsa208sha256-str.php * @param string $password * @param int $opslimit * @param int $memlimit * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_pwhash_scryptsalsa208sha256_str(string $password, int $opslimit, int $memlimit): string {} /** * Verify a password against a hash * Scrypt * @link https://www.php.net/manual/en/function.sodium-crypto-pwhash-scryptsalsa208sha256-str-verify * @param string $hash * @param string $password * @return bool * @since 7.2 */ function sodium_crypto_pwhash_scryptsalsa208sha256_str_verify(string $hash, string $password): bool {} /** * Elliptic Curve Diffie Hellman over Curve25519 * X25519 * @link https://www.php.net/manual/en/function.sodium-crypto-scalarmult.php * @param string $n * @param string $p * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_scalarmult(string $n, string $p): string {} /** * Authenticated secret-key encryption (encrypt) * Xsals20 + Poly1305 * @link https://www.php.net/manual/en/function.sodium-crypto-secretbox.php * @param string $message * @param string $nonce * @param string $key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_secretbox(string $message, string $nonce, string $key): string {} /** * Authenticated secret-key encryption (decrypt) * Xsals20 + Poly1305 * @link https://www.php.net/manual/en/function.sodium-crypto-secretbox-open.php * @param string $ciphertext * @param string $nonce * @param string $key * @return string|false * @throws SodiumException * @since 7.2 */ function sodium_crypto_secretbox_open(string $ciphertext, string $nonce, string $key): string|false {} /** * A short keyed hash suitable for data structures * SipHash-2-4 * @link https://www.php.net/manual/en/function.sodium-crypto-shorthash.php * @param string $message * @param string $key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_shorthash(string $message, string $key): string {} /** * Digital Signature * Ed25519 * @link https://www.php.net/manual/en/function.sodium-crypto-sign.php * @param string $message * @param string $secret_key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_sign(string $message, string $secret_key): string {} /** * Digital Signature (detached) * Ed25519 * @link https://www.php.net/manual/en/function.sodium-crypto-sign-detached.php * @param string $message * @param string $secret_key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_sign_detached(string $message, string $secret_key): string {} /** * Convert an Ed25519 public key to an X25519 public key * @link https://www.php.net/manual/en/function.sodium-crypto-sign-ed25519-pk-to-curve25519.php * @param string $public_key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_sign_ed25519_pk_to_curve25519(string $public_key): string {} /** * Convert an Ed25519 secret key to an X25519 secret key * @link https://www.php.net/manual/en/function.sodium-crypto-sign-ed25519-sk-to-curve25519.php * @param string $secret_key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_sign_ed25519_sk_to_curve25519(string $secret_key): string {} /** * Generate an Ed25519 keypair for use with the crypto_sign API * @link https://www.php.net/manual/en/function.sodium-crypto-sign-keypair.php * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_sign_keypair(): string {} /** * Create an Ed25519 keypair from an Ed25519 secret key + Ed25519 public key * @link https://www.php.net/manual/en/function.sodium-crypto-sign-keypair-from-secretkey-and-publickey.php * @param string $secret_key * @param string $public_key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_sign_keypair_from_secretkey_and_publickey( string $secret_key, string $public_key ): string {} /** * Verify a signed message and return the plaintext * @link https://www.php.net/manual/en/function.sodium-crypto-sign-open.php * @param string $signed_message * @param string $public_key * @return string|false * @throws SodiumException * @since 7.2 */ function sodium_crypto_sign_open(string $signed_message, string $public_key): string|false {} /** * Get the public key from an Ed25519 keypair * @link https://www.php.net/manual/en/function.sodium-crypto-sign-publickey.php * @param string $key_pair * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_sign_publickey(string $key_pair): string {} /** * Get the secret key from an Ed25519 keypair * @link https://www.php.net/manual/en/function.sodium-crypto-sign-secretkey.php * @param string $key_pair * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_sign_secretkey(string $key_pair): string {} /** * Derive an Ed25519 public key from an Ed25519 secret key * @link https://www.php.net/manual/en/function.sodium-crypto-sign-publickey-from-secretkey.php * @param string $secret_key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_sign_publickey_from_secretkey(string $secret_key): string {} /** * Derive an Ed25519 keypair for use with the crypto_sign API from a seed * @link https://www.php.net/manual/en/function.sodium-crypto-sign-seed-keypair.php * @param string $seed * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_sign_seed_keypair(string $seed): string {} /** * Verify a detached signature * @link https://www.php.net/manual/en/function.sodium-crypto-sign-verify-detached.php * @param string $signature * @param string $message * @param string $public_key * @return bool * @throws SodiumException * @since 7.2 */ function sodium_crypto_sign_verify_detached(string $signature, string $message, string $public_key): bool {} /** * Create a keystream from a key and nonce * Xsalsa20 * @link https://www.php.net/manual/en/function.sodium-crypto-stream.php * @param int $length * @param string $nonce * @param string $key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_stream( int $length, string $nonce, string $key ): string {} /** * Encrypt a message using a stream cipher * Xsalsa20 * @link https://www.php.net/manual/en/function.sodium-crypto-stream-xor.php * @param string $message * @param string $nonce * @param string $key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_stream_xor( string $message, string $nonce, string $key ): string {} /** * Generate a string of random bytes * /dev/urandom * * @param int $length * @return string|false * @since 7.2 */ function sodium_randombytes_buf(int $length): string {} /** * Generate a 16-bit integer * /dev/urandom * * @return int * @since 7.2 */ function sodium_randombytes_random16(): int {} /** * Generate an unbiased random integer between 0 and a specified value * /dev/urandom * * @param int $upperBoundNonInclusive * @return int * @since 7.2 */ function sodium_randombytes_uniform(int $upperBoundNonInclusive): int {} /** * Convert to hex without side-chanels * @link https://www.php.net/manual/en/function.sodium-bin2hex.php * @param string $string * @return string * @throws SodiumException * @since 7.2 */ function sodium_bin2hex(string $string): string {} /** * Compare two strings in constant time * @link https://www.php.net/manual/en/function.sodium-compare.php * @param string $string1 * @param string $string2 * @return int * @throws SodiumException * @since 7.2 */ function sodium_compare(string $string1, string $string2): int {} /** * Convert from hex without side-chanels * @link https://www.php.net/manual/en/function.sodium-hex2bin.php * @param string $string * @param string $ignore * @return string * @throws SodiumException * @since 7.2 */ function sodium_hex2bin(string $string, string $ignore = ''): string {} /** * Increment a string in little-endian * @link https://www.php.net/manual/en/function.sodium-increment.php * @param string &$string * @return void * @throws SodiumException * @since 7.2 */ function sodium_increment(string &$string): void {} /** * Add the right operand to the left * @link https://www.php.net/manual/en/function.sodium-add.php * @param string &$string1 * @param string $string2 * @throws SodiumException * @since 7.2 */ function sodium_add(string &$string1, string $string2): void {} /** * Get the true major version of libsodium * @return int * @since 7.2 */ function sodium_library_version_major(): int {} /** * Get the true minor version of libsodium * @return int * @since 7.2 */ function sodium_library_version_minor(): int {} /** * Compare two strings in constant time * @link https://www.php.net/manual/en/function.sodium-memcmp.php * @param string $string1 * @param string $string2 * @return int * @throws SodiumException * @since 7.2 */ function sodium_memcmp(string $string1, string $string2): int {} /** * Wipe a buffer * @link https://www.php.net/manual/en/function.sodium-memzero.php * @param string &$string * @throws SodiumException * @since 7.2 */ function sodium_memzero(string &$string): void {} /** * Get the version string * * @return string * @since 7.2 */ function sodium_version_string(): string {} /** * Scalar multiplication of the base point and your key * @link https://www.php.net/manual/en/function.sodium-crypto-scalarmult-base * @param string $secret_key * @return string * @throws SodiumException * @since 7.2 */ function sodium_crypto_scalarmult_base( string $secret_key, #[PhpStormStubsElementAvailable(from: '7.2', to: '7.4')] $string_2 ): string {} /** * Creates a random key * * It is equivalent to calling random_bytes() but improves code clarity and can * prevent misuse by ensuring that the provided key length is always be correct. * * @since 7.2 * @see https://secure.php.net/manual/en/function.sodium-crypto-secretbox-keygen.php */ function sodium_crypto_secretbox_keygen(): string {} /** * Creates a random key * * It is equivalent to calling random_bytes() but improves code clarity and can * prevent misuse by ensuring that the provided key length is always be correct. * * @since 7.2 * @see https://secure.php.net/manual/en/function.sodium-crypto-aead-aes256gcm-keygen.php */ function sodium_crypto_aead_aes256gcm_keygen(): string {} /** * Creates a random key * It is equivalent to calling random_bytes() but improves code clarity and can * prevent misuse by ensuring that the provided key length is always be correct. * * @since 7.2 * @see https://secure.php.net/manual/en/function.sodium-crypto-aead-chacha20poly1305-keygen.php */ function sodium_crypto_aead_chacha20poly1305_keygen(): string {} /** * Creates a random key * * It is equivalent to calling random_bytes() but improves code clarity and can * prevent misuse by ensuring that the provided key length is always be correct. * * @since 7.2 * @see https://secure.php.net/manual/en/function.sodium-crypto-aead-chacha20poly1305-ietf-keygen.php */ function sodium_crypto_aead_chacha20poly1305_ietf_keygen(): string {} /** * @param string $ciphertext * @param string $additional_data * @param string $nonce * @param string $key * @return string|false * @throws SodiumException * @since 7.2 * @see https://www.php.net/manual/en/function.sodium-crypto-aead-xchacha20poly1305-ietf-decrypt.php */ function sodium_crypto_aead_xchacha20poly1305_ietf_decrypt(string $ciphertext, string $additional_data, string $nonce, string $key): string|false {} /** * @param string $message * @param string $additional_data * @param string $nonce * @param string $key * @return string * @throws SodiumException * @since 7.2 * https://www.php.net/manual/en/function.sodium-crypto-aead-xchacha20poly1305-ietf-encrypt.php */ function sodium_crypto_aead_xchacha20poly1305_ietf_encrypt(string $message, string $additional_data, string $nonce, string $key): string {} /** * @since 7.2 * @see https://www.php.net/manual/en/function.sodium-crypto-aead-xchacha20poly1305-ietf-keygen.php */ function sodium_crypto_aead_xchacha20poly1305_ietf_keygen(): string {} /** * @param string $password * @param int $opslimit * @param int $memlimit * @return bool * @since 7.2 * @see https://www.php.net/manual/en/function.sodium-crypto-pwhash-str-needs-rehash.php */ function sodium_crypto_pwhash_str_needs_rehash(string $password, int $opslimit, int $memlimit): bool {} /** * @since 7.2 * @see https://www.php.net/manual/en/function.sodium-crypto-secretstream-xchacha20poly1305-keygen.php */ function sodium_crypto_secretstream_xchacha20poly1305_keygen(): string {} /** * @param string $key * @return array * @throws SodiumException * @since 7.2 * @see https://www.php.net/manual/en/function.sodium-crypto-secretstream-xchacha20poly1305-init-push.php */ function sodium_crypto_secretstream_xchacha20poly1305_init_push(string $key): array {} /** * @param string $header * @param string $key * @return string * @throws SodiumException * @since 7.2 * @see https://www.php.net/manual/en/function.sodium-crypto-secretstream-xchacha20poly1305-init-pull.php */ function sodium_crypto_secretstream_xchacha20poly1305_init_pull(string $header, string $key): string {} /** * @param string &$state * @throws SodiumException * @since 7.2 * @see https://www.php.net/manual/en/function.sodium-crypto-secretstream-xchacha20poly1305-rekey.php */ function sodium_crypto_secretstream_xchacha20poly1305_rekey(string &$state): void {} /** * @param string $string * @param int $id * @return string * @throws SodiumException * @since 7.2 * @see https://www.php.net/manual/en/function.sodium-bin2base64.php */ function sodium_bin2base64(string $string, int $id): string {} /** * @param string $string * @param int $id * @param string $ignore * @throws SodiumException * @since 7.2 * @see https://www.php.net/manual/en/function.sodium-base642bin.php * @return string */ function sodium_base642bin(string $string, int $id, string $ignore = ''): string {} class SodiumException extends Exception {}
Save
Cancel