Tiqr / tiqr-server-libphp

library/tiqr/Tiqr/Service.php

Indentation +33 added lines, -33 removed lines

@@ -571,17 +571,17 @@ 
         }
 
         $metadata = array("service"=>
-                               array("displayName"       => $this->_name,
-                                     "identifier"        => $this->_identifier,
-                                     "logoUrl"           => $this->_logoUrl,
-                                     "infoUrl"           => $this->_infoUrl,
-                                     "authenticationUrl" => $authenticationUrl,
-                                     "ocraSuite"         => $this->_ocraSuite,
-                                     "enrollmentUrl"     => $enrollmentUrl
-                               ),
-                          "identity"=>
-                               array("identifier" =>$data["userId"],
-                                     "displayName"=>$data["displayName"]));
+                                array("displayName"       => $this->_name,
+                                        "identifier"        => $this->_identifier,
+                                        "logoUrl"           => $this->_logoUrl,
+                                        "infoUrl"           => $this->_infoUrl,
+                                        "authenticationUrl" => $authenticationUrl,
+                                        "ocraSuite"         => $this->_ocraSuite,
+                                        "enrollmentUrl"     => $enrollmentUrl
+                                ),
+                            "identity"=>
+                                array("identifier" =>$data["userId"],
+                                        "displayName"=>$data["displayName"]));
 
         $this->_unsetStateValue(self::PREFIX_ENROLLMENT, $enrollmentKey);
 
@@ -611,28 +611,28 @@ 
      */
     public function getEnrollmentSecret(string $enrollmentKey): string
     {
-         $data = $this->_getStateValue(self::PREFIX_ENROLLMENT, $enrollmentKey);
-         if (!is_array($data)) {
-             $this->logger->error('getEnrollmentSecret: enrollment key not found');
-             throw new RuntimeException('enrollment key not found');
-         }
-         $userId = $data["userId"] ?? NULL;
-         $sessionId = $data["sessionId"] ?? NULL;
-         if (!is_string($userId) || !(is_string($sessionId))) {
-             throw new RuntimeException('getEnrollmentSecret: invalid enrollment data');
-         }
-         $enrollmentData = [
-             "userId" => $userId,
-             "sessionId" => $sessionId
-         ];
-         $enrollmentSecret = $this->_uniqueSessionKey();
-         $this->_setStateValue(
-             self::PREFIX_ENROLLMENT_SECRET,
-             $enrollmentSecret,
-             $enrollmentData,
-             self::ENROLLMENT_EXPIRE
-         );
-         return $enrollmentSecret;
+            $data = $this->_getStateValue(self::PREFIX_ENROLLMENT, $enrollmentKey);
+            if (!is_array($data)) {
+                $this->logger->error('getEnrollmentSecret: enrollment key not found');
+                throw new RuntimeException('enrollment key not found');
+            }
+            $userId = $data["userId"] ?? NULL;
+            $sessionId = $data["sessionId"] ?? NULL;
+            if (!is_string($userId) || !(is_string($sessionId))) {
+                throw new RuntimeException('getEnrollmentSecret: invalid enrollment data');
+            }
+            $enrollmentData = [
+                "userId" => $userId,
+                "sessionId" => $sessionId
+            ];
+            $enrollmentSecret = $this->_uniqueSessionKey();
+            $this->_setStateValue(
+                self::PREFIX_ENROLLMENT_SECRET,
+                $enrollmentSecret,
+                $enrollmentData,
+                self::ENROLLMENT_EXPIRE
+            );
+            return $enrollmentSecret;
     }
 
     /**

Spacing +36 added lines, -36 removed lines

@@ -118,7 +118,7 @@ 
     // INVALID_USERID: The client authenticated a different user than the server expected. This error is returned when
     // the application stated an authentication session specifying the userId and later during the authentication
     // provides a different userId
-    const AUTH_RESULT_INVALID_USERID    = 5;
+    const AUTH_RESULT_INVALID_USERID = 5;
     
     /**
      * The default OCRA Suite (RFC 6287) to use for authentication in Tiqr
@@ -244,7 +244,7 @@ 
      * @param int $version The tiqr protocol version to use (defaults to the latest)
      * @throws Exception
      */
