Tiqr / tiqr-server-libphp

library/tiqr/OATH/OCRAParser.php

Doc Comments +3 added lines

@@ -238,6 +238,7 @@ 
 
 	/**
 	 * Borrowed from SimpleSAMLPHP http://simplesamlphp.org/
+	 * @param integer $length
 	 */
 	public static function generateRandomBytes($length, $fallback = TRUE) {
 		static $fp = NULL;
@@ -278,6 +279,8 @@ 
 
 	/**
 	 * Constant time string comparison, see http://codahale.com/a-lesson-in-timing-attacks/
+	 * @param string $s1
+	 * @param string $s2
 	 */
 	public static function constEqual($s1, $s2) {
 		if (strlen($s1) != strlen($s2)) {

library/tiqr/Tiqr/API/Client.php

Doc Comments +1 added lines, -1 removed lines

@@ -45,7 +45,7 @@
      * @param string $method	The HTTP Method (GET, POST, PUT, DELETE)
      * @param array  $data		Data send with request as key => value pairs
      *
-     * @return Object
+     * @return Tiqr_API_Entity_APIResult
      *
      * @throws Exception
      */

library/tiqr/Tiqr/Message/FCM.php

Doc Comments +2 added lines, -3 removed lines

@@ -48,11 +48,10 @@
     /**
      * Send a message to a device using the firebase API key.
      *
-     * @param $deviceToken string device ID
-     * @param $alert string alert message
+     * @param string $deviceToken string device ID
+     * @param string $alert string alert message
      * @param $challenge string tiqr challenge url
      * @param $apiKey string api key for firebase
-     * @param Tiqr_Message_Exception $gcmException
      *
      * @throws Tiqr_Message_Exception_SendFailure
      */

library/tiqr/Tiqr/OATH/HOTP.php

Doc Comments +2 added lines, -2 removed lines

@@ -31,7 +31,7 @@ 
      * Calculate a HOTP response 
      * @param String $secret
      * @param String $counter
-     * @return String The response
+     * @return integer The response
      */
     public function calculateResponse($secret, $counter)
     {
@@ -72,7 +72,7 @@ 
      * Truncate a response to a certain length.
      * @param String $hash
      * @param int $length
-     * @return String a truncated response
+     * @return integer a truncated response
      */
     protected function _truncate($hash, $length = 6)
     {

library/tiqr/Tiqr/OATH/OCRA.php

Doc Comments +11 added lines, -4 removed lines

@@ -32,6 +32,9 @@ 
      * @param String crypto     the crypto algorithm (sha1, sha256 or sha512)
      * @param String keyBytes   the bytes to use for the HMAC key
      * @param String text       the message or text to be authenticated.
+     * @param string $crypto
+     * @param string $keyBytes
+     * @param string $text
      */
     private static function _hmac_sha1($crypto,
             $keyBytes,
@@ -58,19 +61,22 @@ 
      * set of parameters.
      *
      * @param ocraSuite    the OCRA Suite
-     * @param key          the shared secret, HEX encoded
-     * @param counter      the counter that changes
+     * @param key          string shared secret, HEX encoded
+     * @param counter      string counter that changes
      *                     on a per use basis,
      *                     HEX encoded
-     * @param question     the challenge question, HEX encoded
+     * @param question     string challenge question, HEX encoded
      * @param password     a password that can be used,
      *                     HEX encoded
      * @param sessionInformation
      *                     Static information that identifies the
      *                     current session, Hex encoded
      * @param timeStamp    a value that reflects a time
+     * @param string $password
+     * @param string $sessionInformation
+     * @param string $timeStamp
      *
-     * @return A numeric String in base 10 that includes
+     * @return string numeric String in base 10 that includes
      * {@link truncationDigits} digits
      */
     static function generateOCRA($ocraSuite,
@@ -251,6 +257,7 @@ 
 
     /**
      * Truncate a result to a certain length
+     * @param string $hash
      */    
     static function _oath_truncate($hash, $length = 6)
     {

library/tiqr/Tiqr/OATH/OCRA_v1.php

Doc Comments +12 added lines, -5 removed lines

@@ -41,6 +41,9 @@ 
      * @param String crypto     the crypto algorithm (sha1, sha256 or sha512)
      * @param String keyBytes   the bytes to use for the HMAC key
      * @param String text       the message or text to be authenticated.
+     * @param string $crypto
+     * @param string $keyBytes
+     * @param string $text
      */
     private static function _hmac_sha1($crypto,
             $keyBytes,
@@ -66,20 +69,23 @@ 
      * This method generates an OCRA HOTP value for the given
      * set of parameters.
      *
-     * @param ocraSuite    the OCRA Suite
-     * @param key          the shared secret, HEX encoded
-     * @param counter      the counter that changes
+     * @param ocraSuite    string OCRA Suite
+     * @param key          string shared secret, HEX encoded
+     * @param counter      string counter that changes
      *                     on a per use basis,
      *                     HEX encoded
-     * @param question     the challenge question, HEX encoded
+     * @param question     string challenge question, HEX encoded
      * @param password     a password that can be used,
      *                     HEX encoded
      * @param sessionInformation
      *                     Static information that identifies the
      *                     current session, Hex encoded
      * @param timeStamp    a value that reflects a time
+     * @param string $password
+     * @param string $sessionInformation
+     * @param string $timeStamp
      *
-     * @return A numeric String in base 10 that includes
+     * @return integer numeric String in base 10 that includes
      * {@link truncationDigits} digits
      */
     static function generateOCRA($ocraSuite,
@@ -223,6 +229,7 @@ 
 
     /**
      * Truncate a result to a certain length
+     * @param string $hash
      */    
     function _oath_truncate($hash, $length = 6)
     {

library/tiqr/Tiqr/OATH/OCRAWrapper_v1.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
      * @param String $secret a hex representation of the user's secret
      * @param String $challenge a hex or (alfa)numeric challenge question
      * @param String $sessionKey a hex sessionKey identifying the current session
-     * @return String An OCRA response, the length of which is determined by the
+     * @return integer An OCRA response, the length of which is determined by the
      *             OCRA suite.
      */
     public function calculateResponse($secret, $challenge, $sessionKey) 

library/tiqr/Tiqr/Service.php

Doc Comments +1 added lines, -8 removed lines

@@ -334,10 +334,6 @@ 
      * application, for example to create a link in a mobile website on the
      * same device as where the application is installed
      * @param String $sessionKey The session key identifying this authentication session
-     * @param String $userId The userId of a pre-authenticated user, if in  
-     *                       step-up mode. NULL in other scenario's.
-     * @param String $sessionId The application's session identifier. 
-     *                          (defaults to php session)
      */
     public function generateAuthURL($sessionKey)
     {
@@ -613,7 +609,7 @@ 
      *                           session.
      * @param String $response   The response to the challenge that the phone
      *                           has posted.
-     * @return String The result of the authentication. This is one of the
+     * @return integer The result of the authentication. This is one of the
      *                AUTH_RESULT_* constants of the Tiqr_Server class.
      *                (do not make assumptions on the values of these 
      *                constants.)
@@ -710,9 +706,6 @@ 
     /**
      * Generate a challenge URL
      * @param String $sessionKey The key that identifies the session.
-     * @param String $challenge The authentication challenge
-     * @param String $userId The userid to embed in the challenge url (only
-     *                       if a user was pre-authenticated)
      *                       
      */
     protected function _getChallengeUrl($sessionKey)

library/tiqr/Tiqr/UserStorage/Encryption/Dummy.php

Doc Comments +2 added lines, -2 removed lines

@@ -40,7 +40,7 @@ 
      *
      * @param String $data Data to encrypt.
      *
-     * @return encrypted data
+     * @return string data
      */
     public function encrypt($data)
     {
@@ -52,7 +52,7 @@ 
      *
      * @param String $data Data to decrypt.
      *
-     * @return decrypted data
+     * @return string data
      */
     public function decrypt($data)
     {