Merge pull request #22162 from nextcloud/enh/noid/password-generator-sharebymail

ShareByMail: Migrate to GenerateSecurePasswordEvent

Author: MorrisJobke

apps/sharebymail/lib/ShareByMailProvider.php

@@ -36,7 +36,6 @@
 
 namespace OCA\ShareByMail;
 
-use OC\CapabilitiesManager;
 use OC\HintException;
 use OC\Share20\Exception\InvalidShare;
 use OC\Share20\Share;
@@ -45,6 +44,7 @@
 use OCP\Activity\IManager;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\Defaults;
+use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\Folder;
 use OCP\Files\IRootFolder;
 use OCP\Files\Node;
@@ -55,6 +55,7 @@
 use OCP\IUser;
 use OCP\IUserManager;
 use OCP\Mail\IMailer;
+use OCP\Security\Events\GenerateSecurePasswordEvent;
 use OCP\Security\IHasher;
 use OCP\Security\ISecureRandom;
 use OCP\Share\Exceptions\GenericShareException;
@@ -105,8 +106,8 @@ class ShareByMailProvider implements IShareProvider {
 	/** @var IHasher */
 	private $hasher;
 
-	/** @var  CapabilitiesManager */
-	private $capabilitiesManager;
+	/** @var IEventDispatcher */
+	private $eventDispatcher;
 
 	/**
 	 * Return the identifier of this provider.
@@ -117,23 +118,6 @@ public function identifier() {
 		return 'ocMailShare';
 	}
 
-	/**
-	 * DefaultShareProvider constructor.
-	 *
-	 * @param IDBConnection $connection
-	 * @param ISecureRandom $secureRandom
-	 * @param IUserManager $userManager
-	 * @param IRootFolder $rootFolder
-	 * @param IL10N $l
-	 * @param ILogger $logger
-	 * @param IMailer $mailer
-	 * @param IURLGenerator $urlGenerator
-	 * @param IManager $activityManager
-	 * @param SettingsManager $settingsManager
-	 * @param Defaults $defaults
-	 * @param IHasher $hasher
-	 * @param CapabilitiesManager $capabilitiesManager
-	 */
 	public function __construct(
 		IDBConnection $connection,
 		ISecureRandom $secureRandom,
@@ -147,7 +131,7 @@ public function __construct(
 		SettingsManager $settingsManager,
 		Defaults $defaults,
 		IHasher $hasher,
-		CapabilitiesManager $capabilitiesManager
+		IEventDispatcher $eventDispatcher
 	) {
 		$this->dbConnection = $connection;
 		$this->secureRandom = $secureRandom;
@@ -161,7 +145,7 @@ public function __construct(
 		$this->settingsManager = $settingsManager;
 		$this->defaults = $defaults;
 		$this->hasher = $hasher;
-		$this->capabilitiesManager = $capabilitiesManager;
+		$this->eventDispatcher = $eventDispatcher;
 	}
 
 	/**
@@ -227,31 +211,15 @@ protected function autoGeneratePassword($share) {
 			);
 		}
 
-		$passwordPolicy = $this->getPasswordPolicy();
-		$passwordCharset = ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_DIGITS;
-		$passwordLength = 8;
-		if (!empty($passwordPolicy)) {
-			$passwordLength = (int)$passwordPolicy['minLength'] > 0 ? (int)$passwordPolicy['minLength'] : $passwordLength;
-			$passwordCharset .= $passwordPolicy['enforceSpecialCharacters'] ? ISecureRandom::CHAR_SYMBOLS : '';
-		}
+		$passwordEvent = new GenerateSecurePasswordEvent();
+		$this->eventDispatcher->dispatchTyped($passwordEvent);
 
-		$password = $this->secureRandom->generate($passwordLength, $passwordCharset);
-
-		return $password;
-	}
-
-	/**
-	 * get password policy
-	 *
-	 * @return array
-	 */
-	protected function getPasswordPolicy() {
-		$capabilities = $this->capabilitiesManager->getCapabilities();
-		if (isset($capabilities['password_policy'])) {
-			return $capabilities['password_policy'];
+		$password = $passwordEvent->getPassword();
+		if ($password === null) {
+			$password = $this->secureRandom->generate(8, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_DIGITS);
 		}
 
-		return [];
+		return $password;
 	}
 
 	/**

apps/sharebymail/tests/ShareByMailProviderTest.php

@@ -30,11 +30,11 @@
 
 namespace OCA\ShareByMail\Tests;
 
-use OC\CapabilitiesManager;
 use OC\Mail\Message;
 use OCA\ShareByMail\Settings\SettingsManager;
 use OCA\ShareByMail\ShareByMailProvider;
 use OCP\Defaults;
+use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\File;
 use OCP\Files\IRootFolder;
 use OCP\IDBConnection;
@@ -46,10 +46,12 @@
 use OCP\Mail\IEMailTemplate;
 use OCP\Mail\IMailer;
 use OCP\Mail\IMessage;
+use OCP\Security\Events\GenerateSecurePasswordEvent;
 use OCP\Security\IHasher;
 use OCP\Security\ISecureRandom;
 use OCP\Share\IManager;
 use OCP\Share\IShare;
+use PHPUnit\Framework\MockObject\MockObject;
 use Test\TestCase;
 
 /**
@@ -102,8 +104,8 @@ class ShareByMailProviderTest extends TestCase {
 	/** @var  IHasher | \PHPUnit_Framework_MockObject_MockObject */
 	private $hasher;
 
-	/** @var  CapabilitiesManager | \PHPUnit_Framework_MockObject_MockObject */
-	private $capabilitiesManager;
+	/** @var IEventDispatcher */
+	private $eventDispatcher;
 
 	protected function setUp(): void {
 		parent::setUp();
@@ -127,7 +129,7 @@ protected function setUp(): void {
 		$this->settingsManager = $this->getMockBuilder(SettingsManager::class)->disableOriginalConstructor()->getMock();
 		$this->defaults = $this->createMock(Defaults::class);
 		$this->hasher = $this->getMockBuilder(IHasher::class)->getMock();
-		$this->capabilitiesManager = $this->getMockBuilder(CapabilitiesManager::class)->disableOriginalConstructor()->getMock();
+		$this->eventDispatcher = $this->getMockBuilder(IEventDispatcher::class)->getMock();
 
 		$this->userManager->expects($this->any())->method('userExists')->willReturn(true);
 	}
@@ -154,7 +156,7 @@ private function getInstance(array $mockedMethods = []) {
 					$this->settingsManager,
 					$this->defaults,
 					$this->hasher,
-					$this->capabilitiesManager
+					$this->eventDispatcher
 				]
 			);
 
@@ -176,7 +178,7 @@ private function getInstance(array $mockedMethods = []) {
 			$this->settingsManager,
 			$this->defaults,
 			$this->hasher,
-			$this->capabilitiesManager
+			$this->eventDispatcher
 		);
 	}
 
@@ -294,7 +296,15 @@ public function testCreateSendPasswordByMailWithEnforcedPasswordProtection() {
 		$node = $this->getMockBuilder(File::class)->getMock();
 		$node->expects($this->any())->method('getName')->willReturn('filename');
 
-		$instance = $this->getInstance(['getSharedWith', 'createMailShare', 'getRawShare', 'createShareObject', 'createShareActivity', 'autoGeneratePassword', 'createPasswordSendActivity']);
+		$this->secureRandom->expects($this->once())
+			->method('generate')
+			->with(8, ISecureRandom::CHAR_LOWER . ISecureRandom::CHAR_UPPER . ISecureRandom::CHAR_DIGITS)
+			->willReturn('autogeneratedPassword');
+		$this->eventDispatcher->expects($this->once())
+			->method('dispatchTyped')
+			->with(new GenerateSecurePasswordEvent());
+
+		$instance = $this->getInstance(['getSharedWith', 'createMailShare', 'getRawShare', 'createShareObject', 'createShareActivity', 'createPasswordSendActivity']);
 
 		$instance->expects($this->once())->method('getSharedWith')->willReturn([]);
 		$instance->expects($this->once())->method('createMailShare')->with($share)->willReturn(42);
@@ -310,7 +320,6 @@ public function testCreateSendPasswordByMailWithEnforcedPasswordProtection() {
 		// The autogenerated password should be mailed to the receiver of the share.
 		$this->settingsManager->expects($this->any())->method('enforcePasswordProtection')->willReturn(true);
 		$this->settingsManager->expects($this->any())->method('sendPasswordByMail')->willReturn(true);
-		$instance->expects($this->once())->method('autoGeneratePassword')->with($share)->willReturn('autogeneratedPassword');
 
 		$message = $this->createMock(IMessage::class);
 		$message->expects($this->once())->method('setTo')->with(['receiver@example.com']);

lib/private/Share20/ProviderFactory.php

@@ -30,7 +30,6 @@
 
 namespace OC\Share20;
 
-use OC\CapabilitiesManager;
 use OC\Share20\Exception\ProviderException;
 use OCA\FederatedFileSharing\AddressHandler;
 use OCA\FederatedFileSharing\FederatedShareProvider;
@@ -184,7 +183,7 @@ protected function getShareByMailProvider() {
 				$settingsManager,
 				$this->serverContainer->query(Defaults::class),
 				$this->serverContainer->getHasher(),
-				$this->serverContainer->query(CapabilitiesManager::class)
+				$this->serverContainer->get(IEventDispatcher::class)
 			);
 		}