ParagonIE_Sodium_File::box_seal_open( string $inputFile, string $outputFile, string $ecdhKeypair ): bool

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$inputFilestring

$outputFilestring

$ecdhKeypairstring

Return value

bool

Performance profile

How much work a call to ParagonIE_Sodium_File::box_seal_open() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reads or writes the filesystem via file_exists().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

12–95

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 158.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• filesystemfilesystem accessfile_exists()called directly

What one call costs · 9 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost ParagonIE_Sodium_File::box_seal_open() can have, taken from its control-flow graph on PHP 8.5.

Uses · 9

• TypeError::__construct()
• ParagonIE_Sodium_File::strlen()
• ParagonIE_Sodium_Compat::crypto_box_publickey()Extract the public key from a crypto_box keypair.
• SodiumException::__construct()
• ParagonIE_Sodium_Compat::crypto_generichash()Calculates a BLAKE2b hash, with an optional key.
• ParagonIE_Sodium_Compat::crypto_box_keypair_from_secretkey_and_publickey()Combine two keys into a keypair for use in library methods that expect a keypair. This doesn't necessarily have to be the same person's keys.
• ParagonIE_Sodium_Compat::crypto_box_secretkey()Extract the secret key from a crypto_box keypair.
• ParagonIE_Sodium_File::box_decrypt()
• ParagonIE_Sodium_Compat::memzero()It's actually not possible to zero memory buffers in PHP. You need the native library for that.

Source code

View on Trac ↗View on GitHub ↗

288    public static function box_seal_open(289        $inputFile,290        $outputFile,291        #[\SensitiveParameter]292        $ecdhKeypair293    ) {294        /* Type checks: */295        if (!is_string($inputFile)) {296            throw new TypeError('Argument 1 must be a string, ' . gettype($inputFile) . ' given.');297        }298        if (!is_string($outputFile)) {299            throw new TypeError('Argument 2 must be a string, ' . gettype($outputFile) . ' given.');300        }301        if (!is_string($ecdhKeypair)) {302            throw new TypeError('Argument 3 must be a string, ' . gettype($ecdhKeypair) . ' given.');303        }304 305        /* Input validation: */306        if (self::strlen($ecdhKeypair) !== ParagonIE_Sodium_Compat::CRYPTO_BOX_KEYPAIRBYTES) {307            throw new TypeError('Argument 3 must be CRYPTO_BOX_KEYPAIRBYTES bytes');308        }309 310        $publicKey = ParagonIE_Sodium_Compat::crypto_box_publickey($ecdhKeypair);311 312        if (!file_exists($inputFile)) {313            throw new SodiumException('Input file does not exist');314        }315        /** @var int $size */316        $size = filesize($inputFile);317        if (!is_int($size)) {318            throw new SodiumException('Could not obtain the file size');319        }320 321        /** @var resource $ifp */322        $ifp = fopen($inputFile, 'rb');323        if (!is_resource($ifp)) {324            throw new SodiumException('Could not open input file for reading');325        }326 327        /** @var resource $ofp */328        $ofp = @fopen($outputFile, 'wb');329        if (!is_resource($ofp)) {330            fclose($ifp);331            throw new SodiumException('Could not open output file for writing');332        }333 334        $ephemeralPK = fread($ifp, ParagonIE_Sodium_Compat::CRYPTO_BOX_PUBLICKEYBYTES);335        if (!is_string($ephemeralPK)) {336            throw new SodiumException('Could not read input file');337        }338        if (self::strlen($ephemeralPK) !== ParagonIE_Sodium_Compat::CRYPTO_BOX_PUBLICKEYBYTES) {339            fclose($ifp);340            fclose($ofp);341            throw new SodiumException('Could not read public key from sealed file');342        }343 344        $nonce = ParagonIE_Sodium_Compat::crypto_generichash(345            $ephemeralPK . $publicKey,346            '',347            24348        );349        $msgKeypair = ParagonIE_Sodium_Compat::crypto_box_keypair_from_secretkey_and_publickey(350            ParagonIE_Sodium_Compat::crypto_box_secretkey($ecdhKeypair),351            $ephemeralPK352        );353 354        $res = self::box_decrypt($ifp, $ofp, $size, $nonce, $msgKeypair);355        fclose($ifp);356        fclose($ofp);357        try {358            ParagonIE_Sodium_Compat::memzero($nonce);359            ParagonIE_Sodium_Compat::memzero($ephKeypair);360        } catch (SodiumException $ex) {361            if (isset($ephKeypair)) {362                unset($ephKeypair);363            }364        }365        return $res;366    }

Changelog

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/sodium_compat/src/File.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.