sodium_crypto_secretstream_xchacha20poly1305_rekey

Function • Params and return types changed in PHP 8.0

Explicitly rotate the key in the secretstream state.

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_rekey Function synopsis

sodium_crypto_secretstream_xchacha20poly1305_rekey(string &$state): void

Parameters

$state

Passed by referenceTypestring

Secretstream state.

Note that the parameter $state is passed by reference, and contains additional/updated context data that may be useful.

Return value

The sodium_crypto_secretstream_xchacha20poly1305_rekey function is a void function; it does not return any values.

Changes to the sodium_crypto_secretstream_xchacha20poly1305_rekey Function

PHP 8.0

  • Return type added: void
  • Parameter type added for parameter #1 ($state): string
- sodium_crypto_secretstream_xchacha20poly1305_rekey(&$state)
+ sodium_crypto_secretstream_xchacha20poly1305_rekey(string &$state): void

PHP 7.2

  • Function added

sodium_crypto_secretstream_xchacha20poly1305_rekey 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