rugk / threema-msgapi-sdk-php

source/Threema/MsgApi/Tools/CryptTool.php

Doc Comments +15 added lines, -3 removed lines

@@ -142,6 +142,11 @@ 
 		return $this->makeBox($message, $nonce, $senderPrivateKey, $recipientPublicKey);
 	}
 
+	/**
+	 * @param string $senderPrivateKey
+	 * @param string $recipientPublicKey
+	 * @param string $nonce
+	 */
 	final public function encryptFileMessage(UploadFileResult $uploadFileResult,
 											 EncryptResult $encryptResult,
 											 UploadFileResult $thumbnailUploadFileResult = null,
@@ -190,9 +195,9 @@ 
 	 * make a secret box
 	 *
 	 * @param $data
-	 * @param $nonce
+	 * @param string $nonce
 	 * @param $key
-	 * @return mixed
+	 * @return string
 	 */
 	abstract protected function makeSecretBox($data, $nonce, $key);
 
@@ -334,6 +339,9 @@ 
 		return hash_hmac('sha256', $phoneNoClean, self::PHONENO_HMAC_KEY);
 	}
 
+	/**
+	 * @return string
+	 */
 	abstract protected function createRandom($size);
 
 	/**
@@ -376,7 +384,7 @@ 
 	abstract public function validate();
 
 	/**
-	 * @param $data
+	 * @param string $data
 	 * @return EncryptResult
 	 */
 	public final function encryptFile($data) {
@@ -405,6 +413,10 @@ 
 		return new EncryptResult($box, $key,  self::FILE_THUMBNAIL_NONCE, strlen($box));
 	}
 
+	/**
+	 * @param string $data
+	 * @param string $key
+	 */
 	public final function decryptFileThumbnail($data, $key) {
 		$result = $this->openSecretBox($data, self::FILE_THUMBNAIL_NONCE, $key);
 		return false === $result ? null : $result;

Indentation +2 added lines, -2 removed lines

@@ -524,8 +524,8 @@
 			# partly taken from https://github.com/symfony/polyfill-php56/blob/master/Php56.php#L45-L51
 			$ret = 0;
 			for ($i = 0; $i < strlen($str1); ++$i) {
-	            $ret |= ord($str1[$i]) ^ ord($str2[$i]);
-	        }
+				$ret |= ord($str1[$i]) ^ ord($str2[$i]);
+			}
 			return 0 === $result;
 		}
 	}

Spacing +19 added lines, -19 removed lines

