summaryrefslogtreecommitdiffstats
path: root/apps/files_encryption
diff options
context:
space:
mode:
authorMorris Jobke <hey@morrisjobke.de>2014-05-19 17:50:53 +0200
committerMorris Jobke <hey@morrisjobke.de>2014-05-19 17:50:53 +0200
commitdc36d3095314db8d88c2ec1005d99af595c119da (patch)
tree9de515019d7ebae43a545e5dc4eb522ef71dbe9c /apps/files_encryption
parent95741f3936501e3ad6aeb26f93eeb28f9decc273 (diff)
downloadnextcloud-server-dc36d3095314db8d88c2ec1005d99af595c119da.tar.gz
nextcloud-server-dc36d3095314db8d88c2ec1005d99af595c119da.zip
Remove all occurences of @brief and @returns from PHPDoc
* test case added to avoid adding them later
Diffstat (limited to 'apps/files_encryption')
-rw-r--r--apps/files_encryption/ajax/adminrecovery.php2
-rw-r--r--apps/files_encryption/ajax/changeRecoveryPassword.php2
-rw-r--r--apps/files_encryption/ajax/getMigrationStatus.php2
-rw-r--r--apps/files_encryption/ajax/updatePrivateKeyPassword.php2
-rw-r--r--apps/files_encryption/ajax/userrecovery.php2
-rw-r--r--apps/files_encryption/hooks/hooks.php20
-rwxr-xr-xapps/files_encryption/lib/crypt.php38
-rwxr-xr-xapps/files_encryption/lib/helper.php38
-rwxr-xr-xapps/files_encryption/lib/keymanager.php34
-rw-r--r--apps/files_encryption/lib/proxy.php6
-rw-r--r--apps/files_encryption/lib/session.php20
-rw-r--r--apps/files_encryption/lib/stream.php10
-rw-r--r--apps/files_encryption/lib/util.php66
-rwxr-xr-xapps/files_encryption/tests/crypt.php10
-rw-r--r--apps/files_encryption/tests/hooks.php4
-rw-r--r--apps/files_encryption/tests/proxy.php4
-rwxr-xr-xapps/files_encryption/tests/share.php2
-rw-r--r--apps/files_encryption/tests/stream.php4
-rwxr-xr-xapps/files_encryption/tests/trashbin.php8
-rwxr-xr-xapps/files_encryption/tests/util.php14
-rwxr-xr-xapps/files_encryption/tests/webdav.php10
21 files changed, 149 insertions, 149 deletions
diff --git a/apps/files_encryption/ajax/adminrecovery.php b/apps/files_encryption/ajax/adminrecovery.php
index 61e43acc2c3..303ba0e16e1 100644
--- a/apps/files_encryption/ajax/adminrecovery.php
+++ b/apps/files_encryption/ajax/adminrecovery.php
@@ -5,7 +5,7 @@
* This file is licensed under the Affero General Public License version 3 or later.
* See the COPYING-README file.
*
- * @brief Script to handle admin settings for encrypted key recovery
+ * Script to handle admin settings for encrypted key recovery
*/
use OCA\Encryption;
diff --git a/apps/files_encryption/ajax/changeRecoveryPassword.php b/apps/files_encryption/ajax/changeRecoveryPassword.php
index f020e52607d..0cb010d3b56 100644
--- a/apps/files_encryption/ajax/changeRecoveryPassword.php
+++ b/apps/files_encryption/ajax/changeRecoveryPassword.php
@@ -5,7 +5,7 @@
* This file is licensed under the Affero General Public License version 3 or later.
* See the COPYING-README file.
*
- * @brief Script to change recovery key password
+ * Script to change recovery key password
*
*/
diff --git a/apps/files_encryption/ajax/getMigrationStatus.php b/apps/files_encryption/ajax/getMigrationStatus.php
index a8828401934..adceb949044 100644
--- a/apps/files_encryption/ajax/getMigrationStatus.php
+++ b/apps/files_encryption/ajax/getMigrationStatus.php
@@ -4,7 +4,7 @@
* This file is licensed under the Affero General Public License version 3 or later.
* See the COPYING-README file.
*
- * @brief check migration status
+ * check migration status
*/
use OCA\Encryption\Util;
diff --git a/apps/files_encryption/ajax/updatePrivateKeyPassword.php b/apps/files_encryption/ajax/updatePrivateKeyPassword.php
index 29c72952ae9..f7d20c486cf 100644
--- a/apps/files_encryption/ajax/updatePrivateKeyPassword.php
+++ b/apps/files_encryption/ajax/updatePrivateKeyPassword.php
@@ -5,7 +5,7 @@
* This file is licensed under the Affero General Public License version 3 or later.
* See the COPYING-README file.
*
- * @brief Script to change recovery key password
+ * Script to change recovery key password
*
*/
diff --git a/apps/files_encryption/ajax/userrecovery.php b/apps/files_encryption/ajax/userrecovery.php
index 81ca1459a91..0f3b973d69a 100644
--- a/apps/files_encryption/ajax/userrecovery.php
+++ b/apps/files_encryption/ajax/userrecovery.php
@@ -4,7 +4,7 @@
* This file is licensed under the Affero General Public License version 3 or later.
* See the COPYING-README file.
*
- * @brief Script to handle admin settings for encrypted key recovery
+ * Script to handle admin settings for encrypted key recovery
*/
use OCA\Encryption;
diff --git a/apps/files_encryption/hooks/hooks.php b/apps/files_encryption/hooks/hooks.php
index 0ab1c4b129c..c1ccb927df5 100644
--- a/apps/files_encryption/hooks/hooks.php
+++ b/apps/files_encryption/hooks/hooks.php
@@ -36,7 +36,7 @@ class Hooks {
private static $deleteFiles = array();
/**
- * @brief Startup encryption backend upon user login
+ * Startup encryption backend upon user login
* @note This method should never be called for users using client side encryption
*/
public static function login($params) {
@@ -136,7 +136,7 @@ class Hooks {
}
/**
- * @brief setup encryption backend upon user created
+ * setup encryption backend upon user created
* @note This method should never be called for users using client side encryption
*/
public static function postCreateUser($params) {
@@ -149,7 +149,7 @@ class Hooks {
}
/**
- * @brief cleanup encryption backend upon user deleted
+ * cleanup encryption backend upon user deleted
* @note This method should never be called for users using client side encryption
*/
public static function postDeleteUser($params) {
@@ -171,7 +171,7 @@ class Hooks {
}
/**
- * @brief If the password can't be changed within ownCloud, than update the key password in advance.
+ * If the password can't be changed within ownCloud, than update the key password in advance.
*/
public static function preSetPassphrase($params) {
if (\OCP\App::isEnabled('files_encryption')) {
@@ -182,7 +182,7 @@ class Hooks {
}
/**
- * @brief Change a user's encryption passphrase
+ * Change a user's encryption passphrase
* @param array $params keys: uid, password
*/
public static function setPassphrase($params) {
@@ -259,7 +259,7 @@ class Hooks {
}
/*
- * @brief check if files can be encrypted to every user.
+ * check if files can be encrypted to every user.
*/
/**
* @param array $params
@@ -398,7 +398,7 @@ class Hooks {
}
/**
- * @brief mark file as renamed so that we know the original source after the file was renamed
+ * mark file as renamed so that we know the original source after the file was renamed
* @param array $params with the old path and the new path
*/
public static function preRename($params) {
@@ -421,7 +421,7 @@ class Hooks {
}
/**
- * @brief after a file is renamed, rename its keyfile and share-keys also fix the file size and fix also the sharing
+ * after a file is renamed, rename its keyfile and share-keys also fix the file size and fix also the sharing
* @param array $params array with oldpath and newpath
*
* This function is connected to the rename signal of OC_Filesystem and adjust the name and location
@@ -557,7 +557,7 @@ class Hooks {
}
/**
- * @brief if the file was really deleted we remove the encryption keys
+ * if the file was really deleted we remove the encryption keys
* @param array $params
* @return boolean|null
*/
@@ -597,7 +597,7 @@ class Hooks {
}
/**
- * @brief remember the file which should be deleted and it's owner
+ * remember the file which should be deleted and it's owner
* @param array $params
* @return boolean|null
*/
diff --git a/apps/files_encryption/lib/crypt.php b/apps/files_encryption/lib/crypt.php
index 5cdc92e85f7..ec7b3bc92e4 100755
--- a/apps/files_encryption/lib/crypt.php
+++ b/apps/files_encryption/lib/crypt.php
@@ -40,7 +40,7 @@ class Crypt {
/**
- * @brief return encryption mode client or server side encryption
+ * return encryption mode client or server side encryption
* @param string $user name (use system wide setting if name=null)
* @return string 'client' or 'server'
*/
@@ -51,7 +51,7 @@ class Crypt {
}
/**
- * @brief Create a new encryption keypair
+ * Create a new encryption keypair
* @return array publicKey, privatekey
*/
public static function createKeypair() {
@@ -85,7 +85,7 @@ class Crypt {
}
/**
- * @brief Add arbitrary padding to encrypted data
+ * Add arbitrary padding to encrypted data
* @param string $data data to be padded
* @return string padded data
* @note In order to end up with data exactly 8192 bytes long we must
@@ -102,7 +102,7 @@ class Crypt {
}
/**
- * @brief Remove arbitrary padding to encrypted data
+ * Remove arbitrary padding to encrypted data
* @param string $padded padded data to remove padding from
* @return string unpadded data on success, false on error
*/
@@ -124,7 +124,7 @@ class Crypt {
}
/**
- * @brief Check if a file's contents contains an IV and is symmetrically encrypted
+ * Check if a file's contents contains an IV and is symmetrically encrypted
* @param string $content
* @return boolean
* @note see also OCA\Encryption\Util->isEncryptedPath()
@@ -178,7 +178,7 @@ class Crypt {
}
/**
- * @brief Check if a file is encrypted via legacy system
+ * Check if a file is encrypted via legacy system
* @param boolean $isCatFileContent
* @param string $relPath The path of the file, relative to user/data;
* e.g. filename or /Docs/filename, NOT admin/files/filename
@@ -208,7 +208,7 @@ class Crypt {
}
/**
- * @brief Symmetrically encrypt a string
+ * Symmetrically encrypt a string
* @param string $plainContent
* @param string $iv
* @param string $passphrase
@@ -228,7 +228,7 @@ class Crypt {
}
/**
- * @brief Symmetrically decrypt a string
+ * Symmetrically decrypt a string
* @param string $encryptedContent
* @param string $iv
* @param string $passphrase
@@ -250,7 +250,7 @@ class Crypt {
}
/**
- * @brief Concatenate encrypted data with its IV and padding
+ * Concatenate encrypted data with its IV and padding
* @param string $content content to be concatenated
* @param string $iv IV to be concatenated
* @return string concatenated content
@@ -264,7 +264,7 @@ class Crypt {
}
/**
- * @brief Split concatenated data and IV into respective parts
+ * Split concatenated data and IV into respective parts
* @param string $catFile concatenated data to be split
* @return array keys: encrypted, iv
*/
@@ -289,7 +289,7 @@ class Crypt {
}
/**
- * @brief Symmetrically encrypts a string and returns keyfile content
+ * Symmetrically encrypts a string and returns keyfile content
* @param string $plainContent content to be encrypted in keyfile
* @param string $passphrase
* @return false|string encrypted content combined with IV
@@ -321,7 +321,7 @@ class Crypt {
/**
- * @brief Symmetrically decrypts keyfile content
+ * Symmetrically decrypts keyfile content
* @param string $keyfileContent
* @param string $passphrase
* @throws \Exception
@@ -358,7 +358,7 @@ class Crypt {
}
/**
- * @brief Decrypt private key and check if the result is a valid keyfile
+ * Decrypt private key and check if the result is a valid keyfile
* @param string $encryptedKey encrypted keyfile
* @param string $passphrase to decrypt keyfile
* @return string|false encrypted private key or false
@@ -385,7 +385,7 @@ class Crypt {
}
/**
- * @brief Create asymmetrically encrypted keyfile content using a generated key
+ * 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
@@ -433,7 +433,7 @@ class Crypt {
}
/**
- * @brief Asymmetrically encrypt a file using multiple public keys
+ * Asymmetrically encrypt a file using multiple public keys
* @param string $encryptedContent
* @param string $shareKey
* @param mixed $privateKey
@@ -467,7 +467,7 @@ class Crypt {
}
/**
- * @brief Generates a pseudo random initialisation vector
+ * Generates a pseudo random initialisation vector
* @return String $iv generated IV
*/
private static function generateIv() {
@@ -496,7 +496,7 @@ class Crypt {
}
/**
- * @brief Generate a pseudo random 256-bit ASCII key, used as file key
+ * Generate a pseudo random 256-bit ASCII key, used as file key
* @return string|false Generated key
*/
public static function generateKey() {
@@ -522,7 +522,7 @@ class Crypt {
}
/**
- * @brief Get the blowfish encryption handler for a key
+ * Get the blowfish encryption handler for a key
* @param string $key (optional)
* @return \Crypt_Blowfish blowfish object
*
@@ -543,7 +543,7 @@ class Crypt {
}
/**
- * @brief decrypts content using legacy blowfish system
+ * decrypts content using legacy blowfish system
* @param string $content the cleartext message you want to decrypt
* @param string $passphrase
* @return string cleartext content
diff --git a/apps/files_encryption/lib/helper.php b/apps/files_encryption/lib/helper.php
index 2455c605dfe..564e97e0592 100755
--- a/apps/files_encryption/lib/helper.php
+++ b/apps/files_encryption/lib/helper.php
@@ -24,7 +24,7 @@
namespace OCA\Encryption;
/**
- * @brief Class to manage registration of hooks an various helper methods
+ * Class to manage registration of hooks an various helper methods
* @package OCA\Encryption
*/
class Helper {
@@ -32,7 +32,7 @@ class Helper {
private static $tmpFileMapping; // Map tmp files to files in data/user/files
/**
- * @brief register share related hooks
+ * register share related hooks
*
*/
public static function registerShareHooks() {
@@ -43,7 +43,7 @@ class Helper {
}
/**
- * @brief register user related hooks
+ * register user related hooks
*
*/
public static function registerUserHooks() {
@@ -56,7 +56,7 @@ class Helper {
}
/**
- * @brief register filesystem related hooks
+ * register filesystem related hooks
*
*/
public static function registerFilesystemHooks() {
@@ -68,7 +68,7 @@ class Helper {
}
/**
- * @brief register app management related hooks
+ * register app management related hooks
*
*/
public static function registerAppHooks() {
@@ -78,7 +78,7 @@ class Helper {
}
/**
- * @brief setup user for files_encryption
+ * setup user for files_encryption
*
* @param Util $util
* @param string $password
@@ -100,7 +100,7 @@ class Helper {
}
/**
- * @brief enable recovery
+ * enable recovery
*
* @param string $recoveryKeyId
* @param string $recoveryPassword
@@ -164,7 +164,7 @@ class Helper {
}
/**
- * @brief Check if a path is a .part file
+ * Check if a path is a .part file
* @param string $path Path that may identify a .part file
* @return bool
*/
@@ -181,7 +181,7 @@ class Helper {
/**
- * @brief Remove .path extension from a file path
+ * Remove .path extension from a file path
* @param string $path Path that may identify a .part file
* @return string File path without .part extension
* @note this is needed for reusing keys
@@ -208,7 +208,7 @@ class Helper {
}
/**
- * @brief disable recovery
+ * disable recovery
*
* @param string $recoveryPassword
* @return bool
@@ -227,7 +227,7 @@ class Helper {
/**
- * @brief checks if access is public/anonymous user
+ * checks if access is public/anonymous user
* @return bool
*/
public static function isPublicAccess() {
@@ -239,7 +239,7 @@ class Helper {
}
/**
- * @brief Format a path to be relative to the /user/files/ directory
+ * Format a path to be relative to the /user/files/ directory
* @param string $path the absolute path
* @return string e.g. turns '/admin/files/test.txt' into 'test.txt'
*/
@@ -259,7 +259,7 @@ class Helper {
}
/**
- * @brief try to get the user from the path if no user is logged in
+ * try to get the user from the path if no user is logged in
* @param string $path
* @return mixed user or false if we couldn't determine a user
*/
@@ -294,7 +294,7 @@ class Helper {
}
/**
- * @brief get path to the corresponding file in data/user/files if path points
+ * get path to the corresponding file in data/user/files if path points
* to a version or to a file in cache
* @param string $path path to a version or a file in the trash
* @return string path to corresponding file relative to data/user/files
@@ -327,7 +327,7 @@ class Helper {
}
/**
- * @brief create directory recursively
+ * create directory recursively
* @param string $path
* @param \OC\Files\View $view
*/
@@ -344,7 +344,7 @@ class Helper {
}
/**
- * @brief redirect to a error page
+ * redirect to a error page
* @param Session $session
*/
public static function redirectToErrorPage($session, $errorCode = null) {
@@ -428,7 +428,7 @@ class Helper {
}
/**
- * @brief glob uses different pattern than regular expressions, escape glob pattern only
+ * glob uses different pattern than regular expressions, escape glob pattern only
* @param string $path unescaped path
* @return string path
*/
@@ -437,7 +437,7 @@ class Helper {
}
/**
- * @brief remember from which file the tmp file (getLocalFile() call) was created
+ * remember from which file the tmp file (getLocalFile() call) was created
* @param string $tmpFile path of tmp file
* @param string $originalFile path of the original file relative to data/
*/
@@ -446,7 +446,7 @@ class Helper {
}
/**
- * @brief get the path of the original file
+ * get the path of the original file
* @param string $tmpFile path of the tmp file
* @return string|false path of the original file or false
*/
diff --git a/apps/files_encryption/lib/keymanager.php b/apps/files_encryption/lib/keymanager.php
index 0732153f313..3c51c5efba2 100755
--- a/apps/files_encryption/lib/keymanager.php
+++ b/apps/files_encryption/lib/keymanager.php
@@ -24,13 +24,13 @@
namespace OCA\Encryption;
/**
- * @brief Class to manage storage and retrieval of encryption keys
+ * Class to manage storage and retrieval of encryption keys
* @note Where a method requires a view object, it's root must be '/'
*/
class Keymanager {
/**
- * @brief retrieve the ENCRYPTED private key from a user
+ * retrieve the ENCRYPTED private key from a user
*
* @param \OC\Files\View $view
* @param string $user
@@ -55,7 +55,7 @@ class Keymanager {
}
/**
- * @brief retrieve public key for a specified user
+ * retrieve public key for a specified user
* @param \OC\Files\View $view
* @param string $userId
* @return string public key or false
@@ -74,7 +74,7 @@ class Keymanager {
}
/**
- * @brief Retrieve a user's public and private key
+ * Retrieve a user's public and private key
* @param \OC\Files\View $view
* @param string $userId
* @return array keys: privateKey, publicKey
@@ -89,7 +89,7 @@ class Keymanager {
}
/**
- * @brief Retrieve public keys for given users
+ * Retrieve public keys for given users
* @param \OC\Files\View $view
* @param array $userIds
* @return array of public keys for the specified users
@@ -109,7 +109,7 @@ class Keymanager {
}
/**
- * @brief store file encryption key
+ * store file encryption key
*
* @param \OC\Files\View $view
* @param \OCA\Encryption\Util $util
@@ -167,7 +167,7 @@ class Keymanager {
}
/**
- * @brief retrieve keyfile for an encrypted file
+ * retrieve keyfile for an encrypted file
* @param \OC\Files\View $view
* @param \OCA\Encryption\Util $util
* @param string|false $filePath
@@ -210,7 +210,7 @@ class Keymanager {
}
/**
- * @brief Delete a keyfile
+ * Delete a keyfile
*
* @param \OC\Files\View $view
* @param string $path path of the file the key belongs to
@@ -266,7 +266,7 @@ class Keymanager {
}
/**
- * @brief store private key from the user
+ * store private key from the user
* @param string $key
* @return bool
* @note Encryption of the private key must be performed by client code
@@ -293,7 +293,7 @@ class Keymanager {
}
/**
- * @brief store share key
+ * store share key
*
* @param \OC\Files\View $view
* @param string $path where the share key is stored
@@ -319,7 +319,7 @@ class Keymanager {
}
/**
- * @brief store multiple share keys for a single file
+ * store multiple share keys for a single file
* @param \OC\Files\View $view
* @param \OCA\Encryption\Util $util
* @param string $path
@@ -365,7 +365,7 @@ class Keymanager {
}
/**
- * @brief retrieve shareKey for an encrypted file
+ * retrieve shareKey for an encrypted file
* @param \OC\Files\View $view
* @param string $userId
* @param \OCA\Encryption\Util $util
@@ -406,7 +406,7 @@ class Keymanager {
}
/**
- * @brief delete all share keys of a given file
+ * delete all share keys of a given file
* @param \OC\Files\View $view
* @param string $userId owner of the file
* @param string $filePath path to the file, relative to the owners file dir
@@ -445,7 +445,7 @@ class Keymanager {
}
/**
- * @brief Delete a single user's shareKey for a single file
+ * Delete a single user's shareKey for a single file
*/
public static function delShareKey(\OC\Files\View $view, $userIds, $filePath) {
@@ -486,7 +486,7 @@ class Keymanager {
}
/**
- * @brief recursively delete share keys from given users
+ * recursively delete share keys from given users
*
* @param string $dir directory
* @param array $userIds user ids for which the share keys should be deleted
@@ -512,7 +512,7 @@ class Keymanager {
}
/**
- * @brief Make preparations to vars and filesystem for saving a keyfile
+ * Make preparations to vars and filesystem for saving a keyfile
* @param string|boolean $path
* @param string $basePath
*/
@@ -542,7 +542,7 @@ class Keymanager {
}
/**
- * @brief extract filename from share key name
+ * extract filename from share key name
* @param string $shareKey (filename.userid.sharekey)
* @return string|false filename or false
*/
diff --git a/apps/files_encryption/lib/proxy.php b/apps/files_encryption/lib/proxy.php
index 3449516f6ef..ae3df834e9f 100644
--- a/apps/files_encryption/lib/proxy.php
+++ b/apps/files_encryption/lib/proxy.php
@@ -24,7 +24,7 @@
*/
/**
- * @brief Encryption proxy which handles filesystem operations before and after
+ * Encryption proxy which handles filesystem operations before and after
* execution and encrypts, and handles keyfiles accordingly. Used for
* webui.
*/
@@ -144,7 +144,7 @@ class Proxy extends \OC_FileProxy {
}
/**
- * @brief update file cache with the new unencrypted size after file was written
+ * update file cache with the new unencrypted size after file was written
* @param string $path
* @param mixed $result
* @return mixed
@@ -212,7 +212,7 @@ class Proxy extends \OC_FileProxy {
}
/**
- * @brief remember initial fopen mode because sometimes it gets changed during the request
+ * remember initial fopen mode because sometimes it gets changed during the request
* @param string $path path
* @param string $mode type of access
*/
diff --git a/apps/files_encryption/lib/session.php b/apps/files_encryption/lib/session.php
index f9001422560..93be6691f96 100644
--- a/apps/files_encryption/lib/session.php
+++ b/apps/files_encryption/lib/session.php
@@ -36,7 +36,7 @@ class Session {
/**
- * @brief if session is started, check if ownCloud key pair is set up, if not create it
+ * if session is started, check if ownCloud key pair is set up, if not create it
* @param \OC\Files\View $view
*
* @note The ownCloud key pair is used to allow public link sharing even if encryption is enabled
@@ -105,7 +105,7 @@ class Session {
}
/**
- * @brief Sets user private key to session
+ * Sets user private key to session
* @param string $privateKey
* @return bool
*
@@ -120,7 +120,7 @@ class Session {
}
/**
- * @brief Sets status of encryption app
+ * Sets status of encryption app
* @param string $init INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED
* @return bool
*
@@ -135,7 +135,7 @@ class Session {
}
/**
- * @brief remove encryption keys and init status from session
+ * remove encryption keys and init status from session
*/
public function closeSession() {
\OC::$session->remove('encryptionInitialized');
@@ -144,7 +144,7 @@ class Session {
/**
- * @brief Gets status if we already tried to initialize the encryption app
+ * Gets status if we already tried to initialize the encryption app
* @return string init status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED
*
* @note this doesn not indicate of the init was successful, we just remeber the try!
@@ -158,7 +158,7 @@ class Session {
}
/**
- * @brief Gets user or public share private key from session
+ * Gets user or public share private key from session
* @return string $privateKey The user's plaintext private key
*
*/
@@ -176,7 +176,7 @@ class Session {
}
/**
- * @brief Sets public user private key to session
+ * Sets public user private key to session
* @param string $privateKey
* @return bool
*/
@@ -189,7 +189,7 @@ class Session {
}
/**
- * @brief Gets public share private key from session
+ * Gets public share private key from session
* @return string $privateKey
*
*/
@@ -204,7 +204,7 @@ class Session {
/**
- * @brief Sets user legacy key to session
+ * Sets user legacy key to session
* @param string $legacyKey
* @return bool
*/
@@ -216,7 +216,7 @@ class Session {
}
/**
- * @brief Gets user legacy key from session
+ * Gets user legacy key from session
* @return string $legacyKey The user's plaintext legacy key
*
*/
diff --git a/apps/files_encryption/lib/stream.php b/apps/files_encryption/lib/stream.php
index 1008eba43b6..341114214d5 100644
--- a/apps/files_encryption/lib/stream.php
+++ b/apps/files_encryption/lib/stream.php
@@ -31,7 +31,7 @@
namespace OCA\Encryption;
/**
- * @brief Provides 'crypt://' stream wrapper protocol.
+ * Provides 'crypt://' stream wrapper protocol.
* @note We use a stream wrapper because it is the most secure way to handle
* decrypted content transfers. There is no safe way to decrypt the entire file
* somewhere on the server, so we have to encrypt and decrypt blocks on the fly.
@@ -179,7 +179,7 @@ class Stream {
}
/**
- * @brief Returns the current position of the file pointer
+ * Returns the current position of the file pointer
* @return int position of the file pointer
*/
public function stream_tell() {
@@ -246,7 +246,7 @@ class Stream {
}
/**
- * @brief Encrypt and pad data ready for writing to disk
+ * Encrypt and pad data ready for writing to disk
* @param string $plainData data to be encrypted
* @param string $key key to use for encryption
* @return string encrypted data on success, false on failure
@@ -267,7 +267,7 @@ class Stream {
}
/**
- * @brief Fetch the plain encryption key for the file and set it as plainKey property
+ * Fetch the plain encryption key for the file and set it as plainKey property
* @internal param bool $generate if true, a new key will be generated if none can be found
* @return bool true on key found and set, false on key not found and new key generated and set
*/
@@ -318,7 +318,7 @@ class Stream {
}
/**
- * @brief Handle plain data from the stream, and write it in 8192 byte blocks
+ * Handle plain data from the stream, and write it in 8192 byte blocks
* @param string $data data to be written to disk
* @note the data will be written to the path stored in the stream handle, set in stream_open()
* @note $data is only ever be a maximum of 8192 bytes long. This is set by PHP internally. stream_write() is called multiple times in a loop on data larger than 8192 bytes
diff --git a/apps/files_encryption/lib/util.php b/apps/files_encryption/lib/util.php
index 84dbec6fdfc..d20efc3ac7b 100644
--- a/apps/files_encryption/lib/util.php
+++ b/apps/files_encryption/lib/util.php
@@ -25,7 +25,7 @@
namespace OCA\Encryption;
/**
- * @brief Class for utilities relating to encrypted file storage system
+ * Class for utilities relating to encrypted file storage system
* @param \OC\Files\View $view expected to have OC '/' as root path
* @param string $userId ID of the logged in user
* @param int $client indicating status of client side encryption. Currently
@@ -111,7 +111,7 @@ class Util {
}
/**
- * @brief check if the users private & public key exists
+ * check if the users private & public key exists
* @return boolean
*/
public function userKeysExists() {
@@ -125,7 +125,7 @@ class Util {
}
/**
- * @brief Sets up user folders and keys for serverside encryption
+ * Sets up user folders and keys for serverside encryption
*
* @param string $passphrase to encrypt server-stored private key with
* @return bool
@@ -222,7 +222,7 @@ class Util {
}
/**
- * @brief Check whether pwd recovery is enabled for a given user
+ * Check whether pwd recovery is enabled for a given user
* @return bool 1 = yes, 0 = no, false = no record
*
* @note If records are not being returned, check for a hidden space
@@ -264,7 +264,7 @@ class Util {
}
/**
- * @brief Enable / disable pwd recovery for a given user
+ * Enable / disable pwd recovery for a given user
* @param bool $enabled Whether to enable or disable recovery
* @return bool
*/
@@ -300,7 +300,7 @@ class Util {
}
/**
- * @brief Find all files and their encryption status within a directory
+ * Find all files and their encryption status within a directory
* @param string $directory The path of the parent directory to search
* @param bool $found the founded files if called again
* @return mixed false if 0 found, array on success. Keys: name, path
@@ -421,7 +421,7 @@ class Util {
}
/**
- * @brief Check if a given path identifies an encrypted file
+ * Check if a given path identifies an encrypted file
* @param string $path
* @return boolean
*/
@@ -463,7 +463,7 @@ class Util {
}
/**
- * @brief get the file size of the unencrypted file
+ * get the file size of the unencrypted file
* @param string $path absolute path
* @return bool
*/
@@ -537,7 +537,7 @@ class Util {
}
/**
- * @brief fix the file size of the encrypted file
+ * fix the file size of the encrypted file
* @param string $path absolute path
* @return boolean true / false if file is encrypted
*/
@@ -594,7 +594,7 @@ class Util {
}
/**
- * @brief encrypt versions from given file
+ * encrypt versions from given file
* @param array $filelist list of encrypted files, relative to data/user/files
* @return boolean
*/
@@ -640,7 +640,7 @@ class Util {
}
/**
- * @brief decrypt versions from given file
+ * decrypt versions from given file
* @param string $filelist list of decrypted files, relative to data/user/files
* @return boolean
*/
@@ -686,7 +686,7 @@ class Util {
}
/**
- * @brief Decrypt all files
+ * Decrypt all files
* @return bool
*/
public function decryptAll() {
@@ -799,7 +799,7 @@ class Util {
}
/**
- * @brief Encrypt all files in a directory
+ * Encrypt all files in a directory
* @param string $dirPath the directory whose files will be encrypted
* @param null $legacyPassphrase
* @param null $newPassphrase
@@ -926,7 +926,7 @@ class Util {
}
/**
- * @brief Return important encryption related paths
+ * Return important encryption related paths
* @param string $pathName Name of the directory to return the path of
* @return string path
*/
@@ -970,7 +970,7 @@ class Util {
}
/**
- * @brief Filter an array of UIDs to return only ones ready for sharing
+ * Filter an array of UIDs to return only ones ready for sharing
* @param array $unfilteredUsers users to be checked for sharing readiness
* @return array as multi-dimensional array. keys: ready, unready
*/
@@ -1017,7 +1017,7 @@ class Util {
}
/**
- * @brief Decrypt a keyfile
+ * Decrypt a keyfile
* @param string $filePath
* @param string $privateKey
* @return false|string
@@ -1036,7 +1036,7 @@ class Util {
}
/**
- * @brief Encrypt keyfile to multiple users
+ * Encrypt keyfile to multiple users
* @param Session $session
* @param array $users list of users which should be able to access the file
* @param string $filePath path of the file to be shared
@@ -1097,7 +1097,7 @@ class Util {
}
/**
- * @brief Find, sanitise and format users sharing a file
+ * Find, sanitise and format users sharing a file
* @note This wraps other methods into a portable bundle
* @param boolean $sharingEnabled
* @param string $filePath path relativ to current users files folder
@@ -1176,7 +1176,7 @@ class Util {
}
/**
- * @brief set migration status
+ * set migration status
* @param int $status
* @return boolean
*/
@@ -1199,7 +1199,7 @@ class Util {
}
/**
- * @brief start migration mode to initially encrypt users data
+ * start migration mode to initially encrypt users data
* @return boolean
*/
public function beginMigration() {
@@ -1221,7 +1221,7 @@ class Util {
}
/**
- * @brief close migration mode after users data has been encrypted successfully
+ * close migration mode after users data has been encrypted successfully
* @return boolean
*/
public function finishMigration() {
@@ -1237,7 +1237,7 @@ class Util {
}
/**
- * @brief check if files are already migrated to the encryption system
+ * check if files are already migrated to the encryption system
* @return int|false 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
@@ -1288,7 +1288,7 @@ class Util {
}
/**
- * @brief get uid of the owners of the file and the path to the file
+ * get uid of the owners of the file and the path to the file
* @param string $path Path of the file to check
* @throws \Exception
* @note $shareFilePath must be relative to data/UID/files. Files
@@ -1367,7 +1367,7 @@ class Util {
}
/**
- * @brief go recursively through a dir and collect all files and sub files.
+ * go recursively through a dir and collect all files and sub files.
* @param string $dir relative to the users files folder
* @return array with list of files relative to the users files folder
*/
@@ -1397,7 +1397,7 @@ class Util {
}
/**
- * @brief get owner of the shared files.
+ * get owner of the shared files.
* @param int $id ID of a share
* @return string owner
*/
@@ -1511,7 +1511,7 @@ class Util {
}
/**
- * @brief add recovery key to all encrypted files
+ * add recovery key to all encrypted files
*/
public function addRecoveryKeys($path = '/') {
$dirContent = $this->view->getDirectoryContent($this->keyfilesPath . $path);
@@ -1532,7 +1532,7 @@ class Util {
}
/**
- * @brief remove recovery key to all encrypted files
+ * remove recovery key to all encrypted files
*/
public function removeRecoveryKeys($path = '/') {
$dirContent = $this->view->getDirectoryContent($this->keyfilesPath . $path);
@@ -1550,7 +1550,7 @@ class Util {
}
/**
- * @brief decrypt given file with recovery key and encrypt it again to the owner and his new key
+ * decrypt given file with recovery key and encrypt it again to the owner and his new key
* @param string $file
* @param string $privateKey recovery key to decrypt the file
*/
@@ -1598,7 +1598,7 @@ class Util {
}
/**
- * @brief collect all files and recover them one by one
+ * collect all files and recover them one by one
* @param string $path to look for files keys
* @param string $privateKey private recovery key which is used to decrypt the files
*/
@@ -1618,7 +1618,7 @@ class Util {
}
/**
- * @brief recover users files in case of password lost
+ * recover users files in case of password lost
* @param string $recoveryPassword
*/
public function recoverUsersFiles($recoveryPassword) {
@@ -1637,7 +1637,7 @@ class Util {
}
/**
- * @brief check if the file is stored on a system wide mount point
+ * check if the file is stored on a system wide mount point
* @param string $path relative to /data/user with leading '/'
* @return boolean
*/
@@ -1654,7 +1654,7 @@ class Util {
}
/**
- * @brief decrypt private key and add it to the current session
+ * decrypt private key and add it to the current session
* @param array $params with 'uid' and 'password'
* @return mixed session or false
*/
@@ -1682,7 +1682,7 @@ class Util {
}
/*
- * @brief remove encryption related keys from the session
+ * remove encryption related keys from the session
*/
public function closeEncryptionSession() {
$session = new \OCA\Encryption\Session($this->view);
diff --git a/apps/files_encryption/tests/crypt.php b/apps/files_encryption/tests/crypt.php
index b98798d7265..b22cd214eaa 100755
--- a/apps/files_encryption/tests/crypt.php
+++ b/apps/files_encryption/tests/crypt.php
@@ -206,7 +206,7 @@ class Test_Encryption_Crypt extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief Test that data that is written by the crypto stream wrapper
+ * Test that data that is written by the crypto stream wrapper
* @note Encrypted data is manually prepared and decrypted here to avoid dependency on success of stream_read
* @note If this test fails with truncate content, check that enough array slices are being rejoined to form $e, as the crypt.php file may have gotten longer and broken the manual
* reassembly of its data
@@ -293,7 +293,7 @@ class Test_Encryption_Crypt extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief Test that data that is read by the crypto stream wrapper
+ * Test that data that is read by the crypto stream wrapper
*/
function testSymmetricStreamDecryptShortFileContent() {
@@ -388,7 +388,7 @@ class Test_Encryption_Crypt extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test decryption using legacy blowfish method
+ * test decryption using legacy blowfish method
*/
function testLegacyDecryptShort() {
@@ -402,7 +402,7 @@ class Test_Encryption_Crypt extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test decryption using legacy blowfish method
+ * test decryption using legacy blowfish method
*/
function testLegacyDecryptLong() {
@@ -660,7 +660,7 @@ class Test_Encryption_Crypt extends \PHPUnit_Framework_TestCase {
/**
- * @brief encryption using legacy blowfish method
+ * encryption using legacy blowfish method
* @param string $data data to encrypt
* @param string $passwd password
* @return string
diff --git a/apps/files_encryption/tests/hooks.php b/apps/files_encryption/tests/hooks.php
index ee534f708c2..fcb369c7238 100644
--- a/apps/files_encryption/tests/hooks.php
+++ b/apps/files_encryption/tests/hooks.php
@@ -32,7 +32,7 @@ use OCA\Encryption;
/**
* Class Test_Encryption_Hooks
- * @brief this class provide basic hook app tests
+ * this class provide basic hook app tests
*/
class Test_Encryption_Hooks extends \PHPUnit_Framework_TestCase {
@@ -259,7 +259,7 @@ class Test_Encryption_Hooks extends \PHPUnit_Framework_TestCase {
}
/**
- * @brief test rename operation
+ * test rename operation
*/
function testRenameHook() {
diff --git a/apps/files_encryption/tests/proxy.php b/apps/files_encryption/tests/proxy.php
index 533aaa376b9..8d6bc81b08d 100644
--- a/apps/files_encryption/tests/proxy.php
+++ b/apps/files_encryption/tests/proxy.php
@@ -33,7 +33,7 @@ use OCA\Encryption;
/**
* Class Test_Encryption_Proxy
- * @brief this class provide basic proxy app tests
+ * this class provide basic proxy app tests
*/
class Test_Encryption_Proxy extends \PHPUnit_Framework_TestCase {
@@ -91,7 +91,7 @@ class Test_Encryption_Proxy extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test if postFileSize returns the unencrypted file size
+ * test if postFileSize returns the unencrypted file size
*/
function testPostFileSize() {
diff --git a/apps/files_encryption/tests/share.php b/apps/files_encryption/tests/share.php
index f75092f5436..bb3d7505a5d 100755
--- a/apps/files_encryption/tests/share.php
+++ b/apps/files_encryption/tests/share.php
@@ -959,7 +959,7 @@ class Test_Encryption_Share extends \PHPUnit_Framework_TestCase {
/**
- * @brief test moving a shared file out of the Shared folder
+ * test moving a shared file out of the Shared folder
*/
function testRename() {
diff --git a/apps/files_encryption/tests/stream.php b/apps/files_encryption/tests/stream.php
index f742cd3f8e9..5df9cdbe1f1 100644
--- a/apps/files_encryption/tests/stream.php
+++ b/apps/files_encryption/tests/stream.php
@@ -33,7 +33,7 @@ use OCA\Encryption;
/**
* Class Test_Encryption_Stream
- * @brief this class provide basic stream tests
+ * this class provide basic stream tests
*/
class Test_Encryption_Stream extends \PHPUnit_Framework_TestCase {
@@ -183,7 +183,7 @@ class Test_Encryption_Stream extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test if stream wrapper can read files outside from the data folder
+ * test if stream wrapper can read files outside from the data folder
*/
function testStreamFromLocalFile() {
diff --git a/apps/files_encryption/tests/trashbin.php b/apps/files_encryption/tests/trashbin.php
index e36293ba81e..5d54b7db24f 100755
--- a/apps/files_encryption/tests/trashbin.php
+++ b/apps/files_encryption/tests/trashbin.php
@@ -34,7 +34,7 @@ use OCA\Encryption;
/**
* Class Test_Encryption_Trashbin
- * @brief this class provide basic trashbin app tests
+ * this class provide basic trashbin app tests
*/
class Test_Encryption_Trashbin extends \PHPUnit_Framework_TestCase {
@@ -114,7 +114,7 @@ class Test_Encryption_Trashbin extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test delete file
+ * test delete file
*/
function testDeleteFile() {
@@ -186,7 +186,7 @@ class Test_Encryption_Trashbin extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test restore file
+ * test restore file
*
* @depends testDeleteFile
*/
@@ -218,7 +218,7 @@ class Test_Encryption_Trashbin extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test delete file forever
+ * test delete file forever
*/
function testPermanentDeleteFile() {
diff --git a/apps/files_encryption/tests/util.php b/apps/files_encryption/tests/util.php
index 395bf152cd9..a4dcc5cc8bd 100755
--- a/apps/files_encryption/tests/util.php
+++ b/apps/files_encryption/tests/util.php
@@ -121,7 +121,7 @@ class Test_Encryption_Util extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test that paths set during User construction are correct
+ * test that paths set during User construction are correct
*/
function testKeyPaths() {
$util = new Encryption\Util($this->view, $this->userId);
@@ -136,7 +136,7 @@ class Test_Encryption_Util extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test detection of encrypted files
+ * test detection of encrypted files
*/
function testIsEncryptedPath() {
@@ -171,7 +171,7 @@ class Test_Encryption_Util extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test setup of encryption directories
+ * test setup of encryption directories
*/
function testSetupServerSide() {
$this->assertEquals(true, $this->util->setupServerSide($this->pass));
@@ -179,14 +179,14 @@ class Test_Encryption_Util extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test checking whether account is ready for encryption,
+ * test checking whether account is ready for encryption,
*/
function testUserIsReady() {
$this->assertEquals(true, $this->util->ready());
}
/**
- * @brief test checking whether account is not ready for encryption,
+ * test checking whether account is not ready for encryption,
*/
// function testUserIsNotReady() {
// $this->view->unlink($this->publicKeyDir);
@@ -200,7 +200,7 @@ class Test_Encryption_Util extends \PHPUnit_Framework_TestCase {
/**
* @medium
- * @brief test checking whether account is not ready for encryption,
+ * test checking whether account is not ready for encryption,
*/
function testIsLegacyUser() {
\Test_Encryption_Util::loginHelper(\Test_Encryption_Util::TEST_ENCRYPTION_UTIL_LEGACY_USER);
@@ -279,7 +279,7 @@ class Test_Encryption_Util extends \PHPUnit_Framework_TestCase {
}
/**
-< * @brief Test that data that is read by the crypto stream wrapper
+< * Test that data that is read by the crypto stream wrapper
*/
function testGetFileSize() {
\Test_Encryption_Util::loginHelper(\Test_Encryption_Util::TEST_ENCRYPTION_UTIL_USER1);
diff --git a/apps/files_encryption/tests/webdav.php b/apps/files_encryption/tests/webdav.php
index bdd3d51897b..d33dc58cf92 100755
--- a/apps/files_encryption/tests/webdav.php
+++ b/apps/files_encryption/tests/webdav.php
@@ -34,7 +34,7 @@ use OCA\Encryption;
/**
* Class Test_Encryption_Webdav
*
- * @brief this class provide basic webdav tests for PUT,GET and DELETE
+ * this class provide basic webdav tests for PUT,GET and DELETE
*/
class Test_Encryption_Webdav extends \PHPUnit_Framework_TestCase {
@@ -112,7 +112,7 @@ class Test_Encryption_Webdav extends \PHPUnit_Framework_TestCase {
}
/**
- * @brief test webdav put random file
+ * test webdav put random file
*/
function testWebdavPUT() {
@@ -167,7 +167,7 @@ class Test_Encryption_Webdav extends \PHPUnit_Framework_TestCase {
}
/**
- * @brief test webdav get random file
+ * test webdav get random file
*
* @depends testWebdavPUT
*/
@@ -190,7 +190,7 @@ class Test_Encryption_Webdav extends \PHPUnit_Framework_TestCase {
}
/**
- * @brief test webdav delete random file
+ * test webdav delete random file
* @depends testWebdavGET
*/
function testWebdavDELETE($filename) {
@@ -216,7 +216,7 @@ class Test_Encryption_Webdav extends \PHPUnit_Framework_TestCase {
}
/**
- * @brief handle webdav request
+ * handle webdav request
*
* @param bool $body
*