Tiqr / tiqr-server-libphp

library/tiqr/Tiqr/Service.php

Spacing +47 added lines, -47 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
@@ -243,7 +243,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;
@@ -343,7 +343,7 @@ 
                 case 'APNS':
                 case 'APNS_DIRECT':
                     $apns_version = $this->_options['apns.version'] ?? 1;
-                    if ($apns_version ==2 )
+                    if ($apns_version == 2)
                         $message = new Tiqr_Message_APNS2($this->_options, $this->logger);
                     else
                         $message = new Tiqr_Message_APNS($this->_options, $this->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,11 +422,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;
     }
@@ -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();
@@ -457,7 +457,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;
@@ -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->_stateStorage->getValue(self::PREFIX_ENROLLMENT_STATUS.$sessionId);
@@ -564,7 +564,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');
@@ -583,7 +583,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;
@@ -611,7 +611,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');
@@ -627,7 +627,7 @@ 
          ];
          $enrollmentSecret = $this->_uniqueSessionKey();
          $this->_stateStorage->setValue(
-             self::PREFIX_ENROLLMENT_SECRET . $enrollmentSecret,
+             self::PREFIX_ENROLLMENT_SECRET.$enrollmentSecret,
              $enrollmentData,
              self::ENROLLMENT_EXPIRE
          );
@@ -655,11 +655,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');
             }
 
@@ -689,17 +689,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.'
                 );
             }
@@ -747,7 +747,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;
@@ -757,9 +757,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');
         }
 
@@ -768,7 +768,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)
@@ -785,7 +785,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
@@ -794,7 +794,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));
@@ -816,9 +816,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(); 
         }
         
@@ -858,9 +858,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(); 
         }
@@ -889,7 +889,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(
@@ -904,22 +904,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;
     }
 
     /**
@@ -930,7 +930,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);
         }
@@ -949,7 +949,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));
     }
     
     /**

Braces +10 added lines, -9 removed lines

@@ -283,8 +283,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);
         }
     }
@@ -343,10 +342,11 @@ 
                 case 'APNS':
                 case 'APNS_DIRECT':
                     $apns_version = $this->_options['apns.version'] ?? 1;
-                    if ($apns_version ==2 )
-                        $message = new Tiqr_Message_APNS2($this->_options, $this->logger);
-                    else
-                        $message = new Tiqr_Message_APNS($this->_options, $this->logger);
+                    if ($apns_version ==2 ) {
+                                            $message = new Tiqr_Message_APNS2($this->_options, $this->logger);
+                    } else {
+                                            $message = new Tiqr_Message_APNS($this->_options, $this->logger);
+                    }
                     break;
 
                 case 'GCM':
@@ -511,7 +511,9 @@ 
             $sessionId = session_id(); 
         }
         $status = $this->_stateStorage->getValue(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;
     }
         
@@ -867,8 +869,7 @@ 
         
         try {
             return $this->_stateStorage->getValue("authenticated_".$sessionId);
-        }
-        catch (Exception $e) {
+        } catch (Exception $e) {
             $this->logger->error('getAuthenticatedUser failed', array('exception'=>$e));
             return NULL;
         }

library/tiqr/Tiqr/Message/APNS2.php

Spacing +16 added lines, -16 removed lines

@@ -26,7 +26,7 @@ 
 
         // Get the UID from the client certificate we use for authentication, this
         // is set to the bundle ID.
-        $options=$this->getOptions();
+        $options = $this->getOptions();
         $cert_filename = $options['apns.certificate'];
         $cert_file_contents = file_get_contents($cert_filename);
         if (false === $cert_file_contents) {
@@ -35,7 +35,7 @@ 
             );
         }
 
-        $cert=openssl_x509_parse( $cert_file_contents );
+        $cert = openssl_x509_parse($cert_file_contents);
         if (false === $cert) {
             throw new RuntimeException('Error parsing APNS client certificate');
         }
@@ -60,38 +60,38 @@ 
         $authProvider = AuthProvider\Certificate::create($authProviderOptions);
 
         // Create the push message
-        $alert=Alert::create();
+        $alert = Alert::create();
         $alert->setBody($this->getText());
         // TODO: Set title?
-        $payload=Payload::create()->setAlert($alert);
+        $payload = Payload::create()->setAlert($alert);
         $payload->setSound('default');
         // TODO: Can we set an expiry time for the message?
         foreach ($this->getCustomProperties() as $name => $value) {
             $payload->setCustomValue($name, $value);
         }
         $this->logger->debug(sprintf('JSON Payload: %s', $payload->toJson()));
-        $notification=new Notification($payload, $this->getAddress());
+        $notification = new Notification($payload, $this->getAddress());
 
         // Send the push message
         $client = new Client($authProvider, $options['apns.environment'] == 'production');
         $client->addNotification($notification);
-        $responses=$client->push();
-        if ( sizeof($responses) != 1) {
-            $this->logger->warning('Unexpected number responses. Expected 1, got %n', sizeof($responses) );
+        $responses = $client->push();
+        if (sizeof($responses) != 1) {
+            $this->logger->warning('Unexpected number responses. Expected 1, got %n', sizeof($responses));
             if (sizeof($responses) == 0) {
                 $this->logger->warning('Could not determine whether the notification was sent');
                 return;
             }
         }
         /** @var \Pushok\Response $response */
-        $response = reset($responses);  // Get first response from the array
-        $deviceToken=$response->getDeviceToken() ?? '';
+        $response = reset($responses); // Get first response from the array
+        $deviceToken = $response->getDeviceToken() ?? '';
         // A canonical UUID that is the unique ID for the notification. E.g. 123e4567-e89b-12d3-a456-4266554400a0
-        $apnsId=$response->getApnsId() ?? '';
+        $apnsId = $response->getApnsId() ?? '';
         // Status code. E.g. 200 (Success), 410 (The device token is no longer active for the topic.)
-        $statusCode=$response->getStatusCode();
+        $statusCode = $response->getStatusCode();
         $this->logger->info(sprintf('Got response with ApnsId "%s", status %s for deviceToken "%s"', $apnsId, $statusCode, $deviceToken));
-        if ( strcasecmp($deviceToken, $this->getAddress()) ) {
+        if (strcasecmp($deviceToken, $this->getAddress())) {
         $this->logger->warning(sprintf('Unexpected deviceToken in response. Expected: "%s"; got: "%s"', $this->getAddress(), $deviceToken));
         }
         if ($statusCode == 200) {
@@ -99,9 +99,9 @@ 
             return;
         }
 
-        $reasonPhrase=$response->getReasonPhrase(); // E.g. The device token is no longer active for the topic.
-        $errorReason=$response->getErrorReason(); // E.g. Unregistered
-        $errorDescription=$response->getErrorDescription(); // E.g. The device token is inactive for the specified topic.
+        $reasonPhrase = $response->getReasonPhrase(); // E.g. The device token is no longer active for the topic.
+        $errorReason = $response->getErrorReason(); // E.g. Unregistered
+        $errorDescription = $response->getErrorDescription(); // E.g. The device token is inactive for the specified topic.
 
         $this->logger->error(sprintf('Error sending APNS2 push notification. APNS ID: "%s"; deviceToken: "%s"; Error: "%s" "%s" "%s"', $apnsId, $deviceToken, $reasonPhrase, $errorReason, $errorDescription));
         throw new RuntimeException(