123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453 |
- <?php
- /**
- * @author Christoph Wurst <christoph@owncloud.com>
- *
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- * @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 <http://www.gnu.org/licenses/>
- *
- */
- namespace Test\Core\Controller;
- use OC\Authentication\TwoFactorAuth\Manager;
- use OC\Authentication\TwoFactorAuth\ProviderSet;
- use OC\Core\Controller\TwoFactorChallengeController;
- use OCP\AppFramework\Http\RedirectResponse;
- use OCP\AppFramework\Http\StandaloneTemplateResponse;
- use OCP\Authentication\TwoFactorAuth\IActivatableAtLogin;
- use OCP\Authentication\TwoFactorAuth\ILoginSetupProvider;
- use OCP\Authentication\TwoFactorAuth\IProvider;
- use OCP\Authentication\TwoFactorAuth\TwoFactorException;
- use OCP\IRequest;
- use OCP\ISession;
- use OCP\IURLGenerator;
- use OCP\IUser;
- use OCP\IUserSession;
- use OCP\Template;
- use Psr\Log\LoggerInterface;
- use Test\TestCase;
- class TwoFactorChallengeControllerTest extends TestCase {
- /** @var IRequest|\PHPUnit\Framework\MockObject\MockObject */
- private $request;
- /** @var Manager|\PHPUnit\Framework\MockObject\MockObject */
- private $twoFactorManager;
- /** @var IUserSession|\PHPUnit\Framework\MockObject\MockObject */
- private $userSession;
- /** @var ISession|\PHPUnit\Framework\MockObject\MockObject */
- private $session;
- /** @var IURLGenerator|\PHPUnit\Framework\MockObject\MockObject */
- private $urlGenerator;
- /** @var LoggerInterface|\PHPUnit\Framework\MockObject\MockObject */
- private $logger;
- /** @var TwoFactorChallengeController|\PHPUnit\Framework\MockObject\MockObject */
- private $controller;
- protected function setUp(): void {
- parent::setUp();
- $this->request = $this->createMock(IRequest::class);
- $this->twoFactorManager = $this->createMock(Manager::class);
- $this->userSession = $this->createMock(IUserSession::class);
- $this->session = $this->createMock(ISession::class);
- $this->urlGenerator = $this->createMock(IURLGenerator::class);
- $this->logger = $this->createMock(LoggerInterface::class);
- $this->controller = $this->getMockBuilder(TwoFactorChallengeController::class)
- ->setConstructorArgs([
- 'core',
- $this->request,
- $this->twoFactorManager,
- $this->userSession,
- $this->session,
- $this->urlGenerator,
- $this->logger,
- ])
- ->setMethods(['getLogoutUrl'])
- ->getMock();
- $this->controller->expects($this->any())
- ->method('getLogoutUrl')
- ->willReturn('logoutAttribute');
- }
- public function testSelectChallenge() {
- $user = $this->getMockBuilder(IUser::class)->getMock();
- $p1 = $this->createMock(IActivatableAtLogin::class);
- $p1->method('getId')->willReturn('p1');
- $backupProvider = $this->createMock(IProvider::class);
- $backupProvider->method('getId')->willReturn('backup_codes');
- $providerSet = new ProviderSet([$p1, $backupProvider], true);
- $this->twoFactorManager->expects($this->once())
- ->method('getLoginSetupProviders')
- ->with($user)
- ->willReturn([$p1]);
- $this->userSession->expects($this->once())
- ->method('getUser')
- ->willReturn($user);
- $this->twoFactorManager->expects($this->once())
- ->method('getProviderSet')
- ->with($user)
- ->willReturn($providerSet);
- $expected = new StandaloneTemplateResponse('core', 'twofactorselectchallenge', [
- 'providers' => [
- $p1,
- ],
- 'providerMissing' => true,
- 'backupProvider' => $backupProvider,
- 'redirect_url' => '/some/url',
- 'logout_url' => 'logoutAttribute',
- 'hasSetupProviders' => true,
- ], 'guest');
- $this->assertEquals($expected, $this->controller->selectChallenge('/some/url'));
- }
- public function testShowChallenge() {
- $user = $this->createMock(IUser::class);
- $provider = $this->createMock(IProvider::class);
- $provider->method('getId')->willReturn('myprovider');
- $backupProvider = $this->createMock(IProvider::class);
- $backupProvider->method('getId')->willReturn('backup_codes');
- $tmpl = $this->createMock(Template::class);
- $providerSet = new ProviderSet([$provider, $backupProvider], true);
- $this->userSession->expects($this->once())
- ->method('getUser')
- ->willReturn($user);
- $this->twoFactorManager->expects($this->once())
- ->method('getProviderSet')
- ->with($user)
- ->willReturn($providerSet);
- $provider->expects($this->once())
- ->method('getId')
- ->willReturn('u2f');
- $backupProvider->expects($this->once())
- ->method('getId')
- ->willReturn('backup_codes');
- $this->session->expects($this->once())
- ->method('exists')
- ->with('two_factor_auth_error')
- ->willReturn(true);
- $this->session->expects($this->exactly(2))
- ->method('remove')
- ->with($this->logicalOr($this->equalTo('two_factor_auth_error'), $this->equalTo('two_factor_auth_error_message')));
- $provider->expects($this->once())
- ->method('getTemplate')
- ->with($user)
- ->willReturn($tmpl);
- $tmpl->expects($this->once())
- ->method('fetchPage')
- ->willReturn('<html/>');
- $expected = new StandaloneTemplateResponse('core', 'twofactorshowchallenge', [
- 'error' => true,
- 'provider' => $provider,
- 'backupProvider' => $backupProvider,
- 'logout_url' => 'logoutAttribute',
- 'template' => '<html/>',
- 'redirect_url' => '/re/dir/ect/url',
- 'error_message' => null,
- ], 'guest');
- $this->assertEquals($expected, $this->controller->showChallenge('myprovider', '/re/dir/ect/url'));
- }
- public function testShowInvalidChallenge() {
- $user = $this->createMock(IUser::class);
- $providerSet = new ProviderSet([], false);
- $this->userSession->expects($this->once())
- ->method('getUser')
- ->willReturn($user);
- $this->twoFactorManager->expects($this->once())
- ->method('getProviderSet')
- ->with($user)
- ->willReturn($providerSet);
- $this->urlGenerator->expects($this->once())
- ->method('linkToRoute')
- ->with('core.TwoFactorChallenge.selectChallenge')
- ->willReturn('select/challenge/url');
- $expected = new RedirectResponse('select/challenge/url');
- $this->assertEquals($expected, $this->controller->showChallenge('myprovider', 'redirect/url'));
- }
- public function testSolveChallenge() {
- $user = $this->createMock(IUser::class);
- $provider = $this->createMock(IProvider::class);
- $this->userSession->expects($this->once())
- ->method('getUser')
- ->willReturn($user);
- $this->twoFactorManager->expects($this->once())
- ->method('getProvider')
- ->with($user, 'myprovider')
- ->willReturn($provider);
- $this->twoFactorManager->expects($this->once())
- ->method('verifyChallenge')
- ->with('myprovider', $user, 'token')
- ->willReturn(true);
- $this->urlGenerator
- ->expects($this->once())
- ->method('linkToDefaultPageUrl')
- ->willReturn('/default/foo');
- $expected = new RedirectResponse('/default/foo');
- $this->assertEquals($expected, $this->controller->solveChallenge('myprovider', 'token'));
- }
- public function testSolveValidChallengeAndRedirect() {
- $user = $this->createMock(IUser::class);
- $provider = $this->createMock(IProvider::class);
- $this->userSession->expects($this->once())
- ->method('getUser')
- ->willReturn($user);
- $this->twoFactorManager->expects($this->once())
- ->method('getProvider')
- ->with($user, 'myprovider')
- ->willReturn($provider);
- $this->twoFactorManager->expects($this->once())
- ->method('verifyChallenge')
- ->with('myprovider', $user, 'token')
- ->willReturn(true);
- $this->urlGenerator->expects($this->once())
- ->method('getAbsoluteURL')
- ->with('redirect url')
- ->willReturn('redirect/url');
- $expected = new RedirectResponse('redirect/url');
- $this->assertEquals($expected, $this->controller->solveChallenge('myprovider', 'token', 'redirect%20url'));
- }
- public function testSolveChallengeInvalidProvider() {
- $user = $this->getMockBuilder(IUser::class)->getMock();
- $this->userSession->expects($this->once())
- ->method('getUser')
- ->willReturn($user);
- $this->twoFactorManager->expects($this->once())
- ->method('getProvider')
- ->with($user, 'myprovider')
- ->willReturn(null);
- $this->urlGenerator->expects($this->once())
- ->method('linkToRoute')
- ->with('core.TwoFactorChallenge.selectChallenge')
- ->willReturn('select/challenge/url');
- $expected = new RedirectResponse('select/challenge/url');
- $this->assertEquals($expected, $this->controller->solveChallenge('myprovider', 'token'));
- }
- public function testSolveInvalidChallenge() {
- $user = $this->createMock(IUser::class);
- $provider = $this->createMock(IProvider::class);
- $this->userSession->expects($this->once())
- ->method('getUser')
- ->willReturn($user);
- $this->twoFactorManager->expects($this->once())
- ->method('getProvider')
- ->with($user, 'myprovider')
- ->willReturn($provider);
- $this->twoFactorManager->expects($this->once())
- ->method('verifyChallenge')
- ->with('myprovider', $user, 'token')
- ->willReturn(false);
- $this->session->expects($this->once())
- ->method('set')
- ->with('two_factor_auth_error', true);
- $this->urlGenerator->expects($this->once())
- ->method('linkToRoute')
- ->with('core.TwoFactorChallenge.showChallenge', [
- 'challengeProviderId' => 'myprovider',
- 'redirect_url' => '/url',
- ])
- ->willReturn('files/index/url');
- $provider->expects($this->once())
- ->method('getId')
- ->willReturn('myprovider');
- $expected = new RedirectResponse('files/index/url');
- $this->assertEquals($expected, $this->controller->solveChallenge('myprovider', 'token', '/url'));
- }
- public function testSolveChallengeTwoFactorException() {
- $user = $this->createMock(IUser::class);
- $provider = $this->createMock(IProvider::class);
- $exception = new TwoFactorException("2FA failed");
- $this->userSession->expects($this->once())
- ->method('getUser')
- ->willReturn($user);
- $this->twoFactorManager->expects($this->once())
- ->method('getProvider')
- ->with($user, 'myprovider')
- ->willReturn($provider);
- $this->twoFactorManager->expects($this->once())
- ->method('verifyChallenge')
- ->with('myprovider', $user, 'token')
- ->will($this->throwException($exception));
- $this->session->expects($this->exactly(2))
- ->method('set')
- ->withConsecutive(
- ['two_factor_auth_error_message', '2FA failed'],
- ['two_factor_auth_error', true]
- );
- $this->urlGenerator->expects($this->once())
- ->method('linkToRoute')
- ->with('core.TwoFactorChallenge.showChallenge', [
- 'challengeProviderId' => 'myprovider',
- 'redirect_url' => '/url',
- ])
- ->willReturn('files/index/url');
- $provider->expects($this->once())
- ->method('getId')
- ->willReturn('myprovider');
- $expected = new RedirectResponse('files/index/url');
- $this->assertEquals($expected, $this->controller->solveChallenge('myprovider', 'token', '/url'));
- }
- public function testSetUpProviders() {
- $user = $this->createMock(IUser::class);
- $this->userSession->expects($this->once())
- ->method('getUser')
- ->willReturn($user);
- $provider = $this->createMock(IActivatableAtLogin::class);
- $this->twoFactorManager->expects($this->once())
- ->method('getLoginSetupProviders')
- ->with($user)
- ->willReturn([
- $provider,
- ]);
- $expected = new StandaloneTemplateResponse(
- 'core',
- 'twofactorsetupselection',
- [
- 'providers' => [
- $provider,
- ],
- 'logout_url' => 'logoutAttribute',
- ],
- 'guest'
- );
- $response = $this->controller->setupProviders();
- $this->assertEquals($expected, $response);
- }
- public function testSetUpInvalidProvider() {
- $user = $this->createMock(IUser::class);
- $this->userSession->expects($this->once())
- ->method('getUser')
- ->willReturn($user);
- $provider = $this->createMock(IActivatableAtLogin::class);
- $provider->expects($this->any())
- ->method('getId')
- ->willReturn('prov1');
- $this->twoFactorManager->expects($this->once())
- ->method('getLoginSetupProviders')
- ->with($user)
- ->willReturn([
- $provider,
- ]);
- $this->urlGenerator->expects($this->once())
- ->method('linkToRoute')
- ->with('core.TwoFactorChallenge.selectChallenge')
- ->willReturn('2fa/select/page');
- $expected = new RedirectResponse('2fa/select/page');
- $response = $this->controller->setupProvider('prov2');
- $this->assertEquals($expected, $response);
- }
- public function testSetUpProvider() {
- $user = $this->createMock(IUser::class);
- $this->userSession->expects($this->once())
- ->method('getUser')
- ->willReturn($user);
- $provider = $this->createMock(IActivatableAtLogin::class);
- $provider->expects($this->any())
- ->method('getId')
- ->willReturn('prov1');
- $this->twoFactorManager->expects($this->once())
- ->method('getLoginSetupProviders')
- ->with($user)
- ->willReturn([
- $provider,
- ]);
- $loginSetup = $this->createMock(ILoginSetupProvider::class);
- $provider->expects($this->any())
- ->method('getLoginSetup')
- ->with($user)
- ->willReturn($loginSetup);
- $tmpl = $this->createMock(Template::class);
- $loginSetup->expects($this->once())
- ->method('getBody')
- ->willReturn($tmpl);
- $tmpl->expects($this->once())
- ->method('fetchPage')
- ->willReturn('tmpl');
- $expected = new StandaloneTemplateResponse(
- 'core',
- 'twofactorsetupchallenge',
- [
- 'provider' => $provider,
- 'logout_url' => 'logoutAttribute',
- 'template' => 'tmpl',
- ],
- 'guest'
- );
- $response = $this->controller->setupProvider('prov1');
- $this->assertEquals($expected, $response);
- }
- public function testConfirmProviderSetup() {
- $this->urlGenerator->expects($this->once())
- ->method('linkToRoute')
- ->with(
- 'core.TwoFactorChallenge.showChallenge',
- [
- 'challengeProviderId' => 'totp',
- ])
- ->willReturn('2fa/select/page');
- $expected = new RedirectResponse('2fa/select/page');
- $response = $this->controller->confirmProviderSetup('totp');
- $this->assertEquals($expected, $response);
- }
- }
|