Added voucher security check

Author: slischka

.circleci/config.yml

@@ -22,7 +22,7 @@ jobs:
 
     - run: bin/cs
     - run: bin/stan
-    - run: vendor/bin/tester tests -c tests/php-ci.ini --coverage coverage.xml --coverage-src src
+    - run: vendor/bin/tester tests -C --coverage coverage.xml --coverage-src src
     - run: bash <(curl -s https://codecov.io/bash) -t df85f2a9-bd16-49f2-bfb3-64f092dcca7a
 
     - store_artifacts:

.gitignore

@@ -1,6 +1,5 @@
 /composer.lock
 /tests/locks/*
-/tests/php.ini
 /vendor/*
 .idea
 /tests/**/output/*

bin/tests

@@ -6,9 +6,7 @@ declare(strict_types = 1);
 	\escapeshellarg(
 		__DIR__ . '/../vendor/bin/tester'
 	)
-	. ' -c ' . \escapeshellarg(
-		'../tests/php.ini'
-	)
+	. ' -C '
 	. ' '
 	. '../tests',
 	$return

src/Fapi/FapiClient/Tools/SecurityChecker.php

@@ -8,9 +8,17 @@ final class SecurityChecker
 
 	/**
 	 * @param mixed[] $invoice
-	 * @return bool
+	 * @deprecated use isInvoiceSecurityValid instead
 	 */
 	public static function isValid(array $invoice, int $time, string $expectedSecurity): bool
+	{
+		return self::isInvoiceSecurityValid($invoice, $time, $expectedSecurity);
+	}
+
+	/**
+	 * @param mixed[] $invoice
+	 */
+	public static function isInvoiceSecurityValid(array $invoice, int $time, string $expectedSecurity): bool
 	{
 		$id = $invoice['id'] ?? null;
 		$number = $invoice['number'] ?? null;
@@ -29,4 +37,17 @@ public static function isValid(array $invoice, int $time, string $expectedSecuri
 		return $expectedSecurity === \sha1($time . $id . $number . $itemsSecurityHash);
 	}
 
+	/**
+	 * @param mixed[] $voucher
+	 * @param mixed[] $itemTemplate
+	 */
+	public static function isVoucherSecurityValid(array $voucher, array $itemTemplate, int $time, string $expectedSecurity): bool
+	{
+		$voucherId = $voucher['id'] ?? '';
+		$voucherCode = $voucher['code'] ?? '';
+		$itemSecurityHash = \md5(($itemTemplate['id'] ?? '') . ($itemTemplate['code'] ?? ''));
+
+		return $expectedSecurity === \sha1($time . $voucherId . $voucherCode . $itemSecurityHash);
+	}
+
 }

tests/Fapi/ToolsTest/SecurityCheckerTest.phpt

@@ -13,27 +13,51 @@ final class SecurityCheckerTest extends TestCase
 {
 
 	/**
-	 * @dataProvider getIsValidData
+	 * @dataProvider getIsInvoiceSecurityValid
 	 * @param mixed[] $invoice
 	 */
-	public function testIsValid(array $invoice, int $time, string $expectedSecurity)
+	public function testIsInvoiceSecurityValid(array $invoice, int $time, string $expectedSecurity)
 	{
 		Assert::true(SecurityChecker::isValid($invoice, $time, $expectedSecurity));
 	}
 
 	/**
-	 * @dataProvider getInvalidData
+	 * @dataProvider getIsInvoiceSecurityInvalid
 	 * @param mixed[] $invoice
 	 */
-	public function testInvalid(array $invoice, int $time, string $expectedSecurity)
+	public function testIsInvoiceSecurityInvalid(array $invoice, int $time, string $expectedSecurity)
 	{
 		Assert::false(SecurityChecker::isValid($invoice, $time, $expectedSecurity));
 	}
 
+	/**
+	 * @dataProvider getIsVoucherSecurityValid
+	 * @param mixed[] $voucher
+	 * @param mixed[] $itemTemplate
+	 */
+	public function testIsVoucherSecurityValid(array $voucher, array $itemTemplate, int $time, string $expectedSecurity)
+	{
+		Assert::true(SecurityChecker::isVoucherSecurityValid($voucher, $itemTemplate, $time, $expectedSecurity));
+	}
+
+	/**
+	 * @dataProvider getIsVoucherSecurityInvalid
+	 * @param mixed[] $voucher
+	 * @param mixed[] $itemTemplate
+	 */
+	public function testIsVoucherSecurityInvalid(
+		array $voucher,
+		array $itemTemplate,
+		int $time,
+		string $expectedSecurity
+	) {
+		Assert::false(SecurityChecker::isVoucherSecurityValid($voucher, $itemTemplate, $time, $expectedSecurity));
+	}
+
 	/**
 	 * @return mixed[]
 	 */
-	public function getIsValidData(): array
+	public function getIsInvoiceSecurityValid(): array
 	{
 		return [
 			[
@@ -60,7 +84,7 @@ final class SecurityCheckerTest extends TestCase
 	/**
 	 * @return mixed[]
 	 */
-	public function getInvalidData(): array
+	public function getIsInvoiceSecurityInvalid(): array
 	{
 		return [
 			[
@@ -85,6 +109,54 @@ final class SecurityCheckerTest extends TestCase
 		];
 	}
 
+	/**
+	 * @return mixed[]
+	 */
+	public function getIsVoucherSecurityValid(): array
+	{
+		return [
+			[
+				'voucher' => [
+					'id' => 102,
+					'code' => 'ZQSDP3',
+				],
+				'itemTemplate' => [
+					'id' => 1,
+					'code' => 'STARTY',
+				],
+				'time' => 1617179013,
+				'expectedSecurity' => 'cf7550d28d2015944992225ae3a42752608060b7',
+			],
+		];
+	}
+
+	/**
+	 * @return mixed[]
+	 */
+	public function getIsVoucherSecurityInvalid(): array
+	{
+		return [
+			[
+				'voucher' => [
+					'id' => 1,
+					'code' => "ABCD",
+				],
+				'itemTemplate' => [
+					'id' => 1,
+					'code' => 'test',
+				],
+				'time' => 1542298656,
+				'expectedSecurity' => '35221e0d0168d282edc3768ed4b4e878dec3c921',
+			],
+			[
+				'voucher' => [],
+				'itemTemplate' => [],
+				'time' => 1542298656,
+				'expectedSecurity' => '35221e0d0168d282edc3768ed4b4e878dec3c921',
+			],
+		];
+	}
+
 }
 
 (new SecurityCheckerTest())->run();