nextcloud / server

apps/encryption/lib/Recovery.php

Indentation +287 added lines, -287 removed lines

@@ -38,293 +38,293 @@
 class Recovery {
 
 
-	/**
-	 * @var null|IUser
-	 */
-	protected $user;
-	/**
-	 * @var Crypt
-	 */
-	protected $crypt;
-	/**
-	 * @var ISecureRandom
-	 */
-	private $random;
-	/**
-	 * @var KeyManager
-	 */
-	private $keyManager;
-	/**
-	 * @var IConfig
-	 */
-	private $config;
-	/**
-	 * @var IStorage
-	 */
-	private $keyStorage;
-	/**
-	 * @var View
-	 */
-	private $view;
-	/**
-	 * @var IFile
-	 */
-	private $file;
-
-	/**
-	 * @param IUserSession $user
-	 * @param Crypt $crypt
-	 * @param ISecureRandom $random
-	 * @param KeyManager $keyManager
-	 * @param IConfig $config
-	 * @param IStorage $keyStorage
-	 * @param IFile $file
-	 * @param View $view
-	 */
-	public function __construct(IUserSession $user,
-								Crypt $crypt,
-								ISecureRandom $random,
-								KeyManager $keyManager,
-								IConfig $config,
-								IStorage $keyStorage,
-								IFile $file,
-								View $view) {
-		$this->user = ($user && $user->isLoggedIn()) ? $user->getUser() : false;
-		$this->crypt = $crypt;
-		$this->random = $random;
-		$this->keyManager = $keyManager;
-		$this->config = $config;
-		$this->keyStorage = $keyStorage;
-		$this->view = $view;
-		$this->file = $file;
-	}
-
-	/**
-	 * @param string $password
-	 * @return bool
-	 */
-	public function enableAdminRecovery($password) {
-		$appConfig = $this->config;
-		$keyManager = $this->keyManager;
-
-		if (!$keyManager->recoveryKeyExists()) {
-			$keyPair = $this->crypt->createKeyPair();
-			if(!is_array($keyPair)) {
-				return false;
-			}
-
-			$this->keyManager->setRecoveryKey($password, $keyPair);
-		}
-
-		if ($keyManager->checkRecoveryPassword($password)) {
-			$appConfig->setAppValue('encryption', 'recoveryAdminEnabled', 1);
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * change recovery key id
-	 *
-	 * @param string $newPassword
-	 * @param string $oldPassword
-	 * @return bool
-	 */
-	public function changeRecoveryKeyPassword($newPassword, $oldPassword) {
-		$recoveryKey = $this->keyManager->getSystemPrivateKey($this->keyManager->getRecoveryKeyId());
-		$decryptedRecoveryKey = $this->crypt->decryptPrivateKey($recoveryKey, $oldPassword);
-		if($decryptedRecoveryKey === false) {
-			return false;
-		}
-		$encryptedRecoveryKey = $this->crypt->encryptPrivateKey($decryptedRecoveryKey, $newPassword);
-		$header = $this->crypt->generateHeader();
-		if ($encryptedRecoveryKey) {
-			$this->keyManager->setSystemPrivateKey($this->keyManager->getRecoveryKeyId(), $header . $encryptedRecoveryKey);
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * @param string $recoveryPassword
-	 * @return bool
-	 */
-	public function disableAdminRecovery($recoveryPassword) {
-		$keyManager = $this->keyManager;
-
-		if ($keyManager->checkRecoveryPassword($recoveryPassword)) {
-			// Set recoveryAdmin as disabled
-			$this->config->setAppValue('encryption', 'recoveryAdminEnabled', 0);
-			return true;
-		}
-		return false;
-	}
-
-	/**
-	 * check if recovery is enabled for user
-	 *
-	 * @param string $user if no user is given we check the current logged-in user
-	 *
-	 * @return bool
-	 */
-	public function isRecoveryEnabledForUser($user = '') {
-		$uid = empty($user) ? $this->user->getUID() : $user;
-		$recoveryMode = $this->config->getUserValue($uid,
-			'encryption',
-			'recoveryEnabled',
-			0);
-
-		return ($recoveryMode === '1');
-	}
-
-	/**
-	 * check if recovery is key is enabled by the administrator
-	 *
-	 * @return bool
-	 */
-	public function isRecoveryKeyEnabled() {
-		$enabled = $this->config->getAppValue('encryption', 'recoveryAdminEnabled', 0);
-
-		return ($enabled === '1');
-	}
-
-	/**
-	 * @param string $value
-	 * @return bool
-	 */
-	public function setRecoveryForUser($value) {
-
-		try {
-			$this->config->setUserValue($this->user->getUID(),
-				'encryption',
-				'recoveryEnabled',
-				$value);
-
-			if ($value === '1') {
-				$this->addRecoveryKeys('/' . $this->user->getUID() . '/files/');
-			} else {
-				$this->removeRecoveryKeys('/' . $this->user->getUID() . '/files/');
-			}
-
-			return true;
-		} catch (PreConditionNotMetException $e) {
-			return false;
-		}
-	}
-
-	/**
-	 * add recovery key to all encrypted files
-	 * @param string $path
-	 */
-	private function addRecoveryKeys($path) {
-		$dirContent = $this->view->getDirectoryContent($path);
-		foreach ($dirContent as $item) {
-			$filePath = $item->getPath();
-			if ($item['type'] === 'dir') {
-				$this->addRecoveryKeys($filePath . '/');
-			} else {
-				$fileKey = $this->keyManager->getFileKey($filePath, $this->user->getUID());
-				if (!empty($fileKey)) {
-					$accessList = $this->file->getAccessList($filePath);
-					$publicKeys = array();
-					foreach ($accessList['users'] as $uid) {
-						$publicKeys[$uid] = $this->keyManager->getPublicKey($uid);
-					}
-
-					$publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $this->user->getUID());
-
-					$encryptedKeyfiles = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
-					$this->keyManager->setAllFileKeys($filePath, $encryptedKeyfiles);
-				}
-			}
-		}
-	}
-
-	/**
-	 * remove recovery key to all encrypted files
-	 * @param string $path
-	 */
-	private function removeRecoveryKeys($path) {
-		$dirContent = $this->view->getDirectoryContent($path);
-		foreach ($dirContent as $item) {
-			$filePath = $item->getPath();
-			if ($item['type'] === 'dir') {
-				$this->removeRecoveryKeys($filePath . '/');
-			} else {
-				$this->keyManager->deleteShareKey($filePath, $this->keyManager->getRecoveryKeyId());
-			}
-		}
-	}
-
-	/**
-	 * recover users files with the recovery key
-	 *
-	 * @param string $recoveryPassword
-	 * @param string $user
-	 */
-	public function recoverUsersFiles($recoveryPassword, $user) {
-		$encryptedKey = $this->keyManager->getSystemPrivateKey($this->keyManager->getRecoveryKeyId());
-
-		$privateKey = $this->crypt->decryptPrivateKey($encryptedKey, $recoveryPassword);
-		if($privateKey !== false) {
-			$this->recoverAllFiles('/' . $user . '/files/', $privateKey, $user);
-		}
-	}
-
-	/**
-	 * recover users files
-	 *
-	 * @param string $path
-	 * @param string $privateKey
-	 * @param string $uid
-	 */
-	private function recoverAllFiles($path, $privateKey, $uid) {
-		$dirContent = $this->view->getDirectoryContent($path);
-
-		foreach ($dirContent as $item) {
-			// Get relative path from encryption/keyfiles
-			$filePath = $item->getPath();
-			if ($this->view->is_dir($filePath)) {
-				$this->recoverAllFiles($filePath . '/', $privateKey, $uid);
-			} else {
-				$this->recoverFile($filePath, $privateKey, $uid);
-			}
-		}
-
-	}
-
-	/**
-	 * recover file
-	 *
-	 * @param string $path
-	 * @param string $privateKey
-	 * @param string $uid
-	 */
-	private function recoverFile($path, $privateKey, $uid) {
-		$encryptedFileKey = $this->keyManager->getEncryptedFileKey($path);
-		$shareKey = $this->keyManager->getShareKey($path, $this->keyManager->getRecoveryKeyId());
-
-		if ($encryptedFileKey && $shareKey && $privateKey) {
-			$fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey,
-				$shareKey,
-				$privateKey);
-		}
-
-		if (!empty($fileKey)) {
-			$accessList = $this->file->getAccessList($path);
-			$publicKeys = array();
-			foreach ($accessList['users'] as $user) {
-				$publicKeys[$user] = $this->keyManager->getPublicKey($user);
-			}
-
-			$publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $uid);
-
-			$encryptedKeyfiles = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
-			$this->keyManager->setAllFileKeys($path, $encryptedKeyfiles);
-		}
-
-	}
+    /**
+     * @var null|IUser
+     */
+    protected $user;
+    /**
+     * @var Crypt
+     */
+    protected $crypt;
+    /**
+     * @var ISecureRandom
+     */
+    private $random;
+    /**
+     * @var KeyManager
+     */
+    private $keyManager;
+    /**
+     * @var IConfig
+     */
+    private $config;
+    /**
+     * @var IStorage
+     */
+    private $keyStorage;
+    /**
+     * @var View
+     */
+    private $view;
+    /**
+     * @var IFile
+     */
+    private $file;
+
+    /**
+     * @param IUserSession $user
+     * @param Crypt $crypt
+     * @param ISecureRandom $random
+     * @param KeyManager $keyManager
+     * @param IConfig $config
+     * @param IStorage $keyStorage
+     * @param IFile $file
+     * @param View $view
+     */
+    public function __construct(IUserSession $user,
+                                Crypt $crypt,
+                                ISecureRandom $random,
+                                KeyManager $keyManager,
+                                IConfig $config,
+                                IStorage $keyStorage,
+                                IFile $file,
+                                View $view) {
+        $this->user = ($user && $user->isLoggedIn()) ? $user->getUser() : false;
+        $this->crypt = $crypt;
+        $this->random = $random;
+        $this->keyManager = $keyManager;
+        $this->config = $config;
+        $this->keyStorage = $keyStorage;
+        $this->view = $view;
+        $this->file = $file;
+    }
+
+    /**
+     * @param string $password
+     * @return bool
+     */
+    public function enableAdminRecovery($password) {
+        $appConfig = $this->config;
+        $keyManager = $this->keyManager;
+
+        if (!$keyManager->recoveryKeyExists()) {
+            $keyPair = $this->crypt->createKeyPair();
+            if(!is_array($keyPair)) {
+                return false;
+            }
+
+            $this->keyManager->setRecoveryKey($password, $keyPair);
+        }
+
+        if ($keyManager->checkRecoveryPassword($password)) {
+            $appConfig->setAppValue('encryption', 'recoveryAdminEnabled', 1);
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * change recovery key id
+     *
+     * @param string $newPassword
+     * @param string $oldPassword
+     * @return bool
+     */
+    public function changeRecoveryKeyPassword($newPassword, $oldPassword) {
+        $recoveryKey = $this->keyManager->getSystemPrivateKey($this->keyManager->getRecoveryKeyId());
+        $decryptedRecoveryKey = $this->crypt->decryptPrivateKey($recoveryKey, $oldPassword);
+        if($decryptedRecoveryKey === false) {
+            return false;
+        }
+        $encryptedRecoveryKey = $this->crypt->encryptPrivateKey($decryptedRecoveryKey, $newPassword);
+        $header = $this->crypt->generateHeader();
+        if ($encryptedRecoveryKey) {
+            $this->keyManager->setSystemPrivateKey($this->keyManager->getRecoveryKeyId(), $header . $encryptedRecoveryKey);
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * @param string $recoveryPassword
+     * @return bool
+     */
+    public function disableAdminRecovery($recoveryPassword) {
+        $keyManager = $this->keyManager;
+
+        if ($keyManager->checkRecoveryPassword($recoveryPassword)) {
+            // Set recoveryAdmin as disabled
+            $this->config->setAppValue('encryption', 'recoveryAdminEnabled', 0);
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * check if recovery is enabled for user
+     *
+     * @param string $user if no user is given we check the current logged-in user
+     *
+     * @return bool
+     */
+    public function isRecoveryEnabledForUser($user = '') {
+        $uid = empty($user) ? $this->user->getUID() : $user;
+        $recoveryMode = $this->config->getUserValue($uid,
+            'encryption',
+            'recoveryEnabled',
+            0);
+
+        return ($recoveryMode === '1');
+    }
+
+    /**
+     * check if recovery is key is enabled by the administrator
+     *
+     * @return bool
+     */
+    public function isRecoveryKeyEnabled() {
+        $enabled = $this->config->getAppValue('encryption', 'recoveryAdminEnabled', 0);
+
+        return ($enabled === '1');
+    }
+
+    /**
+     * @param string $value
+     * @return bool
+     */
+    public function setRecoveryForUser($value) {
+
+        try {
+            $this->config->setUserValue($this->user->getUID(),
+                'encryption',
+                'recoveryEnabled',
+                $value);
+
+            if ($value === '1') {
+                $this->addRecoveryKeys('/' . $this->user->getUID() . '/files/');
+            } else {
+                $this->removeRecoveryKeys('/' . $this->user->getUID() . '/files/');
+            }
+
+            return true;
+        } catch (PreConditionNotMetException $e) {
+            return false;
+        }
+    }
+
+    /**
+     * add recovery key to all encrypted files
+     * @param string $path
+     */
+    private function addRecoveryKeys($path) {
+        $dirContent = $this->view->getDirectoryContent($path);
+        foreach ($dirContent as $item) {
+            $filePath = $item->getPath();
+            if ($item['type'] === 'dir') {
+                $this->addRecoveryKeys($filePath . '/');
+            } else {
+                $fileKey = $this->keyManager->getFileKey($filePath, $this->user->getUID());
+                if (!empty($fileKey)) {
+                    $accessList = $this->file->getAccessList($filePath);
+                    $publicKeys = array();
+                    foreach ($accessList['users'] as $uid) {
+                        $publicKeys[$uid] = $this->keyManager->getPublicKey($uid);
+                    }
+
+                    $publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $this->user->getUID());
+
+                    $encryptedKeyfiles = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
+                    $this->keyManager->setAllFileKeys($filePath, $encryptedKeyfiles);
+                }
+            }
+        }
+    }
+
+    /**
+     * remove recovery key to all encrypted files
+     * @param string $path
+     */
+    private function removeRecoveryKeys($path) {
+        $dirContent = $this->view->getDirectoryContent($path);
+        foreach ($dirContent as $item) {
+            $filePath = $item->getPath();
+            if ($item['type'] === 'dir') {
+                $this->removeRecoveryKeys($filePath . '/');
+            } else {
+                $this->keyManager->deleteShareKey($filePath, $this->keyManager->getRecoveryKeyId());
+            }
+        }
+    }
+
+    /**
+     * recover users files with the recovery key
+     *
+     * @param string $recoveryPassword
+     * @param string $user
+     */
+    public function recoverUsersFiles($recoveryPassword, $user) {
+        $encryptedKey = $this->keyManager->getSystemPrivateKey($this->keyManager->getRecoveryKeyId());
+
+        $privateKey = $this->crypt->decryptPrivateKey($encryptedKey, $recoveryPassword);
+        if($privateKey !== false) {
+            $this->recoverAllFiles('/' . $user . '/files/', $privateKey, $user);
+        }
+    }
+
+    /**
+     * recover users files
+     *
+     * @param string $path
+     * @param string $privateKey
+     * @param string $uid
+     */
+    private function recoverAllFiles($path, $privateKey, $uid) {
+        $dirContent = $this->view->getDirectoryContent($path);
+
+        foreach ($dirContent as $item) {
+            // Get relative path from encryption/keyfiles
+            $filePath = $item->getPath();
+            if ($this->view->is_dir($filePath)) {
+                $this->recoverAllFiles($filePath . '/', $privateKey, $uid);
+            } else {
+                $this->recoverFile($filePath, $privateKey, $uid);
+            }
+        }
+
+    }
+
+    /**
+     * recover file
+     *
+     * @param string $path
+     * @param string $privateKey
+     * @param string $uid
+     */
+    private function recoverFile($path, $privateKey, $uid) {
+        $encryptedFileKey = $this->keyManager->getEncryptedFileKey($path);
+        $shareKey = $this->keyManager->getShareKey($path, $this->keyManager->getRecoveryKeyId());
+
+        if ($encryptedFileKey && $shareKey && $privateKey) {
+            $fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey,
+                $shareKey,
+                $privateKey);
+        }
+
+        if (!empty($fileKey)) {
+            $accessList = $this->file->getAccessList($path);
+            $publicKeys = array();
+            foreach ($accessList['users'] as $user) {
+                $publicKeys[$user] = $this->keyManager->getPublicKey($user);
+            }
+
+            $publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $uid);
+
+            $encryptedKeyfiles = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
+            $this->keyManager->setAllFileKeys($path, $encryptedKeyfiles);
+        }
+
+    }
 
 
 }

apps/encryption/lib/Command/MigrateKeys.php

Indentation +76 added lines, -76 removed lines

@@ -36,91 +36,91 @@
 
 class MigrateKeys extends Command {
 
-	/** @var IUserManager */
-	private $userManager;
-	/** @var View */
-	private $view;
-	/** @var IDBConnection */
-	private $connection;
-	/** @var IConfig */
-	private $config;
-	/** @var  ILogger */
-	private $logger;
+    /** @var IUserManager */
+    private $userManager;
+    /** @var View */
+    private $view;
+    /** @var IDBConnection */
+    private $connection;
+    /** @var IConfig */
+    private $config;
+    /** @var  ILogger */
+    private $logger;
 
-	/**
-	 * @param IUserManager $userManager
-	 * @param View $view
-	 * @param IDBConnection $connection
-	 * @param IConfig $config
-	 * @param ILogger $logger
-	 */
-	public function __construct(IUserManager $userManager,
-								View $view,
-								IDBConnection $connection,
-								IConfig $config,
-								ILogger $logger) {
+    /**
+     * @param IUserManager $userManager
+     * @param View $view
+     * @param IDBConnection $connection
+     * @param IConfig $config
+     * @param ILogger $logger
+     */
+    public function __construct(IUserManager $userManager,
+                                View $view,
+                                IDBConnection $connection,
+                                IConfig $config,
+                                ILogger $logger) {
 
-		$this->userManager = $userManager;
-		$this->view = $view;
-		$this->connection = $connection;
-		$this->config = $config;
-		$this->logger = $logger;
-		parent::__construct();
-	}
+        $this->userManager = $userManager;
+        $this->view = $view;
+        $this->connection = $connection;
+        $this->config = $config;
+        $this->logger = $logger;
+        parent::__construct();
+    }
 
-	protected function configure() {
-		$this
-			->setName('encryption:migrate')
-			->setDescription('initial migration to encryption 2.0')
-			->addArgument(
-				'user_id',
-				InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
-				'will migrate keys of the given user(s)'
-			);
-	}
+    protected function configure() {
+        $this
+            ->setName('encryption:migrate')
+            ->setDescription('initial migration to encryption 2.0')
+            ->addArgument(
+                'user_id',
+                InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+                'will migrate keys of the given user(s)'
+            );
+    }
 
-	protected function execute(InputInterface $input, OutputInterface $output) {
+    protected function execute(InputInterface $input, OutputInterface $output) {
 
-		// perform system reorganization
-		$migration = new Migration($this->config, $this->view, $this->connection, $this->logger);
+        // perform system reorganization
+        $migration = new Migration($this->config, $this->view, $this->connection, $this->logger);
 
-		$users = $input->getArgument('user_id');
-		if (!empty($users)) {
-			foreach ($users as $user) {
-				if ($this->userManager->userExists($user)) {
-					$output->writeln("Migrating keys   <info>$user</info>");
-					$migration->reorganizeFolderStructureForUser($user);
-				} else {
-					$output->writeln("<error>Unknown user $user</error>");
-				}
-			}
-		} else {
-			$output->writeln("Reorganize system folder structure");
-			$migration->reorganizeSystemFolderStructure();
-			$migration->updateDB();
-			foreach($this->userManager->getBackends() as $backend) {
-				$name = get_class($backend);
+        $users = $input->getArgument('user_id');
+        if (!empty($users)) {
+            foreach ($users as $user) {
+                if ($this->userManager->userExists($user)) {
+                    $output->writeln("Migrating keys   <info>$user</info>");
+                    $migration->reorganizeFolderStructureForUser($user);
+                } else {
+                    $output->writeln("<error>Unknown user $user</error>");
+                }
+            }
+        } else {
+            $output->writeln("Reorganize system folder structure");
+            $migration->reorganizeSystemFolderStructure();
+            $migration->updateDB();
+            foreach($this->userManager->getBackends() as $backend) {
+                $name = get_class($backend);
 
-				if ($backend instanceof IUserBackend) {
-					$name = $backend->getBackendName();
-				}
+                if ($backend instanceof IUserBackend) {
+                    $name = $backend->getBackendName();
+                }
 
-				$output->writeln("Migrating keys for users on backend <info>$name</info>");
+                $output->writeln("Migrating keys for users on backend <info>$name</info>");
 
-				$limit = 500;
-				$offset = 0;
-				do {
-					$users = $backend->getUsers('', $limit, $offset);
-					foreach ($users as $user) {
-						$output->writeln("   <info>$user</info>");
-						$migration->reorganizeFolderStructureForUser($user);
-					}
-					$offset += $limit;
-				} while(count($users) >= $limit);
-			}
-		}
+                $limit = 500;
+                $offset = 0;
+                do {
+                    $users = $backend->getUsers('', $limit, $offset);
+                    foreach ($users as $user) {
+                        $output->writeln("   <info>$user</info>");
+                        $migration->reorganizeFolderStructureForUser($user);
+                    }
+                    $offset += $limit;
+                } while(count($users) >= $limit);
+            }
+        }
 
-		$migration->finalCleanUp();
+        $migration->finalCleanUp();
 
-	}
+    }
 }

apps/encryption/lib/Command/EnableMasterKey.php

Indentation +49 added lines, -49 removed lines

@@ -34,54 +34,54 @@
 
 class EnableMasterKey extends Command {
 
-	/** @var Util */
-	protected $util;
-
-	/** @var IConfig */
-	protected $config;
-
-	/** @var  QuestionHelper */
-	protected $questionHelper;
-
-	/**
-	 * @param Util $util
-	 * @param IConfig $config
-	 * @param QuestionHelper $questionHelper
-	 */
-	public function __construct(Util $util,
-								IConfig $config,
-								QuestionHelper $questionHelper) {
-
-		$this->util = $util;
-		$this->config = $config;
-		$this->questionHelper = $questionHelper;
-		parent::__construct();
-	}
-
-	protected function configure() {
-		$this
-			->setName('encryption:enable-master-key')
-			->setDescription('Enable the master key. Only available for fresh installations with no existing encrypted data! There is also no way to disable it again.');
-	}
-
-	protected function execute(InputInterface $input, OutputInterface $output) {
-
-		$isAlreadyEnabled = $this->util->isMasterKeyEnabled();
-
-		if($isAlreadyEnabled) {
-			$output->writeln('Master key already enabled');
-		} else {
-			$question = new ConfirmationQuestion(
-				'Warning: Only available for fresh installations with no existing encrypted data! '
-			. 'There is also no way to disable it again. Do you want to continue? (y/n) ', false);
-			if ($this->questionHelper->ask($input, $output, $question)) {
-				$this->config->setAppValue('encryption', 'useMasterKey', '1');
-				$output->writeln('Master key successfully enabled.');
-			} else {
-				$output->writeln('aborted.');
-			}
-		}
-
-	}
+    /** @var Util */
+    protected $util;
+
+    /** @var IConfig */
+    protected $config;
+
+    /** @var  QuestionHelper */
+    protected $questionHelper;
+
+    /**
+     * @param Util $util
+     * @param IConfig $config
+     * @param QuestionHelper $questionHelper
+     */
+    public function __construct(Util $util,
+                                IConfig $config,
+                                QuestionHelper $questionHelper) {
+
+        $this->util = $util;
+        $this->config = $config;
+        $this->questionHelper = $questionHelper;
+        parent::__construct();
+    }
+
+    protected function configure() {
+        $this
+            ->setName('encryption:enable-master-key')
+            ->setDescription('Enable the master key. Only available for fresh installations with no existing encrypted data! There is also no way to disable it again.');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output) {
+
+        $isAlreadyEnabled = $this->util->isMasterKeyEnabled();
+
+        if($isAlreadyEnabled) {
+            $output->writeln('Master key already enabled');
+        } else {
+            $question = new ConfirmationQuestion(
+                'Warning: Only available for fresh installations with no existing encrypted data! '
+            . 'There is also no way to disable it again. Do you want to continue? (y/n) ', false);
+            if ($this->questionHelper->ask($input, $output, $question)) {
+                $this->config->setAppValue('encryption', 'useMasterKey', '1');
+                $output->writeln('Master key successfully enabled.');
+            } else {
+                $output->writeln('aborted.');
+            }
+        }
+
+    }
 
 }

apps/encryption/lib/Hooks/UserHooks.php

Indentation +302 added lines, -302 removed lines

@@ -41,306 +41,306 @@
 
 class UserHooks implements IHook {
 
-	/**
-	 * list of user for which we perform a password reset
-	 * @var array
-	 */
-	protected static $passwordResetUsers = [];
-
-	/**
-	 * @var KeyManager
-	 */
-	private $keyManager;
-	/**
-	 * @var IUserManager
-	 */
-	private $userManager;
-	/**
-	 * @var ILogger
-	 */
-	private $logger;
-	/**
-	 * @var Setup
-	 */
-	private $userSetup;
-	/**
-	 * @var IUserSession
-	 */
-	private $user;
-	/**
-	 * @var Util
-	 */
-	private $util;
-	/**
-	 * @var Session
-	 */
-	private $session;
-	/**
-	 * @var Recovery
-	 */
-	private $recovery;
-	/**
-	 * @var Crypt
-	 */
-	private $crypt;
-
-	/**
-	 * UserHooks constructor.
-	 *
-	 * @param KeyManager $keyManager
-	 * @param IUserManager $userManager
-	 * @param ILogger $logger
-	 * @param Setup $userSetup
-	 * @param IUserSession $user
-	 * @param Util $util
-	 * @param Session $session
-	 * @param Crypt $crypt
-	 * @param Recovery $recovery
-	 */
-	public function __construct(KeyManager $keyManager,
-								IUserManager $userManager,
-								ILogger $logger,
-								Setup $userSetup,
-								IUserSession $user,
-								Util $util,
-								Session $session,
-								Crypt $crypt,
-								Recovery $recovery) {
-
-		$this->keyManager = $keyManager;
-		$this->userManager = $userManager;
-		$this->logger = $logger;
-		$this->userSetup = $userSetup;
-		$this->user = $user;
-		$this->util = $util;
-		$this->session = $session;
-		$this->recovery = $recovery;
-		$this->crypt = $crypt;
-	}
-
-	/**
-	 * Connects Hooks
-	 *
-	 * @return null
-	 */
-	public function addHooks() {
-		OCUtil::connectHook('OC_User', 'post_login', $this, 'login');
-		OCUtil::connectHook('OC_User', 'logout', $this, 'logout');
-
-		// this hooks only make sense if no master key is used
-		if ($this->util->isMasterKeyEnabled() === false) {
-			OCUtil::connectHook('OC_User',
-				'post_setPassword',
-				$this,
-				'setPassphrase');
-
-			OCUtil::connectHook('OC_User',
-				'pre_setPassword',
-				$this,
-				'preSetPassphrase');
-
-			OCUtil::connectHook('\OC\Core\LostPassword\Controller\LostController',
-				'post_passwordReset',
-				$this,
-				'postPasswordReset');
-
-			OCUtil::connectHook('\OC\Core\LostPassword\Controller\LostController',
-				'pre_passwordReset',
-				$this,
-				'prePasswordReset');
-
-			OCUtil::connectHook('OC_User',
-				'post_createUser',
-				$this,
-				'postCreateUser');
-
-			OCUtil::connectHook('OC_User',
-				'post_deleteUser',
-				$this,
-				'postDeleteUser');
-		}
-	}
-
-
-	/**
-	 * Startup encryption backend upon user login
-	 *
-	 * @note This method should never be called for users using client side encryption
-	 * @param array $params
-	 * @return boolean|null
-	 */
-	public function login($params) {
-
-		if (!App::isEnabled('encryption')) {
-			return true;
-		}
-
-		// ensure filesystem is loaded
-		if (!\OC\Files\Filesystem::$loaded) {
-			$this->setupFS($params['uid']);
-		}
-		if ($this->util->isMasterKeyEnabled() === false) {
-			$this->userSetup->setupUser($params['uid'], $params['password']);
-		}
-
-		$this->keyManager->init($params['uid'], $params['password']);
-	}
-
-	/**
-	 * remove keys from session during logout
-	 */
-	public function logout() {
-		$this->session->clear();
-	}
-
-	/**
-	 * setup encryption backend upon user created
-	 *
-	 * @note This method should never be called for users using client side encryption
-	 * @param array $params
-	 */
-	public function postCreateUser($params) {
-
-		if (App::isEnabled('encryption')) {
-			$this->userSetup->setupUser($params['uid'], $params['password']);
-		}
-	}
-
-	/**
-	 * cleanup encryption backend upon user deleted
-	 *
-	 * @param array $params : uid, password
-	 * @note This method should never be called for users using client side encryption
-	 */
-	public function postDeleteUser($params) {
-
-		if (App::isEnabled('encryption')) {
-			$this->keyManager->deletePublicKey($params['uid']);
-		}
-	}
-
-	public function prePasswordReset($params) {
-		if (App::isEnabled('encryption')) {
-			$user = $params['uid'];
-			self::$passwordResetUsers[$user] = true;
-		}
-	}
-
-	public function postPasswordReset($params) {
-		$uid = $params['uid'];
-		$password = $params['password'];
-		$this->keyManager->backupUserKeys('passwordReset', $uid);
-		$this->keyManager->deleteUserKeys($uid);
-		$this->userSetup->setupUser($uid, $password);
-		unset(self::$passwordResetUsers[$uid]);
-	}
-
-	/**
-	 * If the password can't be changed within ownCloud, than update the key password in advance.
-	 *
-	 * @param array $params : uid, password
-	 * @return boolean|null
-	 */
-	public function preSetPassphrase($params) {
-		$user = $this->userManager->get($params['uid']);
-
-		if ($user && !$user->canChangePassword()) {
-			$this->setPassphrase($params);
-		}
-	}
-
-	/**
-	 * Change a user's encryption passphrase
-	 *
-	 * @param array $params keys: uid, password
-	 * @return boolean|null
-	 */
-	public function setPassphrase($params) {
-
-		// if we are in the process to resetting a user password, we have nothing
-		// to do here
-		if (isset(self::$passwordResetUsers[$params['uid']])) {
-			return true;
-		}
-
-		// Get existing decrypted private key
-		$privateKey = $this->session->getPrivateKey();
-		$user = $this->user->getUser();
-
-		// current logged in user changes his own password
-		if ($user && $params['uid'] === $user->getUID() && $privateKey) {
-
-			// Encrypt private key with new user pwd as passphrase
-			$encryptedPrivateKey = $this->crypt->encryptPrivateKey($privateKey, $params['password'], $params['uid']);
-
-			// Save private key
-			if ($encryptedPrivateKey) {
-				$this->keyManager->setPrivateKey($this->user->getUser()->getUID(),
-					$this->crypt->generateHeader() . $encryptedPrivateKey);
-			} else {
-				$this->logger->error('Encryption could not update users encryption password');
-			}
-
-			// NOTE: Session does not need to be updated as the
-			// private key has not changed, only the passphrase
-			// used to decrypt it has changed
-		} else { // admin changed the password for a different user, create new keys and re-encrypt file keys
-			$user = $params['uid'];
-			$this->initMountPoints($user);
-			$recoveryPassword = isset($params['recoveryPassword']) ? $params['recoveryPassword'] : null;
-
-			// we generate new keys if...
-			// ...we have a recovery password and the user enabled the recovery key
-			// ...encryption was activated for the first time (no keys exists)
-			// ...the user doesn't have any files
-			if (
-				($this->recovery->isRecoveryEnabledForUser($user) && $recoveryPassword)
-				|| !$this->keyManager->userHasKeys($user)
-				|| !$this->util->userHasFiles($user)
-			) {
-
-				// backup old keys
-				//$this->backupAllKeys('recovery');
-
-				$newUserPassword = $params['password'];
-
-				$keyPair = $this->crypt->createKeyPair();
-
-				// Save public key
-				$this->keyManager->setPublicKey($user, $keyPair['publicKey']);
-
-				// Encrypt private key with new password
-				$encryptedKey = $this->crypt->encryptPrivateKey($keyPair['privateKey'], $newUserPassword, $user);
-
-				if ($encryptedKey) {
-					$this->keyManager->setPrivateKey($user, $this->crypt->generateHeader() . $encryptedKey);
-
-					if ($recoveryPassword) { // if recovery key is set we can re-encrypt the key files
-						$this->recovery->recoverUsersFiles($recoveryPassword, $user);
-					}
-				} else {
-					$this->logger->error('Encryption Could not update users encryption password');
-				}
-			}
-		}
-	}
-
-	/**
-	 * init mount points for given user
-	 *
-	 * @param string $user
-	 * @throws \OC\User\NoUserException
-	 */
-	protected function initMountPoints($user) {
-		Filesystem::initMountPoints($user);
-	}
-
-	/**
-	 * setup file system for user
-	 *
-	 * @param string $uid user id
-	 */
-	protected function setupFS($uid) {
-		\OC_Util::setupFS($uid);
-	}
+    /**
+     * list of user for which we perform a password reset
+     * @var array
+     */
+    protected static $passwordResetUsers = [];
+
+    /**
+     * @var KeyManager
+     */
+    private $keyManager;
+    /**
+     * @var IUserManager
+     */
+    private $userManager;
+    /**
+     * @var ILogger
+     */
+    private $logger;
+    /**
+     * @var Setup
+     */
+    private $userSetup;
+    /**
+     * @var IUserSession
+     */
+    private $user;
+    /**
+     * @var Util
+     */
+    private $util;
+    /**
+     * @var Session
+     */
+    private $session;
+    /**
+     * @var Recovery
+     */
+    private $recovery;
+    /**
+     * @var Crypt
+     */
+    private $crypt;
+
+    /**
+     * UserHooks constructor.
+     *
+     * @param KeyManager $keyManager
+     * @param IUserManager $userManager
+     * @param ILogger $logger
+     * @param Setup $userSetup
+     * @param IUserSession $user
+     * @param Util $util
+     * @param Session $session
+     * @param Crypt $crypt
+     * @param Recovery $recovery
+     */
+    public function __construct(KeyManager $keyManager,
+                                IUserManager $userManager,
+                                ILogger $logger,
+                                Setup $userSetup,
+                                IUserSession $user,
+                                Util $util,
+                                Session $session,
+                                Crypt $crypt,
+                                Recovery $recovery) {
+
+        $this->keyManager = $keyManager;
+        $this->userManager = $userManager;
+        $this->logger = $logger;
+        $this->userSetup = $userSetup;
+        $this->user = $user;
+        $this->util = $util;
+        $this->session = $session;
+        $this->recovery = $recovery;
+        $this->crypt = $crypt;
+    }
+
+    /**
+     * Connects Hooks
+     *
+     * @return null
+     */
+    public function addHooks() {
+        OCUtil::connectHook('OC_User', 'post_login', $this, 'login');
+        OCUtil::connectHook('OC_User', 'logout', $this, 'logout');
+
+        // this hooks only make sense if no master key is used
+        if ($this->util->isMasterKeyEnabled() === false) {
+            OCUtil::connectHook('OC_User',
+                'post_setPassword',
+                $this,
+                'setPassphrase');
+
+            OCUtil::connectHook('OC_User',
+                'pre_setPassword',
+                $this,
+                'preSetPassphrase');
+
+            OCUtil::connectHook('\OC\Core\LostPassword\Controller\LostController',
+                'post_passwordReset',
+                $this,
+                'postPasswordReset');
+
+            OCUtil::connectHook('\OC\Core\LostPassword\Controller\LostController',
+                'pre_passwordReset',
+                $this,
+                'prePasswordReset');
+
+            OCUtil::connectHook('OC_User',
+                'post_createUser',
+                $this,
+                'postCreateUser');
+
+            OCUtil::connectHook('OC_User',
+                'post_deleteUser',
+                $this,
+                'postDeleteUser');
+        }
+    }
+
+
+    /**
+     * Startup encryption backend upon user login
+     *
+     * @note This method should never be called for users using client side encryption
+     * @param array $params
+     * @return boolean|null
+     */
+    public function login($params) {
+
+        if (!App::isEnabled('encryption')) {
+            return true;
+        }
+
+        // ensure filesystem is loaded
+        if (!\OC\Files\Filesystem::$loaded) {
+            $this->setupFS($params['uid']);
+        }
+        if ($this->util->isMasterKeyEnabled() === false) {
+            $this->userSetup->setupUser($params['uid'], $params['password']);
+        }
+
+        $this->keyManager->init($params['uid'], $params['password']);
+    }
+
+    /**
+     * remove keys from session during logout
+     */
+    public function logout() {
+        $this->session->clear();
+    }
+
+    /**
+     * setup encryption backend upon user created
+     *
+     * @note This method should never be called for users using client side encryption
+     * @param array $params
+     */
+    public function postCreateUser($params) {
+
+        if (App::isEnabled('encryption')) {
+            $this->userSetup->setupUser($params['uid'], $params['password']);
+        }
+    }
+
+    /**
+     * cleanup encryption backend upon user deleted
+     *
+     * @param array $params : uid, password
+     * @note This method should never be called for users using client side encryption
+     */
+    public function postDeleteUser($params) {
+
+        if (App::isEnabled('encryption')) {
+            $this->keyManager->deletePublicKey($params['uid']);
+        }
+    }
+
+    public function prePasswordReset($params) {
+        if (App::isEnabled('encryption')) {
+            $user = $params['uid'];
+            self::$passwordResetUsers[$user] = true;
+        }
+    }
+
+    public function postPasswordReset($params) {
+        $uid = $params['uid'];
+        $password = $params['password'];
+        $this->keyManager->backupUserKeys('passwordReset', $uid);
+        $this->keyManager->deleteUserKeys($uid);
+        $this->userSetup->setupUser($uid, $password);
+        unset(self::$passwordResetUsers[$uid]);
+    }
+
+    /**
+     * If the password can't be changed within ownCloud, than update the key password in advance.
+     *
+     * @param array $params : uid, password
+     * @return boolean|null
+     */
+    public function preSetPassphrase($params) {
+        $user = $this->userManager->get($params['uid']);
+
+        if ($user && !$user->canChangePassword()) {
+            $this->setPassphrase($params);
+        }
+    }
+
+    /**
+     * Change a user's encryption passphrase
+     *
+     * @param array $params keys: uid, password
+     * @return boolean|null
+     */
+    public function setPassphrase($params) {
+
+        // if we are in the process to resetting a user password, we have nothing
+        // to do here
+        if (isset(self::$passwordResetUsers[$params['uid']])) {
+            return true;
+        }
+
+        // Get existing decrypted private key
+        $privateKey = $this->session->getPrivateKey();
+        $user = $this->user->getUser();
+
+        // current logged in user changes his own password
+        if ($user && $params['uid'] === $user->getUID() && $privateKey) {
+
+            // Encrypt private key with new user pwd as passphrase
+            $encryptedPrivateKey = $this->crypt->encryptPrivateKey($privateKey, $params['password'], $params['uid']);
+
+            // Save private key
+            if ($encryptedPrivateKey) {
+                $this->keyManager->setPrivateKey($this->user->getUser()->getUID(),
+                    $this->crypt->generateHeader() . $encryptedPrivateKey);
+            } else {
+                $this->logger->error('Encryption could not update users encryption password');
+            }
+
+            // NOTE: Session does not need to be updated as the
+            // private key has not changed, only the passphrase
+            // used to decrypt it has changed
+        } else { // admin changed the password for a different user, create new keys and re-encrypt file keys
+            $user = $params['uid'];
+            $this->initMountPoints($user);
+            $recoveryPassword = isset($params['recoveryPassword']) ? $params['recoveryPassword'] : null;
+
+            // we generate new keys if...
+            // ...we have a recovery password and the user enabled the recovery key
+            // ...encryption was activated for the first time (no keys exists)
+            // ...the user doesn't have any files
+            if (
+                ($this->recovery->isRecoveryEnabledForUser($user) && $recoveryPassword)
+                || !$this->keyManager->userHasKeys($user)
+                || !$this->util->userHasFiles($user)
+            ) {
+
+                // backup old keys
+                //$this->backupAllKeys('recovery');
+
+                $newUserPassword = $params['password'];
+
+                $keyPair = $this->crypt->createKeyPair();
+
+                // Save public key
+                $this->keyManager->setPublicKey($user, $keyPair['publicKey']);
+
+                // Encrypt private key with new password
+                $encryptedKey = $this->crypt->encryptPrivateKey($keyPair['privateKey'], $newUserPassword, $user);
+
+                if ($encryptedKey) {
+                    $this->keyManager->setPrivateKey($user, $this->crypt->generateHeader() . $encryptedKey);
+
+                    if ($recoveryPassword) { // if recovery key is set we can re-encrypt the key files
+                        $this->recovery->recoverUsersFiles($recoveryPassword, $user);
+                    }
+                } else {
+                    $this->logger->error('Encryption Could not update users encryption password');
+                }
+            }
+        }
+    }
+
+    /**
+     * init mount points for given user
+     *
+     * @param string $user
+     * @throws \OC\User\NoUserException
+     */
+    protected function initMountPoints($user) {
+        Filesystem::initMountPoints($user);
+    }
+
+    /**
+     * setup file system for user
+     *
+     * @param string $uid user id
+     */
+    protected function setupFS($uid) {
+        \OC_Util::setupFS($uid);
+    }
 }

apps/encryption/lib/Hooks/Contracts/IHook.php

Indentation +6 added lines, -6 removed lines

@@ -24,10 +24,10 @@
 
 
 interface IHook {
-	/**
-	 * Connects Hooks
-	 *
-	 * @return null
-	 */
-	public function addHooks();
+    /**
+     * Connects Hooks
+     *
+     * @return null
+     */
+    public function addHooks();
 }

apps/encryption/lib/Settings/Admin.php

Indentation +85 added lines, -85 removed lines

@@ -38,90 +38,90 @@
 
 class Admin implements ISettings {
 
-	/** @var IL10N */
-	private $l;
-
-	/** @var ILogger */
-	private $logger;
-
-	/** @var IUserSession */
-	private $userSession;
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var ISession */
-	private $session;
-
-	public function __construct(
-		IL10N $l,
-		ILogger $logger,
-		IUserSession $userSession,
-		IConfig $config,
-		IUserManager $userManager,
-		ISession $session
-	) {
-		$this->l = $l;
-		$this->logger = $logger;
-		$this->userSession = $userSession;
-		$this->config = $config;
-		$this->userManager = $userManager;
-		$this->session = $session;
-	}
-
-	/**
-	 * @return TemplateResponse
-	 */
-	public function getForm() {
-		$crypt = new Crypt(
-			$this->logger,
-			$this->userSession,
-			$this->config,
-			$this->l);
-
-		$util = new Util(
-			new View(),
-			$crypt,
-			$this->logger,
-			$this->userSession,
-			$this->config,
-			$this->userManager);
-
-		// Check if an adminRecovery account is enabled for recovering files after lost pwd
-		$recoveryAdminEnabled = $this->config->getAppValue('encryption', 'recoveryAdminEnabled', '0');
-		$session = new Session($this->session);
-
-		$encryptHomeStorage = $util->shouldEncryptHomeStorage();
-
-		$parameters = [
-			'recoveryEnabled'    => $recoveryAdminEnabled,
-			'initStatus'         => $session->getStatus(),
-			'encryptHomeStorage' => $encryptHomeStorage,
-			'masterKeyEnabled'   => $util->isMasterKeyEnabled(),
-		];
-
-		return new TemplateResponse('encryption', 'settings-admin', $parameters, '');
-	}
-
-	/**
-	 * @return string the section ID, e.g. 'sharing'
-	 */
-	public function getSection() {
-		return 'encryption';
-	}
-
-	/**
-	 * @return int whether the form should be rather on the top or bottom of
-	 * the admin section. The forms are arranged in ascending order of the
-	 * priority values. It is required to return a value between 0 and 100.
-	 *
-	 * E.g.: 70
-	 */
-	public function getPriority() {
-		return 5;
-	}
+    /** @var IL10N */
+    private $l;
+
+    /** @var ILogger */
+    private $logger;
+
+    /** @var IUserSession */
+    private $userSession;
+
+    /** @var IConfig */
+    private $config;
+
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var ISession */
+    private $session;
+
+    public function __construct(
+        IL10N $l,
+        ILogger $logger,
+        IUserSession $userSession,
+        IConfig $config,
+        IUserManager $userManager,
+        ISession $session
+    ) {
+        $this->l = $l;
+        $this->logger = $logger;
+        $this->userSession = $userSession;
+        $this->config = $config;
+        $this->userManager = $userManager;
+        $this->session = $session;
+    }
+
+    /**
+     * @return TemplateResponse
+     */
+    public function getForm() {
+        $crypt = new Crypt(
+            $this->logger,
+            $this->userSession,
+            $this->config,
+            $this->l);
+
+        $util = new Util(
+            new View(),
+            $crypt,
+            $this->logger,
+            $this->userSession,
+            $this->config,
+            $this->userManager);
+
+        // Check if an adminRecovery account is enabled for recovering files after lost pwd
+        $recoveryAdminEnabled = $this->config->getAppValue('encryption', 'recoveryAdminEnabled', '0');
+        $session = new Session($this->session);
+
+        $encryptHomeStorage = $util->shouldEncryptHomeStorage();
+
+        $parameters = [
+            'recoveryEnabled'    => $recoveryAdminEnabled,
+            'initStatus'         => $session->getStatus(),
+            'encryptHomeStorage' => $encryptHomeStorage,
+            'masterKeyEnabled'   => $util->isMasterKeyEnabled(),
+        ];
+
+        return new TemplateResponse('encryption', 'settings-admin', $parameters, '');
+    }
+
+    /**
+     * @return string the section ID, e.g. 'sharing'
+     */
+    public function getSection() {
+        return 'encryption';
+    }
+
+    /**
+     * @return int whether the form should be rather on the top or bottom of
+     * the admin section. The forms are arranged in ascending order of the
+     * priority values. It is required to return a value between 0 and 100.
+     *
+     * E.g.: 70
+     */
+    public function getPriority() {
+        return 5;
+    }
 
 }

apps/encryption/lib/Session.php

Indentation +154 added lines, -154 removed lines

@@ -29,159 +29,159 @@
 
 class Session {
 
-	/** @var ISession */
-	protected $session;
-
-	const NOT_INITIALIZED = '0';
-	const INIT_EXECUTED = '1';
-	const INIT_SUCCESSFUL = '2';
-	const RUN_MIGRATION = '3';
-
-	/**
-	 * @param ISession $session
-	 */
-	public function __construct(ISession $session) {
-		$this->session = $session;
-	}
-
-	/**
-	 * Sets status of encryption app
-	 *
-	 * @param string $status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED
-	 */
-	public function setStatus($status) {
-		$this->session->set('encryptionInitialized', $status);
-	}
-
-	/**
-	 * Gets status if we already tried to initialize the encryption app
-	 *
-	 * @return string init status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED
-	 */
-	public function getStatus() {
-		$status = $this->session->get('encryptionInitialized');
-		if (is_null($status)) {
-			$status = self::NOT_INITIALIZED;
-		}
-
-		return $status;
-	}
-
-	/**
-	 * check if encryption was initialized successfully
-	 *
-	 * @return bool
-	 */
-	public function isReady() {
-		$status = $this->getStatus();
-		return $status === self::INIT_SUCCESSFUL;
-	}
-
-	/**
-	 * Gets user or public share private key from session
-	 *
-	 * @return string $privateKey The user's plaintext private key
-	 * @throws Exceptions\PrivateKeyMissingException
-	 */
-	public function getPrivateKey() {
-		$key = $this->session->get('privateKey');
-		if (is_null($key)) {
-			throw new Exceptions\PrivateKeyMissingException('please try to log-out and log-in again', 0);
-		}
-		return $key;
-	}
-
-	/**
-	 * check if private key is set
-	 *
-	 * @return boolean
-	 */
-	public function isPrivateKeySet() {
-		$key = $this->session->get('privateKey');
-		if (is_null($key)) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Sets user private key to session
-	 *
-	 * @param string $key users private key
-	 *
-	 * @note this should only be set on login
-	 */
-	public function setPrivateKey($key) {
-		$this->session->set('privateKey', $key);
-	}
-
-	/**
-	 * store data needed for the decrypt all operation in the session
-	 *
-	 * @param string $user
-	 * @param string $key
-	 */
-	public function prepareDecryptAll($user, $key) {
-		$this->session->set('decryptAll', true);
-		$this->session->set('decryptAllKey', $key);
-		$this->session->set('decryptAllUid', $user);
-	}
-
-	/**
-	 * check if we are in decrypt all mode
-	 *
-	 * @return bool
-	 */
-	public function decryptAllModeActivated() {
-		$decryptAll = $this->session->get('decryptAll');
-		return ($decryptAll === true);
-	}
-
-	/**
-	 * get uid used for decrypt all operation
-	 *
-	 * @return string
-	 * @throws \Exception
-	 */
-	public function getDecryptAllUid() {
-		$uid = $this->session->get('decryptAllUid');
-		if (is_null($uid) && $this->decryptAllModeActivated()) {
-			throw new \Exception('No uid found while in decrypt all mode');
-		} elseif (is_null($uid)) {
-			throw new \Exception('Please activate decrypt all mode first');
-		}
-
-		return $uid;
-	}
-
-	/**
-	 * get private key for decrypt all operation
-	 *
-	 * @return string
-	 * @throws PrivateKeyMissingException
-	 */
-	public function getDecryptAllKey() {
-		$privateKey = $this->session->get('decryptAllKey');
-		if (is_null($privateKey) && $this->decryptAllModeActivated()) {
-			throw new PrivateKeyMissingException('No private key found while in decrypt all mode');
-		} elseif (is_null($privateKey)) {
-			throw new PrivateKeyMissingException('Please activate decrypt all mode first');
-		}
-
-		return $privateKey;
-	}
-
-	/**
-	 * remove keys from session
-	 */
-	public function clear() {
-		$this->session->remove('publicSharePrivateKey');
-		$this->session->remove('privateKey');
-		$this->session->remove('encryptionInitialized');
-		$this->session->remove('decryptAll');
-		$this->session->remove('decryptAllKey');
-		$this->session->remove('decryptAllUid');
-	}
+    /** @var ISession */
+    protected $session;
+
+    const NOT_INITIALIZED = '0';
+    const INIT_EXECUTED = '1';
+    const INIT_SUCCESSFUL = '2';
+    const RUN_MIGRATION = '3';
+
+    /**
+     * @param ISession $session
+     */
+    public function __construct(ISession $session) {
+        $this->session = $session;
+    }
+
+    /**
+     * Sets status of encryption app
+     *
+     * @param string $status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED
+     */
+    public function setStatus($status) {
+        $this->session->set('encryptionInitialized', $status);
+    }
+
+    /**
+     * Gets status if we already tried to initialize the encryption app
+     *
+     * @return string init status INIT_SUCCESSFUL, INIT_EXECUTED, NOT_INITIALIZED
+     */
+    public function getStatus() {
+        $status = $this->session->get('encryptionInitialized');
+        if (is_null($status)) {
+            $status = self::NOT_INITIALIZED;
+        }
+
+        return $status;
+    }
+
+    /**
+     * check if encryption was initialized successfully
+     *
+     * @return bool
+     */
+    public function isReady() {
+        $status = $this->getStatus();
+        return $status === self::INIT_SUCCESSFUL;
+    }
+
+    /**
+     * Gets user or public share private key from session
+     *
+     * @return string $privateKey The user's plaintext private key
+     * @throws Exceptions\PrivateKeyMissingException
+     */
+    public function getPrivateKey() {
+        $key = $this->session->get('privateKey');
+        if (is_null($key)) {
+            throw new Exceptions\PrivateKeyMissingException('please try to log-out and log-in again', 0);
+        }
+        return $key;
+    }
+
+    /**
+     * check if private key is set
+     *
+     * @return boolean
+     */
+    public function isPrivateKeySet() {
+        $key = $this->session->get('privateKey');
+        if (is_null($key)) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Sets user private key to session
+     *
+     * @param string $key users private key
+     *
+     * @note this should only be set on login
+     */
+    public function setPrivateKey($key) {
+        $this->session->set('privateKey', $key);
+    }
+
+    /**
+     * store data needed for the decrypt all operation in the session
+     *
+     * @param string $user
+     * @param string $key
+     */
+    public function prepareDecryptAll($user, $key) {
+        $this->session->set('decryptAll', true);
+        $this->session->set('decryptAllKey', $key);
+        $this->session->set('decryptAllUid', $user);
+    }
+
+    /**
+     * check if we are in decrypt all mode
+     *
+     * @return bool
+     */
+    public function decryptAllModeActivated() {
+        $decryptAll = $this->session->get('decryptAll');
+        return ($decryptAll === true);
+    }
+
+    /**
+     * get uid used for decrypt all operation
+     *
+     * @return string
+     * @throws \Exception
+     */
+    public function getDecryptAllUid() {
+        $uid = $this->session->get('decryptAllUid');
+        if (is_null($uid) && $this->decryptAllModeActivated()) {
+            throw new \Exception('No uid found while in decrypt all mode');
+        } elseif (is_null($uid)) {
+            throw new \Exception('Please activate decrypt all mode first');
+        }
+
+        return $uid;
+    }
+
+    /**
+     * get private key for decrypt all operation
+     *
+     * @return string
+     * @throws PrivateKeyMissingException
+     */
+    public function getDecryptAllKey() {
+        $privateKey = $this->session->get('decryptAllKey');
+        if (is_null($privateKey) && $this->decryptAllModeActivated()) {
+            throw new PrivateKeyMissingException('No private key found while in decrypt all mode');
+        } elseif (is_null($privateKey)) {
+            throw new PrivateKeyMissingException('Please activate decrypt all mode first');
+        }
+
+        return $privateKey;
+    }
+
+    /**
+     * remove keys from session
+     */
+    public function clear() {
+        $this->session->remove('publicSharePrivateKey');
+        $this->session->remove('privateKey');
+        $this->session->remove('encryptionInitialized');
+        $this->session->remove('decryptAll');
+        $this->session->remove('decryptAllKey');
+        $this->session->remove('decryptAllUid');
+    }
 
 }

apps/encryption/lib/Crypto/Encryption.php

Indentation +526 added lines, -526 removed lines

@@ -43,530 +43,530 @@
 
 class Encryption implements IEncryptionModule {
 
-	const ID = 'OC_DEFAULT_MODULE';
-	const DISPLAY_NAME = 'Default encryption module';
-
-	/**
-	 * @var Crypt
-	 */
-	private $crypt;
-
-	/** @var string */
-	private $cipher;
-
-	/** @var string */
-	private $path;
-
-	/** @var string */
-	private $user;
-
-	/** @var string */
-	private $fileKey;
-
-	/** @var string */
-	private $writeCache;
-
-	/** @var KeyManager */
-	private $keyManager;
-
-	/** @var array */
-	private $accessList;
-
-	/** @var boolean */
-	private $isWriteOperation;
-
-	/** @var Util */
-	private $util;
-
-	/** @var  Session */
-	private $session;
-
-	/** @var  ILogger */
-	private $logger;
-
-	/** @var IL10N */
-	private $l;
-
-	/** @var EncryptAll */
-	private $encryptAll;
-
-	/** @var  bool */
-	private $useMasterPassword;
-
-	/** @var DecryptAll  */
-	private $decryptAll;
-
-	/** @var int unencrypted block size if block contains signature */
-	private $unencryptedBlockSizeSigned = 6072;
-
-	/** @var int unencrypted block size */
-	private $unencryptedBlockSize = 6126;
-
-	/** @var int Current version of the file */
-	private $version = 0;
-
-	/** @var array remember encryption signature version */
-	private static $rememberVersion = [];
-
-
-	/**
-	 *
-	 * @param Crypt $crypt
-	 * @param KeyManager $keyManager
-	 * @param Util $util
-	 * @param Session $session
-	 * @param EncryptAll $encryptAll
-	 * @param DecryptAll $decryptAll
-	 * @param ILogger $logger
-	 * @param IL10N $il10n
-	 */
-	public function __construct(Crypt $crypt,
-								KeyManager $keyManager,
-								Util $util,
-								Session $session,
-								EncryptAll $encryptAll,
-								DecryptAll $decryptAll,
-								ILogger $logger,
-								IL10N $il10n) {
-		$this->crypt = $crypt;
-		$this->keyManager = $keyManager;
-		$this->util = $util;
-		$this->session = $session;
-		$this->encryptAll = $encryptAll;
-		$this->decryptAll = $decryptAll;
-		$this->logger = $logger;
-		$this->l = $il10n;
-		$this->useMasterPassword = $util->isMasterKeyEnabled();
-	}
-
-	/**
-	 * @return string defining the technical unique id
-	 */
-	public function getId() {
-		return self::ID;
-	}
-
-	/**
-	 * In comparison to getKey() this function returns a human readable (maybe translated) name
-	 *
-	 * @return string
-	 */
-	public function getDisplayName() {
-		return self::DISPLAY_NAME;
-	}
-
-	/**
-	 * start receiving chunks from a file. This is the place where you can
-	 * perform some initial step before starting encrypting/decrypting the
-	 * chunks
-	 *
-	 * @param string $path to the file
-	 * @param string $user who read/write the file
-	 * @param string $mode php stream open mode
-	 * @param array $header contains the header data read from the file
-	 * @param array $accessList who has access to the file contains the key 'users' and 'public'
-	 *
-	 * @return array $header contain data as key-value pairs which should be
-	 *                       written to the header, in case of a write operation
-	 *                       or if no additional data is needed return a empty array
-	 */
-	public function begin($path, $user, $mode, array $header, array $accessList) {
-		$this->path = $this->getPathToRealFile($path);
-		$this->accessList = $accessList;
-		$this->user = $user;
-		$this->isWriteOperation = false;
-		$this->writeCache = '';
-
-		if($this->session->isReady() === false) {
-			// if the master key is enabled we can initialize encryption
-			// with a empty password and user name
-			if ($this->util->isMasterKeyEnabled()) {
-				$this->keyManager->init('', '');
-			}
-		}
-
-		if ($this->session->decryptAllModeActivated()) {
-			$encryptedFileKey = $this->keyManager->getEncryptedFileKey($this->path);
-			$shareKey = $this->keyManager->getShareKey($this->path, $this->session->getDecryptAllUid());
-			$this->fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey,
-				$shareKey,
-				$this->session->getDecryptAllKey());
-		} else {
-			$this->fileKey = $this->keyManager->getFileKey($this->path, $this->user);
-		}
-
-		// always use the version from the original file, also part files
-		// need to have a correct version number if they get moved over to the
-		// final location
-		$this->version = (int)$this->keyManager->getVersion($this->stripPartFileExtension($path), new View());
-
-		if (
-			$mode === 'w'
-			|| $mode === 'w+'
-			|| $mode === 'wb'
-			|| $mode === 'wb+'
-		) {
-			$this->isWriteOperation = true;
-			if (empty($this->fileKey)) {
-				$this->fileKey = $this->crypt->generateFileKey();
-			}
-		} else {
-			// if we read a part file we need to increase the version by 1
-			// because the version number was also increased by writing
-			// the part file
-			if(Scanner::isPartialFile($path)) {
-				$this->version = $this->version + 1;
-			}
-		}
-
-		if ($this->isWriteOperation) {
-			$this->cipher = $this->crypt->getCipher();
-		} elseif (isset($header['cipher'])) {
-			$this->cipher = $header['cipher'];
-		} else {
-			// if we read a file without a header we fall-back to the legacy cipher
-			// which was used in <=oC6
-			$this->cipher = $this->crypt->getLegacyCipher();
-		}
-
-		return array('cipher' => $this->cipher, 'signed' => 'true');
-	}
-
-	/**
-	 * last chunk received. This is the place where you can perform some final
-	 * operation and return some remaining data if something is left in your
-	 * buffer.
-	 *
-	 * @param string $path to the file
-	 * @param int $position
-	 * @return string remained data which should be written to the file in case
-	 *                of a write operation
-	 * @throws PublicKeyMissingException
-	 * @throws \Exception
-	 * @throws \OCA\Encryption\Exceptions\MultiKeyEncryptException
-	 */
-	public function end($path, $position = 0) {
-		$result = '';
-		if ($this->isWriteOperation) {
-			$this->keyManager->setVersion($path, $this->version + 1, new View());
-			// in case of a part file we remember the new signature versions
-			// the version will be set later on update.
-			// This way we make sure that other apps listening to the pre-hooks
-			// still get the old version which should be the correct value for them
-			if (Scanner::isPartialFile($path)) {
-				self::$rememberVersion[$this->stripPartFileExtension($path)] = $this->version + 1;
-			}
-			if (!empty($this->writeCache)) {
-				$result = $this->crypt->symmetricEncryptFileContent($this->writeCache, $this->fileKey, $this->version + 1, $position);
-				$this->writeCache = '';
-			}
-			$publicKeys = array();
-			if ($this->useMasterPassword === true) {
-				$publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
-			} else {
-				foreach ($this->accessList['users'] as $uid) {
-					try {
-						$publicKeys[$uid] = $this->keyManager->getPublicKey($uid);
-					} catch (PublicKeyMissingException $e) {
-						$this->logger->warning(
-							'no public key found for user "{uid}", user will not be able to read the file',
-							['app' => 'encryption', 'uid' => $uid]
-						);
-						// if the public key of the owner is missing we should fail
-						if ($uid === $this->user) {
-							throw $e;
-						}
-					}
-				}
-			}
-
-			$publicKeys = $this->keyManager->addSystemKeys($this->accessList, $publicKeys, $this->user);
-			$encryptedKeyfiles = $this->crypt->multiKeyEncrypt($this->fileKey, $publicKeys);
-			$this->keyManager->setAllFileKeys($this->path, $encryptedKeyfiles);
-		}
-		return $result;
-	}
-
-	/**
-	 * encrypt data
-	 *
-	 * @param string $data you want to encrypt
-	 * @param int $position
-	 * @return string encrypted data
-	 */
-	public function encrypt($data, $position = 0) {
-		// If extra data is left over from the last round, make sure it
-		// is integrated into the next block
-		if ($this->writeCache) {
-
-			// Concat writeCache to start of $data
-			$data = $this->writeCache . $data;
-
-			// Clear the write cache, ready for reuse - it has been
-			// flushed and its old contents processed
-			$this->writeCache = '';
-
-		}
-
-		$encrypted = '';
-		// While there still remains some data to be processed & written
-		while (strlen($data) > 0) {
-
-			// Remaining length for this iteration, not of the
-			// entire file (may be greater than 8192 bytes)
-			$remainingLength = strlen($data);
-
-			// If data remaining to be written is less than the
-			// size of 1 6126 byte block
-			if ($remainingLength < $this->unencryptedBlockSizeSigned) {
-
-				// Set writeCache to contents of $data
-				// The writeCache will be carried over to the
-				// next write round, and added to the start of
-				// $data to ensure that written blocks are
-				// always the correct length. If there is still
-				// data in writeCache after the writing round
-				// has finished, then the data will be written
-				// to disk by $this->flush().
-				$this->writeCache = $data;
-
-				// Clear $data ready for next round
-				$data = '';
-
-			} else {
-
-				// Read the chunk from the start of $data
-				$chunk = substr($data, 0, $this->unencryptedBlockSizeSigned);
-
-				$encrypted .= $this->crypt->symmetricEncryptFileContent($chunk, $this->fileKey, $this->version + 1, $position);
-
-				// Remove the chunk we just processed from
-				// $data, leaving only unprocessed data in $data
-				// var, for handling on the next round
-				$data = substr($data, $this->unencryptedBlockSizeSigned);
-
-			}
-
-		}
-
-		return $encrypted;
-	}
-
-	/**
-	 * decrypt data
-	 *
-	 * @param string $data you want to decrypt
-	 * @param int $position
-	 * @return string decrypted data
-	 * @throws DecryptionFailedException
-	 */
-	public function decrypt($data, $position = 0) {
-		if (empty($this->fileKey)) {
-			$msg = 'Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.';
-			$hint = $this->l->t('Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
-			$this->logger->error($msg);
-
-			throw new DecryptionFailedException($msg, $hint);
-		}
-
-		return $this->crypt->symmetricDecryptFileContent($data, $this->fileKey, $this->cipher, $this->version, $position);
-	}
-
-	/**
-	 * update encrypted file, e.g. give additional users access to the file
-	 *
-	 * @param string $path path to the file which should be updated
-	 * @param string $uid of the user who performs the operation
-	 * @param array $accessList who has access to the file contains the key 'users' and 'public'
-	 * @return boolean
-	 */
-	public function update($path, $uid, array $accessList) {
-
-		if (empty($accessList)) {
-			if (isset(self::$rememberVersion[$path])) {
-				$this->keyManager->setVersion($path, self::$rememberVersion[$path], new View());
-				unset(self::$rememberVersion[$path]);
-			}
-			return;
-		}
-
-		$fileKey = $this->keyManager->getFileKey($path, $uid);
-
-		if (!empty($fileKey)) {
-
-			$publicKeys = array();
-			if ($this->useMasterPassword === true) {
-				$publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
-			} else {
-				foreach ($accessList['users'] as $user) {
-					try {
-						$publicKeys[$user] = $this->keyManager->getPublicKey($user);
-					} catch (PublicKeyMissingException $e) {
-						$this->logger->warning('Could not encrypt file for ' . $user . ': ' . $e->getMessage());
-					}
-				}
-			}
-
-			$publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $uid);
-
-			$encryptedFileKey = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
-
-			$this->keyManager->deleteAllFileKeys($path);
-
-			$this->keyManager->setAllFileKeys($path, $encryptedFileKey);
-
-		} else {
-			$this->logger->debug('no file key found, we assume that the file "{file}" is not encrypted',
-				array('file' => $path, 'app' => 'encryption'));
-
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * should the file be encrypted or not
-	 *
-	 * @param string $path
-	 * @return boolean
-	 */
-	public function shouldEncrypt($path) {
-		if ($this->util->shouldEncryptHomeStorage() === false) {
-			$storage = $this->util->getStorage($path);
-			if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
-				return false;
-			}
-		}
-		$parts = explode('/', $path);
-		if (count($parts) < 4) {
-			return false;
-		}
-
-		if ($parts[2] == 'files') {
-			return true;
-		}
-		if ($parts[2] == 'files_versions') {
-			return true;
-		}
-		if ($parts[2] == 'files_trashbin') {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * get size of the unencrypted payload per block.
-	 * ownCloud read/write files with a block size of 8192 byte
-	 *
-	 * @param bool $signed
-	 * @return int
-	 */
-	public function getUnencryptedBlockSize($signed = false) {
-		if ($signed === false) {
-			return $this->unencryptedBlockSize;
-		}
-
-		return $this->unencryptedBlockSizeSigned;
-	}
-
-	/**
-	 * check if the encryption module is able to read the file,
-	 * e.g. if all encryption keys exists
-	 *
-	 * @param string $path
-	 * @param string $uid user for whom we want to check if he can read the file
-	 * @return bool
-	 * @throws DecryptionFailedException
-	 */
-	public function isReadable($path, $uid) {
-		$fileKey = $this->keyManager->getFileKey($path, $uid);
-		if (empty($fileKey)) {
-			$owner = $this->util->getOwner($path);
-			if ($owner !== $uid) {
-				// if it is a shared file we throw a exception with a useful
-				// error message because in this case it means that the file was
-				// shared with the user at a point where the user didn't had a
-				// valid private/public key
-				$msg = 'Encryption module "' . $this->getDisplayName() .
-					'" is not able to read ' . $path;
-				$hint = $this->l->t('Can not read this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
-				$this->logger->warning($msg);
-				throw new DecryptionFailedException($msg, $hint);
-			}
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Initial encryption of all files
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output write some status information to the terminal during encryption
-	 */
-	public function encryptAll(InputInterface $input, OutputInterface $output) {
-		$this->encryptAll->encryptAll($input, $output);
-	}
-
-	/**
-	 * prepare module to perform decrypt all operation
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output
-	 * @param string $user
-	 * @return bool
-	 */
-	public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = '') {
-		return $this->decryptAll->prepare($input, $output, $user);
-	}
-
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	protected function getPathToRealFile($path) {
-		$realPath = $path;
-		$parts = explode('/', $path);
-		if ($parts[2] === 'files_versions') {
-			$realPath = '/' . $parts[1] . '/files/' . implode('/', array_slice($parts, 3));
-			$length = strrpos($realPath, '.');
-			$realPath = substr($realPath, 0, $length);
-		}
-
-		return $realPath;
-	}
-
-	/**
-	 * remove .part file extension and the ocTransferId from the file to get the
-	 * original file name
-	 *
-	 * @param string $path
-	 * @return string
-	 */
-	protected function stripPartFileExtension($path) {
-		if (pathinfo($path, PATHINFO_EXTENSION) === 'part') {
-			$pos = strrpos($path, '.', -6);
-			$path = substr($path, 0, $pos);
-		}
-
-		return $path;
-	}
-
-	/**
-	 * Check if the module is ready to be used by that specific user.
-	 * In case a module is not ready - because e.g. key pairs have not been generated
-	 * upon login this method can return false before any operation starts and might
-	 * cause issues during operations.
-	 *
-	 * @param string $user
-	 * @return boolean
-	 * @since 9.1.0
-	 */
-	public function isReadyForUser($user) {
-		return $this->keyManager->userHasKeys($user);
-	}
+    const ID = 'OC_DEFAULT_MODULE';
+    const DISPLAY_NAME = 'Default encryption module';
+
+    /**
+     * @var Crypt
+     */
+    private $crypt;
+
+    /** @var string */
+    private $cipher;
+
+    /** @var string */
+    private $path;
+
+    /** @var string */
+    private $user;
+
+    /** @var string */
+    private $fileKey;
+
+    /** @var string */
+    private $writeCache;
+
+    /** @var KeyManager */
+    private $keyManager;
+
+    /** @var array */
+    private $accessList;
+
+    /** @var boolean */
+    private $isWriteOperation;
+
+    /** @var Util */
+    private $util;
+
+    /** @var  Session */
+    private $session;
+
+    /** @var  ILogger */
+    private $logger;
+
+    /** @var IL10N */
+    private $l;
+
+    /** @var EncryptAll */
+    private $encryptAll;
+
+    /** @var  bool */
+    private $useMasterPassword;
+
+    /** @var DecryptAll  */
+    private $decryptAll;
+
+    /** @var int unencrypted block size if block contains signature */
+    private $unencryptedBlockSizeSigned = 6072;
+
+    /** @var int unencrypted block size */
+    private $unencryptedBlockSize = 6126;
+
+    /** @var int Current version of the file */
+    private $version = 0;
+
+    /** @var array remember encryption signature version */
+    private static $rememberVersion = [];
+
+
+    /**
+     *
+     * @param Crypt $crypt
+     * @param KeyManager $keyManager
+     * @param Util $util
+     * @param Session $session
+     * @param EncryptAll $encryptAll
+     * @param DecryptAll $decryptAll
+     * @param ILogger $logger
+     * @param IL10N $il10n
+     */
+    public function __construct(Crypt $crypt,
+                                KeyManager $keyManager,
+                                Util $util,
+                                Session $session,
+                                EncryptAll $encryptAll,
+                                DecryptAll $decryptAll,
+                                ILogger $logger,
+                                IL10N $il10n) {
+        $this->crypt = $crypt;
+        $this->keyManager = $keyManager;
+        $this->util = $util;
+        $this->session = $session;
+        $this->encryptAll = $encryptAll;
+        $this->decryptAll = $decryptAll;
+        $this->logger = $logger;
+        $this->l = $il10n;
+        $this->useMasterPassword = $util->isMasterKeyEnabled();
+    }
+
+    /**
+     * @return string defining the technical unique id
+     */
+    public function getId() {
+        return self::ID;
+    }
+
+    /**
+     * In comparison to getKey() this function returns a human readable (maybe translated) name
+     *
+     * @return string
+     */
+    public function getDisplayName() {
+        return self::DISPLAY_NAME;
+    }
+
+    /**
+     * start receiving chunks from a file. This is the place where you can
+     * perform some initial step before starting encrypting/decrypting the
+     * chunks
+     *
+     * @param string $path to the file
+     * @param string $user who read/write the file
+     * @param string $mode php stream open mode
+     * @param array $header contains the header data read from the file
+     * @param array $accessList who has access to the file contains the key 'users' and 'public'
+     *
+     * @return array $header contain data as key-value pairs which should be
+     *                       written to the header, in case of a write operation
+     *                       or if no additional data is needed return a empty array
+     */
+    public function begin($path, $user, $mode, array $header, array $accessList) {
+        $this->path = $this->getPathToRealFile($path);
+        $this->accessList = $accessList;
+        $this->user = $user;
+        $this->isWriteOperation = false;
+        $this->writeCache = '';
+
+        if($this->session->isReady() === false) {
+            // if the master key is enabled we can initialize encryption
+            // with a empty password and user name
+            if ($this->util->isMasterKeyEnabled()) {
+                $this->keyManager->init('', '');
+            }
+        }
+
+        if ($this->session->decryptAllModeActivated()) {
+            $encryptedFileKey = $this->keyManager->getEncryptedFileKey($this->path);
+            $shareKey = $this->keyManager->getShareKey($this->path, $this->session->getDecryptAllUid());
+            $this->fileKey = $this->crypt->multiKeyDecrypt($encryptedFileKey,
+                $shareKey,
+                $this->session->getDecryptAllKey());
+        } else {
+            $this->fileKey = $this->keyManager->getFileKey($this->path, $this->user);
+        }
+
+        // always use the version from the original file, also part files
+        // need to have a correct version number if they get moved over to the
+        // final location
+        $this->version = (int)$this->keyManager->getVersion($this->stripPartFileExtension($path), new View());
+
+        if (
+            $mode === 'w'
+            || $mode === 'w+'
+            || $mode === 'wb'
+            || $mode === 'wb+'
+        ) {
+            $this->isWriteOperation = true;
+            if (empty($this->fileKey)) {
+                $this->fileKey = $this->crypt->generateFileKey();
+            }
+        } else {
+            // if we read a part file we need to increase the version by 1
+            // because the version number was also increased by writing
+            // the part file
+            if(Scanner::isPartialFile($path)) {
+                $this->version = $this->version + 1;
+            }
+        }
+
+        if ($this->isWriteOperation) {
+            $this->cipher = $this->crypt->getCipher();
+        } elseif (isset($header['cipher'])) {
+            $this->cipher = $header['cipher'];
+        } else {
+            // if we read a file without a header we fall-back to the legacy cipher
+            // which was used in <=oC6
+            $this->cipher = $this->crypt->getLegacyCipher();
+        }
+
+        return array('cipher' => $this->cipher, 'signed' => 'true');
+    }
+
+    /**
+     * last chunk received. This is the place where you can perform some final
+     * operation and return some remaining data if something is left in your
+     * buffer.
+     *
+     * @param string $path to the file
+     * @param int $position
+     * @return string remained data which should be written to the file in case
+     *                of a write operation
+     * @throws PublicKeyMissingException
+     * @throws \Exception
+     * @throws \OCA\Encryption\Exceptions\MultiKeyEncryptException
+     */
+    public function end($path, $position = 0) {
+        $result = '';
+        if ($this->isWriteOperation) {
+            $this->keyManager->setVersion($path, $this->version + 1, new View());
+            // in case of a part file we remember the new signature versions
+            // the version will be set later on update.
+            // This way we make sure that other apps listening to the pre-hooks
+            // still get the old version which should be the correct value for them
+            if (Scanner::isPartialFile($path)) {
+                self::$rememberVersion[$this->stripPartFileExtension($path)] = $this->version + 1;
+            }
+            if (!empty($this->writeCache)) {
+                $result = $this->crypt->symmetricEncryptFileContent($this->writeCache, $this->fileKey, $this->version + 1, $position);
+                $this->writeCache = '';
+            }
+            $publicKeys = array();
+            if ($this->useMasterPassword === true) {
+                $publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
+            } else {
+                foreach ($this->accessList['users'] as $uid) {
+                    try {
+                        $publicKeys[$uid] = $this->keyManager->getPublicKey($uid);
+                    } catch (PublicKeyMissingException $e) {
+                        $this->logger->warning(
+                            'no public key found for user "{uid}", user will not be able to read the file',
+                            ['app' => 'encryption', 'uid' => $uid]
+                        );
+                        // if the public key of the owner is missing we should fail
+                        if ($uid === $this->user) {
+                            throw $e;
+                        }
+                    }
+                }
+            }
+
+            $publicKeys = $this->keyManager->addSystemKeys($this->accessList, $publicKeys, $this->user);
+            $encryptedKeyfiles = $this->crypt->multiKeyEncrypt($this->fileKey, $publicKeys);
+            $this->keyManager->setAllFileKeys($this->path, $encryptedKeyfiles);
+        }
+        return $result;
+    }
+
+    /**
+     * encrypt data
+     *
+     * @param string $data you want to encrypt
+     * @param int $position
+     * @return string encrypted data
+     */
+    public function encrypt($data, $position = 0) {
+        // If extra data is left over from the last round, make sure it
+        // is integrated into the next block
+        if ($this->writeCache) {
+
+            // Concat writeCache to start of $data
+            $data = $this->writeCache . $data;
+
+            // Clear the write cache, ready for reuse - it has been
+            // flushed and its old contents processed
+            $this->writeCache = '';
+
+        }
+
+        $encrypted = '';
+        // While there still remains some data to be processed & written
+        while (strlen($data) > 0) {
+
+            // Remaining length for this iteration, not of the
+            // entire file (may be greater than 8192 bytes)
+            $remainingLength = strlen($data);
+
+            // If data remaining to be written is less than the
+            // size of 1 6126 byte block
+            if ($remainingLength < $this->unencryptedBlockSizeSigned) {
+
+                // Set writeCache to contents of $data
+                // The writeCache will be carried over to the
+                // next write round, and added to the start of
+                // $data to ensure that written blocks are
+                // always the correct length. If there is still
+                // data in writeCache after the writing round
+                // has finished, then the data will be written
+                // to disk by $this->flush().
+                $this->writeCache = $data;
+
+                // Clear $data ready for next round
+                $data = '';
+
+            } else {
+
+                // Read the chunk from the start of $data
+                $chunk = substr($data, 0, $this->unencryptedBlockSizeSigned);
+
+                $encrypted .= $this->crypt->symmetricEncryptFileContent($chunk, $this->fileKey, $this->version + 1, $position);
+
+                // Remove the chunk we just processed from
+                // $data, leaving only unprocessed data in $data
+                // var, for handling on the next round
+                $data = substr($data, $this->unencryptedBlockSizeSigned);
+
+            }
+
+        }
+
+        return $encrypted;
+    }
+
+    /**
+     * decrypt data
+     *
+     * @param string $data you want to decrypt
+     * @param int $position
+     * @return string decrypted data
+     * @throws DecryptionFailedException
+     */
+    public function decrypt($data, $position = 0) {
+        if (empty($this->fileKey)) {
+            $msg = 'Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.';
+            $hint = $this->l->t('Can not decrypt this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
+            $this->logger->error($msg);
+
+            throw new DecryptionFailedException($msg, $hint);
+        }
+
+        return $this->crypt->symmetricDecryptFileContent($data, $this->fileKey, $this->cipher, $this->version, $position);
+    }
+
+    /**
+     * update encrypted file, e.g. give additional users access to the file
+     *
+     * @param string $path path to the file which should be updated
+     * @param string $uid of the user who performs the operation
+     * @param array $accessList who has access to the file contains the key 'users' and 'public'
+     * @return boolean
+     */
+    public function update($path, $uid, array $accessList) {
+
+        if (empty($accessList)) {
+            if (isset(self::$rememberVersion[$path])) {
+                $this->keyManager->setVersion($path, self::$rememberVersion[$path], new View());
+                unset(self::$rememberVersion[$path]);
+            }
+            return;
+        }
+
+        $fileKey = $this->keyManager->getFileKey($path, $uid);
+
+        if (!empty($fileKey)) {
+
+            $publicKeys = array();
+            if ($this->useMasterPassword === true) {
+                $publicKeys[$this->keyManager->getMasterKeyId()] = $this->keyManager->getPublicMasterKey();
+            } else {
+                foreach ($accessList['users'] as $user) {
+                    try {
+                        $publicKeys[$user] = $this->keyManager->getPublicKey($user);
+                    } catch (PublicKeyMissingException $e) {
+                        $this->logger->warning('Could not encrypt file for ' . $user . ': ' . $e->getMessage());
+                    }
+                }
+            }
+
+            $publicKeys = $this->keyManager->addSystemKeys($accessList, $publicKeys, $uid);
+
+            $encryptedFileKey = $this->crypt->multiKeyEncrypt($fileKey, $publicKeys);
+
+            $this->keyManager->deleteAllFileKeys($path);
+
+            $this->keyManager->setAllFileKeys($path, $encryptedFileKey);
+
+        } else {
+            $this->logger->debug('no file key found, we assume that the file "{file}" is not encrypted',
+                array('file' => $path, 'app' => 'encryption'));
+
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * should the file be encrypted or not
+     *
+     * @param string $path
+     * @return boolean
+     */
+    public function shouldEncrypt($path) {
+        if ($this->util->shouldEncryptHomeStorage() === false) {
+            $storage = $this->util->getStorage($path);
+            if ($storage->instanceOfStorage('\OCP\Files\IHomeStorage')) {
+                return false;
+            }
+        }
+        $parts = explode('/', $path);
+        if (count($parts) < 4) {
+            return false;
+        }
+
+        if ($parts[2] == 'files') {
+            return true;
+        }
+        if ($parts[2] == 'files_versions') {
+            return true;
+        }
+        if ($parts[2] == 'files_trashbin') {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * get size of the unencrypted payload per block.
+     * ownCloud read/write files with a block size of 8192 byte
+     *
+     * @param bool $signed
+     * @return int
+     */
+    public function getUnencryptedBlockSize($signed = false) {
+        if ($signed === false) {
+            return $this->unencryptedBlockSize;
+        }
+
+        return $this->unencryptedBlockSizeSigned;
+    }
+
+    /**
+     * check if the encryption module is able to read the file,
+     * e.g. if all encryption keys exists
+     *
+     * @param string $path
+     * @param string $uid user for whom we want to check if he can read the file
+     * @return bool
+     * @throws DecryptionFailedException
+     */
+    public function isReadable($path, $uid) {
+        $fileKey = $this->keyManager->getFileKey($path, $uid);
+        if (empty($fileKey)) {
+            $owner = $this->util->getOwner($path);
+            if ($owner !== $uid) {
+                // if it is a shared file we throw a exception with a useful
+                // error message because in this case it means that the file was
+                // shared with the user at a point where the user didn't had a
+                // valid private/public key
+                $msg = 'Encryption module "' . $this->getDisplayName() .
+                    '" is not able to read ' . $path;
+                $hint = $this->l->t('Can not read this file, probably this is a shared file. Please ask the file owner to reshare the file with you.');
+                $this->logger->warning($msg);
+                throw new DecryptionFailedException($msg, $hint);
+            }
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Initial encryption of all files
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output write some status information to the terminal during encryption
+     */
+    public function encryptAll(InputInterface $input, OutputInterface $output) {
+        $this->encryptAll->encryptAll($input, $output);
+    }
+
+    /**
+     * prepare module to perform decrypt all operation
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @param string $user
+     * @return bool
+     */
+    public function prepareDecryptAll(InputInterface $input, OutputInterface $output, $user = '') {
+        return $this->decryptAll->prepare($input, $output, $user);
+    }
+
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    protected function getPathToRealFile($path) {
+        $realPath = $path;
+        $parts = explode('/', $path);
+        if ($parts[2] === 'files_versions') {
+            $realPath = '/' . $parts[1] . '/files/' . implode('/', array_slice($parts, 3));
+            $length = strrpos($realPath, '.');
+            $realPath = substr($realPath, 0, $length);
+        }
+
+        return $realPath;
+    }
+
+    /**
+     * remove .part file extension and the ocTransferId from the file to get the
+     * original file name
+     *
+     * @param string $path
+     * @return string
+     */
+    protected function stripPartFileExtension($path) {
+        if (pathinfo($path, PATHINFO_EXTENSION) === 'part') {
+            $pos = strrpos($path, '.', -6);
+            $path = substr($path, 0, $pos);
+        }
+
+        return $path;
+    }
+
+    /**
+     * Check if the module is ready to be used by that specific user.
+     * In case a module is not ready - because e.g. key pairs have not been generated
+     * upon login this method can return false before any operation starts and might
+     * cause issues during operations.
+     *
+     * @param string $user
+     * @return boolean
+     * @since 9.1.0
+     */
+    public function isReadyForUser($user) {
+        return $this->keyManager->userHasKeys($user);
+    }
 }

apps/encryption/lib/Crypto/EncryptAll.php

Indentation +426 added lines, -426 removed lines

@@ -45,431 +45,431 @@
 
 class EncryptAll {
 
-	/** @var Setup */
-	protected $userSetup;
-
-	/** @var IUserManager */
-	protected $userManager;
-
-	/** @var View */
-	protected $rootView;
-
-	/** @var KeyManager */
-	protected $keyManager;
-
-	/** @var Util */
-	protected $util;
-
-	/** @var array  */
-	protected $userPasswords;
-
-	/** @var  IConfig */
-	protected $config;
-
-	/** @var IMailer */
-	protected $mailer;
-
-	/** @var  IL10N */
-	protected $l;
-
-	/** @var  QuestionHelper */
-	protected $questionHelper;
-
-	/** @var  OutputInterface */
-	protected $output;
-
-	/** @var  InputInterface */
-	protected $input;
-
-	/** @var ISecureRandom */
-	protected $secureRandom;
-
-	/**
-	 * @param Setup $userSetup
-	 * @param IUserManager $userManager
-	 * @param View $rootView
-	 * @param KeyManager $keyManager
-	 * @param Util $util
-	 * @param IConfig $config
-	 * @param IMailer $mailer
-	 * @param IL10N $l
-	 * @param QuestionHelper $questionHelper
-	 * @param ISecureRandom $secureRandom
-	 */
-	public function __construct(
-		Setup $userSetup,
-		IUserManager $userManager,
-		View $rootView,
-		KeyManager $keyManager,
-		Util $util,
-		IConfig $config,
-		IMailer $mailer,
-		IL10N $l,
-		QuestionHelper $questionHelper,
-		ISecureRandom $secureRandom
-	) {
-		$this->userSetup = $userSetup;
-		$this->userManager = $userManager;
-		$this->rootView = $rootView;
-		$this->keyManager = $keyManager;
-		$this->util = $util;
-		$this->config = $config;
-		$this->mailer = $mailer;
-		$this->l = $l;
-		$this->questionHelper = $questionHelper;
-		$this->secureRandom = $secureRandom;
-		// store one time passwords for the users
-		$this->userPasswords = array();
-	}
-
-	/**
-	 * start to encrypt all files
-	 *
-	 * @param InputInterface $input
-	 * @param OutputInterface $output
-	 */
-	public function encryptAll(InputInterface $input, OutputInterface $output) {
-
-		$this->input = $input;
-		$this->output = $output;
-
-		$headline = 'Encrypt all files with the ' . Encryption::DISPLAY_NAME;
-		$this->output->writeln("\n");
-		$this->output->writeln($headline);
-		$this->output->writeln(str_pad('', strlen($headline), '='));
-		$this->output->writeln("\n");
-
-		if ($this->util->isMasterKeyEnabled()) {
-			$this->output->writeln('Use master key to encrypt all files.');
-			$this->keyManager->validateMasterKey();
-		} else {
-			//create private/public keys for each user and store the private key password
-			$this->output->writeln('Create key-pair for every user');
-			$this->output->writeln('------------------------------');
-			$this->output->writeln('');
-			$this->output->writeln('This module will encrypt all files in the users files folder initially.');
-			$this->output->writeln('Already existing versions and files in the trash bin will not be encrypted.');
-			$this->output->writeln('');
-			$this->createKeyPairs();
-		}
-
-		//setup users file system and encrypt all files one by one (take should encrypt setting of storage into account)
-		$this->output->writeln("\n");
-		$this->output->writeln('Start to encrypt users files');
-		$this->output->writeln('----------------------------');
-		$this->output->writeln('');
-		$this->encryptAllUsersFiles();
-		if ($this->util->isMasterKeyEnabled() === false) {
-			//send-out or display password list and write it to a file
-			$this->output->writeln("\n");
-			$this->output->writeln('Generated encryption key passwords');
-			$this->output->writeln('----------------------------------');
-			$this->output->writeln('');
-			$this->outputPasswords();
-		}
-		$this->output->writeln("\n");
-	}
-
-	/**
-	 * create key-pair for every user
-	 */
-	protected function createKeyPairs() {
-		$this->output->writeln("\n");
-		$progress = new ProgressBar($this->output);
-		$progress->setFormat(" %message% \n [%bar%]");
-		$progress->start();
-
-		foreach($this->userManager->getBackends() as $backend) {
-			$limit = 500;
-			$offset = 0;
-			do {
-				$users = $backend->getUsers('', $limit, $offset);
-				foreach ($users as $user) {
-					if ($this->keyManager->userHasKeys($user) === false) {
-						$progress->setMessage('Create key-pair for ' . $user);
-						$progress->advance();
-						$this->setupUserFS($user);
-						$password = $this->generateOneTimePassword($user);
-						$this->userSetup->setupUser($user, $password);
-					} else {
-						// users which already have a key-pair will be stored with a
-						// empty password and filtered out later
-						$this->userPasswords[$user] = '';
-					}
-				}
-				$offset += $limit;
-			} while(count($users) >= $limit);
-		}
-
-		$progress->setMessage('Key-pair created for all users');
-		$progress->finish();
-	}
-
-	/**
-	 * iterate over all user and encrypt their files
-	 */
-	protected function encryptAllUsersFiles() {
-		$this->output->writeln("\n");
-		$progress = new ProgressBar($this->output);
-		$progress->setFormat(" %message% \n [%bar%]");
-		$progress->start();
-		$numberOfUsers = count($this->userPasswords);
-		$userNo = 1;
-		if ($this->util->isMasterKeyEnabled()) {
-			$this->encryptAllUserFilesWithMasterKey($progress);
-		} else {
-			foreach ($this->userPasswords as $uid => $password) {
-				$userCount = "$uid ($userNo of $numberOfUsers)";
-				$this->encryptUsersFiles($uid, $progress, $userCount);
-				$userNo++;
-			}
-		}
-		$progress->setMessage("all files encrypted");
-		$progress->finish();
-
-	}
-
-	/**
-	 * encrypt all user files with the master key
-	 *
-	 * @param ProgressBar $progress
-	 */
-	protected function encryptAllUserFilesWithMasterKey(ProgressBar $progress) {
-		$userNo = 1;
-		foreach($this->userManager->getBackends() as $backend) {
-			$limit = 500;
-			$offset = 0;
-			do {
-				$users = $backend->getUsers('', $limit, $offset);
-				foreach ($users as $user) {
-					$userCount = "$user ($userNo)";
-					$this->encryptUsersFiles($user, $progress, $userCount);
-					$userNo++;
-				}
-				$offset += $limit;
-			} while(count($users) >= $limit);
-		}
-	}
-
-	/**
-	 * encrypt files from the given user
-	 *
-	 * @param string $uid
-	 * @param ProgressBar $progress
-	 * @param string $userCount
-	 */
-	protected function encryptUsersFiles($uid, ProgressBar $progress, $userCount) {
-
-		$this->setupUserFS($uid);
-		$directories = array();
-		$directories[] =  '/' . $uid . '/files';
-
-		while($root = array_pop($directories)) {
-			$content = $this->rootView->getDirectoryContent($root);
-			foreach ($content as $file) {
-				$path = $root . '/' . $file['name'];
-				if ($this->rootView->is_dir($path)) {
-					$directories[] = $path;
-					continue;
-				} else {
-					$progress->setMessage("encrypt files for user $userCount: $path");
-					$progress->advance();
-					if($this->encryptFile($path) === false) {
-						$progress->setMessage("encrypt files for user $userCount: $path (already encrypted)");
-						$progress->advance();
-					}
-				}
-			}
-		}
-	}
-
-	/**
-	 * encrypt file
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	protected function encryptFile($path) {
-
-		$source = $path;
-		$target = $path . '.encrypted.' . time();
-
-		try {
-			$this->rootView->copy($source, $target);
-			$this->rootView->rename($target, $source);
-		} catch (DecryptionFailedException $e) {
-			if ($this->rootView->file_exists($target)) {
-				$this->rootView->unlink($target);
-			}
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * output one-time encryption passwords
-	 */
-	protected function outputPasswords() {
-		$table = new Table($this->output);
-		$table->setHeaders(array('Username', 'Private key password'));
-
-		//create rows
-		$newPasswords = array();
-		$unchangedPasswords = array();
-		foreach ($this->userPasswords as $uid => $password) {
-			if (empty($password)) {
-				$unchangedPasswords[] = $uid;
-			} else {
-				$newPasswords[] = [$uid, $password];
-			}
-		}
-
-		if (empty($newPasswords)) {
-			$this->output->writeln("\nAll users already had a key-pair, no further action needed.\n");
-			return;
-		}
-
-		$table->setRows($newPasswords);
-		$table->render();
-
-		if (!empty($unchangedPasswords)) {
-			$this->output->writeln("\nThe following users already had a key-pair which was reused without setting a new password:\n");
-			foreach ($unchangedPasswords as $uid) {
-				$this->output->writeln("    $uid");
-			}
-		}
-
-		$this->writePasswordsToFile($newPasswords);
-
-		$this->output->writeln('');
-		$question = new ConfirmationQuestion('Do you want to send the passwords directly to the users by mail? (y/n) ', false);
-		if ($this->questionHelper->ask($this->input, $this->output, $question)) {
-			$this->sendPasswordsByMail();
-		}
-	}
-
-	/**
-	 * write one-time encryption passwords to a csv file
-	 *
-	 * @param array $passwords
-	 */
-	protected function writePasswordsToFile(array $passwords) {
-		$fp = $this->rootView->fopen('oneTimeEncryptionPasswords.csv', 'w');
-		foreach ($passwords as $pwd) {
-			fputcsv($fp, $pwd);
-		}
-		fclose($fp);
-		$this->output->writeln("\n");
-		$this->output->writeln('A list of all newly created passwords was written to data/oneTimeEncryptionPasswords.csv');
-		$this->output->writeln('');
-		$this->output->writeln('Each of these users need to login to the web interface, go to the');
-		$this->output->writeln('personal settings section "basic encryption module" and');
-		$this->output->writeln('update the private key password to match the login password again by');
-		$this->output->writeln('entering the one-time password into the "old log-in password" field');
-		$this->output->writeln('and their current login password');
-	}
-
-	/**
-	 * setup user file system
-	 *
-	 * @param string $uid
-	 */
-	protected function setupUserFS($uid) {
-		\OC_Util::tearDownFS();
-		\OC_Util::setupFS($uid);
-	}
-
-	/**
-	 * generate one time password for the user and store it in a array
-	 *
-	 * @param string $uid
-	 * @return string password
-	 */
-	protected function generateOneTimePassword($uid) {
-		$password = $this->secureRandom->generate(8);
-		$this->userPasswords[$uid] = $password;
-		return $password;
-	}
-
-	/**
-	 * send encryption key passwords to the users by mail
-	 */
-	protected function sendPasswordsByMail() {
-		$noMail = [];
-
-		$this->output->writeln('');
-		$progress = new ProgressBar($this->output, count($this->userPasswords));
-		$progress->start();
-
-		foreach ($this->userPasswords as $uid => $password) {
-			$progress->advance();
-			if (!empty($password)) {
-				$recipient = $this->userManager->get($uid);
-				$recipientDisplayName = $recipient->getDisplayName();
-				$to = $recipient->getEMailAddress();
-
-				if ($to === '') {
-					$noMail[] = $uid;
-					continue;
-				}
-
-				$subject = (string)$this->l->t('one-time password for server-side-encryption');
-				list($htmlBody, $textBody) = $this->createMailBody($password);
-
-				// send it out now
-				try {
-					$message = $this->mailer->createMessage();
-					$message->setSubject($subject);
-					$message->setTo([$to => $recipientDisplayName]);
-					$message->setHtmlBody($htmlBody);
-					$message->setPlainBody($textBody);
-					$message->setFrom([
-						\OCP\Util::getDefaultEmailAddress('admin-noreply')
-					]);
-
-					$this->mailer->send($message);
-				} catch (\Exception $e) {
-					$noMail[] = $uid;
-				}
-			}
-		}
-
-		$progress->finish();
-
-		if (empty($noMail)) {
-			$this->output->writeln("\n\nPassword successfully send to all users");
-		} else {
-			$table = new Table($this->output);
-			$table->setHeaders(array('Username', 'Private key password'));
-			$this->output->writeln("\n\nCould not send password to following users:\n");
-			$rows = [];
-			foreach ($noMail as $uid) {
-				$rows[] = [$uid, $this->userPasswords[$uid]];
-			}
-			$table->setRows($rows);
-			$table->render();
-		}
-
-	}
-
-	/**
-	 * create mail body for plain text and html mail
-	 *
-	 * @param string $password one-time encryption password
-	 * @return array an array of the html mail body and the plain text mail body
-	 */
-	protected function createMailBody($password) {
-
-		$html = new \OC_Template("encryption", "mail", "");
-		$html->assign ('password', $password);
-		$htmlMail = $html->fetchPage();
-
-		$plainText = new \OC_Template("encryption", "altmail", "");
-		$plainText->assign ('password', $password);
-		$plainTextMail = $plainText->fetchPage();
-
-		return [$htmlMail, $plainTextMail];
-	}
+    /** @var Setup */
+    protected $userSetup;
+
+    /** @var IUserManager */
+    protected $userManager;
+
+    /** @var View */
+    protected $rootView;
+
+    /** @var KeyManager */
+    protected $keyManager;
+
+    /** @var Util */
+    protected $util;
+
+    /** @var array  */
+    protected $userPasswords;
+
+    /** @var  IConfig */
+    protected $config;
+
+    /** @var IMailer */
+    protected $mailer;
+
+    /** @var  IL10N */
+    protected $l;
+
+    /** @var  QuestionHelper */
+    protected $questionHelper;
+
+    /** @var  OutputInterface */
+    protected $output;
+
+    /** @var  InputInterface */
+    protected $input;
+
+    /** @var ISecureRandom */
+    protected $secureRandom;
+
+    /**
+     * @param Setup $userSetup
+     * @param IUserManager $userManager
+     * @param View $rootView
+     * @param KeyManager $keyManager
+     * @param Util $util
+     * @param IConfig $config
+     * @param IMailer $mailer
+     * @param IL10N $l
+     * @param QuestionHelper $questionHelper
+     * @param ISecureRandom $secureRandom
+     */
+    public function __construct(
+        Setup $userSetup,
+        IUserManager $userManager,
+        View $rootView,
+        KeyManager $keyManager,
+        Util $util,
+        IConfig $config,
+        IMailer $mailer,
+        IL10N $l,
+        QuestionHelper $questionHelper,
+        ISecureRandom $secureRandom
+    ) {
+        $this->userSetup = $userSetup;
+        $this->userManager = $userManager;
+        $this->rootView = $rootView;
+        $this->keyManager = $keyManager;
+        $this->util = $util;
+        $this->config = $config;
+        $this->mailer = $mailer;
+        $this->l = $l;
+        $this->questionHelper = $questionHelper;
+        $this->secureRandom = $secureRandom;
+        // store one time passwords for the users
+        $this->userPasswords = array();
+    }
+
+    /**
+     * start to encrypt all files
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     */
+    public function encryptAll(InputInterface $input, OutputInterface $output) {
+
+        $this->input = $input;
+        $this->output = $output;
+
+        $headline = 'Encrypt all files with the ' . Encryption::DISPLAY_NAME;
+        $this->output->writeln("\n");
+        $this->output->writeln($headline);
+        $this->output->writeln(str_pad('', strlen($headline), '='));
+        $this->output->writeln("\n");
+
+        if ($this->util->isMasterKeyEnabled()) {
+            $this->output->writeln('Use master key to encrypt all files.');
+            $this->keyManager->validateMasterKey();
+        } else {
+            //create private/public keys for each user and store the private key password
+            $this->output->writeln('Create key-pair for every user');
+            $this->output->writeln('------------------------------');
+            $this->output->writeln('');
+            $this->output->writeln('This module will encrypt all files in the users files folder initially.');
+            $this->output->writeln('Already existing versions and files in the trash bin will not be encrypted.');
+            $this->output->writeln('');
+            $this->createKeyPairs();
+        }
+
+        //setup users file system and encrypt all files one by one (take should encrypt setting of storage into account)
+        $this->output->writeln("\n");
+        $this->output->writeln('Start to encrypt users files');
+        $this->output->writeln('----------------------------');
+        $this->output->writeln('');
+        $this->encryptAllUsersFiles();
+        if ($this->util->isMasterKeyEnabled() === false) {
+            //send-out or display password list and write it to a file
+            $this->output->writeln("\n");
+            $this->output->writeln('Generated encryption key passwords');
+            $this->output->writeln('----------------------------------');
+            $this->output->writeln('');
+            $this->outputPasswords();
+        }
+        $this->output->writeln("\n");
+    }
+
+    /**
+     * create key-pair for every user
+     */
+    protected function createKeyPairs() {
+        $this->output->writeln("\n");
+        $progress = new ProgressBar($this->output);
+        $progress->setFormat(" %message% \n [%bar%]");
+        $progress->start();
+
+        foreach($this->userManager->getBackends() as $backend) {
+            $limit = 500;
+            $offset = 0;
+            do {
+                $users = $backend->getUsers('', $limit, $offset);
+                foreach ($users as $user) {
+                    if ($this->keyManager->userHasKeys($user) === false) {
+                        $progress->setMessage('Create key-pair for ' . $user);
+                        $progress->advance();
+                        $this->setupUserFS($user);
+                        $password = $this->generateOneTimePassword($user);
+                        $this->userSetup->setupUser($user, $password);
+                    } else {
+                        // users which already have a key-pair will be stored with a
+                        // empty password and filtered out later
+                        $this->userPasswords[$user] = '';
+                    }
+                }
+                $offset += $limit;
+            } while(count($users) >= $limit);
+        }
+
+        $progress->setMessage('Key-pair created for all users');
+        $progress->finish();
+    }
+
+    /**
+     * iterate over all user and encrypt their files
+     */
+    protected function encryptAllUsersFiles() {
+        $this->output->writeln("\n");
+        $progress = new ProgressBar($this->output);
+        $progress->setFormat(" %message% \n [%bar%]");
+        $progress->start();
+        $numberOfUsers = count($this->userPasswords);
+        $userNo = 1;
+        if ($this->util->isMasterKeyEnabled()) {
+            $this->encryptAllUserFilesWithMasterKey($progress);
+        } else {
+            foreach ($this->userPasswords as $uid => $password) {
+                $userCount = "$uid ($userNo of $numberOfUsers)";
+                $this->encryptUsersFiles($uid, $progress, $userCount);
+                $userNo++;
+            }
+        }
+        $progress->setMessage("all files encrypted");
+        $progress->finish();
+
+    }
+
+    /**
+     * encrypt all user files with the master key
+     *
+     * @param ProgressBar $progress
+     */
+    protected function encryptAllUserFilesWithMasterKey(ProgressBar $progress) {
+        $userNo = 1;
+        foreach($this->userManager->getBackends() as $backend) {
+            $limit = 500;
+            $offset = 0;
+            do {
+                $users = $backend->getUsers('', $limit, $offset);
+                foreach ($users as $user) {
+                    $userCount = "$user ($userNo)";
+                    $this->encryptUsersFiles($user, $progress, $userCount);
+                    $userNo++;
+                }
+                $offset += $limit;
+            } while(count($users) >= $limit);
+        }
+    }
+
+    /**
+     * encrypt files from the given user
+     *
+     * @param string $uid
+     * @param ProgressBar $progress
+     * @param string $userCount
+     */
+    protected function encryptUsersFiles($uid, ProgressBar $progress, $userCount) {
+
+        $this->setupUserFS($uid);
+        $directories = array();
+        $directories[] =  '/' . $uid . '/files';
+
+        while($root = array_pop($directories)) {
+            $content = $this->rootView->getDirectoryContent($root);
+            foreach ($content as $file) {
+                $path = $root . '/' . $file['name'];
+                if ($this->rootView->is_dir($path)) {
+                    $directories[] = $path;
+                    continue;
+                } else {
+                    $progress->setMessage("encrypt files for user $userCount: $path");
+                    $progress->advance();
+                    if($this->encryptFile($path) === false) {
+                        $progress->setMessage("encrypt files for user $userCount: $path (already encrypted)");
+                        $progress->advance();
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * encrypt file
+     *
+     * @param string $path
+     * @return bool
+     */
+    protected function encryptFile($path) {
+
+        $source = $path;
+        $target = $path . '.encrypted.' . time();
+
+        try {
+            $this->rootView->copy($source, $target);
+            $this->rootView->rename($target, $source);
+        } catch (DecryptionFailedException $e) {
+            if ($this->rootView->file_exists($target)) {
+                $this->rootView->unlink($target);
+            }
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * output one-time encryption passwords
+     */
+    protected function outputPasswords() {
+        $table = new Table($this->output);
+        $table->setHeaders(array('Username', 'Private key password'));
+
+        //create rows
+        $newPasswords = array();
+        $unchangedPasswords = array();
+        foreach ($this->userPasswords as $uid => $password) {
+            if (empty($password)) {
+                $unchangedPasswords[] = $uid;
+            } else {
+                $newPasswords[] = [$uid, $password];
+            }
+        }
+
+        if (empty($newPasswords)) {
+            $this->output->writeln("\nAll users already had a key-pair, no further action needed.\n");
+            return;
+        }
+
+        $table->setRows($newPasswords);
+        $table->render();
+
+        if (!empty($unchangedPasswords)) {
+            $this->output->writeln("\nThe following users already had a key-pair which was reused without setting a new password:\n");
+            foreach ($unchangedPasswords as $uid) {
+                $this->output->writeln("    $uid");
+            }
+        }
+
+        $this->writePasswordsToFile($newPasswords);
+
+        $this->output->writeln('');
+        $question = new ConfirmationQuestion('Do you want to send the passwords directly to the users by mail? (y/n) ', false);
+        if ($this->questionHelper->ask($this->input, $this->output, $question)) {
+            $this->sendPasswordsByMail();
+        }
+    }
+
+    /**
+     * write one-time encryption passwords to a csv file
+     *
+     * @param array $passwords
+     */
+    protected function writePasswordsToFile(array $passwords) {
+        $fp = $this->rootView->fopen('oneTimeEncryptionPasswords.csv', 'w');
+        foreach ($passwords as $pwd) {
+            fputcsv($fp, $pwd);
+        }
+        fclose($fp);
+        $this->output->writeln("\n");
+        $this->output->writeln('A list of all newly created passwords was written to data/oneTimeEncryptionPasswords.csv');
+        $this->output->writeln('');
+        $this->output->writeln('Each of these users need to login to the web interface, go to the');
+        $this->output->writeln('personal settings section "basic encryption module" and');
+        $this->output->writeln('update the private key password to match the login password again by');
+        $this->output->writeln('entering the one-time password into the "old log-in password" field');
+        $this->output->writeln('and their current login password');
+    }
+
+    /**
+     * setup user file system
+     *
+     * @param string $uid
+     */
+    protected function setupUserFS($uid) {
+        \OC_Util::tearDownFS();
+        \OC_Util::setupFS($uid);
+    }
+
+    /**
+     * generate one time password for the user and store it in a array
+     *
+     * @param string $uid
+     * @return string password
+     */
+    protected function generateOneTimePassword($uid) {
+        $password = $this->secureRandom->generate(8);
+        $this->userPasswords[$uid] = $password;
+        return $password;
+    }
+
+    /**
+     * send encryption key passwords to the users by mail
+     */
+    protected function sendPasswordsByMail() {
+        $noMail = [];
+
+        $this->output->writeln('');
+        $progress = new ProgressBar($this->output, count($this->userPasswords));
+        $progress->start();
+
+        foreach ($this->userPasswords as $uid => $password) {
+            $progress->advance();
+            if (!empty($password)) {
+                $recipient = $this->userManager->get($uid);
+                $recipientDisplayName = $recipient->getDisplayName();
+                $to = $recipient->getEMailAddress();
+
+                if ($to === '') {
+                    $noMail[] = $uid;
+                    continue;
+                }
+
+                $subject = (string)$this->l->t('one-time password for server-side-encryption');
+                list($htmlBody, $textBody) = $this->createMailBody($password);
+
+                // send it out now
+                try {
+                    $message = $this->mailer->createMessage();
+                    $message->setSubject($subject);
+                    $message->setTo([$to => $recipientDisplayName]);
+                    $message->setHtmlBody($htmlBody);
+                    $message->setPlainBody($textBody);
+                    $message->setFrom([
+                        \OCP\Util::getDefaultEmailAddress('admin-noreply')
+                    ]);
+
+                    $this->mailer->send($message);
+                } catch (\Exception $e) {
+                    $noMail[] = $uid;
+                }
+            }
+        }
+
+        $progress->finish();
+
+        if (empty($noMail)) {
+            $this->output->writeln("\n\nPassword successfully send to all users");
+        } else {
+            $table = new Table($this->output);
+            $table->setHeaders(array('Username', 'Private key password'));
+            $this->output->writeln("\n\nCould not send password to following users:\n");
+            $rows = [];
+            foreach ($noMail as $uid) {
+                $rows[] = [$uid, $this->userPasswords[$uid]];
+            }
+            $table->setRows($rows);
+            $table->render();
+        }
+
+    }
+
+    /**
+     * create mail body for plain text and html mail
+     *
+     * @param string $password one-time encryption password
+     * @return array an array of the html mail body and the plain text mail body
+     */
+    protected function createMailBody($password) {
+
+        $html = new \OC_Template("encryption", "mail", "");
+        $html->assign ('password', $password);
+        $htmlMail = $html->fetchPage();
+
+        $plainText = new \OC_Template("encryption", "altmail", "");
+        $plainText->assign ('password', $password);
+        $plainTextMail = $plainText->fetchPage();
+
+        return [$htmlMail, $plainTextMail];
+    }
 
 }