Migrate to value types

simplesamlphp · Jan 18, 2025 · 633f23d · 633f23d
1 parent feb95e1
commit 633f23d
Show file tree

Hide file tree

Showing 220 changed files with 3,373 additions and 2,349 deletions.
diff --git a/composer.json b/composer.json
@@ -44,7 +44,7 @@
         "ext-spl": "*",
 
         "simplesamlphp/assert": "~1.8.0",
-        "simplesamlphp/xml-common": "~1.24.0"
+        "simplesamlphp/xml-common": "dev-feature/xsd-types"
     },
     "require-dev": {
         "simplesamlphp/simplesamlphp-test-framework": "~1.8.0"

diff --git a/src/Assert/Assert.php b/src/Assert/Assert.php
@@ -10,7 +10,28 @@
  * SimpleSAML\XMLSecurity\Assert\Assert wrapper class
  *
  * @package simplesamlphp/xml-security
+ *
+ * @method static void validCryptoBinary(mixed $value, string $message = '', string $exception = '')
+ * @method static void validDigestValue(mixed $value, string $message = '', string $exception = '')
+ * @method static void validECPoint(mixed $value, string $message = '', string $exception = '')
+ * @method static void validHMACOutputLength(mixed $value, string $message = '', string $exception = '')
+ * @method static void validKeySize(mixed $value, string $message = '', string $exception = '')
+ * @method static void nullOrValidCryptoBinary(mixed $value, string $message = '', string $exception = '')
+ * @method static void nullOrValidDigestValue(mixed $value, string $message = '', string $exception = '')
+ * @method static void nullOrValidECPoint(mixed $value, string $message = '', string $exception = '')
+ * @method static void nullOrValidHMACOutputLength(mixed $value, string $message = '', string $exception = '')
+ * @method static void nullOrValidKeySize(mixed $value, string $message = '', string $exception = '')
+ * @method static void allValidCryptoBinary(mixed $value, string $message = '', string $exception = '')
+ * @method static void allValidDigestValue(mixed $value, string $message = '', string $exception = '')
+ * @method static void allValidECPoint(mixed $value, string $message = '', string $exception = '')
+ * @method static void allValidHMACOutputLength(mixed $value, string $message = '', string $exception = '')
+ * @method static void allValidKeyValue(mixed $value, string $message = '', string $exception = '')
  */
 class Assert extends BaseAssert
 {
+    use CryptoBinaryTrait;
+    use DigestValueTrait;
+    use ECPointTrait;
+    use HMACOutputLengthTrait;
+    use KeySizeTrait;
 }
diff --git a/src/Assert/CryptoBinaryTrait.php b/src/Assert/CryptoBinaryTrait.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-security
+ */
+trait CryptoBinaryTrait
+{
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validCryptoBinary(string $value, string $message = ''): void
+    {
+        parent::validBase64Binary(
+            $value,
+            $message ?: '%s is not a valid xs:CryptoBinary',
+            InvalidArgumentException::class,
+        );
+    }
+}
diff --git a/src/Assert/DigestValueTrait.php b/src/Assert/DigestValueTrait.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-security
+ */
+trait DigestValueTrait
+{
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validDigestValue(string $value, string $message = ''): void
+    {
+        parent::validBase64Binary(
+            $value,
+            $message ?: '%s is not a valid xs:DigestValue',
+            InvalidArgumentException::class,
+        );
+    }
+}
diff --git a/src/Assert/ECPointTrait.php b/src/Assert/ECPointTrait.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-security
+ */
+trait ECPointTrait
+{
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validECPoint(string $value, string $message = ''): void
+    {
+        Assert::validCryptoBinary(
+            $value,
+            $message ?: '%s is not a valid dsig11:ECPointType',
+            InvalidArgumentException::class,
+        );
+    }
+}
diff --git a/src/Assert/HMACOutputLengthTrait.php b/src/Assert/HMACOutputLengthTrait.php
@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-security
+ */
+trait HMACOutputLengthTrait
+{
+    /**
+     * The HMAC algorithm (RFC2104 [HMAC]) takes the output (truncation) length in bits as a parameter;
+     * this specification REQUIRES that the truncation length be a multiple of 8 (i.e. fall on a byte boundary)
+     * because Base64 encoding operates on full bytes
+     *
+     * @var string
+     */
+    private static string $HMACOutputLength_regex = '/^([1-9]\d*)$/D';
+
+
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validHMACOutputLength(string $value, string $message = ''): void
+    {
+        parent::regex(
+            $value,
+            self::$HMACOutputLength_regex,
+            $message ?: '%s is not a valid ds:HMACOutputLengthType',
+            InvalidArgumentException::class,
+        );
+    }
+}
diff --git a/src/Assert/KeySizeTrait.php b/src/Assert/KeySizeTrait.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\Assert;
+
+use InvalidArgumentException;
+
+/**
+ * @package simplesamlphp/xml-security
+ */
+trait KeySizeTrait
+{
+    /**
+     * The size in bits of the key to be derived from the shared secret as the UTF-8 string for the corresponding
+     * decimal integer with only digits in the string and no leading zeros.
+     *
+     * @var string
+     */
+    private static string $keySize_regex = '/^([1-9]\d*)$/D';
+
+
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validKeySize(string $value, string $message = ''): void
+    {
+        parent::regex(
+            $value,
+            self::$keySize_regex,
+            $message ?: '%s is not a valid xenc:keySizeType',
+            InvalidArgumentException::class,
+        );
+    }
+}
diff --git a/src/Constants.php b/src/Constants.php
@@ -12,7 +12,52 @@
 class Constants extends \SimpleSAML\XML\Constants
 {
     /**
-     * Digest algorithms
+     * Symmetric key wrap algorithms
+     */
+    public const KEY_WRAP_3DES = 'http://www.w3.org/2001/04/xmlenc#kw-tripledes';
+    public const KEY_WRAP_AES128 = 'http://www.w3.org/2001/04/xmlenc#kw-aes128';
+    public const KEY_WRAP_AES192 = 'http://www.w3.org/2001/04/xmlenc#kw-aes192';
+    public const KEY_WRAP_AES256 = 'http://www.w3.org/2001/04/xmlenc#kw-aes256';
+
+    /** @var string[] */
+    public static array $KEY_WRAP_ALGORITHMS = [
+        self::KEY_WRAP_3DES,
+        self::KEY_WRAP_AES128,
+        self::KEY_WRAP_AES192,
+        self::KEY_WRAP_AES256,
+    ];
+
+
+    /**
+     * Key derivation algorithms
+     */
+    public const KEY_DERIVATION_CONCATKDF = 'http://www.w3.org/2009/xmlenc11#ConcatKDF';
+    public const KEY_DERIVATION_PBKDF2 = 'http://www.w3.org/2009/xmlenc11#pbkdf2';
+
+    /** @var string[] */
+    public static array $KEY_DERIVATION_ALGORITHMS = [
+        self::KEY_DERIVATION_CONCATKDF,
+        self::KEY_DERIVATION_PBKDF2,
+    ];
+
+
+    /**
+     * Key agreement algorithms
+     */
+    public const KEY_AGREEMENT_ECDH_ES = 'http://www.w3.org/2009/xmlenc11#ECDH-ES';
+    public const KEY_AGREEMENT_DH = 'http://www.w3.org/2001/04/xmlenc#dh';
+    public const KEY_AGREEMENT_DH_ES = 'http://www.w3.org/2009/xmlenc11#dh-es';
+
+    /** @var string[] */
+    public static array $KEY_AGREEMENT_ALGORITHMS = [
+        self::KEY_AGREEMENT_ECDH_ES,
+        self::KEY_AGREEMENT_DH,
+        self::KEY_AGREEMENT_DH_ES,
+    ];
+
+
+    /**
+     * Message digest algorithms
      */
     public const DIGEST_SHA1 = 'http://www.w3.org/2000/09/xmldsig#sha1';
     public const DIGEST_SHA224 = 'http://www.w3.org/2001/04/xmldsig-more#sha224';
@@ -31,12 +76,14 @@ class Constants extends \SimpleSAML\XML\Constants
         self::DIGEST_RIPEMD160 => 'ripemd160',
     ];
 
+
     /**
      * Padding schemas
      */
     public const PADDING_PKCS1 = "PKCS1";
     public const PADDING_PKCS1_OAEP = "OAEP";
 
+
     /**
      * Block encryption algorithms
      */
@@ -81,6 +128,7 @@ class Constants extends \SimpleSAML\XML\Constants
         self::BLOCK_ENC_AES256_GCM => 32,
     ];
 
