Tiqr / tiqr-server-libphp

library/tiqr/Tiqr/Service.php

Spacing +46 added lines, -46 removed lines

@@ -116,7 +116,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
@@ -240,7 +240,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;
@@ -354,7 +354,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();
@@ -400,13 +400,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;
         }
 
@@ -415,11 +415,11 @@ 
         
         $data = array("sessionId"=>$sessionId, "challenge"=>$challenge, "spIdentifier" => $spIdentifier);
         
-        if ($userId!="") {
+        if ($userId != "") {
             $data["userId"] = $userId;
         }
         
-        $this->_stateStorage->setValue(self::PREFIX_CHALLENGE . $sessionKey, $data, self::CHALLENGE_EXPIRE);
+        $this->_stateStorage->setValue(self::PREFIX_CHALLENGE.$sessionKey, $data, self::CHALLENGE_EXPIRE);
        
         return $sessionKey;
     }
@@ -439,9 +439,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();
@@ -450,7 +450,7 @@ 
             "displayName" => $displayName,
             "sessionId" => $sessionId
         ];
-        $this->_stateStorage->setValue(self::PREFIX_ENROLLMENT . $enrollmentKey, $data, self::ENROLLMENT_EXPIRE);
+        $this->_stateStorage->setValue(self::PREFIX_ENROLLMENT.$enrollmentKey, $data, self::ENROLLMENT_EXPIRE);
         $this->_setEnrollmentStatus($sessionId, self::ENROLLMENT_STATUS_INITIALIZED);
 
         return $enrollmentKey;
@@ -461,9 +461,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();
         }
 
@@ -498,9 +498,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->_stateStorage->getValue(self::PREFIX_ENROLLMENT_STATUS.$sessionId);
@@ -557,7 +557,7 @@ 
      */
     public function getEnrollmentMetadata(string $enrollmentKey, string $authenticationUrl, string $enrollmentUrl): array
     {
-        $data = $this->_stateStorage->getValue(self::PREFIX_ENROLLMENT . $enrollmentKey);
+        $data = $this->_stateStorage->getValue(self::PREFIX_ENROLLMENT.$enrollmentKey);
         if (!is_array($data)) {
             $this->logger->error('Unable to find enrollment metadata in state storage');
             throw new Exception('Unable to find enrollment metadata in state storage');
@@ -576,7 +576,7 @@ 
                                array("identifier" =>$data["userId"],
                                      "displayName"=>$data["displayName"]));
 
-        $this->_stateStorage->unsetValue(self::PREFIX_ENROLLMENT . $enrollmentKey);
+        $this->_stateStorage->unsetValue(self::PREFIX_ENROLLMENT.$enrollmentKey);
 
         $this->_setEnrollmentStatus($data["sessionId"], self::ENROLLMENT_STATUS_RETRIEVED);
         return $metadata;
@@ -604,7 +604,7 @@ 
      */
     public function getEnrollmentSecret(string $enrollmentKey): string
     {
-         $data = $this->_stateStorage->getValue(self::PREFIX_ENROLLMENT . $enrollmentKey);
+         $data = $this->_stateStorage->getValue(self::PREFIX_ENROLLMENT.$enrollmentKey);
          if (!is_array($data)) {
              $this->logger->error('getEnrollmentSecret: enrollment key not found');
              throw new RuntimeException('enrollment key not found');
@@ -620,7 +620,7 @@ 
          ];
          $enrollmentSecret = $this->_uniqueSessionKey();
          $this->_stateStorage->setValue(
-             self::PREFIX_ENROLLMENT_SECRET . $enrollmentSecret,
+             self::PREFIX_ENROLLMENT_SECRET.$enrollmentSecret,
              $enrollmentData,
              self::ENROLLMENT_EXPIRE
          );
@@ -648,11 +648,11 @@ 
     public function validateEnrollmentSecret(string $enrollmentSecret): string
     {
         try {
-            $data = $this->_stateStorage->getValue(self::PREFIX_ENROLLMENT_SECRET . $enrollmentSecret);
+            $data = $this->_stateStorage->getValue(self::PREFIX_ENROLLMENT_SECRET.$enrollmentSecret);
             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');
             }
 
@@ -682,17 +682,17 @@ 
     public function finalizeEnrollment(string $enrollmentSecret): bool
     {
         try {
-            $data = $this->_stateStorage->getValue(self::PREFIX_ENROLLMENT_SECRET . $enrollmentSecret);
+            $data = $this->_stateStorage->getValue(self::PREFIX_ENROLLMENT_SECRET.$enrollmentSecret);
             if (NULL === $data) {
                 throw new RuntimeException('Enrollment secret not found');
             }
             if (is_array($data)) {
                 // Enrollment is finalized, destroy our session data.
-                $this->_stateStorage->unsetValue(self::PREFIX_ENROLLMENT_SECRET . $enrollmentSecret);
+                $this->_stateStorage->unsetValue(self::PREFIX_ENROLLMENT_SECRET.$enrollmentSecret);
                 $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.'
                 );
             }
@@ -740,7 +740,7 @@ 
     public function authenticate(string $userId, string $userSecret, string $sessionKey, string $response): int
     {
         try {
-            $state = $this->_stateStorage->getValue(self::PREFIX_CHALLENGE . $sessionKey);
+            $state = $this->_stateStorage->getValue(self::PREFIX_CHALLENGE.$sessionKey);
             if (is_null($state)) {
                 $this->logger->notice('The auth challenge could not be found in the state storage');
                 return self::AUTH_RESULT_INVALID_CHALLENGE;
@@ -750,9 +750,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');
         }
 
@@ -761,7 +761,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)
@@ -778,7 +778,7 @@ 
 
         if ($equal) {
             // Set application session as authenticated
-            $this->_stateStorage->setValue(self::PREFIX_AUTHENTICATED . $sessionId, $userId, self::LOGIN_EXPIRE);
+            $this->_stateStorage->setValue(self::PREFIX_AUTHENTICATED.$sessionId, $userId, self::LOGIN_EXPIRE);
             $this->logger->notice(sprintf('Authenticated user "%s" in session "%s"', $userId, $sessionId));
 
             // Cleanup challenge
@@ -787,7 +787,7 @@ 
             // Cleaning up only after successful authentication enables the user to retry authentication after e.g. an
             // invalid response
             try {
-                $this->_stateStorage->unsetValue(self::PREFIX_CHALLENGE . $sessionKey); // May throw
+                $this->_stateStorage->unsetValue(self::PREFIX_CHALLENGE.$sessionKey); // May throw
             } catch (Exception $e) {
                 // Only log error
                 $this->logger->warning('Could not delete authentication session key', array('error' => $e));
@@ -809,9 +809,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(); 
         }
         
@@ -851,9 +851,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(); 
         }
@@ -882,7 +882,7 @@ 
         // We probably just generated the challenge and stored it in the StateStorage
         // We can save a roundtrip to the storage backend here by reusing this information
 
-        $state = $this->_stateStorage->getValue(self::PREFIX_CHALLENGE . $sessionKey);
+        $state = $this->_stateStorage->getValue(self::PREFIX_CHALLENGE.$sessionKey);
         if (is_null($state)) {
             $this->logger->error(
                 sprintf(
@@ -897,22 +897,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;
     }
 
     /**
@@ -923,7 +923,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);
         }
@@ -942,7 +942,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));
     }
     
     /**