Merge pull request #19 from simplesamlphp/feature/xsd-types

Feature/xsd types

Author: tvdijen

.gitattributes

@@ -5,8 +5,10 @@ codecov.yml export-ignore
 .editorconfig export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
-psalm.xml export-ignore
-psalm-dev.xml export-ignore
+phpstan-baseline.neon export-ignore
+phpstan-baseline-dev.neon export-ignore
+phpstan.neon export-ignore
+phpstan-dev.neon export-ignore
 phpcs.xml export-ignore
 phpunit.xml export-ignore
 .php_cs.dist export-ignore

.github/workflows/php.yml

@@ -19,7 +19,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-version: ['8.1', '8.2', '8.3', '8.4']
+        php-version: ['8.2', '8.3', '8.4', '8.5']
 
     uses: simplesamlphp/simplesamlphp-test-framework/.github/workflows/reusable_phplinter.yml@v1.10.6
     with:
@@ -45,7 +45,7 @@ jobs:
       fail-fast: false
       matrix:
         operating-system: [ubuntu-latest]
-        php-versions: ['8.1', '8.2', '8.3', '8.4']
+        php-versions: ['8.2', '8.3', '8.4', '8.5']
 
     steps:
       - name: Setup PHP, with composer and extensions
@@ -85,15 +85,15 @@ jobs:
         run: composer install --no-progress --prefer-dist --optimize-autoloader
 
       - name: Run unit tests with coverage
-        if: ${{ matrix.php-versions == '8.4' }}
+        if: ${{ matrix.php-versions == '8.5' }}
         run: vendor/bin/phpunit
 
       - name: Run unit tests (no coverage)
-        if: ${{ matrix.php-versions != '8.4' }}
+        if: ${{ matrix.php-versions != '8.5' }}
         run: vendor/bin/phpunit --no-coverage
 
       - name: Save coverage data
-        if: ${{ matrix.php-versions == '8.4' }}
+        if: ${{ matrix.php-versions == '8.5' }}
         uses: actions/upload-artifact@v5
         with:
           name: coverage-data
@@ -107,7 +107,7 @@ jobs:
       fail-fast: true
       matrix:
         operating-system: [windows-latest]
-        php-versions: ['8.1', '8.2', '8.3', '8.4']
+        php-versions: ['8.2', '8.3', '8.4', '8.5']
 
     steps:
       - name: Setup PHP, with composer and extensions
@@ -151,6 +151,7 @@ jobs:
 
   quality:
     name: Quality control
+    needs: [unit-tests-linux]
     runs-on: [ubuntu-latest]
 
     steps:
@@ -160,7 +161,7 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           # Should be the higest supported version, so we can use the newest tools
-          php-version: '8.4'
+          php-version: '8.5'
           tools: composer, composer-require-checker, composer-unused, phpcs
           extensions: ctype, date, dom, filter, pcre, soap, spl, xml
           coverage: none
@@ -193,7 +194,7 @@ jobs:
         run: composer-unused
 
       - name: PHP Code Sniffer
-        run: phpcs
+        run: vendor/bin/phpcs
 
       - name: PHPStan
         run: |
@@ -205,14 +206,16 @@ jobs:
 
   security:
     name: Security checks
+    needs: [unit-tests-linux]
     runs-on: [ubuntu-latest]
+
     steps:
       - name: Setup PHP, with composer and extensions
         # https://github.com/shivammathur/setup-php
         uses: shivammathur/setup-php@v2
         with:
           # Should be the lowest supported version
-          php-version: '8.1'
+          php-version: '8.2'
           extensions: ctype, date, dom, filter, pcre, soap, spl, xml
           tools: composer
           coverage: none

src/XML/element.registry.php classes/element.registry.phpsrc/XML/element.registry.php renamed to classes/element.registry.php

@@ -17,4 +17,4 @@ comment:
 github_checks:
   annotations: false
 ignore:
-  - 'src/XML/element.registry.php'
+  - 'classes/element.registry.php'

codecov.yml

@@ -10,17 +10,18 @@
         }
     ],
     "require": {
-        "php": "^8.1",
+        "php": "^8.2",
         "ext-dom": "*",
         "ext-spl": "*",
 
-        "simplesamlphp/assert": "~1.8.1",
-        "simplesamlphp/saml2": "^5.0",
-        "simplesamlphp/xml-security": "~1.13.0",
-        "simplesamlphp/xml-common": "~1.25.0"
+        "simplesamlphp/assert": "~1.9",
+        "simplesamlphp/saml2": "~6.0",
+        "simplesamlphp/xml-common": "~2.4",
+        "simplesamlphp/xml-security": "~2.0",
+        "simplesamlphp/xml-soap": "~2.0"
     },
     "require-dev": {
-        "simplesamlphp/simplesamlphp-test-framework": "~1.9.2"
+        "simplesamlphp/simplesamlphp-test-framework": "~1.10"
     },
     "autoload": {
         "psr-4": {

composer.json

@@ -45,8 +45,8 @@ MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
       <xs:any namespace='##other' processContents='lax' minOccurs='1' maxOccurs='1' />
     </xs:choice>
     <xs:attribute name='Name' type='xs:anyURI' use='required' />
-	<xs:attribute name='Scope' type='xs:anyURI' use='optional' />
-	<xs:anyAttribute namespace='##other' processContents='lax' />	
+    <xs:attribute name='Scope' type='xs:anyURI' use='optional' />
+    <xs:anyAttribute namespace='##other' processContents='lax' />	
   </xs:complexType>
 
   <!-- Section 9.3 -->
@@ -57,16 +57,16 @@ MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
       <xs:element name="Description" type="tns:DescriptionType" minOccurs="0" maxOccurs="1" />
       <xs:element name="DisplayValue" type="tns:DisplayValueType" minOccurs="0" maxOccurs="1" />
       <xs:choice minOccurs='0'>
-	      <xs:element name='Value' type='xs:string' minOccurs='1' maxOccurs='1' />
+        <xs:element name='Value' type='xs:string' minOccurs='1' maxOccurs='1' />
         <xs:element name='EncryptedValue' type='tns:EncryptedValueType' minOccurs='1' maxOccurs='1' />
         <xs:element name='StructuredValue' type='tns:StructuredValueType' minOccurs='1' maxOccurs='1' />
         <xs:element name='ConstrainedValue' type='tns:ConstrainedValueType' minOccurs='1' maxOccurs='1' />
- 	      <xs:any namespace='##other' processContents='lax' minOccurs='1' maxOccurs='1' />
-	    </xs:choice>
+        <xs:any namespace='##other' processContents='lax' minOccurs='1' maxOccurs='1' />
+      </xs:choice>
     </xs:sequence>
-	<xs:attribute name='Uri' type='xs:anyURI' use='required' />
-	<xs:attribute name='Optional' type='xs:boolean' use='optional' />
-	<xs:anyAttribute namespace='##other' processContents='lax' />	
+    <xs:attribute name='Uri' type='xs:anyURI' use='required' />
+    <xs:attribute name='Optional' type='xs:boolean' use='optional' />
+    <xs:anyAttribute namespace='##other' processContents='lax' />	
   </xs:complexType>
 
   <xs:complexType name="DisplayNameType">

resources/schemas/ws-authorization.xsd

@@ -8,7 +8,12 @@
 
 /**
  * @package simplesamlphp/ws-security
+ *
+ * @method static void validWSUDateTime(mixed $value, string $message = '', string $exception = '')
+ * @method static void allWSUDateTime(mixed $value, string $message = '', string $exception = '')
+ * @method static void nullOrValueWSUDateTime(mixed $value, string $message = '', string $exception = '')
  */
 class Assert extends BaseAssert
 {
+    use WSUDateTimeTrait;
 }

src/Assert/Assert.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SimpleSAML\WSSecurity\Assert;
+
+use SimpleSAML\Assert\AssertionFailedException;
+use SimpleSAML\WSSecurity\Exception\ProtocolViolationException;
+
+/**
+ * @package simplesamlphp/ws-security
+ */
+trait WSUDateTimeTrait
+{
+    /**
+     * @param string $value
+     * @param string $message
+     */
+    protected static function validWSUDateTime(string $value, string $message = ''): void
+    {
+        parent::validDateTime($value);
+
+        try {
+            parent::endsWith(
+                $value,
+                'Z',
+                '%s is not a DateTime expressed in the UTC timezone using the \'Z\' timezone identifier.',
+            );
+        } catch (AssertionFailedException $e) {
+            throw new ProtocolViolationException($e->getMessage());
+        }
+    }
+}

src/Assert/WSUDateTimeTrait.php

@@ -16,6 +16,7 @@ class Constants extends \SimpleSAML\SAML2\Constants
      * The namespace for WS-Addressing protocol.
      */
     public const NS_ADDR_200408 = 'http://schemas.xmlsoap.org/ws/2004/08/addressing';
+
     public const NS_ADDR_200508 = 'http://www.w3.org/2005/08/addressing';
 
     /**
@@ -37,6 +38,7 @@ class Constants extends \SimpleSAML\SAML2\Constants
      * The namespace for WS-Trust protocol.
      */
     public const NS_TRUST_200502 = 'http://schemas.xmlsoap.org/ws/2005/02/trust';
+
     public const NS_TRUST_200512 = 'http://docs.oasis-open.org/ws-sx/ws-trust/200512/';
 
     /**
@@ -48,6 +50,7 @@ class Constants extends \SimpleSAML\SAML2\Constants
      * The namespace for the Web Service Security Policy protocol.
      */
     public const NS_SEC_POLICY_11 = 'http://schemas.xmlsoap.org/ws/2005/07/securitypolicy';
+
     public const NS_SEC_POLICY_12 = 'http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702';
 
     /**
@@ -79,15 +82,25 @@ class Constants extends \SimpleSAML\SAML2\Constants
      * The schema-defined wsa fault codes
      */
     public const WSA_FAULT_INVALID_ADDRESSING_HEADER = 'InvalidAddressingHeader';
+
     public const WSA_FAULT_INVALID_ADDRESS = 'InvalidAddress';
+
     public const WSA_FAULT_INVALID_EPR = 'InvalidEPR';
+
     public const WSA_FAULT_INVALID_CARDINALITY = 'InvalidCardinality';
+
     public const WSA_FAULT_MISSING_ADDRESS_IN_EPR = 'MissingAddressInEPR';
+
     public const WSA_FAULT_DUPLICATE_MESSAGEID = 'DupicateMessageID';
+
     public const WSA_FAULT_ACTION_MISMATCH = 'ActionMismatch';
+
     public const WSA_FAULT_MESSAGE_ADDRESSING_HEADER_REQUIRED = 'MessageAddressingHeaderRequired';
+
     public const WSA_FAULT_DESTINATION_UNREACHABLE = 'DestinationUnreachable';
+
     public const WSA_FAULT_ACTION_NOT_SUPPORTED = 'ActionNotSupported';
+
     public const WSA_FAULT_ENDPOINT_UNAVAILABLE = 'EndpointUnavailable';
 
     public const FAULT_CODES = [
@@ -107,6 +120,7 @@ class Constants extends \SimpleSAML\SAML2\Constants
     /**
      */
     public const WST_REFID_PIN = 'http://docs.oasis-open.org/ws-sx/ws-trust/200802/challenge/PIN';
+
     public const WST_REFID_OTP = 'http://docs.oasis-open.org/ws-sx/ws-trust/200802/challenge/OTP';
 
     /**

src/Constants.php

@@ -19,13 +19,14 @@ class XPath extends \SimpleSAML\XMLSecurity\Utils\XPath
      * Get a DOMXPath object that can be used to search for WS Security elements.
      *
      * @param \DOMNode $node The document to associate to the DOMXPath object.
+     * @param bool $autoregister Whether to auto-register all namespaces used in the document
      *
      * @return \DOMXPath A DOMXPath object ready to use in the given document, with several
      *   ws-related namespaces already registered.
      */
-    public static function getXPath(DOMNode $node): DOMXPath
+    public static function getXPath(DOMNode $node, bool $autoregister = false): DOMXPath
     {
-        $xp = parent::getXPath($node);
+        $xp = parent::getXPath($node, $autoregister);
 
         $xp->registerNamespace('wsa', C::NS_ADDR_200508);
         $xp->registerNamespace('wsa', C::NS_ADDR_200408);