WE2-681 Added initial AuthToken validation configuration

WE2-681 Added Uri class to parse URL to parts. Added phpunit test
WE2-684 Updated WebEidAuthToken class. Added phpunit tests

Author: Guido Gröön

src/authtoken/WebEidAuthToken.php

@@ -24,21 +24,114 @@
 
 namespace web_eid\web_eid_authtoken_validation_php\authtoken;
 
+use UnexpectedValueException;
+
 class WebEidAuthToken
 {
 
     /**
-     * @var array Disallowed policies
+     * @var string Unverified certificate
      */
-    private array $disallowedPolicies = [];
-
+    private ?string $unverifiedCertificate = null;
+    /**
+     * @var string Signature
+     */
+    private ?string $signature = null;
+    /**
+     * @var string Algorithm
+     */
+    private ?string $algorithm = null;
+    /**
+     * @var string Format
+     */
+    private ?string $format = null;
     /**
-     * Add disallowed policy to array
-     * 
-     * @param string $policyOID
-     */    
-    public function addDisallowedPolicy(string $policyOID): void {
-        $this->disallowedPolicies[] = $policyOID;
+     * @var string App version
+     */
+    private ?string $appVersion = null;
+
+    public function __construct(string $authenticationTokenJSON)
+    {
+        $jsonDecoded = json_decode($authenticationTokenJSON, true);
+        if (is_null($jsonDecoded)) {
+            return null;
+        }
+
+        // unverifiedCertificate
+        if (isset($jsonDecoded['unverifiedCertificate'])) {
+            $this->unverifiedCertificate = $this->filterString('unverifiedCertificate', $jsonDecoded['unverifiedCertificate']);
+        }
+        // algorithm
+        if (isset($jsonDecoded['algorithm'])) {
+            $this->algorithm = $this->filterString('algorithm', $jsonDecoded['algorithm']);
+        }
+        // signature
+        if (isset($jsonDecoded['signature'])) {
+            $this->signature = $this->filterString('signature', $jsonDecoded['signature']);
+        }
+        // format
+        if (isset($jsonDecoded['format'])) {
+            $this->format = $this->filterString('format', $jsonDecoded['format']);
+        }
+        // appVersion
+        if (isset($jsonDecoded['appVersion'])) {
+            $this->appVersion = $this->filterString('appVersion', $jsonDecoded['appVersion']);
+        }
+
+    }
+
+    public function getUnverifiedCertificate(): ?string
+    {
+        return $this->unverifiedCertificate;
+    }
+
+    public function setUnverifiedCertificate(string $unverifiedCertificate): void
+    {
+        $this->unverifiedCertificate = $unverifiedCertificate;
+    }
+
+    public function getAlgorithm(): ?string
+    {
+        return $this->algorithm;
+    }
+
+    public function setAlgorithm(string $algorithm): void
+    {
+        $this->algorithm = $algorithm;
+    }
+
+    public function getSignature(): ?string
+    {
+        return $this->signature;
+    }
+
+    public function setSignature(string $signature): void
+    {
+        $this->signature = $signature;
+    }
+
+    public function getFormat(): ?string
+    {
+        return $this->format;
+    }
+
+    public function setFormat(string $format): void
+    {
+        $this->format = $format;
+    }
+
+    public function getAppVersion(): ?string
+    {
+        return $this->appVersion;
+    }
+
+    private function filterString(string $key, $data): string
+    {
+        $type = gettype($data);
+        if ($type != "string") {
+            throw new UnexpectedValueException("'{$key}' is {$type}, string expected");
+        }
+        return $data;
     }
 
 

src/exceptions/MalformedUriException.php

@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * Copyright (c) 2020-2021 Estonian Information System Authority
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace web_eid\web_eid_authtoken_validation_php\exceptions;
+
+class MalformedUriException extends AuthTokenException
+{
+    public function __construct(string $uri)
+    {
+        parent::__construct("Unable to parse URI: $uri");
+    }
+}

src/util/SubjectCertificatePolicies.php

@@ -0,0 +1,42 @@
+<?php
+
+/*
+ * Copyright (c) 2020-2021 Estonian Information System Authority
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+namespace web_eid\web_eid_authtoken_validation_php\util;
+
+use BadFunctionCallException;
+
+final class SubjectCertificatePolicies
+{
+    private const ESTEID_SK_2015_MOBILE_ID_POLICY_PREFIX = '1.3.6.1.4.1.10015.1.3';
+    public static $ESTEID_SK_2015_MOBILE_ID_POLICY = self::ESTEID_SK_2015_MOBILE_ID_POLICY_PREFIX;
+    public static $ESTEID_SK_2015_MOBILE_ID_POLICY_V1 = self::ESTEID_SK_2015_MOBILE_ID_POLICY_PREFIX.'.1';
+    public static $ESTEID_SK_2015_MOBILE_ID_POLICY_V2 = self::ESTEID_SK_2015_MOBILE_ID_POLICY_PREFIX.'.2';
+    public static $ESTEID_SK_2015_MOBILE_ID_POLICY_V3 = self::ESTEID_SK_2015_MOBILE_ID_POLICY_PREFIX.'.3';
+
+    public function __construct()
+    {
+        throw new BadFunctionCallException('Utility class');
+    }
+
+}