sodium_crypto_secretstream_xchacha20poly1305_init_pull

Function • Params and return types changed in PHP 8.0

Initialize a secretstream context for decryption.

PHP 5
PHP 7.0-7.1
PHP 7.2
Added
PHP 7.3-7.4
PHP 8.0
Improved
PHP 8.1
PHP 8.2
PHP 8.3
PHP 8.4
PHP 8.5

sodium_crypto_secretstream_xchacha20poly1305_init_pull Function synopsis

sodium_crypto_secretstream_xchacha20poly1305_init_pull(string $header, string $key): string

Parameters

$header

Typestring

The header of the secretstream. This should be one of the values produced by sodium_crypto_secretstream_xchacha20poly1305_init_push.

$key

Typestring

Encryption key (256-bit).

Return value

Typestring

Secretstream state.

Changes to the sodium_crypto_secretstream_xchacha20poly1305_init_pull Function

PHP 8.0

  • Return type added: string
  • Parameter name of parameter #1 changed: $string to $header
  • Parameter type added for parameter #1 ($header): string
  • Parameter type added for parameter #2 ($key): string
- sodium_crypto_secretstream_xchacha20poly1305_init_pull($string, $key)
+ sodium_crypto_secretstream_xchacha20poly1305_init_pull(string $header, string $key): string

PHP 7.2

  • Function added

sodium_crypto_secretstream_xchacha20poly1305_init_pull Function Availability

PHP VersionAvailability
PHP 8.5Future Release Yes
PHP 8.4Upcoming Release Yes
PHP 8.3Supported (Latest) Yes
PHP 8.2Supported Yes
PHP 8.1Security-Fixes Only Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported No
PHP 7.0Unsupported No
PHP 5.6Unsupported No
PHP 5.5Unsupported No
PHP 5.4Unsupported No
PHP 5.3Unsupported No