-
Notifications
You must be signed in to change notification settings - Fork 88
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix
File::verify()
, forgot File docs
- Loading branch information
1 parent
576429c
commit f484547
Showing
2 changed files
with
53 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters