diff --git a/doc/Classes/File.md b/doc/Classes/File.md new file mode 100644 index 0000000..e1b42ca --- /dev/null +++ b/doc/Classes/File.md @@ -0,0 +1,50 @@ +# File + +**Namespace**: `\ParagonIE\Halite` + +## Methods + +### `checksum()` + +> `public static` checksum(`$filepath`, [`AuthenticationKey`](Symmetric/AuthenticationKey.md) `$key = null`, `$raw = false`) : `string` + +Calculates a BLAKE2b-512 hash of the given file. + +* `$filepath` - Path to a file (or an open file handle) +* `$key` (optional) +* `$raw` - Set to `TRUE` if you don't want a hexadecimal string returned + +### `encrypt()` + +> `public static` encrypt(`$input`, `$output`, [`EncryptionKey`](Symmetric/EncryptionKey.md) `$key`) : `string` + + + +### `decrypt()` + +> `public static` decrypt(`$input`, `$output`, [`EncryptionKey`](Symmetric/EncryptionKey.md) `$key`) : `string` + + + + +### `seal()` + +> `public static` seal(`$input`, `$output`, [`EncryptionPublicKey`](Asymmetric/EncryptionPublicKey.md) `$key`) : `string` + + + +### `unseal()` + +> `public static` unseal(`$input`, `$output`, [`EncryptionSecretKey`](Asymmetric/EncryptionSecretKey.md) `$key`) : `string` + + + +### `sign()` + +> `public static` sign(`$input`, [`SignatureSecretKey`](Asymmetric/SignatureSecretKey.md) `$key`, `boolean $raw_binary`) : `string` + + + +### `verify()` + +> `public static` sign(`$input`, [`SignaturePublicKey`](Asymmetric/SignaturePublicKey.md) `$key`, `string $signature`, `boolean $raw_binary`) : `boolean` \ No newline at end of file diff --git a/src/File.php b/src/File.php index cf32fcd..666b44f 100644 --- a/src/File.php +++ b/src/File.php @@ -194,6 +194,7 @@ public static function sign( * * @param string|resource $filename * @param SignaturePublicKey $publickey + * @param string $signature * @param bool $raw_binary * * @return string @@ -201,6 +202,7 @@ public static function sign( public static function verify( $filename, KeyInterface $publickey, + $signature, $raw_binary = false ) { if ( @@ -210,6 +212,7 @@ public static function verify( return self::verifyStream( new ReadOnlyFile($filename), $publickey, + $signature, $raw_binary ); }