rugk / threema-msgapi-sdk-php

source/Threema/MsgApi/Tools/CryptTool.php

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) {