Docblock cleanup.

paragonie · Jan 15, 2018 · 9647486 · 9647486
1 parent ff17ec8
commit 9647486
Show file tree

Hide file tree

Showing 21 changed files with 75 additions and 90 deletions.
diff --git a/src/Asymmetric/Crypto.php b/src/Asymmetric/Crypto.php
@@ -204,8 +204,7 @@ public static function decryptWithAd(
      * @param bool $get_as_object             Get as a Key object?
      * @return HiddenString|Key
      *
-     * @throws CannotPerformOperation
-     * @throws InvalidType
+     * @throws \TypeError
      */
     public static function getSharedSecret(
         EncryptionSecretKey $privateKey,
@@ -238,8 +237,8 @@ public static function getSharedSecret(
      * @param mixed $encoding                Which encoding scheme to use?
      * @return string                        Ciphertext
      *
-     * @throws CannotPerformOperation
      * @throws InvalidType
+     * @throws \TypeError
      */
     public static function seal(
         HiddenString $plaintext,
@@ -265,8 +264,8 @@ public static function seal(
      * @param mixed $encoding                Which encoding scheme to use?
      * @return string Signature (detached)
      *
-     * @throws CannotPerformOperation
      * @throws InvalidType
+     * @throws \TypeError
      */
     public static function sign(
         string $message,
@@ -292,9 +291,10 @@ public static function sign(
      * @param PublicKey $recipientPublicKey   Public encryption key
      * @param mixed $encoding                 Which encoding scheme to use?
      * @return string
-     * @throws CannotPerformOperation
+     *
      * @throws InvalidKey
      * @throws InvalidType
+     * @throws \TypeError
      */
     public static function signAndEncrypt(
         HiddenString $message,
@@ -324,10 +324,10 @@ public static function signAndEncrypt(
      * @param mixed $encoding                 Which encoding scheme to use?
      * @return HiddenString
      *
-     * @throws CannotPerformOperation
      * @throws InvalidKey
      * @throws InvalidMessage
      * @throws InvalidType
+     * @throws \TypeError
      */
     public static function unseal(
         string $ciphertext,
@@ -386,9 +386,9 @@ public static function unseal(
      * @param mixed $encoding               Which encoding scheme to use?
      * @return bool
      *
-     * @throws CannotPerformOperation
      * @throws InvalidSignature
      * @throws InvalidType
+     * @throws \TypeError
      */
     public static function verify(
         string $message,
@@ -424,7 +424,6 @@ public static function verify(
      * @param mixed $encoding                      Which encoding scheme to use?
      * @return HiddenString
      *
-     * @throws CannotPerformOperation
      * @throws InvalidKey
      * @throws InvalidMessage
      * @throws InvalidSignature

diff --git a/src/Asymmetric/EncryptionPublicKey.php b/src/Asymmetric/EncryptionPublicKey.php
@@ -25,9 +25,8 @@ final class EncryptionPublicKey extends PublicKey
      *
      * @param HiddenString $keyMaterial - The actual key data
      *
-     * @throws CannotPerformOperation
      * @throws InvalidKey
-     * @throws InvalidType
+     * @throws \TypeError
      */
     public function __construct(HiddenString $keyMaterial)
     {

diff --git a/src/Asymmetric/EncryptionSecretKey.php b/src/Asymmetric/EncryptionSecretKey.php
@@ -23,9 +23,8 @@ final class EncryptionSecretKey extends SecretKey
     /**
      * EncryptionSecretKey constructor.
      * @param HiddenString $keyMaterial - The actual key data
-     * @throws CannotPerformOperation
      * @throws InvalidKey
-     * @throws InvalidType
+     * @throws \TypeError
      */
     public function __construct(HiddenString $keyMaterial)
     {
@@ -42,8 +41,7 @@ public function __construct(HiddenString $keyMaterial)
      *
      * @return EncryptionPublicKey
      *
-     * @throws CannotPerformOperation
-     * @throws InvalidType
+     * @throws \TypeError
      */
     public function derivePublicKey()
     {

diff --git a/src/Asymmetric/PublicKey.php b/src/Asymmetric/PublicKey.php
@@ -23,8 +23,7 @@ class PublicKey extends Key
      * PublicKey constructor.
      * @param HiddenString $keyMaterial - The actual key data
      *
-     * @throws CannotPerformOperation
-     * @throws InvalidType
+     * @throws \TypeError
      */
     public function __construct(HiddenString $keyMaterial)
     {

diff --git a/src/Asymmetric/SecretKey.php b/src/Asymmetric/SecretKey.php
@@ -22,8 +22,7 @@ class SecretKey extends Key
      * SecretKey constructor.
      * @param HiddenString $keyMaterial - The actual key data
      *
-     * @throws CannotPerformOperation
-     * @throws InvalidType
+     * @throws \TypeError
      */
     public function __construct(HiddenString $keyMaterial)
     {

diff --git a/src/Asymmetric/SignaturePublicKey.php b/src/Asymmetric/SignaturePublicKey.php
@@ -26,8 +26,7 @@ final class SignaturePublicKey extends PublicKey
      * @param HiddenString $keyMaterial - The actual key data
      *
      * @throws InvalidKey
-     * @throws CannotPerformOperation
-     * @throws InvalidType
+     * @throws \TypeError
      */
     public function __construct(HiddenString $keyMaterial)
     {
@@ -44,8 +43,7 @@ public function __construct(HiddenString $keyMaterial)
      * Get an encryption public key from a signing public key.
      *
      * @return EncryptionPublicKey
-     * @throws CannotPerformOperation
-     * @throws InvalidType
+     * @throws \TypeError
      */
     public function getEncryptionPublicKey(): EncryptionPublicKey
     {

diff --git a/src/Asymmetric/SignatureSecretKey.php b/src/Asymmetric/SignatureSecretKey.php
@@ -26,8 +26,7 @@ final class SignatureSecretKey extends SecretKey
      * @param HiddenString $keyMaterial - The actual key data
      *
      * @throws InvalidKey
-     * @throws CannotPerformOperation
-     * @throws InvalidType
+     * @throws \TypeError
      */
     public function __construct(HiddenString $keyMaterial)
     {
@@ -44,8 +43,7 @@ public function __construct(HiddenString $keyMaterial)
      * See the appropriate derived class.
      * 
      * @return SignaturePublicKey
-     * @throws CannotPerformOperation
-     * @throws InvalidType
+     * @throws \TypeError
      */
     public function derivePublicKey()
     {
@@ -59,8 +57,7 @@ public function derivePublicKey()
      * Get an encryption secret key from a signing secret key.
      *
      * @return EncryptionSecretKey
-     * @throws CannotPerformOperation
-     * @throws InvalidType
+     * @throws \TypeError
      */
     public function getEncryptionSecretKey(): EncryptionSecretKey
     {

diff --git a/src/Cookie.php b/src/Cookie.php
@@ -147,6 +147,7 @@ protected static function getConfig(string $stored): SymmetricConfig
      * @throws CannotPerformOperation
      * @throws InvalidMessage
      * @throws InvalidType
+     * @throws \TypeError
      */
     public function store(
         string $name,

diff --git a/src/EncryptionKeyPair.php b/src/EncryptionKeyPair.php
@@ -49,6 +49,7 @@ final class EncryptionKeyPair extends KeyPair
      * @throws InvalidType
      * @throws InvalidKey
      * @throws \InvalidArgumentException
+     * @throws \TypeError
      */
     public function __construct(Key ...$keys)
     {

diff --git a/src/File.php b/src/File.php
@@ -5,6 +5,7 @@
 use ParagonIE\Halite\Alerts\{
     CannotPerformOperation,
     FileAccessDenied,
+    FileError,
     FileModified,
     InvalidDigestLength,
     InvalidKey,
@@ -66,9 +67,11 @@ final private function __construct()
      *
      * @throws CannotPerformOperation
      * @throws FileAccessDenied
+     * @throws FileError
      * @throws InvalidKey
      * @throws InvalidMessage
      * @throws InvalidType
+     * @throws \TypeError
      */
     public static function checksum(
         $filePath,
@@ -100,11 +103,12 @@ public static function checksum(
      *
      * @throws CannotPerformOperation
      * @throws FileAccessDenied
+     * @throws FileError
      * @throws FileModified
      * @throws InvalidDigestLength
-     * @throws InvalidKey
      * @throws InvalidMessage
      * @throws InvalidType
+     * @throws \TypeError
      */
     public static function encrypt(
         $input,
@@ -142,11 +146,12 @@ public static function encrypt(
      *
      * @throws CannotPerformOperation
      * @throws FileAccessDenied
+     * @throws FileError
      * @throws FileModified
      * @throws InvalidDigestLength
-     * @throws InvalidKey
      * @throws InvalidMessage
      * @throws InvalidType
+     * @throws \TypeError
      */
     public static function decrypt(
         $input,
@@ -232,6 +237,7 @@ public static function seal(
      *
      * @throws CannotPerformOperation
      * @throws FileAccessDenied
+     * @throws FileError
      * @throws FileModified
      * @throws InvalidDigestLength
      * @throws InvalidMessage
@@ -282,9 +288,11 @@ public static function unseal(
      *
      * @throws CannotPerformOperation
      * @throws FileAccessDenied
+     * @throws FileError
      * @throws InvalidKey
      * @throws InvalidMessage
      * @throws InvalidType
+     * @throws \TypeError
      */
     public static function sign(
         $filename,
@@ -317,10 +325,12 @@ public static function sign(
      * @return bool
      * @throws CannotPerformOperation
      * @throws FileAccessDenied
+     * @throws FileError
      * @throws InvalidKey
      * @throws InvalidMessage
      * @throws InvalidSignature
      * @throws InvalidType
+     * @throws \TypeError
      */
     public static function verify(
         $filename,
@@ -354,9 +364,11 @@ public static function verify(
      *
      * @throws CannotPerformOperation
      * @throws FileAccessDenied
+     * @throws FileError
      * @throws InvalidKey
      * @throws InvalidMessage
      * @throws InvalidType
+     * @throws \TypeError
      */
     protected static function checksumData(
         StreamInterface $fileStream,
@@ -433,11 +445,12 @@ protected static function checksumData(
      *
      * @throws CannotPerformOperation
      * @throws FileAccessDenied
+     * @throws FileError
      * @throws FileModified
      * @throws InvalidDigestLength
-     * @throws InvalidKey
      * @throws InvalidMessage
      * @throws InvalidType
+     * @throws \TypeError
      */
     protected static function encryptData(
         ReadOnlyFile $input,
@@ -502,11 +515,12 @@ protected static function encryptData(
      *
      * @throws CannotPerformOperation
      * @throws FileAccessDenied
+     * @throws FileError
      * @throws FileModified
      * @throws InvalidDigestLength
-     * @throws InvalidKey
      * @throws InvalidMessage
      * @throws InvalidType
+     * @throws \TypeError
      */
     protected static function decryptData(
         ReadOnlyFile $input,
@@ -689,6 +703,7 @@ protected static function sealData(
      *
      * @throws CannotPerformOperation
      * @throws FileAccessDenied
+     * @throws FileError
      * @throws FileModified
      * @throws InvalidDigestLength
      * @throws InvalidMessage
@@ -798,9 +813,11 @@ protected static function unsealData(
      *
      * @throws CannotPerformOperation
      * @throws FileAccessDenied
+     * @throws FileError
      * @throws InvalidKey
      * @throws InvalidMessage
      * @throws InvalidType
+     * @throws \TypeError
      */
     protected static function signData(
         ReadOnlyFile $input,
@@ -832,9 +849,11 @@ protected static function signData(
      * @throws InvalidSignature
      * @throws CannotPerformOperation
      * @throws FileAccessDenied
+     * @throws FileError
      * @throws InvalidKey
      * @throws InvalidMessage
      * @throws InvalidType
+     * @throws \TypeError
      */
     protected static function verifyData(
         ReadOnlyFile $input,
@@ -1007,7 +1026,7 @@ protected static function getConfigChecksum(int $major, int $minor): array
      *
      * @throws InvalidDigestLength
      * @throws CannotPerformOperation
-     * @throws InvalidType
+     * @throws \TypeError
      */
     protected static function splitKeys(
         Key $master,
@@ -1043,10 +1062,11 @@ protected static function splitKeys(
      *
      * @return int (number of bytes)
      *
+     * @throws FileError
      * @throws CannotPerformOperation
      * @throws FileAccessDenied
      * @throws FileModified
-     * @throws InvalidType
+     * @throws \TypeError
      */
     final private static function streamEncrypt(
         ReadOnlyFile $input,
@@ -1104,11 +1124,12 @@ final private static function streamEncrypt(
      *
      * @return bool
      *
+     * @throws FileError
      * @throws CannotPerformOperation
      * @throws FileAccessDenied
      * @throws FileModified
      * @throws InvalidMessage
-     * @throws InvalidType
+     * @throws \TypeError
      */
     final private static function streamDecrypt(
         ReadOnlyFile $input,
@@ -1185,7 +1206,7 @@ final private static function streamDecrypt(
      * @throws FileAccessDenied
      * @throws FileModified
      * @throws InvalidMessage
-     * @throws InvalidType
+     * @throws \TypeError
      */
     final private static function streamVerify(
         ReadOnlyFile $input,

diff --git a/src/Halite.php b/src/Halite.php
@@ -36,7 +36,7 @@
  */
 final class Halite
 {
-    const VERSION              = '4.1.0';
+    const VERSION              = '4.2.0';
 
     const HALITE_VERSION_KEYS  = "\x31\x40\x04\x00";
     const HALITE_VERSION_FILE  = "\x31\x41\x04\x00";