@@ -42,8 +42,8 @@ 
 	 * @return CryptTool
 	 */
 	public static function getInstance() {
-		if(null === self::$instance) {
-			foreach(array(
+		if (null === self::$instance) {
+			foreach (array(
 				function() {
 					return self::createInstance(self::TYPE_SODIUM);
 				},
@@ -51,7 +51,7 @@ 
 					return self::createInstance(self::TYPE_SALT);
 				}) as $instanceGenerator) {
 				$i = $instanceGenerator->__invoke();
-				if(null !== $i) {
+				if (null !== $i) {
 					self::$instance = $i;
 					break;
 				}
@@ -66,18 +66,18 @@ 
 	 * @return null|CryptTool null on unknown type
 	 */
 	public static function createInstance($type) {
-		switch($type) {
+		switch ($type) {
 			case self::TYPE_SODIUM:
 				$instance = new CryptToolSodium();
-				if(false === $instance->isSupported()) {
+				if (false === $instance->isSupported()) {
 					//try to instance old version of sodium wrapper
 					/** @noinspection PhpDeprecationInspection */
 					$instance = new CryptToolSodiumDep();
 				}
-				return $instance->isSupported() ? $instance :null;
+				return $instance->isSupported() ? $instance : null;
 			case self::TYPE_SALT:
 				$instance = new CryptToolSalt();
-				return $instance->isSupported() ? $instance :null;
+				return $instance->isSupported() ? $instance : null;
 			default:
 				return null;
 		}
@@ -104,7 +104,7 @@ 
 	 */
 	final public function encryptMessageText($text, $senderPrivateKey, $recipientPublicKey, $nonce) {
 		/* prepend type byte (0x01) to message data */
-		$textBytes = "\x01" . $text;
+		$textBytes = "\x01".$text;
 
 		/* determine random amount of PKCS7 padding */
 		$padbytes = $this->generatePadBytes();
@@ -129,7 +129,7 @@ 
 			$senderPrivateKey,
 			$recipientPublicKey,
 			$nonce) {
-		$message = "\x02" . $this->hex2bin($uploadFileResult->getBlobId());
+		$message = "\x02".$this->hex2bin($uploadFileResult->getBlobId());
 		$message .= pack('V', $encryptResult->getSize());
 		$message .= $encryptResult->getNonce();
 
@@ -160,11 +160,11 @@ 
 			'i' => 0
 		);
 
-		if($thumbnailUploadFileResult != null && strlen($thumbnailUploadFileResult->getBlobId()) > 0) {
+		if ($thumbnailUploadFileResult != null && strlen($thumbnailUploadFileResult->getBlobId()) > 0) {
 			$messageContent['t'] = $thumbnailUploadFileResult->getBlobId();
 		}
 
-		$message = "\x17" . json_encode($messageContent);
+		$message = "\x17".json_encode($messageContent);
 
 		/* determine random amount of PKCS7 padding */
 		$padbytes = $this->generatePadBytes();
@@ -237,7 +237,7 @@ 
 
 		/* remove padding */
 		$padbytes = ord($data[strlen($data)-1]);
-		$realDataLength = strlen($data) - $padbytes;
+		$realDataLength = strlen($data)-$padbytes;
 		if ($realDataLength < 1) {
 			throw new BadMessageException();
 		}
@@ -263,7 +263,7 @@ 
 				return new TextMessage(substr($data, 1));
 			case DeliveryReceipt::TYPE_CODE:
 				/* Delivery receipt */
-				if ($realDataLength < (self::MESSAGE_ID_LEN-2) || (($realDataLength - 2) % self::MESSAGE_ID_LEN) != 0)  {
+				if ($realDataLength < (self::MESSAGE_ID_LEN-2) || (($realDataLength-2)%self::MESSAGE_ID_LEN) != 0) {
 					throw new BadMessageException();
 				}
 
@@ -273,7 +273,7 @@ 
 				return new DeliveryReceipt($receiptType, $messageIds);
 			case ImageMessage::TYPE_CODE:
 				/* Image Message */
-				if ($realDataLength != 1 + self::BLOB_ID_LEN + self::IMAGE_FILE_SIZE_LEN + self::IMAGE_NONCE_LEN)  {
+				if ($realDataLength != 1+self::BLOB_ID_LEN+self::IMAGE_FILE_SIZE_LEN+self::IMAGE_NONCE_LEN) {
 					throw new BadMessageException();
 				}
 
@@ -284,12 +284,12 @@ 
 			case FileMessage::TYPE_CODE:
 				/* Image Message */
 				$decodeResult = json_decode(substr($data, 1), true);
-				if(null === $decodeResult || false === $decodeResult) {
+				if (null === $decodeResult || false === $decodeResult) {
 					throw new BadMessageException();
 				}
 
 				$values = AssocArray::byJsonString(substr($data, 1), array('b', 't', 'k', 'm', 'n', 's'));
-				if(null === $values) {
+				if (null === $values) {
 					throw new BadMessageException();
 				}
 
@@ -391,7 +391,7 @@ 
 	 * @return null|string
 	 */
 	public final function decryptFile($data, $key) {
-		$result =  $this->openSecretBox($data, self::FILE_NONCE, $key);
+		$result = $this->openSecretBox($data, self::FILE_NONCE, $key);
 		return false === $result ? null : $result;
 	}
 
@@ -402,7 +402,7 @@ 
 	 */
 	public final function encryptFileThumbnail($data, $key) {
 		$box = $this->makeSecretBox($data, self::FILE_THUMBNAIL_NONCE, $key);
-		return new EncryptResult($box, $key,  self::FILE_THUMBNAIL_NONCE, strlen($box));
+		return new EncryptResult($box, $key, self::FILE_THUMBNAIL_NONCE, strlen($box));
 	}
 
 	public final function decryptFileThumbnail($data, $key) {
@@ -449,7 +449,7 @@ 
 	 */
 	private function generatePadBytes() {
 		$padbytes = 0;
-		while($padbytes < 1 || $padbytes > 255) {
+		while ($padbytes < 1 || $padbytes > 255) {
 			$padbytes = ord($this->createRandom(1));
 		}
 		return $padbytes;

source/Threema/Console/Command/GenerateKeyPair.php

Unused Use Statements -1 removed lines

@@ -8,7 +8,6 @@
 namespace Threema\Console\Command;
 
 use Threema\Console\Common;
-use Threema\MsgApi\Tools\CryptTool;
 
 class GenerateKeyPair extends Base {
 	function __construct() {

source/Threema/MsgApi/Tests/CryptToolTest.php

Spacing +10 added lines, -10 removed lines

@@ -56,7 +56,7 @@ 
 
 			$this->assertNotNull($message);
 			$this->assertTrue($message instanceof TextMessage);
-			if($message instanceof TextMessage) {
+			if ($message instanceof TextMessage) {
 				$this->assertEquals($message->getText(), 'Dies ist eine Testnachricht. äöü');
 			}
 		});
@@ -92,7 +92,7 @@ 
 
 
 	public function testDerivePublicKey() {
-		$this->doTest(function(CryptTool $cryptTool, $prefix){
+		$this->doTest(function(CryptTool $cryptTool, $prefix) {
 			$publicKey = $cryptTool->derivePublicKey($cryptTool->hex2bin(Common::getPrivateKey(Constants::myPrivateKey)));
 			$myPublicKey = $cryptTool->hex2bin(Common::getPublicKey(Constants::myPublicKey));
 
@@ -165,15 +165,15 @@ 
 
 				// test different strings when comparing and get time needed
 				$result = [];
-				foreach(array(
-					'length' => [$string1, $string1 . 'a'],
+				foreach (array(
+					'length' => [$string1, $string1.'a'],
 					'diff' => [$string1, $string2],
 					'same' => [$string1, $string1]
 				) as $testName => $strings) {
 					$timeStart = microtime(true);
 					$comparisonResult = $cryptTool->stringCompare($strings[0], $strings[1]);
 					$timeEnd = microtime(true);
-					$timeElapsed = $timeEnd - $timeStart;
+					$timeElapsed = $timeEnd-$timeStart;
 
 					// echo $prefix.': '.$humanDescr[$testName].': '.$timeElapsed.'; result: '.$comparisonResult.PHP_EOL;
 					$result[$testName] = [$timeElapsed, $comparisonResult];
@@ -188,8 +188,8 @@ 
 
 				// check timings
 				echo 'Timing test results with '.$prefix.':'.PHP_EOL;
-				$timingRatio = $result['diff'][0] / $result['same'][0];
-				$absoluteDifference = abs($result['diff'][0] - $result['same'][0]);
+				$timingRatio = $result['diff'][0]/$result['same'][0];
+				$absoluteDifference = abs($result['diff'][0]-$result['same'][0]);
 				echo 'timing ratio: '.$timingRatio.PHP_EOL;
 				echo 'absolute difference: '.$absoluteDifference.PHP_EOL;
 
@@ -208,7 +208,7 @@ 
 	 */
 	public function testRemoveVar() {
 		$this->doTest(function(CryptTool $cryptTool, $prefix) {
-			foreach(array(
+			foreach (array(
 						'hex' => Constants::myPrivateKeyExtract,
 						'bin' => $cryptTool->hex2bin(Constants::myPrivateKeyExtract)
 					) as $key => $testVar) {
@@ -222,12 +222,12 @@ 
 	}
 
 	private function doTest(\Closure $c) {
-		foreach(array(
+		foreach (array(
 					'Salt' => CryptTool::createInstance(CryptTool::TYPE_SALT),
 					'Sodium' => CryptTool::createInstance(CryptTool::TYPE_SODIUM)
 				) as $key => $instance) {
 
-			if($instance === null) {
+			if ($instance === null) {
 				echo $key.": could not instance crypt tool\n";
 				break;
 			}

source/Threema/MsgApi/Connection.php

Spacing +6 added lines, -6 removed lines

@@ -202,12 +202,12 @@ 
 			}
 		}
 		if ($tlsCipher = $this->setting->getTlsOption(ConnectionSettings::tlsOptionCipher, null)) {
-			if(true === is_string($tlsCipher)) {
+			if (true === is_string($tlsCipher)) {
 				$options[CURLOPT_SSL_CIPHER_LIST] = $tlsCipher;
 			}
 		}
 		if ($pinnedKey = $this->setting->getTlsOption(ConnectionSettings::tlsOptionPinnedKey, Constants::DEFAULT_PINNED_KEY)) {
-			if(true === is_string($pinnedKey)) {
+			if (true === is_string($pinnedKey)) {
 				$options[CURLOPT_PINNEDPUBLICKEY] = $pinnedKey;
 			}
 		}
@@ -239,7 +239,7 @@ 
 		return $this->call($command->getPath(),
 			$this->createDefaultOptions($progress),
 			$params,
-			function ($httpCode, $response) use ($command) {
+			function($httpCode, $response) use ($command) {
 				return $command->parseResult($httpCode, $response);
 			});
 	}
@@ -257,7 +257,7 @@ 
 		$options[CURLOPT_HTTPHEADER] = array(
 			'Content-Type: application/x-www-form-urlencoded');
 
-		return $this->call($command->getPath(), $options, null, function ($httpCode, $response) use ($command) {
+		return $this->call($command->getPath(), $options, null, function($httpCode, $response) use ($command) {
 			return $command->parseResult($httpCode, $response);
 		});
 	}
@@ -277,7 +277,7 @@ 
 			'blob' => $command->getData()
 		);
 
-		return $this->call($command->getPath(), $options, $params, function ($httpCode, $response) use ($command) {
+		return $this->call($command->getPath(), $options, $params, function($httpCode, $response) use ($command) {
 			return $command->parseResult($httpCode, $response);
 		});
 	}
@@ -304,7 +304,7 @@ 
 
 		$response = curl_exec($session);
 		if (false === $response) {
-			throw new Exception($path . ' ' . curl_error($session));
+			throw new Exception($path.' '.curl_error($session));
 		}
 
 		$httpCode = curl_getinfo($session, CURLINFO_HTTP_CODE);

source/Threema/MsgApi/ConnectionSettings.php

Spacing +5 added lines, -5 removed lines

@@ -49,20 +49,20 @@
 		$this->host = $host;
 
 		// TLS options
-		if(null !== $tlsOptions && is_array($tlsOptions)) {
-			if(true === array_key_exists(self::tlsOptionForceHttps, $tlsOptions)) {
+		if (null !== $tlsOptions && is_array($tlsOptions)) {
+			if (true === array_key_exists(self::tlsOptionForceHttps, $tlsOptions)) {
 				$this->tlsOptions[self::tlsOptionForceHttps] = $tlsOptions[self::tlsOptionForceHttps] === true;
 			}
 
-			if(true === array_key_exists(self::tlsOptionVersion, $tlsOptions)) {
+			if (true === array_key_exists(self::tlsOptionVersion, $tlsOptions)) {
 				$this->tlsOptions[self::tlsOptionVersion] = $tlsOptions[self::tlsOptionVersion];
 			}
 
-			if(true === array_key_exists(self::tlsOptionCipher, $tlsOptions)) {
+			if (true === array_key_exists(self::tlsOptionCipher, $tlsOptions)) {
 				$this->tlsOptions[self::tlsOptionCipher] = $tlsOptions[self::tlsOptionCipher];
 			}
 
-			if(true === array_key_exists(self::tlsOptionPinnedKey, $tlsOptions)) {
+			if (true === array_key_exists(self::tlsOptionPinnedKey, $tlsOptions)) {
 				$this->tlsOptions[self::tlsOptionPinnedKey] = $tlsOptions[self::tlsOptionPinnedKey];
 			}
 		}

source/bootstrap.php

Spacing +10 added lines, -10 removed lines

@@ -2,11 +2,11 @@ 
 require_once("Salt/autoload.php");
 
 //define possibly missing constants
-defined('CURL_SSLVERSION_DEFAULT')  || define('CURL_SSLVERSION_DEFAULT', 0);
-defined('CURL_SSLVERSION_TLSv1')    || define('CURL_SSLVERSION_TLSv1', 1);
-defined('CURL_SSLVERSION_TLSv1_1')  || define('CURL_SSLVERSION_TLSv1_1', 5);
-defined('CURL_SSLVERSION_TLSv1_2')  || define('CURL_SSLVERSION_TLSv1_2', 6);
-defined('CURLOPT_PINNEDPUBLICKEY')  || define('CURLOPT_PINNEDPUBLICKEY', 10230);
+defined('CURL_SSLVERSION_DEFAULT') || define('CURL_SSLVERSION_DEFAULT', 0);
+defined('CURL_SSLVERSION_TLSv1') || define('CURL_SSLVERSION_TLSv1', 1);
+defined('CURL_SSLVERSION_TLSv1_1') || define('CURL_SSLVERSION_TLSv1_1', 5);
+defined('CURL_SSLVERSION_TLSv1_2') || define('CURL_SSLVERSION_TLSv1_2', 6);
+defined('CURLOPT_PINNEDPUBLICKEY') || define('CURLOPT_PINNEDPUBLICKEY', 10230);
 
 //define autoloader
 $d = dirname(__FILE__);
@@ -16,12 +16,12 @@ 
 	$fileName  = '';
 	if ($lastNsPos = strrpos($className, '\\')) {
 		$namespace = substr($className, 0, $lastNsPos);
-		$className = substr($className, $lastNsPos + 1);
-		$fileName  = str_replace('\\', DIRECTORY_SEPARATOR, $namespace) . DIRECTORY_SEPARATOR;
+		$className = substr($className, $lastNsPos+1);
+		$fileName  = str_replace('\\', DIRECTORY_SEPARATOR, $namespace).DIRECTORY_SEPARATOR;
 	}
-	$fileName .= str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php';
+	$fileName .= str_replace('_', DIRECTORY_SEPARATOR, $className).'.php';
 
-	if(true === file_exists( $d.'/'.$fileName)) {
+	if (true === file_exists($d.'/'.$fileName)) {
 		require $d.'/'.$fileName;
 	}
 });
@@ -30,7 +30,7 @@ 
 define('MSGAPI_SDK_VERSION', $sdkVersion);
 $cryptTool = Threema\MsgApi\Tools\CryptTool::getInstance();
 
-if(null === $cryptTool) {
+if (null === $cryptTool) {
 	throw new \Threema\Core\Exception("no supported crypt-tool");
 }