owncloud / core

apps/files_encryption/lib/crypt.php

Doc Comments +5 added lines, -4 removed lines

@@ -185,7 +185,7 @@ 
 	 * @param string $plainContent

 	 * @param string $iv

 	 * @param string $passphrase

-	 * @param string $cypher used for encryption, currently we support AES-128-CFB and AES-256-CFB

+	 * @param string $cipher used for encryption, currently we support AES-128-CFB and AES-256-CFB

 	 * @return string encrypted file content

 	 * @throws \OCA\Files_Encryption\Exception\EncryptionException

 	 */

@@ -241,7 +241,7 @@ 
 	/**

 	 * Split concatenated data and IV into respective parts

 	 * @param string $catFile concatenated data to be split

-	 * @return array keys: encrypted, iv

+	 * @return string keys: encrypted, iv

 	 */

 	private static function splitIv($catFile) {

 

@@ -267,7 +267,7 @@ 
 	 * Symmetrically encrypts a string and returns keyfile content

 	 * @param string $plainContent content to be encrypted in keyfile

 	 * @param string $passphrase

-	 * @param string $cypher used for encryption, currently we support AES-128-CFB and AES-256-CFB

+	 * @param string $cipher used for encryption, currently we support AES-128-CFB and AES-256-CFB

 	 * @return false|string encrypted content combined with IV

 	 * @note IV need not be specified, as it will be stored in the returned keyfile

 	 * and remain accessible therein.

@@ -375,7 +375,7 @@ 
 	 * Create asymmetrically encrypted keyfile content using a generated key

 	 * @param string $plainContent content to be encrypted

 	 * @param array $publicKeys array keys must be the userId of corresponding user

-	 * @return array keys: keys (array, key = userId), data

+	 * @return string keys: keys (array, key = userId), data

 	 * @throws \OCA\Files_Encryption\Exception\MultiKeyEncryptException if encryption failed

 	 * @note symmetricDecryptFileContent() can decrypt files created using this method

 	 */

@@ -552,6 +552,7 @@ 
 	 *

 	 * @param array $header

 	 * @throws \OCA\Files_Encryption\Exception\EncryptionException

+	 * @return string
 	 */

 	public static function getCipher($header) {

 		$cipher = isset($header['cipher']) ? $header['cipher'] : 'AES-128-CFB';

apps/files_encryption/lib/helper.php

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
 	/**
 	 * get recovery key id
 	 *
-	 * @return string|bool recovery key ID or false
+	 * @return string recovery key ID or false
 	 */
 	public static function getRecoveryKeyId() {
 		$appConfig = \OC::$server->getAppConfig();

apps/files_encryption/lib/hooks.php

Doc Comments +3 added lines

@@ -421,6 +421,9 @@
 		self::preRenameOrCopy($params, 'copy');
 	}
 
+	/**
+	 * @param string $operation
+	 */
 	private static function preRenameOrCopy($params, $operation) {
 		$user = \OCP\User::getUser();
 		$view = new \OC\Files\View('/');

apps/files_encryption/lib/keymanager.php

Doc Comments +4 added lines, -2 removed lines

@@ -323,6 +323,9 @@ 
 		return $result;
 	}
 
+	/**
+	 * @param \OC\Files\View $view
+	 */
 	public static function publicShareKeyExists($view) {
 		$result = false;
 
@@ -424,7 +427,7 @@ 
 	 *
 	 * @param \OC\Files\View $view relative to data/
 	 * @param array $userIds list of users we want to remove
-	 * @param string $keyPath
+	 * @param string $keysPath
 	 * @param string $owner the owner of the file
 	 * @param string $ownerPath the owners name of the file for which we want to remove the users relative to data/user/files
 	 */
@@ -474,7 +477,6 @@ 
 	 *
 	 * @param \OC\Files\View $view
 	 * @param string $path relatvie to the views root
-	 * @param string $basePath
 	 */
 	protected static function keySetPreparation($view, $path) {
 		// If the file resides within a subdirectory, create it

apps/files_encryption/lib/session.php

Doc Comments +1 added lines, -1 removed lines

@@ -188,7 +188,7 @@
 
 	/**
 	 * Gets public share private key from session
-	 * @return string $privateKey
+	 * @return boolean $privateKey
 	 *
 	 */
 	private static function getPublicSharePrivateKey() {

apps/files_encryption/lib/util.php

Doc Comments +3 added lines, -3 removed lines

@@ -443,7 +443,7 @@ 
 	/**
 	 * get the file size of the unencrypted file
 	 * @param string $path absolute path
-	 * @return bool
+	 * @return string
 	 */
 	public function getFileSize($path) {
 
@@ -1000,7 +1000,7 @@ 
 	 * Decrypt a keyfile
 	 * @param string $filePath
 	 * @param string $privateKey
-	 * @return false|string
+	 * @return string
 	 */
 	private function decryptKeyfile($filePath, $privateKey) {
 
@@ -1222,7 +1222,7 @@ 
 
 	/**
 	 * check if files are already migrated to the encryption system
-	 * @return int|false migration status, false = in case of no record
+	 * @return integer migration status, false = in case of no record
 	 * @note If records are not being returned, check for a hidden space
 	 *       at the start of the uid in db
 	 */

apps/files_encryption/tests/hooks.php

Doc Comments +2 added lines

@@ -295,6 +295,7 @@ 
 
 	/**
 	 * test rename operation
+	 * @param string $filename
 	 */
 	function doTestRenameHook($filename) {
 		// check if keys exists
@@ -357,6 +358,7 @@ 
 
 	/**
 	 * test rename operation
+	 * @param string $filename
 	 */
 	function doTestCopyHook($filename) {
 		// check if keys exists

apps/files_encryption/tests/keymanager.php

Doc Comments -1 removed lines

@@ -382,7 +382,6 @@
 	/**
 	 * @param \OC\Files\View $view relative to data/
 	 * @param string $path
-	 * @param string $basePath
 	 */
 	public static function testKeySetPreperation($view, $path) {
 		self::keySetPreparation($view, $path);

apps/files_encryption/tests/migration.php

Doc Comments +15 added lines

@@ -118,6 +118,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $uid
+	 */
 	protected function createDummyShareKeys($uid) {
 		$this->view->mkdir($uid . '/files_encryption/share-keys/folder1/folder2/folder3');
 		$this->view->mkdir($uid . '/files_encryption/share-keys/folder2/');
@@ -141,6 +144,9 @@ 
 		}
 	}
 
+	/**
+	 * @param string $uid
+	 */
 	protected function createDummyFileKeys($uid) {
 		$this->view->mkdir($uid . '/files_encryption/keyfiles/folder1/folder2/folder3');
 		$this->view->mkdir($uid . '/files_encryption/keyfiles/folder2/');
@@ -150,6 +156,9 @@ 
 		$this->view->file_put_contents($uid . '/files_encryption/keyfiles/folder2/file.2.1.key'  , 'data');
 	}
 
+	/**
+	 * @param string $uid
+	 */
 	protected function createDummyFilesInTrash($uid) {
 		$this->view->mkdir($uid . '/files_trashbin/share-keys');
 		$this->view->mkdir($uid . '/files_trashbin/share-keys/folder1.d7437648723');
@@ -219,6 +228,9 @@ 
 
 	}
 
+	/**
+	 * @param string $uid
+	 */
 	protected function verifyFilesInTrash($uid) {
 		// share keys
 		$this->view->file_exists($uid . '/files_trashbin/keys/file1.d5457864/' . self::TEST_ENCRYPTION_MIGRATION_USER1 . '.shareKey.d5457864' , 'data');
@@ -231,6 +243,9 @@ 
 		$this->view->file_exists($uid . '/files_trashbin/keyfiles/folder1.d7437648723/file2/fileKey' , 'data');
 	}
 
+	/**
+	 * @param string $uid
+	 */
 	protected function verifyNewKeyPath($uid) {
 		// private key
 		if ($uid !== '') {