* @author Björn Schießle * @author Christoph Wurst * @author Clark Tomlinson * @author Joas Schilling * @author Morris Jobke * @author Roeland Jago Douma * * @license AGPL-3.0 * * This code is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License, version 3, * as published by the Free Software Foundation. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License, version 3, * along with this program. If not, see * */ namespace OCA\Encryption\Tests\Hooks; use OCA\Encryption\Crypto\Crypt; use OCA\Encryption\Hooks\UserHooks; use OCA\Encryption\KeyManager; use OCA\Encryption\Recovery; use OCA\Encryption\Session; use OCA\Encryption\Users\Setup; use OCA\Encryption\Util; use OCP\IUser; use OCP\IUserManager; use OCP\IUserSession; use PHPUnit\Framework\MockObject\MockObject; use Psr\Log\LoggerInterface; use Test\TestCase; /** * Class UserHooksTest * * @group DB * @package OCA\Encryption\Tests\Hooks */ class UserHooksTest extends TestCase { /** * @var \PHPUnit\Framework\MockObject\MockObject */ private $utilMock; /** * @var \PHPUnit\Framework\MockObject\MockObject */ private $recoveryMock; /** * @var \PHPUnit\Framework\MockObject\MockObject */ private $sessionMock; /** * @var \PHPUnit\Framework\MockObject\MockObject */ private $keyManagerMock; /** * @var \PHPUnit\Framework\MockObject\MockObject */ private $userManagerMock; /** * @var \PHPUnit\Framework\MockObject\MockObject */ private $userSetupMock; /** * @var \PHPUnit\Framework\MockObject\MockObject */ private $userSessionMock; /** * @var MockObject|IUser */ private $user; /** * @var \PHPUnit\Framework\MockObject\MockObject */ private $cryptMock; /** * @var \PHPUnit\Framework\MockObject\MockObject */ private $loggerMock; /** * @var UserHooks */ private $instance; private $params = ['uid' => 'testUser', 'password' => 'password']; public function testLogin() { $this->userSetupMock->expects($this->once()) ->method('setupUser') ->willReturnOnConsecutiveCalls(true, false); $this->keyManagerMock->expects($this->once()) ->method('init') ->with('testUser', 'password'); $this->assertNull($this->instance->login($this->params)); } public function testLogout() { $this->sessionMock->expects($this->once()) ->method('clear'); $this->instance->logout(); $this->addToAssertionCount(1); } public function testPostCreateUser() { $this->userSetupMock->expects($this->once()) ->method('setupUser'); $this->instance->postCreateUser($this->params); $this->addToAssertionCount(1); } public function testPostDeleteUser() { $this->keyManagerMock->expects($this->once()) ->method('deletePublicKey') ->with('testUser'); $this->instance->postDeleteUser($this->params); $this->addToAssertionCount(1); } public function testPrePasswordReset() { $params = ['uid' => 'user1']; $expected = ['user1' => true]; $this->instance->prePasswordReset($params); $passwordResetUsers = $this->invokePrivate($this->instance, 'passwordResetUsers'); $this->assertSame($expected, $passwordResetUsers); } public function testPostPasswordReset() { $params = ['uid' => 'user1', 'password' => 'password']; $this->invokePrivate($this->instance, 'passwordResetUsers', [['user1' => true]]); $this->keyManagerMock->expects($this->once())->method('backupUserKeys') ->with('passwordReset', 'user1'); $this->keyManagerMock->expects($this->once())->method('deleteUserKeys') ->with('user1'); $this->userSetupMock->expects($this->once())->method('setupUser') ->with('user1', 'password'); $this->instance->postPasswordReset($params); $passwordResetUsers = $this->invokePrivate($this->instance, 'passwordResetUsers'); $this->assertEmpty($passwordResetUsers); } /** * @dataProvider dataTestPreSetPassphrase */ public function testPreSetPassphrase($canChange) { /** @var UserHooks | \PHPUnit\Framework\MockObject\MockObject $instance */ $instance = $this->getMockBuilder(UserHooks::class) ->setConstructorArgs( [ $this->keyManagerMock, $this->userManagerMock, $this->loggerMock, $this->userSetupMock, $this->userSessionMock, $this->utilMock, $this->sessionMock, $this->cryptMock, $this->recoveryMock ] ) ->setMethods(['setPassphrase']) ->getMock(); $userMock = $this->createMock(IUser::class); $this->userManagerMock->expects($this->once()) ->method('get') ->with($this->params['uid']) ->willReturn($userMock); $userMock->expects($this->once()) ->method('canChangePassword') ->willReturn($canChange); if ($canChange) { // in this case the password will be changed in the post hook $instance->expects($this->never())->method('setPassphrase'); } else { // if user can't change the password we update the encryption // key password already in the pre hook $instance->expects($this->once()) ->method('setPassphrase') ->with($this->params); } $instance->preSetPassphrase($this->params); } public function dataTestPreSetPassphrase() { return [ [true], [false] ]; } public function XtestSetPassphrase() { $this->sessionMock->expects($this->once()) ->method('getPrivateKey') ->willReturn(true); $this->cryptMock->expects($this->exactly(4)) ->method('encryptPrivateKey') ->willReturn(true); $this->cryptMock->expects($this->any()) ->method('generateHeader') ->willReturn(Crypt::HEADER_START . ':Cipher:test:' . Crypt::HEADER_END); $this->keyManagerMock->expects($this->exactly(4)) ->method('setPrivateKey') ->willReturnCallback(function ($user, $key) { $header = substr($key, 0, strlen(Crypt::HEADER_START)); $this->assertSame( Crypt::HEADER_START, $header, 'every encrypted file should start with a header'); }); $this->assertNull($this->instance->setPassphrase($this->params)); $this->params['recoveryPassword'] = 'password'; $this->recoveryMock->expects($this->exactly(3)) ->method('isRecoveryEnabledForUser') ->with('testUser1') ->willReturnOnConsecutiveCalls(true, false); $this->instance = $this->getMockBuilder(UserHooks::class) ->setConstructorArgs( [ $this->keyManagerMock, $this->userManagerMock, $this->loggerMock, $this->userSetupMock, $this->userSessionMock, $this->utilMock, $this->sessionMock, $this->cryptMock, $this->recoveryMock ] )->setMethods(['initMountPoints'])->getMock(); $this->instance->expects($this->exactly(3))->method('initMountPoints'); $this->params['uid'] = 'testUser1'; // Test first if statement $this->assertNull($this->instance->setPassphrase($this->params)); // Test Second if conditional $this->keyManagerMock->expects($this->exactly(2)) ->method('userHasKeys') ->with('testUser1') ->willReturn(true); $this->assertNull($this->instance->setPassphrase($this->params)); // Test third and final if condition $this->utilMock->expects($this->once()) ->method('userHasFiles') ->with('testUser1') ->willReturn(false); $this->cryptMock->expects($this->once()) ->method('createKeyPair'); $this->keyManagerMock->expects($this->once()) ->method('setPrivateKey'); $this->recoveryMock->expects($this->once()) ->method('recoverUsersFiles') ->with('password', 'testUser1'); $this->assertNull($this->instance->setPassphrase($this->params)); } public function testSetPassphraseResetUserMode() { $params = ['uid' => 'user1', 'password' => 'password']; $this->invokePrivate($this->instance, 'passwordResetUsers', [[$params['uid'] => true]]); $this->sessionMock->expects($this->never())->method('getPrivateKey'); $this->keyManagerMock->expects($this->never())->method('setPrivateKey'); $this->assertTrue($this->instance->setPassphrase($params)); $this->invokePrivate($this->instance, 'passwordResetUsers', [[]]); } public function XtestSetPasswordNoUser() { $userSessionMock = $this->getMockBuilder(IUserSession::class) ->disableOriginalConstructor() ->getMock(); $userSessionMock->expects($this->any())->method('getUser')->willReturn(null); $this->recoveryMock->expects($this->once()) ->method('isRecoveryEnabledForUser') ->with('testUser') ->willReturn(false); $userHooks = $this->getMockBuilder(UserHooks::class) ->setConstructorArgs( [ $this->keyManagerMock, $this->userManagerMock, $this->loggerMock, $this->userSetupMock, $userSessionMock, $this->utilMock, $this->sessionMock, $this->cryptMock, $this->recoveryMock ] )->setMethods(['initMountPoints'])->getMock(); /** @var \OCA\Encryption\Hooks\UserHooks $userHooks */ $this->assertNull($userHooks->setPassphrase($this->params)); } protected function setUp(): void { parent::setUp(); $this->loggerMock = $this->createMock(LoggerInterface::class); $this->keyManagerMock = $this->getMockBuilder(KeyManager::class) ->disableOriginalConstructor() ->getMock(); $this->userManagerMock = $this->getMockBuilder(IUserManager::class) ->disableOriginalConstructor() ->getMock(); $this->userSetupMock = $this->getMockBuilder(Setup::class) ->disableOriginalConstructor() ->getMock(); $this->user = $this->createMock(IUser::class); $this->user->expects($this->any()) ->method('getUID') ->willReturn('testUser'); $this->userSessionMock = $this->createMock(IUserSession::class); $this->userSessionMock->expects($this->any()) ->method('getUser') ->willReturn($this->user); $utilMock = $this->getMockBuilder(Util::class) ->disableOriginalConstructor() ->getMock(); $sessionMock = $this->getMockBuilder(Session::class) ->disableOriginalConstructor() ->getMock(); $this->cryptMock = $this->getMockBuilder(Crypt::class) ->disableOriginalConstructor() ->getMock(); $recoveryMock = $this->getMockBuilder(Recovery::class) ->disableOriginalConstructor() ->getMock(); $this->sessionMock = $sessionMock; $this->recoveryMock = $recoveryMock; $this->utilMock = $utilMock; $this->utilMock->expects($this->any())->method('isMasterKeyEnabled')->willReturn(false); $this->instance = $this->getMockBuilder(UserHooks::class) ->setConstructorArgs( [ $this->keyManagerMock, $this->userManagerMock, $this->loggerMock, $this->userSetupMock, $this->userSessionMock, $this->utilMock, $this->sessionMock, $this->cryptMock, $this->recoveryMock ] )->setMethods(['setupFS'])->getMock(); } }