+
     /**
      * Key transport algorithms
      */
@@ -95,13 +143,27 @@ class Constants extends \SimpleSAML\XML\Constants
         self::KEY_TRANSPORT_OAEP_MGF1P,
     ];
 
+
     /**
      * Canonicalization algorithms
      */
     public const C14N_INCLUSIVE_WITH_COMMENTS = 'http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments';
     public const C14N_INCLUSIVE_WITHOUT_COMMENTS = 'http://www.w3.org/TR/2001/REC-xml-c14n-20010315';
     public const C14N_EXCLUSIVE_WITH_COMMENTS = 'http://www.w3.org/2001/10/xml-exc-c14n#WithComments';
     public const C14N_EXCLUSIVE_WITHOUT_COMMENTS = 'http://www.w3.org/2001/10/xml-exc-c14n#';
+    public const C14N11_INCLUSIVE_WITH_COMMENTS = 'http://www.w3.org/2006/12/xml-c14n11';
+    public const C14N11_INCLUSIVE_WITHOUT_COMMENTS = 'http://www.w3.org/2006/12/xml-c14n11#WithComments';
+
+    /** @var string[] */
+    public static array $CANONICALIZATION_ALGORITHMS = [
+        self::C14N_INCLUSIVE_WITH_COMMENTS,
+        self::C14N_INCLUSIVE_WITHOUT_COMMENTS,
+        self::C14N_EXCLUSIVE_WITH_COMMENTS,
+        self::C14N_EXCLUSIVE_WITHOUT_COMMENTS,
+//        self::C14N11_INCLUSIVE_WITH_COMMENTS,
+//        self::C14N11_INCLUSIVE_WITHOUT_COMMENTS,
+    ];
+
 
     /**
      * Signature algorithms
@@ -139,6 +201,19 @@ class Constants extends \SimpleSAML\XML\Constants
         self::SIG_HMAC_RIPEMD160 => self::DIGEST_RIPEMD160,
     ];
 
+
+    /**
+     * Encoding algorithms
+     */
+    public const ENCODING_BASE64 = 'http://www.w3.org/2000/09/xmldsig#base64';
+
+
+    /**
+     * Transforms algorithms
+     */
+    public const TRANSFORMS_BASE64 = 'http://www.w3.org/2000/09/xmldsig#base64';
+
+
     /**
      * XML & XPath namespaces and identifiers
      */
