ParagonIE_Sodium_File::verify( string $sig, string $filePath, string $publicKey ): bool

Compatibility

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

Parameters

$sigstring

Ed25519 signature

$filePathstring

Absolute path to a file on the filesystem

$publicKeystring

Signing public key

Return value

bool

Performance profile

How much work a call to ParagonIE_Sodium_File::verify() 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

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

12–162

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

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 · 21 distinct outcomes

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

Uses · 17

• TypeError::__construct()
• ParagonIE_Sodium_File::strlen()
• SodiumException::__construct()
• ParagonIE_Sodium_File::verify_core32()Verify a file (rather than a string). Uses less memory than ParagonIE_Sodium_Compat::crypto_sign_verify_detached(), but produces the same result. (32-bit)
• ParagonIE_Sodium_Core_Ed25519::chrToInt()
• ParagonIE_Sodium_Core_Ed25519::check_S_lt_L()
• ParagonIE_Sodium_File::substr()
• ParagonIE_Sodium_Core_Ed25519::small_order()
• ParagonIE_Sodium_File::chrToInt()
• ParagonIE_Sodium_Core_Ed25519::ge_frombytes_negate_vartime()
• ParagonIE_Sodium_Core_Ed25519::is_on_main_subgroup()Returns TRUE if $A represents a point on the order of the Edwards25519 prime order subgroup.
• ParagonIE_Sodium_File::hash_update()

Source code

View on Trac ↗View on GitHub ↗

715    public static function verify(716        $sig,717        $filePath,718        $publicKey719    ) {720        /* Type checks: */721        if (!is_string($sig)) {722            throw new TypeError('Argument 1 must be a string, ' . gettype($sig) . ' given.');723        }724        if (!is_string($filePath)) {725            throw new TypeError('Argument 2 must be a string, ' . gettype($filePath) . ' given.');726        }727        if (!is_string($publicKey)) {728            throw new TypeError('Argument 3 must be a string, ' . gettype($publicKey) . ' given.');729        }730 731        /* Input validation: */732        if (self::strlen($sig) !== ParagonIE_Sodium_Compat::CRYPTO_SIGN_BYTES) {733            throw new TypeError('Argument 1 must be CRYPTO_SIGN_BYTES bytes');734        }735        if (self::strlen($publicKey) !== ParagonIE_Sodium_Compat::CRYPTO_SIGN_PUBLICKEYBYTES) {736            throw new TypeError('Argument 3 must be CRYPTO_SIGN_PUBLICKEYBYTES bytes');737        }738        if (self::strlen($sig) < 64) {739            throw new SodiumException('Signature is too short');740        }741 742        if (PHP_INT_SIZE === 4) {743            return self::verify_core32($sig, $filePath, $publicKey);744        }745 746        /* Security checks */747        if (748            (ParagonIE_Sodium_Core_Ed25519::chrToInt($sig[63]) & 240)749                &&750            ParagonIE_Sodium_Core_Ed25519::check_S_lt_L(self::substr($sig, 32, 32))751        ) {752            throw new SodiumException('S < L - Invalid signature');753        }754        if (ParagonIE_Sodium_Core_Ed25519::small_order($sig)) {755            throw new SodiumException('Signature is on too small of an order');756        }757        if ((self::chrToInt($sig[63]) & 224) !== 0) {758            throw new SodiumException('Invalid signature');759        }760        $d = 0;761        for ($i = 0; $i < 32; ++$i) {762            $d |= self::chrToInt($publicKey[$i]);763        }764        if ($d === 0) {765            throw new SodiumException('All zero public key');766        }767 768        if (!file_exists($filePath)) {769            throw new SodiumException('File does not exist');770        }771        /** @var int $size */772        $size = filesize($filePath);773        if (!is_int($size)) {774            throw new SodiumException('Could not obtain the file size');775        }776 777        /** @var resource $fp */778        $fp = fopen($filePath, 'rb');779        if (!is_resource($fp)) {780            throw new SodiumException('Could not open input file for reading');781        }782 783        /** @var bool The original value of ParagonIE_Sodium_Compat::$fastMult */784        $orig = ParagonIE_Sodium_Compat::$fastMult;785 786        // Set ParagonIE_Sodium_Compat::$fastMult to true to speed up verification.787        ParagonIE_Sodium_Compat::$fastMult = true;788 789        if (ParagonIE_Sodium_Core_Ed25519::small_order($publicKey)) {790            throw new SodiumException('Public key has small order');791        }792        /** @var ParagonIE_Sodium_Core_Curve25519_Ge_P3 $A */793        $A = ParagonIE_Sodium_Core_Ed25519::ge_frombytes_negate_vartime($publicKey);794        if (!ParagonIE_Sodium_Core_Ed25519::is_on_main_subgroup($A)) {

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.