sodium_crypto_box_secretkey

Function • Misc changes in PHP 8.2

Extracts the secret key from a crypto_box keypair.

PHP 5

PHP 7.0-7.1

Added

PHP 7.3-7.4

Improved

PHP 8.1-8.2

PHP 8.3-8.4

PHP 8.5

PHP 8.6

`sodium_crypto_box_secretkey` Function synopsis

sodium_crypto_box_secretkey(string $key_pair): string

Parameters

`$key_pair`

Typestring

A keypair, such as one generated by sodium_crypto_box_keypair or sodium_crypto_box_seed_keypair

Return value

Typestring

X25519 secret key.

Changes to the `sodium_crypto_box_secretkey` Function

PHP 8.2

Attribute added for parameter $key_pair: #[SensitiveParameter]

PHP 8.0

Return type added: string
Parameter name of parameter #1 changed: $key to $key_pair
Parameter type added for parameter #1 ($key_pair): string

- sodium_crypto_box_secretkey($key)
+ sodium_crypto_box_secretkey(string $key_pair): string

PHP 7.2

Function added

`sodium_crypto_box_secretkey` Function Availability

PHP Version	Availability
PHP 8.6Upcoming Release	Yes
PHP 8.5Supported (Latest)	Yes
PHP 8.4Supported	Yes
PHP 8.3Supported	Yes
PHP 8.2Security-Fixes Only	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