allow admin to enforce password on mail shares

Signed-off-by: Bjoern Schiessle <bjoern@schiessle.org>

5 files changed, 150 insertions, 22 deletions

diff --git a/apps/sharebymail/lib/AppInfo/Application.php b/apps/sharebymail/lib/AppInfo/Application.php
index 98febf9dad7..12419a8c3d9 100644
--- a/apps/sharebymail/lib/AppInfo/Application.php
+++ b/apps/sharebymail/lib/AppInfo/Application.php
@@ -32,7 +32,8 @@ class Application extends App {
 	public function __construct(array $urlParams = array()) {
 		parent::__construct('sharebymail', $urlParams);
 
-		$settings = new Settings();
+		$settingsManager = \OC::$server->query(Settings\SettingsManager::class);
+		$settings = new Settings($settingsManager);
 
 		/** register capabilities */
 		$container = $this->getContainer();
@@ -40,6 +41,7 @@ class Application extends App {
 
 		/** register hooks */
 		Util::connectHook('\OCP\Config', 'js', $settings, 'announceShareProvider');
+		Util::connectHook('\OCP\Config', 'js', $settings, 'announceShareByMailSettings');
 	}
 
 }
diff --git a/apps/sharebymail/lib/Settings.php b/apps/sharebymail/lib/Settings.php
index 4ab1622425b..e032bc43ff1 100644
--- a/apps/sharebymail/lib/Settings.php
+++ b/apps/sharebymail/lib/Settings.php
@@ -23,8 +23,17 @@
 namespace OCA\ShareByMail;
 
 
+use OCA\ShareByMail\Settings\SettingsManager;
+
 class Settings {
 
+	/** @var SettingsManager */
+	private $settingsManager;
+
+	public function __construct(SettingsManager $settingsManager) {
+		$this->settingsManager = $settingsManager;
+	}
+
 	/**
 	 * announce that the share-by-mail share provider is enabled
 	 *
@@ -35,4 +44,10 @@ class Settings {
 		$array['shareByMailEnabled'] = true;
 		$settings['array']['oc_appconfig'] = json_encode($array);
 	}
+
+	public function announceShareByMailSettings(array $settings) {
+		$array = json_decode($settings['array']['oc_appconfig'], true);
+		$array['shareByMail']['enforcePasswordProtection'] = $this->settingsManager->enforcePasswordProtection();
+		$settings['array']['oc_appconfig'] = json_encode($array);
+	}
 }
diff --git a/apps/sharebymail/lib/Settings/Admin.php b/apps/sharebymail/lib/Settings/Admin.php
index b6e7e5d3b4a..93a8d3aafa4 100644
--- a/apps/sharebymail/lib/Settings/Admin.php
+++ b/apps/sharebymail/lib/Settings/Admin.php
@@ -40,7 +40,8 @@ class Admin implements ISettings {
 	public function getForm() {
 
 		$parameters = [
-			'sendPasswordMail' => $this->settingsManager->sendPasswordByMail()
+			'sendPasswordMail' => $this->settingsManager->sendPasswordByMail(),
+			'enforcePasswordProtection' => $this->settingsManager->enforcePasswordProtection()
 		];
 
 		return new TemplateResponse('sharebymail', 'settings-admin', $parameters, '');
diff --git a/apps/sharebymail/lib/Settings/SettingsManager.php b/apps/sharebymail/lib/Settings/SettingsManager.php
index 205b253f337..2b35e5833a7 100644
--- a/apps/sharebymail/lib/Settings/SettingsManager.php
+++ b/apps/sharebymail/lib/Settings/SettingsManager.php
@@ -30,7 +30,9 @@ class SettingsManager {
 	/** @var IConfig */
 	private $config;
 
-	private $defaultSetting = 'yes';
+	private $sendPasswordByMailDefault = 'yes';
+
+	private $enforcePasswordProtectionDefault = 'no';
 
 	public function __construct(IConfig $config) {
 		$this->config = $config;
@@ -42,8 +44,18 @@ class SettingsManager {
 	 * @return bool
 	 */
 	public function sendPasswordByMail() {
-		$sendPasswordByMail = $this->config->getAppValue('sharebymail', 'sendpasswordmail', $this->defaultSetting);
+		$sendPasswordByMail = $this->config->getAppValue('sharebymail', 'sendpasswordmail', $this->sendPasswordByMailDefault);
 		return $sendPasswordByMail === 'yes';
 	}
 
+	/**
+	 * do we require a share by mail to be password protected
+	 *
+	 * @return bool
+	 */
+	public function enforcePasswordProtection() {
+		$enforcePassword = $this->config->getAppValue('sharebymail', 'enforcePasswordProtection', $this->enforcePasswordProtectionDefault);
+		return $enforcePassword === 'yes';
+	}
+
 }
diff --git a/apps/sharebymail/lib/ShareByMailProvider.php b/apps/sharebymail/lib/ShareByMailProvider.php
index 767bdc86a4a..defcd5d4ace 100644
--- a/apps/sharebymail/lib/ShareByMailProvider.php
+++ b/apps/sharebymail/lib/ShareByMailProvider.php
@@ -37,6 +37,7 @@ use OCP\IURLGenerator;
 use OCP\IUser;
 use OCP\IUserManager;
 use OCP\Mail\IMailer;
+use OCP\Security\IHasher;
 use OCP\Security\ISecureRandom;
 use OC\Share20\Share;
 use OCP\Share\Exceptions\ShareNotFound;
@@ -84,6 +85,9 @@ class ShareByMailProvider implements IShareProvider {
 	/** @var Defaults */
 	private $defaults;
 
+	/** @var IHasher */
+	private $hasher;
+
 	/**
 	 * Return the identifier of this provider.
 	 *
@@ -107,6 +111,7 @@ class ShareByMailProvider implements IShareProvider {
 	 * @param IManager $activityManager
 	 * @param SettingsManager $settingsManager
 	 * @param Defaults $defaults
+	 * @param IHasher $hasher
 	 */
 	public function __construct(
 		IDBConnection $connection,
@@ -119,7 +124,8 @@ class ShareByMailProvider implements IShareProvider {
 		IURLGenerator $urlGenerator,
 		IManager $activityManager,
 		SettingsManager $settingsManager,
-		Defaults $defaults
+		Defaults $defaults,
+		IHasher $hasher
 	) {
 		$this->dbConnection = $connection;
 		$this->secureRandom = $secureRandom;
@@ -132,6 +138,7 @@ class ShareByMailProvider implements IShareProvider {
 		$this->activityManager = $activityManager;
 		$this->settingsManager = $settingsManager;
 		$this->defaults = $defaults;
+		$this->hasher = $hasher;
 	}
 
 	/**
@@ -156,14 +163,51 @@ class ShareByMailProvider implements IShareProvider {
 			throw new \Exception($message_t);
 		}
 
+		// if the admin enforces a password for all mail shares we create a
+		// random password and send it to the recipient
+		$password = '';
+		$passwordEnforced = $this->settingsManager->enforcePasswordProtection();
+		if ($passwordEnforced) {
+			$password = $this->autoGeneratePassword($share);
+		}
+
 		$shareId = $this->createMailShare($share);
+		$send = $this->sendPassword($share->getNode()->getName(), $share->getSharedBy(), $share->getSharedWith(), $password);
+		if ($passwordEnforced && $send === false) {
+			$this->sendPasswordToOwner($share->getNode()->getName(), $share->getSharedBy(), $shareWith, $password);
+		}
 		$this->createActivity($share);
 		$data = $this->getRawShare($shareId);
+
 		return $this->createShareObject($data);
 
 	}
 
 	/**
+	 * auto generate password in case of password enforcement on mail shares
+	 *
+	 * @param IShare $share
+	 * @return string
+	 * @throws \Exception
+	 */
+	protected function autoGeneratePassword($share) {
+		$initiatorUser = $this->userManager->get($share->getSharedBy());
+		$initiatorEMailAddress = ($initiatorUser instanceof IUser) ? $initiatorUser->getEMailAddress() : null;
+		$allowPasswordByMail = $this->settingsManager->sendPasswordByMail();
+
+		if ($initiatorEMailAddress === null && !$allowPasswordByMail) {
+			throw new \Exception(
+				$this->l->t("We can't send you the auto-generated password. Please set a valid email address in your personal settings and try again.")
+			);
+		}
+
+		$password = $this->generateToken(8);
+		$share->setPassword($this->hasher->hash($password));
+
+		return $password;
+	}
+
+	/**
 	 * create activity if a file/folder was shared by mail
 	 *
 	 * @param IShare $share
@@ -230,7 +274,8 @@ class ShareByMailProvider implements IShareProvider {
 			$share->getSharedBy(),
 			$share->getShareOwner(),
 			$share->getPermissions(),
-			$share->getToken()
+			$share->getToken(),
+			$share->getPassword()
 		);
 
 		try {
@@ -275,6 +320,7 @@ class ShareByMailProvider implements IShareProvider {
 		$initiatorUser = $this->userManager->get($initiator);
 		$ownerDisplayName = ($ownerUser instanceof IUser) ? $ownerUser->getDisplayName() : $owner;
 		$initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
+		$initiatorEmailAddress = ($initiatorUser instanceof IUser) ? $initiatorUser->getEMailAddress() : null;
 		if ($owner === $initiator) {
 			$subject = (string)$this->l->t('%s shared »%s« with you', array($ownerDisplayName, $filename));
 		} else {
@@ -287,23 +333,25 @@ class ShareByMailProvider implements IShareProvider {
 
 		$emailTemplate->addHeader();
 		$emailTemplate->addHeading($this->l->t('%s shared »%s« with you', [$ownerDisplayName, $filename]), false);
-
 		if ($owner === $initiator) {
 			$text = $this->l->t('%s shared »%s« with you.', [$ownerDisplayName, $filename]);
 		} else {
 			$text= $this->l->t('%s shared »%s« with you on behalf of %s.', [$ownerDisplayName, $filename, $initiator]);
 		}
-
 		$emailTemplate->addBodyText(
 			$text . ' ' . $this->l->t('Click the button below to open it.'),
 			$text
 		);
-
 		$emailTemplate->addBodyButton(
 			$this->l->t('Open »%s«', [$filename]),
 			$link
 		);
 
+		$emailTemplate->addFooter();
+		if ($initiatorEmailAddress !== null) {
+			$message->setFrom([$initiatorEmailAddress => $initiatorDisplayName]);
+		}
+
 		$message->setTo([$shareWith]);
 
 		// The "From" contains the sharers name
@@ -339,49 +387,98 @@ class ShareByMailProvider implements IShareProvider {
 	 * @param string $filename
 	 * @param string $initiator
 	 * @param string $shareWith
+	 * @param string $password
+	 * @return bool
 	 */
 	protected function sendPassword($filename, $initiator, $shareWith, $password) {
 
-		if ($this->settingsManager->sendPasswordByMail() === false) {
-			return;
+		if ($password === '' || $this->settingsManager->sendPasswordByMail() === false) {
+			return false;
 		}
 
 		$initiatorUser = $this->userManager->get($initiator);
 		$initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
+		$initiatorEmailAddress = ($initiatorUser instanceof IUser) ? $initiatorUser->getEMailAddress() : null;
+
 		$subject = (string)$this->l->t('Password to access »%s« shared to you by %s', [$filename, $initiatorDisplayName]);
+		$plainBodyPart = $this->l->t("%s shared »%s« with you.\nYou should have already received a separate mail with a link to access it.\n", [$initiatorDisplayName, $filename]);
+		$htmlBodyPart = $this->l->t('%s shared »%s« with you. You should have already received a separate mail with a link to access it.', [$initiatorDisplayName, $filename]);
 
 		$message = $this->mailer->createMessage();
 
 		$emailTemplate = $this->mailer->createEMailTemplate();
-
 		$emailTemplate->addHeader();
-		$emailTemplate->addHeading($this->l->t('Password to access »%s«', [$filename]));
-
-		$emailTemplate->addBodyText($this->l->t(
-			'%s shared »%s« with you. You should have already received a separate mail with a link to access it.',
-				[$initiatorDisplayName, $filename]
-		));
+		$emailTemplate->addHeading($this->l->t('Password to access »%s«', [$filename]), false);
+		$emailTemplate->addBodyText($htmlBodyPart, $plainBodyPart);
 		$emailTemplate->addBodyText($this->l->t('It is protected with the following password: %s', [$password]));
-
 		$emailTemplate->addFooter();
 
+		if ($initiatorEmailAddress !== null) {
+			$message->setFrom([$initiatorEmailAddress => $initiatorDisplayName]);
+		}
 		$message->setTo([$shareWith]);
 		$message->setSubject($subject);
 		$message->setBody($emailTemplate->renderText(), 'text/plain');
 		$message->setHtmlBody($emailTemplate->renderHtml());
 		$this->mailer->send($message);
 
+		return true;
 	}
 
+	/**
+	 * send auto generated password to the owner. This happens if the admin enforces
+	 * a password for mail shares and forbid to send the password by mail to the recipient
+	 *
+	 * @param string $filename
+	 * @param string $initiator
+	 * @param string $shareWith
+	 * @param string $password
+	 * @throws \Exception
+	 */
+	protected function sendPasswordToOwner($filename, $initiator, $shareWith, $password) {
+
+		$initiatorUser = $this->userManager->get($initiator);
+		$initiatorEMailAddress = ($initiatorUser instanceof IUser) ? $initiatorUser->getEMailAddress() : null;
+		$initiatorDisplayName = ($initiatorUser instanceof IUser) ? $initiatorUser->getDisplayName() : $initiator;
+
+		if ($initiatorEMailAddress === null) {
+			throw new \Exception(
+				$this->l->t("We can't send you the auto-generated password. Please set a valid email address in your personal settings and try again.")
+			);
+		}
+
+		$subject = (string)$this->l->t('Password to access »%s« shared with %s', [$filename, $shareWith]);
+		$plainBodyPart = $this->l->t("You just shared »%s« with %s.\nThe share was already send to the recipient. Due to the security policies\neach share needs to be protected by password and it is not allowed to send the\npassword directly by mail to the recipient. Therefore you need to forward\nthe password manually to the recipient.", [$filename, $shareWith]);
+		$htmlBodyPart = $this->l->t('You just shared »%s« with %s. The share was already send to the recipient. Due to the security policies each share needs to be protected by password and it is not allowed to send the password directly by mail to the recipient. Therefore you need to forward the password manually to the recipient.', [$filename, $shareWith]);
+
+		$message = $this->mailer->createMessage();
+		$emailTemplate = $this->mailer->createEMailTemplate();
+
+		$emailTemplate->addHeader();
+		$emailTemplate->addHeading($this->l->t('Password to access »%s«', [$filename]), false);
+		$emailTemplate->addBodyText($htmlBodyPart, $plainBodyPart);
+		$emailTemplate->addBodyText($this->l->t('This is the password: %s', [$password]));
+		$emailTemplate->addBodyText($this->l->t('You can chose a different password at any time in the share dialog.'));
+		$emailTemplate->addFooter();
+
+		if ($initiatorEMailAddress) {
+			$message->setFrom([$initiatorEMailAddress => $initiatorDisplayName]);
+		}
+		$message->setTo([$initiatorEMailAddress => $initiatorDisplayName]);
+		$message->setSubject($subject);
+		$message->setBody($emailTemplate->renderText(), 'text/plain');
+		$message->setHtmlBody($emailTemplate->renderHTML());
+		$this->mailer->send($message);
+	}
 
 	/**
 	 * generate share token
 	 *
 	 * @return string
 	 */
-	protected function generateToken() {
+	protected function generateToken($size = 15) {
 		$token = $this->secureRandom->generate(
-			15, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_DIGITS);
+			$size, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_DIGITS);
 		return $token;
 	}
 
@@ -422,7 +519,7 @@ class ShareByMailProvider implements IShareProvider {
 	 * @param string $token
 	 * @return int
 	 */
-	protected function addShareToDB($itemSource, $itemType, $shareWith, $sharedBy, $uidOwner, $permissions, $token) {
+	protected function addShareToDB($itemSource, $itemType, $shareWith, $sharedBy, $uidOwner, $permissions, $token, $password) {
 		$qb = $this->dbConnection->getQueryBuilder();
 		$qb->insert('share')
 			->setValue('share_type', $qb->createNamedParameter(\OCP\Share::SHARE_TYPE_EMAIL))
@@ -434,6 +531,7 @@ class ShareByMailProvider implements IShareProvider {
 			->setValue('uid_initiator', $qb->createNamedParameter($sharedBy))
 			->setValue('permissions', $qb->createNamedParameter($permissions))
 			->setValue('token', $qb->createNamedParameter($token))
+			->setValue('password', $qb->createNamedParameter($password))
 			->setValue('stime', $qb->createNamedParameter(time()));
 
 		/*