Create assertion and type-class for xs:base64Binary

Author: tvdijen

src/Assert/Assert.php

@@ -10,6 +10,7 @@
  * @package simplesamlphp/xml-common
  *
  * @method static void validAnyURI(mixed $value, string $message = '', string $exception = '')
+ * @method static void validBase64(mixed $value, string $message = '', string $exception = '')
  * @method static void validDate(mixed $value, string $message = '', string $exception = '')
  * @method static void validDateTime(mixed $value, string $message = '', string $exception = '')
  * @method static void validDay(mixed $value, string $message = '', string $exception = '')
@@ -33,6 +34,7 @@
  * @method static void validToken(mixed $value, string $message = '', string $exception = '')
  * @method static void validYearMonth(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidAnyURI(mixed $value, string $message = '', string $exception = '')
+ * @method static void nullOrValidBase64(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidDate(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidDateTime(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidDay(mixed $value, string $message = '', string $exception = '')
@@ -56,6 +58,7 @@
  * @method static void nullOrValidToken(mixed $value, string $message = '', string $exception = '')
  * @method static void nullOrValidYearMonth(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidAnyURI(mixed $value, string $message = '', string $exception = '')
+ * @method static void allValidBase64(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidDate(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidDateTime(mixed $value, string $message = '', string $exception = '')
  * @method static void allValidDay(mixed $value, string $message = '', string $exception = '')
@@ -82,6 +85,7 @@
 class Assert extends BaseAssert
 {
     use AnyURITrait;
+    use Base64Trait;
     use DateTrait;
     use DateTimeTrait;
     use DayTrait;

src/Assert/Base64Trait.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XML\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-common
+ */
+trait Base64BinaryTrait
+{
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validBase64Binary(string $value, string $message = ''): void
+    {
+        parent::validBase64(
+            $value,
+            $message ?: '%s is not a valid xs:base64Binary',
+            InvalidArgumentException::class,
+        );
+    }
+}

src/Type/Base64BinaryValue.php

@@ -0,0 +1,43 @@
+<?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 Base64BinaryValue extends AbstractValueType
+{
+    /**
+     * Sanitize the value.
+     *
+     * Note:  There are no processing rules for xs:base64 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::validBase64Binary($this->sanitizeValue($value), SchemaViolationException::class);
+    }
+}

tests/Assert/Base64Test.php

@@ -0,0 +1,49 @@
+<?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\XML\Assert\Base64BinaryTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Assert::class)]
+final class Base64BinaryTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $uri
+     */
+    #[DataProvider('provideBase64')]
+    public function testValidBase64Binary(bool $shouldPass, string $base64): void
+    {
+        try {
+            Assert::validBase64Binary($base64);
+            $this->assertTrue($shouldPass);
+        } catch (AssertionFailedException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideBase64(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid' => [true, 'U2ltcGxlU0FNTHBocA=='],
+            'illegal characters' => [false, '&*$(#&^@!(^%$'],
+            'length not dividable by 4' => [false, 'U2ltcGxlU0FTHBocA=='],
+        ];
+    }
+}

tests/Type/Base64BinaryTest.php

@@ -0,0 +1,49 @@
+<?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\Base64BinaryValue;
+
+/**
+ * Class \SimpleSAML\Test\Type\Base64BinaryValueTest
+ *
+ * @package simplesamlphp/xml-common
+ */
+#[CoversClass(Base64BinaryValue::class)]
+final class Base64BinaryValueTest extends TestCase
+{
+    /**
+     * @param boolean $shouldPass
+     * @param string $base64
+     */
+    #[DataProvider('provideBase64')]
+    public function testBase64Binary(bool $shouldPass, string $base64): void
+    {
+        try {
+            Base64BinaryValue::fromString($base64);
+            $this->assertTrue($shouldPass);
+        } catch (SchemaViolationException $e) {
+            $this->assertFalse($shouldPass);
+        }
+    }
+
+
+    /**
+     * @return array<string, array{0: bool, 1: string}>
+     */
+    public static function provideBase64(): array
+    {
+        return [
+            'empty' => [false, ''],
+            'valid' => [true, 'U2ltcGxlU0FNTHBocA=='],
+            'illegal characters' => [false, '&*$(#&^@!(^%$'],
+            'length not dividable by 4' => [false, 'U2ltcGxlU0FTHBocA=='],
+        ];
+    }
+}