rugk / threema-msgapi-sdk-php

source/Threema/MsgApi/Tools/CryptTool.php

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @author Threema GmbH
- * @copyright Copyright (c) 2015 Threema GmbH
- */
+	 * @author Threema GmbH
+	 * @copyright Copyright (c) 2015 Threema GmbH
+	 */
 
 
 namespace Threema\MsgApi\Tools;

Doc Comments +16 added lines, -4 removed lines

@@ -145,6 +145,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,
@@ -193,9 +198,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);
 
@@ -337,6 +342,9 @@ 
 		return hash_hmac('sha256', $phoneNoClean, self::PHONENO_HMAC_KEY);
 	}
 
+	/**
+	 * @return string
+	 */
 	abstract protected function createRandom($size);
 
 	/**
@@ -379,7 +387,7 @@ 
 	abstract public function validate();
 
 	/**
-	 * @param $data
+	 * @param string $data
 	 * @return EncryptResult
 	 */
 	public final function encryptFile($data) {
@@ -391,7 +399,7 @@ 
 	/**
 	 * @param string $data as binary
 	 * @param string $key as binary
-	 * @return null|string
+	 * @return string
 	 */
 	public final function decryptFile($data, $key) {
 		$result =  $this->openSecretBox($data, self::FILE_NONCE, $key);
@@ -408,6 +416,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;

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,14 +104,14 @@ 
 	 */
 	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 = mt_rand(1, 255);
 
 		/* append padding */
 		$padbytes = 0;
-		while($padbytes < 1 || $padbytes > 255) {
+		while ($padbytes < 1 || $padbytes > 255) {
 			$padbytes = ord($this->createRandom(1));
 		}
 
@@ -132,7 +132,7 @@ 
 			$senderPrivateKey,
 			$recipientPublicKey,
 			$nonce) {
-		$message = "\x02" . hex2bin($uploadFileResult->getBlobId());
+		$message = "\x02".hex2bin($uploadFileResult->getBlobId());
 		$message .= pack('V', $encryptResult->getSize());
 		$message .= $encryptResult->getNonce();
 
@@ -163,11 +163,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 = mt_rand(1, 255);
@@ -240,7 +240,7 @@ 
 
 		/* remove padding */
 		$padbytes = ord($data[strlen($data)-1]);
-		$realDataLength = strlen($data) - $padbytes;
+		$realDataLength = strlen($data)-$padbytes;
 		if ($realDataLength < 1) {
 			throw new BadMessageException();
 		}
@@ -266,7 +266,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();
 				}
 
@@ -276,7 +276,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();
 				}
 
@@ -287,12 +287,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();
 				}
 
@@ -394,7 +394,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;
 	}
 
