Create assertion and type-class for xs:hexBinary

Author: tvdijen

src/Assert/HexBinaryTrait.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait HexBinaryTrait
+{
+    /** @var string */
+    private static string $hexbin_regex = '/^([0-9a-fA-F]{2})+$/D';
+
+
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validHexBinary(string $value, string $message = ''): void
+    {
+        parent::regex(
+            $value,
+            self::$hexbin_regex,
+            $message ?: '%s is not a valid xs:hexBinary',
+            InvalidArgumentException::class,
+        );
+    }
+}

src/Type/HexBinaryValue.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Type;
+
+use SimpleSAML\XML\Assert\Assert;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+
+use function str_replace;
+
+/**
+ * @package simplesaml/xml-common
+ */
+class HexBinaryValue extends AbstractValueType
+{
+    /**
+     * Sanitize the value.
+     *
+     * Note:  There are no processing rules for xs:hexBinary regarding whitespace. General consensus is to strip them
+     *
+     * @param string $value  The unsanitized value
+     * @return string
+     */
+    protected function sanitizeValue(string $value): string
+    {
+        return str_replace(["\f", "\r", "\n", "\t", "\v", ' '], '', $value);
+    }
+
+
+    /**
+     * Validate the value.
+     *
+     * @param string $value
+     * @throws \SimpleSAML\XML\Exception\SchemaViolationException on failure
+     * @return void
+     */
+    protected function validateValue(string $value): void
+    {
+        // Note: value must already be sanitized before validating
+        Assert::regex(
+            $this->sanitizeValue($value),
+            '/([0-9A-F]{2})*/i',
+            SchemaViolationException::class,
+        );
+    }
+}

tests/Assert/HexBinaryTest.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\XML\Assert;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\Assert\AssertionFailedException;
+use SimpleSAML\XML\Assert\Assert;
+
+/**
+ * Class \SimpleSAML\Test\Assert\HexBinaryTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class HexBinaryTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $name
+     */
+    #[DataProvider('provideHexBinary')]
+    public function testHexBinary(bool $shouldPass, string $name): void
+    {
+        try {
+            Assert::validHexBinary($name);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideHexBinary(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'base64' => [false, 'U2ltcGxlU0FNTHBocA=='],
+            'valid' => [true, '3f3c6d78206c657673726f693d6e3122302e20226e656f636964676e223d54552d4622383e3f'],
+            'invalid' => [false, '3f3r'],
+            'bogus' => [false, '&*$(#&^@!(^%$'],
+            'length not dividable by 4' => [false, '3f3'],
+        ];
+    }
+}

tests/Type/HexBinaryValueTest.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\Test\XML\Type;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\TestCase;
+use SimpleSAML\XML\Exception\SchemaViolationException;
+use SimpleSAML\XML\Type\HexBinaryValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\HexBinaryValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(HexBinaryValue::class)]
+final class HexBinaryValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $hexbin
+     */
+    #[DataProvider('provideHexBinary')]
+    public function testHexBinary(bool $shouldPass, string $hexbin): void
+    {
+        try {
+            HexBinaryValue::fromString($hexbin);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideHexBinary(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'base64' => [false, 'U2ltcGxlU0FNTHBocA=='],
+            'valid' => [true, '3f3c6d78206c657673726f693d6e3122302e20226e656f636964676e223d54552d4622383e3f'],
+            'invalid' => [false, '3f3r'],
+            'bogus' => [false, '&*$(#&^@!(^%$'],
+            'length not dividable by 4' => [false, '3f3'],
+        ];
+    }
+}