Binary: account for potential empty string in read(Signed)Byte

Author: dktapps

.github/workflows/ci.yml

@@ -27,3 +27,5 @@ jobs:
       run: composer install --prefer-dist --no-interaction
     - name: Run PHPStan
       run: ./vendor/bin/phpstan analyze --no-progress
+    - name: Run PHPUnit
+      run: ./vendor/bin/phpunit tests/phpunit --fail-on-warning

composer.json

@@ -10,11 +10,18 @@
 	"require-dev": {
 		"phpstan/phpstan": "1.2.0",
 		"phpstan/extension-installer": "^1.0",
-		"phpstan/phpstan-strict-rules": "^1.0.0"
+		"phpstan/phpstan-strict-rules": "^1.0.0",
+		"phpunit/phpunit": "^9.5",
+		"phpstan/phpstan-phpunit": "^1.0"
 	},
 	"autoload": {
 		"psr-4": {
 			"pocketmine\\utils\\": "src/"
 		}
+	},
+	"autoload-dev": {
+		"psr-4": {
+			"pocketmine\\utils\\": "tests/phpunit/"
+		}
 	}
 }

phpstan.neon.dist

@@ -2,6 +2,7 @@ parameters:
 	level: 8
 	paths:
 		- src
+		- tests/phpunit
 	ignoreErrors:
 		-
 			#this would only happen if the regex was broken

src/Binary.php

@@ -103,15 +103,25 @@ public static function writeBool(bool $b) : string{
 
 	/**
 	 * Reads an unsigned byte (0 - 255)
+	 *
+	 * @throws BinaryDataException
 	 */
 	public static function readByte(string $c) : int{
+		if($c === ""){
+			throw new BinaryDataException("Expected a string of length 1");
+		}
 		return ord($c[0]);
 	}
 
 	/**
 	 * Reads a signed byte (-128 - 127)
+	 *
+	 * @throws BinaryDataException
 	 */
 	public static function readSignedByte(string $c) : int{
+		if($c === ""){
+			throw new BinaryDataException("Expected a string of length 1");
+		}
 		return self::signByte(ord($c[0]));
 	}
 

tests/phpunit/BinaryTest.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+*/
+
+declare(strict_types=1);
+
+namespace pocketmine\utils;
+
+use PHPUnit\Framework\TestCase;
+
+final class BinaryTest extends TestCase{
+
+	public function testReadByteWithEmptyString() : void{
+		$this->expectException(BinaryDataException::class);
+		Binary::readByte("");
+	}
+
+	public function testReadSignedByteWithEmptyString() : void{
+		$this->expectException(BinaryDataException::class);
+		Binary::readSignedByte("");
+	}
+}