@@ -405,7 +405,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) {

source/Threema/MsgApi/Tools/CryptToolSodium.php

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @author Threema GmbH
- * @copyright Copyright (c) 2015 Threema GmbH
- */
+	 * @author Threema GmbH
+	 * @copyright Copyright (c) 2015 Threema GmbH
+	 */
 
 
 namespace Threema\MsgApi\Tools;

Spacing +1 added lines, -1 removed lines

@@ -124,7 +124,7 @@
 	 * @throws Exception
 	 */
 	public function validate() {
-		if(false === $this->isSupported()) {
+		if (false === $this->isSupported()) {
 			throw new Exception('Sodium implementation not supported');
 		}
 		return true;

source/Threema/MsgApi/Tools/EncryptResult.php

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @author Threema GmbH
- * @copyright Copyright (c) 2015 Threema GmbH
- */
+	 * @author Threema GmbH
+	 * @copyright Copyright (c) 2015 Threema GmbH
+	 */
 
 
 namespace Threema\MsgApi\Tools;

source/Threema/MsgApi/Tools/FileAnalysisResult.php

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @author Threema GmbH
- * @copyright Copyright (c) 2015 Threema GmbH
- */
+	 * @author Threema GmbH
+	 * @copyright Copyright (c) 2015 Threema GmbH
+	 */
 
 
 namespace Threema\MsgApi\Tools;

source/Threema/Core/KeyPair.php

Indentation +3 added lines, -3 removed lines

@@ -1,8 +1,8 @@
 <?php
 /**
- * @author Threema GmbH
- * @copyright Copyright (c) 2015 Threema GmbH
- */
+	 * @author Threema GmbH
+	 * @copyright Copyright (c) 2015 Threema GmbH
+	 */
 
 
 namespace Threema\MsgApi\Tools;

samples/web/include/Connection.php

Doc Comments +1 added lines, -1 removed lines

@@ -32,7 +32,7 @@
  *
  * @param string $keystorePath Path public key store file (PHP)
  *
- * @return PhpFile public key store
+ * @return Threema\MsgApi\PublicKeyStores\PhpFile public key store
  */
 function CreatePublicKeyStore($keystorePath)
 {

Indentation +35 added lines, -35 removed lines

@@ -1,9 +1,9 @@ 
 <?php
 /**
- * @author rugk
- * @copyright Copyright (c) 2015 rugk
- * @license MIT
- */
+	 * @author rugk
+	 * @copyright Copyright (c) 2015 rugk
+	 * @license MIT
+	 */
 
 use Threema\MsgApi\Connection;
 use Threema\MsgApi\ConnectionSettings;
@@ -20,11 +20,11 @@ 
  */
 function CreateConnection($keystorePath='../../keystore.php', $useTlsOptions=true)
 {
-    $publicKeyStore = CreatePublicKeyStore($keystorePath);
-    $settings = CreateConnectionSettings($publicKeyStore, $useTlsOptions);
-    $connector = InitiateConnection($settings, $publicKeyStore);
+	$publicKeyStore = CreatePublicKeyStore($keystorePath);
+	$settings = CreateConnectionSettings($publicKeyStore, $useTlsOptions);
+	$connector = InitiateConnection($settings, $publicKeyStore);
 
-    return $connector;
+	return $connector;
 }
 
 /**
@@ -36,12 +36,12 @@ 
  */
 function CreatePublicKeyStore($keystorePath)
 {
-    if (!file_exists($keystorePath)) {
-        if (!touch($keystorePath)) {
-            throw new Exception("PHP keystore could not be created.");
-        }
-    }
-    return $publicKeyStore = new Threema\MsgApi\PublicKeyStores\PhpFile($keystorePath);
+	if (!file_exists($keystorePath)) {
+		if (!touch($keystorePath)) {
+			throw new Exception("PHP keystore could not be created.");
+		}
+	}
+	return $publicKeyStore = new Threema\MsgApi\PublicKeyStores\PhpFile($keystorePath);
 }
 
 /**
@@ -54,27 +54,27 @@ 
  */
 function CreateConnectionSettings($publicKeyStore, $useTlsOptions)
 {
-    if ($useTlsOptions == true) {
-        //create a connection with advanced options
-        $settings = new ConnectionSettings(
-            MSGAPI_GATEWAY_THREEMA_ID,
-            MSGAPI_GATEWAY_THREEMA_ID_SECRET,
-            null,
-            [
-                'forceHttps' => true,
-                'tlsVersion' => '1.2',
-                'tlsCipher' => 'ECDHE-RSA-AES128-GCM-SHA256'
-            ]
-        );
-    } else {
-        //create a connection with default options
-        $settings = new ConnectionSettings(
-            MSGAPI_GATEWAY_THREEMA_ID,
-            MSGAPI_GATEWAY_THREEMA_ID_SECRET
-        );
-    }
+	if ($useTlsOptions == true) {
+		//create a connection with advanced options
+		$settings = new ConnectionSettings(
+			MSGAPI_GATEWAY_THREEMA_ID,
+			MSGAPI_GATEWAY_THREEMA_ID_SECRET,
+			null,
+			[
+				'forceHttps' => true,
+				'tlsVersion' => '1.2',
+				'tlsCipher' => 'ECDHE-RSA-AES128-GCM-SHA256'
+			]
+		);
+	} else {
+		//create a connection with default options
+		$settings = new ConnectionSettings(
+			MSGAPI_GATEWAY_THREEMA_ID,
+			MSGAPI_GATEWAY_THREEMA_ID_SECRET
+		);
+	}
 
-    return $settings;
+	return $settings;
 }
 
 /**
@@ -87,5 +87,5 @@ 
  */
 function InitiateConnection($settings, $publicKeyStore)
 {
-    return $connector = new Connection($settings, $publicKeyStore);
+	return $connector = new Connection($settings, $publicKeyStore);
 }

Spacing +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
  *
  * @return Connection $connector
  */
-function CreateConnection($keystorePath='../../keystore.php', $useTlsOptions=true)
+function CreateConnection($keystorePath = '../../keystore.php', $useTlsOptions = true)
 {
     $publicKeyStore = CreatePublicKeyStore($keystorePath);
     $settings = CreateConnectionSettings($publicKeyStore, $useTlsOptions);

samples/web/SendTextMessage.php

Doc Comments +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
  * @param string $threemaId The id whose public key should be fetched
  * @param string $message The message to send (max 3500 characters)
  *
- * @return string|Exception
+ * @return string
  */
 function SendMessage($connector, $threemaId, $message)
 {

Indentation +25 added lines, -25 removed lines

@@ -38,22 +38,22 @@ 
  */
 function SendMessage($connector, $threemaId, $message)
 {
-    $e2eHelper = new \Threema\MsgApi\Helpers\E2EHelper(KeyHexToBin(MSGAPI_PRIVATE_KEY), $connector);
-    $result = $e2eHelper->sendTextMessage($threemaId, $message);
+	$e2eHelper = new \Threema\MsgApi\Helpers\E2EHelper(KeyHexToBin(MSGAPI_PRIVATE_KEY), $connector);
+	$result = $e2eHelper->sendTextMessage($threemaId, $message);
 
-    if (true === $result->isSuccess()) {
-        return $result->getMessageId();
-    } else {
-        throw new Exception($result->getErrorMessage());
-    }
+	if (true === $result->isSuccess()) {
+		return $result->getMessageId();
+	} else {
+		throw new Exception($result->getErrorMessage());
+	}
 }
 
 //get params
 if (ReturnGetPost('recieverid') &&
-    preg_match('/' . REGEXP_THREEMAID_ANY . '/', ReturnGetPost('recieverid'))
+	preg_match('/' . REGEXP_THREEMAID_ANY . '/', ReturnGetPost('recieverid'))
 ) {
-    $threemaId = htmlentities(ReturnGetPost('recieverid'));
-    $message = ReturnGetPost('message');
+	$threemaId = htmlentities(ReturnGetPost('recieverid'));
+	$message = ReturnGetPost('message');
 }
 
 //create connection
@@ -61,24 +61,24 @@ 
 
 //Send message
 if ($threemaId != null && $message != null) {
-    if (!$isIncluded) {
-        header('Content-Type: text/plain');
-    }
-    $actionDone = true;
+	if (!$isIncluded) {
+		header('Content-Type: text/plain');
+	}
+	$actionDone = true;
 
-    try {
-        $messageId = SendMessage($connector, $threemaId, $message);
-    } catch (Exception $e) {
-        http_response_code(500);
-        $errorMessage = $e->getMessage();
-    }
+	try {
+		$messageId = SendMessage($connector, $threemaId, $message);
+	} catch (Exception $e) {
+		http_response_code(500);
+		$errorMessage = $e->getMessage();
+	}
 }
 
 //Show direct output if the file is called directly
 if (!$isIncluded) {
-    if ($errorMessage == null) {
-        echo 'Message ID: ' . $messageId;
-    } else {
-        echo $errorMessage;
-    }
+	if ($errorMessage == null) {
+		echo 'Message ID: ' . $messageId;
+	} else {
+		echo $errorMessage;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -50,7 +50,7 @@ 
 
 //get params
 if (ReturnGetPost('recieverid') &&
-    preg_match('/' . REGEXP_THREEMAID_ANY . '/', ReturnGetPost('recieverid'))
+    preg_match('/'.REGEXP_THREEMAID_ANY.'/', ReturnGetPost('recieverid'))
 ) {
     $threemaId = htmlentities(ReturnGetPost('recieverid'));
     $message = ReturnGetPost('message');
@@ -77,7 +77,7 @@ 
 //Show direct output if the file is called directly
 if (!$isIncluded) {
     if ($errorMessage == null) {
-        echo 'Message ID: ' . $messageId;
+        echo 'Message ID: '.$messageId;
     } else {
         echo $errorMessage;
     }

samples/web/include/GetPost.php

Indentation +11 added lines, -11 removed lines

@@ -1,9 +1,9 @@ 
 <?php
 /**
- * @author rugk
- * @copyright Copyright (c) 2015 rugk
- * @license MIT
- */
+	 * @author rugk
+	 * @copyright Copyright (c) 2015 rugk
+	 * @license MIT
+	 */
 
 /**
  * Returns the parameter from GET (preferred) or POST.
@@ -13,12 +13,12 @@ 
  */
 function ReturnGetPost($name)
 {
-    if (isset($_GET[$name])) {
-        return $_GET[$name];
-    }
-    if (isset($_POST[$name])) {
-        return $_POST[$name];
-    }
+	if (isset($_GET[$name])) {
+		return $_GET[$name];
+	}
+	if (isset($_POST[$name])) {
+		return $_POST[$name];
+	}
 
-    return null;
+	return null;
 }

samples/web/include/PublicKey.php

Indentation +21 added lines, -21 removed lines

@@ -1,9 +1,9 @@ 
 <?php
 /**
- * @author rugk
- * @copyright Copyright (c) 2015 rugk
- * @license MIT
- */
+	 * @author rugk
+	 * @copyright Copyright (c) 2015 rugk
+	 * @license MIT
+	 */
 
 /**
  * Checks whether a HEX-key is valid.
@@ -14,8 +14,8 @@ 
  */
 function KeyCheck($publicKey, $suffix='')
 {
-    // RegExp: https://regex101.com/r/sU5tC8/1
-    return preg_match('/^(' . $suffix . ')?[[:alnum:]]{64}$/', $publicKey);
+	// RegExp: https://regex101.com/r/sU5tC8/1
+	return preg_match('/^(' . $suffix . ')?[[:alnum:]]{64}$/', $publicKey);
 }
 
 /**
@@ -32,14 +32,14 @@ 
  */
 function KeyGetUserDisplay($publicKey)
 {
-    //force key to be binary
-    if (ctype_alnum($publicKey)) {
-        $publicKey = KeyHexToBin($publicKey);
-    }
+	//force key to be binary
+	if (ctype_alnum($publicKey)) {
+		$publicKey = KeyHexToBin($publicKey);
+	}
 
-    //create short hash
-    $shortHash = substr(hash('sha256', $publicKey, 0, 32));
-    return $shortHash;
+	//create short hash
+	$shortHash = substr(hash('sha256', $publicKey, 0, 32));
+	return $shortHash;
 }
 
 /**
@@ -51,13 +51,13 @@ 
  */
 function KeyHexToBin($keyHex)
 {
-    //delete prefix
-    $keyTypeCheck = substr($keyHex, 0, 8);
-    if ($keyTypeCheck == 'private:' || $keyTypeCheck == 'public:') {
-        $keyHex = substr($keyHex, 8);
-    }
+	//delete prefix
+	$keyTypeCheck = substr($keyHex, 0, 8);
+	if ($keyTypeCheck == 'private:' || $keyTypeCheck == 'public:') {
+		$keyHex = substr($keyHex, 8);
+	}
 
-    //convert key
-    $keyBin = hex2bin($keyHex);
-    return $keyBin;
+	//convert key
+	$keyBin = hex2bin($keyHex);
+	return $keyBin;
 }

Spacing +2 added lines, -2 removed lines

@@ -12,10 +12,10 @@
  * @param string optional suffix (usually 'private:' or 'public:') (default: '')
  * @return bool whether the key is valid (true) or not (false)
  */
-function KeyCheck($publicKey, $suffix='')
+function KeyCheck($publicKey, $suffix = '')
 {
     // RegExp: https://regex101.com/r/sU5tC8/1
-    return preg_match('/^(' . $suffix . ')?[[:alnum:]]{64}$/', $publicKey);
+    return preg_match('/^('.$suffix.')?[[:alnum:]]{64}$/', $publicKey);
 }
 
 /**