Merge ed76c28 into 77a4f89

src/Alerts/CannotCloneKey.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class CannotCloneKey extends HaliteAlert
 {

src/Alerts/CannotPerformOperation.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class CannotPerformOperation extends HaliteAlert
 {

src/Alerts/CannotSerializeKey.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class CannotSerializeKey extends HaliteAlert
 {

src/Alerts/ConfigDirectiveNotFound.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class ConfigDirectiveNotFound extends HaliteAlert
 {

src/Alerts/FileAccessDenied.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class FileAccessDenied extends FileError
 {

src/Alerts/FileError.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class FileError extends HaliteAlert
 {

src/Alerts/FileModified.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class FileModified extends FileError
 {

src/Alerts/HaliteAlert.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class HaliteAlert extends \Exception
 {

src/Alerts/InvalidDigestLength.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class InvalidDigestLength extends HaliteAlert
 {

src/Alerts/InvalidFlags.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class InvalidFlags extends HaliteAlert
 {

src/Alerts/InvalidKey.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class InvalidKey extends HaliteAlert
 {

src/Alerts/InvalidMessage.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class InvalidMessage extends HaliteAlert
 {

src/Alerts/InvalidSalt.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class InvalidSalt extends HaliteAlert
 {

src/Alerts/InvalidSignature.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class InvalidSignature extends HaliteAlert
 {

src/Alerts/InvalidType.php

@@ -9,6 +9,7 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ * @codeCoverageIgnore
  */
 class InvalidType extends HaliteAlert
 {

src/Cookie.php

@@ -35,6 +35,8 @@
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * @codeCoverageIgnore
  */
 final class Cookie 
 {

src/KeyPair.php

@@ -39,6 +39,7 @@ class KeyPair
      * Hide this from var_dump(), etc.
      * 
      * @return array
+     * @codeCoverageIgnore
      */
     public function __debugInfo()
     {
@@ -52,6 +53,7 @@ public function __debugInfo()
      * Get a Key object for the public key
      * 
      * @return PublicKey
+     * @codeCoverageIgnore
      */
     public function getPublicKey()
     {
@@ -62,6 +64,7 @@ public function getPublicKey()
      * Get a Key object for the secret key
      * 
      * @return SecretKey
+     * @codeCoverageIgnore
      */
     public function getSecretKey()
     {

src/SignatureKeyPair.php

@@ -42,12 +42,11 @@ final class SignatureKeyPair extends KeyPair
 
     /**
      * Pass it a secret key, it will automatically generate a public key
-     * 
+     *
      * @param array<int, Key> $keys
      *
-     * @throws CannotPerformOperation
      * @throws InvalidKey
-     * @throws InvalidType
+     * @throws \TypeError
      */
     public function __construct(Key ...$keys)
     {
@@ -125,8 +124,7 @@ public function __construct(Key ...$keys)
      * @param SignatureSecretKey $secret
      * @return void
      *
-     * @throws CannotPerformOperation
-     * @throws InvalidType
+     * @throws \TypeError
      */
     protected function setupKeyPair(SignatureSecretKey $secret): void
     {

src/Stream/MutableFile.php

@@ -28,6 +28,7 @@
  */
 class MutableFile implements StreamInterface
 {
+    const ALLOWED_MODES = ['r+', 'r+b', 'wb', 'w+', 'w+b', 'c', 'c+', 'cb', 'c+b'];
     const CHUNK = 8192; // PHP's fread() buffer is set to 8192 by default
 
     /**
@@ -59,17 +60,36 @@ class MutableFile implements StreamInterface
     public function __construct($file)
     {
         if (\is_string($file)) {
+            if (!\is_readable($file)) {
+                throw new FileAccessDenied(
+                    'Could not open file for reading'
+                );
+            }
+            if (!\is_writable($file)) {
+                throw new FileAccessDenied(
+                    'Could not open file for writing'
+                );
+            }
             $fp = \fopen($file, 'wb');
+            // @codeCoverageIgnoreStart
             if (!\is_resource($fp)) {
                 throw new FileAccessDenied(
                     'Could not open file for reading'
                 );
             }
+            // @codeCoverageIgnoreEnd
             $this->fp = $fp;
             $this->closeAfter = true;
             $this->pos = 0;
             $this->stat = \fstat($this->fp);
         } elseif (\is_resource($file)) {
+            /** @var array<string, string> $metadata */
+            $metadata = \stream_get_meta_data($file);
+            if (!\in_array($metadata['mode'], self::ALLOWED_MODES, true)) {
+                throw new FileAccessDenied(
+                    'Resource is in ' . $metadata['mode'] . ' mode, which is not allowed.'
+                );
+            }
             $this->fp = $file;
             $this->pos = \ftell($this->fp);
             $this->stat = \fstat($this->fp);

src/Stream/ReadOnlyFile.php

@@ -29,6 +29,7 @@
  */
 class ReadOnlyFile implements StreamInterface
 {
+    const ALLOWED_MODES = ['rb'];
     const CHUNK = 8192; // PHP's fread() buffer is set to 8192 by default
 
     /**
@@ -75,18 +76,32 @@ class ReadOnlyFile implements StreamInterface
     public function __construct($file, Key $key = null)
     {
         if (\is_string($file)) {
+            if (!\is_readable($file)) {
+                throw new FileAccessDenied(
+                    'Could not open file for reading'
+                );
+            }
             $fp = \fopen($file, 'rb');
+            // @codeCoverageIgnoreStart
             if (!\is_resource($fp)) {
                 throw new FileAccessDenied(
                     'Could not open file for reading'
                 );
             }
+            // @codeCoverageIgnoreEnd
             $this->fp = $fp;
 
             $this->closeAfter = true;
             $this->pos = 0;
             $this->stat = \fstat($this->fp);
         } elseif (\is_resource($file)) {
+            /** @var array<string, string> $metadata */
+            $metadata = \stream_get_meta_data($file);
+            if (!\in_array($metadata['mode'], self::ALLOWED_MODES, true)) {
+                throw new FileAccessDenied(
+                    'Resource is in ' . $metadata['mode'] . ' mode, which is not allowed.'
+                );
+            }
             $this->fp = $file;
             $this->pos = \ftell($this->fp);
             $this->stat = \fstat($this->fp);
@@ -95,9 +110,11 @@ public function __construct($file, Key $key = null)
                 'Argument 1: Expected a filename or resource'
             );
         }
-        $this->hashKey = !empty($key) 
+        // @codeCoverageIgnoreStart
+        $this->hashKey = !empty($key)
             ? $key->getRawKeyMaterial()
             : '';
+        // @codeCoverageIgnoreEnd
         $this->hash = $this->getHash();
     }
 
@@ -145,7 +162,9 @@ public function getHash(): string
                 $c = \fread($this->fp, self::CHUNK);
             }
             if (!\is_string($c)) {
+                // @codeCoverageIgnoreStart
                 throw new FileError('Could not read file');
+                // @codeCoverageIgnoreEnd
             }
             \sodium_crypto_generichash_update($h, $c);
         }
@@ -206,14 +225,18 @@ public function readBytes(int $num, bool $skipTests = false): string
         }
         do {
             if ($remaining <= 0) {
+                // @codeCoverageIgnoreStart
                 break;
+                // @codeCoverageIgnoreEnd
             }
             /** @var string $read */
             $read = \fread($this->fp, $remaining);
             if (!\is_string($read)) {
+                // @codeCoverageIgnoreStart
                 throw new FileAccessDenied(
                     'Could not read from the file'
                 );
+                // @codeCoverageIgnoreEnd
             }
             $buf .= $read;
             $readSize = Binary::safeStrlen($read);
@@ -250,9 +273,11 @@ public function reset(int $position = 0): bool
         if (\fseek($this->fp, $position, SEEK_SET) === 0) {
             return true;
         }
+        // @codeCoverageIgnoreStart
         throw new CannotPerformOperation(
             'fseek() failed'
         );
+        // @codeCoverageIgnoreEnd
     }
 
     /**
@@ -266,9 +291,11 @@ public function reset(int $position = 0): bool
     public function toctouTest()
     {
         if (\ftell($this->fp) !== $this->pos) {
+            // @codeCoverageIgnoreStart
             throw new FileModified(
                 'Read-only file has been modified since it was opened for reading'
             );
+            // @codeCoverageIgnoreEnd
         }
         $stat = \fstat($this->fp);
         if ($stat['size'] !== $this->stat['size']) {

src/Util.php

@@ -33,6 +33,7 @@ final class Util
     /**
      * Don't allow this to be instantiated.
      * @throws \Error
+     * @codeCoverageIgnore
      */
     final private function __construct()
     {
@@ -64,6 +65,7 @@ public static function chrToInt(string $chr): int
      * @param int $length
      * @return string
      * @throws CannotPerformOperation
+     * @throws \TypeError
      */
     public static function hash(
         string $input,
@@ -124,7 +126,9 @@ public static function hkdfBlake2b(
         }
         // "If [salt] not provided, is set to a string of HashLen zeroes."
         if (empty($salt)) {
+            // @codeCoverageIgnoreStart
             $salt = \str_repeat("\x00", \SODIUM_CRYPTO_GENERICHASH_KEYBYTES);
+            // @codeCoverageIgnoreEnd
         }
 
         // HKDF-Extract:
@@ -155,11 +159,13 @@ public static function hkdfBlake2b(
         /** @var string $orm */
         $orm = Binary::safeSubstr($t, 0, $length);
 
+        // @codeCoverageIgnoreStart
         if (!\is_string($orm)) {
             throw new CannotPerformOperation(
                 'An unknown error has occurred'
             );
         }
+        // @codeCoverageIgnoreEnd
         return $orm;
     }
 
@@ -203,6 +209,7 @@ public static function intToChr(int $int): string
      * @param int $length
      * @return string
      * @throws CannotPerformOperation
+     * @throws \TypeError
      */
     public static function keyed_hash(
         string $input,