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;