@@ -153,7 +228,4 @@ class Constants extends \SimpleSAML\XML\Constants
     public const XMLENC_ELEMENT = 'http://www.w3.org/2001/04/xmlenc#Element';
     public const XMLENC_ENCRYPTEDKEY = 'http://www.w3.org/2001/04/xmlenc#EncryptedKey';
     public const XMLENC_EXI = 'http://www.w3.org/2009/xmlenc11#EXI';
-
-    // The namespace for the Elliptic Curve Diffie-Hellman Ephemeral Static (ECDH-ES) algorithm
-    public const XMLENC11_ECDH_ES = 'http://www.w3.org/2009/xmlenc11#ECDH-ES';
 }
diff --git a/src/Exception/ProtocolViolationException.php b/src/Exception/ProtocolViolationException.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\XMLSecurity\Exception;
+
+/**
+ * This exception may be raised when a violation of the xmldsig specification is detected
+ *
+ * @package simplesamlphp/xml-security
+ */
+class ProtocolViolationException extends RuntimeException
+{
+    /**
+     * @param string|null $message
+     */
+    public function __construct(?string $message = null)
+    {
+        if ($message === null) {
+            if (defined('static::DEFAULT_MESSAGE')) {
+                $message = static::DEFAULT_MESSAGE;
+            } else {
+                $message = 'A violation of the XML Signature Syntax and Processing specification occurred.';
+            }
+        }
+
+        parent::__construct($message);
+    }
+}