• Home
• ParagonIE
• Halite
• File

PHP Class ParagonIE\Halite\File

Cryptography operations for the filesystem. This library makes heavy use of return-type declarations, which are a PHP 7 only feature. Read more about them here: Show file Open project: paragonie/halite Class Usage Examples

Public Methods

Method	Description
checksum ( string | resource $filePath, Key $key = null, boolean $raw = false ) : string	Calculate the BLAKE2b-512 checksum of a file. This method doesn't load the entire file into memory. You may optionally supply a key to use in the BLAKE2b hash.
checksum ( string | resource $filePath, Key $key = null, mixed $encoding = Halite::ENCODE_BASE64URLSAFE ) : string	Calculate the BLAKE2b-512 checksum of a file. This method doesn't load the entire file into memory. You may optionally supply a key to use in the BLAKE2b hash.
decrypt ( string | resource $input, string | resource $output, EncryptionKey $key ) : boolean	Decrypt a file using symmetric-key authenticated encryption.
encrypt ( string | resource $input, string | resource $output, EncryptionKey $key ) : integer	Encrypt a file using symmetric authenticated encryption.
seal ( string | resource $input, string | resource $output, EncryptionPublicKey $publicKey ) : integer	Encrypt a file using anonymous public-key encryption (with ciphertext authentication).
sign ( string | resource $filename, SignatureSecretKey $secretKey, boolean $raw_binary = false ) : string	Calculate a digital signature (Ed25519) of a file
sign ( string | resource $filename, SignatureSecretKey $secretKey, mixed $encoding = Halite::ENCODE_BASE64URLSAFE ) : string	Calculate a digital signature (Ed25519) of a file
unseal ( string | resource $input, string | resource $output, EncryptionSecretKey $secretKey ) : boolean	Decrypt a file using anonymous public-key encryption. Ciphertext integrity is still assured thanks to the Encrypt-then-MAC construction.
verify ( string | resource $filename, SignaturePublicKey $publicKey, string $signature, boolean $raw_binary = false ) : boolean	Verify a digital signature for a file.
verify ( string | resource $filename, SignaturePublicKey $publicKey, string $signature, mixed $encoding = Halite::ENCODE_BASE64URLSAFE ) : boolean	Verify a digital signature for a file.

Protected Methods

Method	Description
checksumData ( StreamInterface $fileStream, Key $key = null, boolean $raw = false ) : string	Calculate the BLAKE2b checksum of the contents of a file
checksumData ( StreamInterface $fileStream, Key $key = null, mixed $encoding = Halite::ENCODE_BASE64URLSAFE ) : string	Calculate the BLAKE2b checksum of the contents of a file
decryptData ( ReadOnlyFile $input, MutableFile $output, EncryptionKey $key ) : boolean	Decrypt the contents of a file.
encryptData ( ReadOnlyFile $input, MutableFile $output, EncryptionKey $key ) : integer	Encrypt the contents of a file.
getConfig ( string $header, string $mode = 'encrypt' ) : Config	Get the configuration
getConfigChecksum ( integer $major, integer $minor ) : array	Get the configuration for encrypt operations
getConfigEncrypt ( integer $major, integer $minor ) : array	Get the configuration for encrypt operations
getConfigSeal ( integer $major, integer $minor ) : array	Get the configuration for seal operations
sealData ( ReadOnlyFile $input, MutableFile $output, EncryptionPublicKey $publicKey ) : integer	Seal the contents of a file.
signData ( ReadOnlyFile $input, SignatureSecretKey $secretKey, boolean $raw_binary = false ) : string	Sign the contents of a file
signData ( ReadOnlyFile $input, SignatureSecretKey $secretKey, mixed $encoding = Halite::ENCODE_BASE64URLSAFE ) : string	Sign the contents of a file
splitKeys ( Key $master, string $salt = '', Config $config = null ) : array	Split a key using HKDF-BLAKE2b
unsealData ( ReadOnlyFile $input, MutableFile $output, EncryptionSecretKey $secretKey ) : boolean	Unseal the contents of a file.
verifyData ( ReadOnlyFile $input, SignaturePublicKey $publicKey, string $signature, boolean $raw_binary = false ) : boolean	Verify the contents of a file
verifyData ( ReadOnlyFile $input, SignaturePublicKey $publicKey, string $signature, mixed $encoding = Halite::ENCODE_BASE64URLSAFE ) : boolean	Verify the contents of a file

Private Methods

Method	Description
__construct ( )	Don't allow this to be instantiated.
streamDecrypt ( ReadOnlyFile $input, MutableFile $output, EncryptionKey $encKey, string $nonce, string $mac, Config $config, array &$chunk_macs ) : boolean	Stream decryption - Do not call directly
streamEncrypt ( ReadOnlyFile $input, MutableFile $output, EncryptionKey $encKey, string $nonce, string $mac, Config $config ) : integer	Stream encryption - Do not call directly
streamVerify ( ReadOnlyFile $input, resource | string $mac, Config $config ) : array	Recalculate and verify the HMAC of the input file

Method Details