ParagonIE_Sodium_File::sign( string $filePath, string $secretKey ): string

Compatibility

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

Parameters

$filePathstring

Absolute path to a file on the filesystem

$secretKeystring

Secret signing key

Return value

string

Ed25519 signature

Performance profile

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

11–172

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

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

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

Uses · 14

• TypeError::__construct()
• ParagonIE_Sodium_File::strlen()
• ParagonIE_Sodium_File::sign_core32()Sign a file (rather than a string). Uses less memory than ParagonIE_Sodium_Compat::crypto_sign_detached(), but produces the same result. (32-bit)
• SodiumException::__construct()
• ParagonIE_Sodium_File::substr()
• ParagonIE_Sodium_File::intToChr()
• ParagonIE_Sodium_File::chrToInt()
• ParagonIE_Sodium_File::hash_update()
• ParagonIE_Sodium_File::updateHashWithFile()Update a hash context with the contents of a file, without loading the entire file into memory.
• ParagonIE_Sodium_Core_Ed25519::sc_reduce()
• ParagonIE_Sodium_Core_Ed25519::ge_p3_tobytes()
• ParagonIE_Sodium_Core_Ed25519::ge_scalarmult_base()

Source code

View on Trac ↗View on GitHub ↗

613    public static function sign(614        $filePath,615        #[\SensitiveParameter]616        $secretKey617    ) {618        /* Type checks: */619        if (!is_string($filePath)) {620            throw new TypeError('Argument 1 must be a string, ' . gettype($filePath) . ' given.');621        }622        if (!is_string($secretKey)) {623            throw new TypeError('Argument 2 must be a string, ' . gettype($secretKey) . ' given.');624        }625 626        /* Input validation: */627        if (self::strlen($secretKey) !== ParagonIE_Sodium_Compat::CRYPTO_SIGN_SECRETKEYBYTES) {628            throw new TypeError('Argument 2 must be CRYPTO_SIGN_SECRETKEYBYTES bytes');629        }630        if (PHP_INT_SIZE === 4) {631            return self::sign_core32($filePath, $secretKey);632        }633 634        if (!file_exists($filePath)) {635            throw new SodiumException('File does not exist');636        }637        /** @var int $size */638        $size = filesize($filePath);639        if (!is_int($size)) {640            throw new SodiumException('Could not obtain the file size');641        }642 643        /** @var resource $fp */644        $fp = fopen($filePath, 'rb');645        if (!is_resource($fp)) {646            throw new SodiumException('Could not open input file for reading');647        }648 649        /** @var string $az */650        $az = hash('sha512', self::substr($secretKey, 0, 32), true);651 652        $az[0] = self::intToChr(self::chrToInt($az[0]) & 248);653        $az[31] = self::intToChr((self::chrToInt($az[31]) & 63) | 64);654 655        $hs = hash_init('sha512');656        self::hash_update($hs, self::substr($az, 32, 32));657        /** @var resource $hs */658        $hs = self::updateHashWithFile($hs, $fp, $size);659 660        /** @var string $nonceHash */661        $nonceHash = hash_final($hs, true);662 663        /** @var string $pk */664        $pk = self::substr($secretKey, 32, 32);665 666        /** @var string $nonce */667        $nonce = ParagonIE_Sodium_Core_Ed25519::sc_reduce($nonceHash) . self::substr($nonceHash, 32);668 669        /** @var string $sig */670        $sig = ParagonIE_Sodium_Core_Ed25519::ge_p3_tobytes(671            ParagonIE_Sodium_Core_Ed25519::ge_scalarmult_base($nonce)672        );673 674        $hs = hash_init('sha512');675        self::hash_update($hs, self::substr($sig, 0, 32));676        self::hash_update($hs, self::substr($pk, 0, 32));677        /** @var resource $hs */678        $hs = self::updateHashWithFile($hs, $fp, $size);679 680        /** @var string $hramHash */681        $hramHash = hash_final($hs, true);682 683        /** @var string $hram */684        $hram = ParagonIE_Sodium_Core_Ed25519::sc_reduce($hramHash);685 686        /** @var string $sigAfter */687        $sigAfter = ParagonIE_Sodium_Core_Ed25519::sc_muladd($hram, $az, $nonce);688 689        /** @var string $sig */690        $sig = self::substr($sig, 0, 32) . self::substr($sigAfter, 0, 32);691 692        try {

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.