ParagonIE_Sodium_File

Methods · 21

• box()Box a file (rather than a string). Uses less memory than ParagonIE_Sodium_Compat::crypto_box(), but produces the same result.
• box_open()Open a boxed file (rather than a string). Uses less memory than ParagonIE_Sodium_Compat::crypto_box_open(), but produces the same result.
• box_seal()Seal a file (rather than a string). Uses less memory than ParagonIE_Sodium_Compat::crypto_box_seal(), but produces the same result.
• box_seal_open()Open a sealed file (rather than a string). Uses less memory than ParagonIE_Sodium_Compat::crypto_box_seal_open(), but produces the same result.
• generichash()Calculate the BLAKE2b hash of a file.
• secretbox()Encrypt a file (rather than a string). Uses less memory than ParagonIE_Sodium_Compat::crypto_secretbox(), but produces the same result.
• secretbox_open()Seal a file (rather than a string). Uses less memory than ParagonIE_Sodium_Compat::crypto_secretbox_open(), but produces the same result.
• sign()Sign a file (rather than a string). Uses less memory than ParagonIE_Sodium_Compat::crypto_sign_detached(), but produces the same result.
• verify()Verify a file (rather than a string). Uses less memory than ParagonIE_Sodium_Compat::crypto_sign_verify_detached(), but produces the same result.
• box_encrypt()
• box_decrypt()
• secretbox_encrypt()Encrypt a file
• secretbox_decrypt()Decrypt a file
• onetimeauth_verify()
• updateHashWithFile()Update a hash context with the contents of a file, without loading the entire file into memory.
• 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)
• 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)
• secretbox_encrypt_core32()Encrypt a file (32-bit)
• secretbox_decrypt_core32()Decrypt a file (32-bit)
• onetimeauth_verify_core32()One-time message authentication for 32-bit systems
• ftell()

Source

View on Trac ↗View on GitHub ↗

9class ParagonIE_Sodium_File extends ParagonIE_Sodium_Core_Util10{11    /* PHP's default buffer size is 8192 for fread()/fwrite(). */12    const BUFFER_SIZE = 8192;13 14    /**15     * Box a file (rather than a string). Uses less memory than16     * ParagonIE_Sodium_Compat::crypto_box(), but produces17     * the same result.18     *19     * @param string $inputFile  Absolute path to a file on the filesystem20     * @param string $outputFile Absolute path to a file on the filesystem21     * @param string $nonce      Number to be used only once22     * @param string $keyPair    ECDH secret key and ECDH public key concatenated23     *24     * @return bool25     * @throws SodiumException26     * @throws TypeError27     */28    public static function box(29        $inputFile,30        $outputFile,31        $nonce,32        #[\SensitiveParameter]33        $keyPair34    ) {35        /* Type checks: */36        if (!is_string($inputFile)) {37            throw new TypeError('Argument 1 must be a string, ' . gettype($inputFile) . ' given.');38        }39        if (!is_string($outputFile)) {40            throw new TypeError('Argument 2 must be a string, ' . gettype($outputFile) . ' given.');41        }42        if (!is_string($nonce)) {43            throw new TypeError('Argument 3 must be a string, ' . gettype($nonce) . ' given.');44        }45 46        /* Input validation: */47        if (!is_string($keyPair)) {48            throw new TypeError('Argument 4 must be a string, ' . gettype($keyPair) . ' given.');49        }50        if (self::strlen($nonce) !== ParagonIE_Sodium_Compat::CRYPTO_BOX_NONCEBYTES) {51            throw new TypeError('Argument 3 must be CRYPTO_BOX_NONCEBYTES bytes');52        }53        if (self::strlen($keyPair) !== ParagonIE_Sodium_Compat::CRYPTO_BOX_KEYPAIRBYTES) {54            throw new TypeError('Argument 4 must be CRYPTO_BOX_KEYPAIRBYTES bytes');55        }56 57        /** @var int $size */58        $size = filesize($inputFile);59        if (!is_int($size)) {60            throw new SodiumException('Could not obtain the file size');61        }62 63        /** @var resource $ifp */64        $ifp = fopen($inputFile, 'rb');65        if (!is_resource($ifp)) {66            throw new SodiumException('Could not open input file for reading');67        }68 69        /** @var resource $ofp */70        $ofp = fopen($outputFile, 'wb');71        if (!is_resource($ofp)) {72            fclose($ifp);73            throw new SodiumException('Could not open output file for writing');74        }75 76        $res = self::box_encrypt($ifp, $ofp, $size, $nonce, $keyPair);77        fclose($ifp);78        fclose($ofp);79        return $res;80    }81 82    /**83     * Open a boxed file (rather than a string). Uses less memory than84     * ParagonIE_Sodium_Compat::crypto_box_open(), but produces85     * the same result.86     *87     * Warning: Does not protect against TOCTOU attacks. You should88     * just load the file into memory and use crypto_box_open() if

History

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 6.8.8 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.