-    public function __construct(LoggerInterface $logger, array $options=array(), int $version = 2)
+    public function __construct(LoggerInterface $logger, array $options = array(), int $version = 2)
     {
         $this->_options = $options; // Used to later get settings for Tiqr_Message_*
         $this->logger = $logger;
@@ -361,7 +361,7 @@ 
 
             $this->logger->info(sprintf('Creating and sending a %s push notification', $notificationType));
             $message->setId(time());
-            $message->setText("Please authenticate for " . $this->_name);
+            $message->setText("Please authenticate for ".$this->_name);
             $message->setAddress($notificationAddress);
             $message->setCustomProperty('challenge', $this->_getChallengeUrl($sessionKey));
             $message->send();
@@ -407,13 +407,13 @@ 
      * @return string The authentication sessionKey
      * @throws Exception when starting the authentication session failed
      */
-    public function startAuthenticationSession(string $userId="", string $sessionId="", string $spIdentifier=""): string
+    public function startAuthenticationSession(string $userId = "", string $sessionId = "", string $spIdentifier = ""): string
     {
-        if ($sessionId=="") {
+        if ($sessionId == "") {
             $sessionId = session_id();
         }
 
-        if ($spIdentifier=="") {
+        if ($spIdentifier == "") {
             $spIdentifier = $this->_identifier;
         }
 
@@ -422,7 +422,7 @@ 
         
         $data = array("sessionId"=>$sessionId, "challenge"=>$challenge, "spIdentifier" => $spIdentifier);
         
-        if ($userId!="") {
+        if ($userId != "") {
             $data["userId"] = $userId;
         }
         
@@ -446,9 +446,9 @@ 
      * @return String The enrollment key
      * @throws Exception when start the enrollement session failed
      */
-    public function startEnrollmentSession(string $userId, string $displayName, string $sessionId=""): string
+    public function startEnrollmentSession(string $userId, string $displayName, string $sessionId = ""): string
     {
-        if ($sessionId=="") {
+        if ($sessionId == "") {
             $sessionId = session_id();
         }
         $enrollmentKey = $this->_uniqueSessionKey();
@@ -468,9 +468,9 @@ 
      * @param string $sessionId The application's session identifier (defaults to php session)
      * @throws Exception when resetting the session failed
      */
-    public function resetEnrollmentSession(string $sessionId=""): void
+    public function resetEnrollmentSession(string $sessionId = ""): void
     {
-        if ($sessionId=="") {
+        if ($sessionId == "") {
             $sessionId = session_id();
         }
 
@@ -505,9 +505,9 @@ 
      *
      * @throws Exception when an error communicating with the state storage backend was detected
      */
-    public function getEnrollmentStatus(string $sessionId=""): int
+    public function getEnrollmentStatus(string $sessionId = ""): int
     { 
-        if ($sessionId=="") {
+        if ($sessionId == "") {
             $sessionId = session_id(); 
         }
         $status = $this->_getStateValue(self::PREFIX_ENROLLMENT_STATUS, $sessionId);
@@ -660,7 +660,7 @@ 
             if (NULL === $data) {
                 throw new RuntimeException('Enrollment secret not found');
             }
-            if ( !is_array($data) || !is_string($data["userId"] ?? NULL)) {
+            if (!is_array($data) || !is_string($data["userId"] ?? NULL)) {
                 throw new RuntimeException('Invalid enrollment data');
             }
 
@@ -700,7 +700,7 @@ 
                 $this->_setEnrollmentStatus($data["sessionId"], self::ENROLLMENT_STATUS_FINALIZED);
             } else {
                 $this->logger->error(
-                    'Enrollment status is not finalized, enrollmentsecret was not found in state storage. ' .
+                    'Enrollment status is not finalized, enrollmentsecret was not found in state storage. '.
                     'Warning! the method will still return "true" as a result.'
                 );
             }
@@ -758,9 +758,9 @@ 
             throw $e;
         }
 
-        $sessionId = $state["sessionId"] ?? NULL;   // Application's sessionId
-        $challenge = $state["challenge"] ?? NULL;   // The challenge we sent to the Tiqr client
-        if (!is_string($sessionId) || (!is_string($challenge)) ) {
+        $sessionId = $state["sessionId"] ?? NULL; // Application's sessionId
+        $challenge = $state["challenge"] ?? NULL; // The challenge we sent to the Tiqr client
+        if (!is_string($sessionId) || (!is_string($challenge))) {
             throw new RuntimeException('Invalid state for state storage');
         }
 
@@ -769,7 +769,7 @@ 
         $challengeUserId = $state["userId"] ?? NULL;
 
         // If the application requested a specific userId, verify that that is that userId that we're now authenticating
-        if ($challengeUserId!==NULL && ($userId !== $challengeUserId)) {
+        if ($challengeUserId !== NULL && ($userId !== $challengeUserId)) {
             $this->logger->error(
                 sprintf('Authentication failed: the requested userId "%s" does not match userId "%s" that is being authenticated',
                 $challengeUserId, $userId)
@@ -817,9 +817,9 @@ 
      *
      * @throws Exception when there was an error communicating with the storage backed
      */
-    public function logout(string $sessionId=""): void
+    public function logout(string $sessionId = ""): void
     {
-        if ($sessionId=="") {
+        if ($sessionId == "") {
             $sessionId = session_id(); 
         }
         
@@ -859,9 +859,9 @@ 
      *
      * Does not throw
      */
-    public function getAuthenticatedUser(string $sessionId=""): ?string
+    public function getAuthenticatedUser(string $sessionId = ""): ?string
     {
-        if ($sessionId=="") {
+        if ($sessionId == "") {
             $this->logger->debug('Using the PHP session id, as no session id was provided');
             $sessionId = session_id(); 
         }
@@ -905,22 +905,22 @@ 
         $challenge = $state["challenge"] ?? '';
         $spIdentifier = $state["spIdentifier"] ?? '';
 
-        if ( (strpos($this->_protocolAuth, 'https://') === 0) || (strpos($this->_protocolAuth, 'http://') === 0) ) {
+        if ((strpos($this->_protocolAuth, 'https://') === 0) || (strpos($this->_protocolAuth, 'http://') === 0)) {
             // Create universal Link
-            $parameters=array();
+            $parameters = array();
             if (!is_null($userId)) {
-                $parameters[]='u='.urlencode($userId);
+                $parameters[] = 'u='.urlencode($userId);
             }
-            $parameters[]='s='.urlencode($sessionKey);
-            $parameters[]='q='.urlencode($challenge);
-            $parameters[]='i='.urlencode($this->getIdentifier());
-            $parameters[]='v='.urlencode($this->_protocolVersion);
+            $parameters[] = 's='.urlencode($sessionKey);
+            $parameters[] = 'q='.urlencode($challenge);
+            $parameters[] = 'i='.urlencode($this->getIdentifier());
+            $parameters[] = 'v='.urlencode($this->_protocolVersion);
             return $this->_protocolAuth.'?'.implode('&', $parameters);
         }
 
         // Create custom URL scheme
         // Last bit is the spIdentifier
-        return $this->_protocolAuth."://".(!is_null($userId)?urlencode($userId).'@':'').$this->getIdentifier()."/".$sessionKey."/".$challenge."/".urlencode($spIdentifier)."/".$this->_protocolVersion;
+        return $this->_protocolAuth."://".(!is_null($userId) ?urlencode($userId).'@' : '').$this->getIdentifier()."/".$sessionKey."/".$challenge."/".urlencode($spIdentifier)."/".$this->_protocolVersion;
     }
 
     /**
@@ -931,7 +931,7 @@ 
     {
         // The are two formats see: https://tiqr.org/technical/protocol/
 
-        if ( (strpos($this->_protocolEnroll, 'https://') === 0) || (strpos($this->_protocolEnroll, 'http://') === 0) ) {
+        if ((strpos($this->_protocolEnroll, 'https://') === 0) || (strpos($this->_protocolEnroll, 'http://') === 0)) {
             // Create universal Link
             return $this->_protocolEnroll.'?metadata='.urlencode($metadataUrl);
         }
@@ -950,7 +950,7 @@ 
     protected function _uniqueSessionKey(): string
     {
 
-        return bin2hex( Tiqr_Random::randomBytes(self::SESSION_KEY_LENGTH_BYTES) );
+        return bin2hex(Tiqr_Random::randomBytes(self::SESSION_KEY_LENGTH_BYTES));
     }
     
     /**
@@ -981,7 +981,7 @@ 
      */
     protected function _setStateValue(string $key_prefix, string $key, $value, int $expire): void {
         $this->_stateStorage->setValue(
-            $key_prefix . $this->_hashKey($key),
+            $key_prefix.$this->_hashKey($key),
             $value,
             $expire
         );
@@ -998,7 +998,7 @@ 
 
     protected function _getStateValue(string $key_prefix, string $key) {
         return $this->_stateStorage->getValue(
-            $key_prefix . $this->_hashKey($key)
+            $key_prefix.$this->_hashKey($key)
         );
     }
 
@@ -1012,7 +1012,7 @@ 
      */
     protected function _unsetStateValue(string $key_prefix, string $key): void {
         $this->_stateStorage->unsetValue(
-            $key_prefix . $this->_hashKey($key)
+            $key_prefix.$this->_hashKey($key)
         );
     }
 

Braces +5 added lines, -5 removed lines

@@ -287,8 +287,7 @@ 
         if (isset($options['ocraservice']) && $options['ocraservice']['type'] != 'tiqr') {
             $options['ocraservice']['ocra.suite'] = $this->_ocraSuite;
             $this->_ocraService = Tiqr_OcraService::getOcraService($options['ocraservice']['type'], $options['ocraservice'], $logger);
-        }
-        else { // Create default ocraservice
+        } else { // Create default ocraservice
             $this->_ocraService = Tiqr_OcraService::getOcraService('tiqr', array('ocra.suite' => $this->_ocraSuite), $logger);
         }
     }
@@ -511,7 +510,9 @@ 
             $sessionId = session_id(); 
         }
         $status = $this->_getStateValue(self::PREFIX_ENROLLMENT_STATUS, $sessionId);
-        if (is_null($status)) return self::ENROLLMENT_STATUS_IDLE;
+        if (is_null($status)) {
+            return self::ENROLLMENT_STATUS_IDLE;
+        }
         return $status;
     }
         
@@ -868,8 +869,7 @@ 
         
         try {
             return $this->_getStateValue("authenticated_", $sessionId);
-        }
-        catch (Exception $e) {
+        } catch (Exception $e) {
             $this->logger->error('getAuthenticatedUser failed', array('exception'=>$e));
             return NULL;
         }

library/tiqr/Tiqr/OcraService/Tiqr.php

Spacing +1 added lines, -1 removed lines

@@ -1,6 +1,6 @@
 <?php
 
-require_once __DIR__ . '/../OATH/OCRA.php';
+require_once __DIR__.'/../OATH/OCRA.php';
 
 /**
  * This file is part of the tiqr project.

library/tiqr/Tiqr/UserStorage/Pdo.php

Indentation -2 removed lines

@@ -30,13 +30,11 @@
     notificationtype varchar(10),
     notificationaddress varchar(64)
 );
-
  *
  * In version 3.0 the format of the tmpblocktimestamp was changed from a datetime format to an integer.
  * Because it holds a unix timestamp a 64-bit (8-byte) integer. To upgrade the user table to the new format use:
 
 ALTER TABLE user MODIFY tmpblocktimestamp BIGINT;
-
  */
 
 use Psr\Log\LoggerInterface;

Spacing +16 added lines, -16 removed lines

@@ -89,21 +89,21 @@ 
      */
     private function _getStringValue(string $columnName, string $userId): string
     {
-        if ( !in_array($columnName, $this->_allowedStringColumns) ) {
+        if (!in_array($columnName, $this->_allowedStringColumns)) {
             throw new InvalidArgumentException('Unsupported column name');
         }
 
         try {
-            $sth = $this->handle->prepare('SELECT ' . $columnName . ' FROM ' . $this->tablename . ' WHERE userid = ?');
+            $sth = $this->handle->prepare('SELECT '.$columnName.' FROM '.$this->tablename.' WHERE userid = ?');
             $sth->execute(array($userId));
-            $res=$sth->fetchColumn();
+            $res = $sth->fetchColumn();
             if ($res === false) {
                 // No result
                 $this->logger->error(sprintf('No result getting "%s" for user "%s"', $columnName, $userId));
                 throw new RuntimeException('User not found');
             }
             if ($res === NULL) {
-                return '';  // Value unset
+                return ''; // Value unset
             }
             if (!is_string($res)) {
                 $this->logger->error(sprintf('Expected string type while getting "%s" for user "%s"', $columnName, $userId));
@@ -127,28 +127,28 @@ 
      */
     private function _getIntValue(string $columnName, string $userId): int
     {
-        if ( !in_array($columnName, $this->_allowedIntColumns) ) {
+        if (!in_array($columnName, $this->_allowedIntColumns)) {
             throw new InvalidArgumentException('Unsupported column name');
         }
 
         try {
-            $sth = $this->handle->prepare('SELECT ' . $columnName . ' FROM ' . $this->tablename . ' WHERE userid = ?');
+            $sth = $this->handle->prepare('SELECT '.$columnName.' FROM '.$this->tablename.' WHERE userid = ?');
             $sth->execute(array($userId));
-            $res=$sth->fetchColumn();
+            $res = $sth->fetchColumn();
             if ($res === false) {
                 // No result
                 $this->logger->error(sprintf('No result getting "%s" for user "%s"', $columnName, $userId));
                 throw new RuntimeException('User not found');
             }
             if ($res === NULL) {
-                return 0;  // Value unset
+                return 0; // Value unset
             }
             // Return type for integers depends on the PDO driver, can be string
             if (!is_numeric($res)) {
                 $this->logger->error(sprintf('Expected int type while getting "%s" for user "%s"', $columnName, $userId));
                 throw new RuntimeException('Unexpected return type');
             }
-            return (int)$res;
+            return (int) $res;
         }
         catch (Exception $e) {
             $this->logger->error('PDO error getting user', array('exception' => $e, 'userId' => $userId, 'columnName'=>$columnName));
@@ -165,11 +165,11 @@ 
      */
     private function _setStringValue(string $columnName, string $userId, string $value): void
     {
-        if ( !in_array($columnName, $this->_allowedStringColumns) ) {
+        if (!in_array($columnName, $this->_allowedStringColumns)) {
             throw new InvalidArgumentException('Unsupported column name');
         }
         try {
-            $sth = $this->handle->prepare('UPDATE ' . $this->tablename . ' SET ' . $columnName . ' = ? WHERE userid = ?');
+            $sth = $this->handle->prepare('UPDATE '.$this->tablename.' SET '.$columnName.' = ? WHERE userid = ?');
             $sth->execute(array($value, $userId));
             if ($sth->rowCount() == 0) {
                 // Required for mysql which only returns the number of rows that were actually updated
@@ -193,11 +193,11 @@ 
      */
     private function _setIntValue(string $columnName, string $userId, int $value): void
     {
-        if ( !in_array($columnName, $this->_allowedIntColumns) ) {
+        if (!in_array($columnName, $this->_allowedIntColumns)) {
             throw new InvalidArgumentException('Unsupported column name');
         }
         try {
-            $sth = $this->handle->prepare('UPDATE ' . $this->tablename . ' SET ' . $columnName . ' = ? WHERE userid = ?');
+            $sth = $this->handle->prepare('UPDATE '.$this->tablename.' SET '.$columnName.' = ? WHERE userid = ?');
             $sth->execute(array($value, $userId));
             if ($sth->rowCount() == 0) {
                 // Required for mysql which only returns the number of rows that were actually updated
@@ -309,17 +309,17 @@ 
     {
         // Check for blocked
         if ($this->_getIntValue('blocked', $userId) != 0) {
-            return true;   // Blocked
+            return true; // Blocked
         }
 
         if (0 == $tempBlockDuration) {
-            return false;   // No check for temporary block
+            return false; // No check for temporary block
         }
 
         // Check for temporary block
         $timestamp = $this->getTemporaryBlockTimestamp($userId);
         // if no temporary block timestamp is set or if the temporary block is expired, return false
-        if ( 0 == $timestamp || ($timestamp + $tempBlockDuration * 60) < time()) {
+        if (0 == $timestamp || ($timestamp + $tempBlockDuration * 60) < time()) {
             return false;
         }
         return true;

Braces +6 added lines, -12 removed lines

@@ -110,8 +110,7 @@ 
                 throw new RuntimeException('Unexpected return type');
             }
             return $res;
-        }
-        catch (Exception $e) {
+        } catch (Exception $e) {
             $this->logger->error('PDO error getting user', array('exception' => $e, 'userId' => $userId, 'columnName'=>$columnName));
             throw ReadWriteException::fromOriginalException($e);
         }
@@ -149,8 +148,7 @@ 
                 throw new RuntimeException('Unexpected return type');
             }
             return (int)$res;
-        }
-        catch (Exception $e) {
+        } catch (Exception $e) {
             $this->logger->error('PDO error getting user', array('exception' => $e, 'userId' => $userId, 'columnName'=>$columnName));
             throw ReadWriteException::fromOriginalException($e);
         }
@@ -177,8 +175,7 @@ 
                     throw new RuntimeException('User not found');
                 }
             }
-        }
-        catch (Exception $e) {
+        } catch (Exception $e) {
             $this->logger->error('PDO error updating user', array('exception' => $e, 'userId' => $userId, 'columnName'=>$columnName));
             throw ReadWriteException::fromOriginalException($e);
         }
@@ -205,8 +202,7 @@ 
                     throw new RuntimeException('User not found');
                 }
             }
-        }
-        catch (Exception $e) {
+        } catch (Exception $e) {
             $this->logger->error('PDO error updating user', array('exception' => $e, 'userId' => $userId, 'columnName'=>$columnName));
             throw ReadWriteException::fromOriginalException($e);
         }
@@ -223,8 +219,7 @@ 
         try {
             $sth = $this->handle->prepare("INSERT INTO ".$this->tablename." (displayname,userid) VALUES (?,?)");
             $sth->execute(array($displayName, $userId));
-        }
-        catch (Exception $e) {
+        } catch (Exception $e) {
             $this->logger->error(sprintf('Error creating user "%s"', $userId), array('exception'=>$e));
             throw new ReadWriteException('The user could not be saved in the user storage (PDO)');
         }
@@ -239,8 +234,7 @@ 
             $sth = $this->handle->prepare("SELECT userid FROM ".$this->tablename." WHERE userid = ?");
             $sth->execute(array($userId));
             return (false !== $sth->fetchColumn());
-        }
-        catch (Exception $e) {
+        } catch (Exception $e) {
             $this->logger->error('PDO error checking user exists', array('exception'=>$e, 'userId'=>$userId));
             throw ReadWriteException::fromOriginalException($e);
         }