- Loading QR Code...
+
+ Loading QR Code...
@lang('base.security.2fa_checkpoint_help')
diff --git a/tests/Unit/Http/Controllers/Base/SecurityControllerTest.php b/tests/Unit/Http/Controllers/Base/SecurityControllerTest.php
index 727f2ab54..3c821729e 100644
--- a/tests/Unit/Http/Controllers/Base/SecurityControllerTest.php
+++ b/tests/Unit/Http/Controllers/Base/SecurityControllerTest.php
@@ -1,69 +1,41 @@
.
- *
- * This software is licensed under the terms of the MIT license.
- * https://opensource.org/licenses/MIT
- */
namespace Tests\Unit\Http\Controllers\Base;
use Mockery as m;
-use Tests\TestCase;
-use Illuminate\Http\Request;
-use Pterodactyl\Models\User;
use Prologue\Alerts\AlertsMessageBag;
-use Illuminate\Contracts\Session\Session;
use Illuminate\Contracts\Config\Repository;
-use Tests\Assertions\ControllerAssertionsTrait;
+use Tests\Unit\Http\Controllers\ControllerTestCase;
use Pterodactyl\Services\Users\TwoFactorSetupService;
use Pterodactyl\Services\Users\ToggleTwoFactorService;
use Pterodactyl\Http\Controllers\Base\SecurityController;
use Pterodactyl\Contracts\Repository\SessionRepositoryInterface;
use Pterodactyl\Exceptions\Service\User\TwoFactorAuthenticationTokenInvalid;
-class SecurityControllerTest extends TestCase
+class SecurityControllerTest extends ControllerTestCase
{
- use ControllerAssertionsTrait;
-
/**
- * @var \Prologue\Alerts\AlertsMessageBag
+ * @var \Prologue\Alerts\AlertsMessageBag|\Mockery\Mock
*/
protected $alert;
/**
- * @var \Illuminate\Contracts\Config\Repository
+ * @var \Illuminate\Contracts\Config\Repository|\Mockery\Mock
*/
protected $config;
/**
- * @var \Pterodactyl\Http\Controllers\Base\SecurityController
- */
- protected $controller;
-
- /**
- * @var \Pterodactyl\Contracts\Repository\SessionRepositoryInterface
+ * @var \Pterodactyl\Contracts\Repository\SessionRepositoryInterface|\Mockery\Mock
*/
protected $repository;
/**
- * @var \Illuminate\Http\Request
- */
- protected $request;
-
- /**
- * @var \Illuminate\Contracts\Session\Session
- */
- protected $session;
-
- /**
- * @var \Pterodactyl\Services\Users\ToggleTwoFactorService
+ * @var \Pterodactyl\Services\Users\ToggleTwoFactorService|\Mockery\Mock
*/
protected $toggleTwoFactorService;
/**
- * @var \Pterodactyl\Services\Users\TwoFactorSetupService
+ * @var \Pterodactyl\Services\Users\TwoFactorSetupService|\Mockery\Mock
*/
protected $twoFactorSetupService;
@@ -77,19 +49,8 @@ class SecurityControllerTest extends TestCase
$this->alert = m::mock(AlertsMessageBag::class);
$this->config = m::mock(Repository::class);
$this->repository = m::mock(SessionRepositoryInterface::class);
- $this->request = m::mock(Request::class);
- $this->session = m::mock(Session::class);
$this->toggleTwoFactorService = m::mock(ToggleTwoFactorService::class);
$this->twoFactorSetupService = m::mock(TwoFactorSetupService::class);
-
- $this->controller = new SecurityController(
- $this->alert,
- $this->config,
- $this->session,
- $this->repository,
- $this->toggleTwoFactorService,
- $this->twoFactorSetupService
- );
}
/**
@@ -97,13 +58,12 @@ class SecurityControllerTest extends TestCase
*/
public function testIndexControllerWithDatabaseDriver()
{
- $model = factory(User::class)->make();
+ $model = $this->setRequestUser();
$this->config->shouldReceive('get')->with('session.driver')->once()->andReturn('database');
- $this->request->shouldReceive('user')->withNoArgs()->once()->andReturn($model);
$this->repository->shouldReceive('getUserSessions')->with($model->id)->once()->andReturn(['sessions']);
- $response = $this->controller->index($this->request);
+ $response = $this->getController()->index($this->request);
$this->assertIsViewResponse($response);
$this->assertViewNameEquals('base.security', $response);
$this->assertViewHasKey('sessions', $response);
@@ -117,7 +77,7 @@ class SecurityControllerTest extends TestCase
{
$this->config->shouldReceive('get')->with('session.driver')->once()->andReturn('redis');
- $response = $this->controller->index($this->request);
+ $response = $this->getController()->index($this->request);
$this->assertIsViewResponse($response);
$this->assertViewNameEquals('base.security', $response);
$this->assertViewHasKey('sessions', $response);
@@ -129,14 +89,13 @@ class SecurityControllerTest extends TestCase
*/
public function testGenerateTotpController()
{
- $model = factory(User::class)->make();
+ $model = $this->setRequestUser();
- $this->request->shouldReceive('user')->withNoArgs()->once()->andReturn($model);
- $this->twoFactorSetupService->shouldReceive('handle')->with($model)->once()->andReturn(['string']);
+ $this->twoFactorSetupService->shouldReceive('handle')->with($model)->once()->andReturn('qrCodeImage');
- $response = $this->controller->generateTotp($this->request);
+ $response = $this->getController()->generateTotp($this->request);
$this->assertIsJsonResponse($response);
- $this->assertResponseJsonEquals(['string'], $response);
+ $this->assertResponseJsonEquals(['qrImage' => 'qrCodeImage'], $response);
}
/**
@@ -144,13 +103,12 @@ class SecurityControllerTest extends TestCase
*/
public function testDisableTotpControllerSuccess()
{
- $model = factory(User::class)->make();
+ $model = $this->setRequestUser();
- $this->request->shouldReceive('user')->withNoArgs()->once()->andReturn($model);
$this->request->shouldReceive('input')->with('token')->once()->andReturn('testToken');
$this->toggleTwoFactorService->shouldReceive('handle')->with($model, 'testToken', false)->once()->andReturnNull();
- $response = $this->controller->disableTotp($this->request);
+ $response = $this->getController()->disableTotp($this->request);
$this->assertIsRedirectResponse($response);
$this->assertRedirectRouteEquals('account.security', $response);
}
@@ -160,16 +118,14 @@ class SecurityControllerTest extends TestCase
*/
public function testDisableTotpControllerWhenExceptionIsThrown()
{
- $model = factory(User::class)->make();
+ $model = $this->setRequestUser();
- $this->request->shouldReceive('user')->withNoArgs()->once()->andReturn($model);
$this->request->shouldReceive('input')->with('token')->once()->andReturn('testToken');
- $this->toggleTwoFactorService->shouldReceive('handle')->with($model, 'testToken', false)->once()
- ->andThrow(new TwoFactorAuthenticationTokenInvalid);
- $this->alert->shouldReceive('danger')->with(trans('base.security.2fa_disable_error'))->once()->andReturnSelf()
- ->shouldReceive('flash')->withNoArgs()->once()->andReturnNull();
+ $this->toggleTwoFactorService->shouldReceive('handle')->with($model, 'testToken', false)->once()->andThrow(new TwoFactorAuthenticationTokenInvalid);
+ $this->alert->shouldReceive('danger')->with(trans('base.security.2fa_disable_error'))->once()->andReturnSelf();
+ $this->alert->shouldReceive('flash')->withNoArgs()->once()->andReturnNull();
- $response = $this->controller->disableTotp($this->request);
+ $response = $this->getController()->disableTotp($this->request);
$this->assertIsRedirectResponse($response);
$this->assertRedirectRouteEquals('account.security', $response);
}
@@ -179,13 +135,28 @@ class SecurityControllerTest extends TestCase
*/
public function testRevokeController()
{
- $model = factory(User::class)->make();
+ $model = $this->setRequestUser();
- $this->request->shouldReceive('user')->withNoArgs()->once()->andReturn($model);
$this->repository->shouldReceive('deleteUserSession')->with($model->id, 123)->once()->andReturnNull();
- $response = $this->controller->revoke($this->request, 123);
+ $response = $this->getController()->revoke($this->request, 123);
$this->assertIsRedirectResponse($response);
$this->assertRedirectRouteEquals('account.security', $response);
}
+
+ /**
+ * Return an instance of the controller for testing with mocked dependencies.
+ *
+ * @return \Pterodactyl\Http\Controllers\Base\SecurityController
+ */
+ private function getController(): SecurityController
+ {
+ return new SecurityController(
+ $this->alert,
+ $this->config,
+ $this->repository,
+ $this->toggleTwoFactorService,
+ $this->twoFactorSetupService
+ );
+ }
}
diff --git a/tests/Unit/Jobs/Schedule/RunTaskJobTest.php b/tests/Unit/Jobs/Schedule/RunTaskJobTest.php
index 176eb4d85..c72ab33b5 100644
--- a/tests/Unit/Jobs/Schedule/RunTaskJobTest.php
+++ b/tests/Unit/Jobs/Schedule/RunTaskJobTest.php
@@ -64,7 +64,7 @@ class RunTaskJobTest extends TestCase
{
parent::setUp();
Bus::fake();
- Carbon::setTestNow();
+ Carbon::setTestNow(Carbon::now());
$this->commandRepository = m::mock(CommandRepositoryInterface::class);
$this->config = m::mock(Repository::class);
diff --git a/tests/Unit/Services/DaemonKeys/DaemonKeyProviderServiceTest.php b/tests/Unit/Services/DaemonKeys/DaemonKeyProviderServiceTest.php
index 7c240b083..87d5f506b 100644
--- a/tests/Unit/Services/DaemonKeys/DaemonKeyProviderServiceTest.php
+++ b/tests/Unit/Services/DaemonKeys/DaemonKeyProviderServiceTest.php
@@ -44,7 +44,7 @@ class DaemonKeyProviderServiceTest extends TestCase
public function setUp()
{
parent::setUp();
- Carbon::setTestNow();
+ Carbon::setTestNow(Carbon::now());
$this->keyCreationService = m::mock(DaemonKeyCreationService::class);
$this->keyUpdateService = m::mock(DaemonKeyUpdateService::class);
diff --git a/tests/Unit/Services/Users/ToggleTwoFactorServiceTest.php b/tests/Unit/Services/Users/ToggleTwoFactorServiceTest.php
index ae45ec8f1..c8d1cc852 100644
--- a/tests/Unit/Services/Users/ToggleTwoFactorServiceTest.php
+++ b/tests/Unit/Services/Users/ToggleTwoFactorServiceTest.php
@@ -1,37 +1,42 @@
.
- *
- * This software is licensed under the terms of the MIT license.
- * https://opensource.org/licenses/MIT
- */
namespace Tests\Unit\Services\Users;
use Mockery as m;
+use Carbon\Carbon;
use Tests\TestCase;
use Pterodactyl\Models\User;
-use PragmaRX\Google2FA\Contracts\Google2FA;
+use PragmaRX\Google2FA\Google2FA;
+use Illuminate\Contracts\Config\Repository;
+use Illuminate\Contracts\Encryption\Encrypter;
use Pterodactyl\Services\Users\ToggleTwoFactorService;
use Pterodactyl\Contracts\Repository\UserRepositoryInterface;
class ToggleTwoFactorServiceTest extends TestCase
{
- /**
- * @var \PragmaRX\Google2FA\Contracts\Google2FA
- */
- protected $google2FA;
+ const TEST_WINDOW_INT = 4;
+ const USER_TOTP_SECRET = 'encryptedValue';
+ const DECRYPTED_USER_SECRET = 'decryptedValue';
/**
- * @var \Pterodactyl\Contracts\Repository\UserRepositoryInterface
+ * @var \Illuminate\Contracts\Config\Repository|\Mockery\Mock
*/
- protected $repository;
+ private $config;
/**
- * @var \Pterodactyl\Services\Users\ToggleTwoFactorService
+ * @var \Illuminate\Contracts\Encryption\Encrypter|\Mockery\Mock
*/
- protected $service;
+ private $encrypter;
+
+ /**
+ * @var \PragmaRX\Google2FA\Google2FA|\Mockery\Mock
+ */
+ private $google2FA;
+
+ /**
+ * @var \Pterodactyl\Contracts\Repository\UserRepositoryInterface|\Mockery\Mock
+ */
+ private $repository;
/**
* Setup tests.
@@ -39,11 +44,15 @@ class ToggleTwoFactorServiceTest extends TestCase
public function setUp()
{
parent::setUp();
+ Carbon::setTestNow(Carbon::now());
+ $this->config = m::mock(Repository::class);
+ $this->encrypter = m::mock(Encrypter::class);
$this->google2FA = m::mock(Google2FA::class);
$this->repository = m::mock(UserRepositoryInterface::class);
- $this->service = new ToggleTwoFactorService($this->google2FA, $this->repository);
+ $this->config->shouldReceive('get')->with('pterodactyl.auth.2fa.window')->once()->andReturn(self::TEST_WINDOW_INT);
+ $this->encrypter->shouldReceive('decrypt')->with(self::USER_TOTP_SECRET)->once()->andReturn(self::DECRYPTED_USER_SECRET);
}
/**
@@ -51,13 +60,15 @@ class ToggleTwoFactorServiceTest extends TestCase
*/
public function testTwoFactorIsEnabledForUser()
{
- $model = factory(User::class)->make(['totp_secret' => 'secret', 'use_totp' => false]);
+ $model = factory(User::class)->make(['totp_secret' => self::USER_TOTP_SECRET, 'use_totp' => false]);
- $this->google2FA->shouldReceive('verifyKey')->with($model->totp_secret, 'test-token', 2)->once()->andReturn(true);
- $this->repository->shouldReceive('withoutFresh')->withNoArgs()->once()->andReturnSelf()
- ->shouldReceive('update')->with($model->id, ['use_totp' => true])->once()->andReturnNull();
+ $this->google2FA->shouldReceive('verifyKey')->with(self::DECRYPTED_USER_SECRET, 'test-token', self::TEST_WINDOW_INT)->once()->andReturn(true);
+ $this->repository->shouldReceive('withoutFresh->update')->with($model->id, [
+ 'totp_authenticated_at' => Carbon::now(),
+ 'use_totp' => true,
+ ])->once()->andReturnNull();
- $this->assertTrue($this->service->handle($model, 'test-token'));
+ $this->assertTrue($this->getService()->handle($model, 'test-token'));
}
/**
@@ -65,13 +76,15 @@ class ToggleTwoFactorServiceTest extends TestCase
*/
public function testTwoFactorIsDisabled()
{
- $model = factory(User::class)->make(['totp_secret' => 'secret', 'use_totp' => true]);
+ $model = factory(User::class)->make(['totp_secret' => self::USER_TOTP_SECRET, 'use_totp' => true]);
- $this->google2FA->shouldReceive('verifyKey')->with($model->totp_secret, 'test-token', 2)->once()->andReturn(true);
- $this->repository->shouldReceive('withoutFresh')->withNoArgs()->once()->andReturnSelf()
- ->shouldReceive('update')->with($model->id, ['use_totp' => false])->once()->andReturnNull();
+ $this->google2FA->shouldReceive('verifyKey')->with(self::DECRYPTED_USER_SECRET, 'test-token', self::TEST_WINDOW_INT)->once()->andReturn(true);
+ $this->repository->shouldReceive('withoutFresh->update')->with($model->id, [
+ 'totp_authenticated_at' => Carbon::now(),
+ 'use_totp' => false,
+ ])->once()->andReturnNull();
- $this->assertTrue($this->service->handle($model, 'test-token'));
+ $this->assertTrue($this->getService()->handle($model, 'test-token'));
}
/**
@@ -79,13 +92,15 @@ class ToggleTwoFactorServiceTest extends TestCase
*/
public function testTwoFactorRemainsDisabledForUser()
{
- $model = factory(User::class)->make(['totp_secret' => 'secret', 'use_totp' => false]);
+ $model = factory(User::class)->make(['totp_secret' => self::USER_TOTP_SECRET, 'use_totp' => false]);
- $this->google2FA->shouldReceive('verifyKey')->with($model->totp_secret, 'test-token', 2)->once()->andReturn(true);
- $this->repository->shouldReceive('withoutFresh')->withNoArgs()->once()->andReturnSelf()
- ->shouldReceive('update')->with($model->id, ['use_totp' => false])->once()->andReturnNull();
+ $this->google2FA->shouldReceive('verifyKey')->with(self::DECRYPTED_USER_SECRET, 'test-token', self::TEST_WINDOW_INT)->once()->andReturn(true);
+ $this->repository->shouldReceive('withoutFresh->update')->with($model->id, [
+ 'totp_authenticated_at' => Carbon::now(),
+ 'use_totp' => false,
+ ])->once()->andReturnNull();
- $this->assertTrue($this->service->handle($model, 'test-token', false));
+ $this->assertTrue($this->getService()->handle($model, 'test-token', false));
}
/**
@@ -95,23 +110,19 @@ class ToggleTwoFactorServiceTest extends TestCase
*/
public function testExceptionIsThrownIfTokenIsInvalid()
{
- $model = factory(User::class)->make();
+ $model = factory(User::class)->make(['totp_secret' => self::USER_TOTP_SECRET]);
$this->google2FA->shouldReceive('verifyKey')->once()->andReturn(false);
- $this->service->handle($model, 'test-token');
+ $this->getService()->handle($model, 'test-token');
}
/**
- * Test that an integer can be passed in place of a user model.
+ * Return an instance of the service with mocked dependencies.
+ *
+ * @return \Pterodactyl\Services\Users\ToggleTwoFactorService
*/
- public function testIntegerCanBePassedInPlaceOfUserModel()
+ private function getService(): ToggleTwoFactorService
{
- $model = factory(User::class)->make(['totp_secret' => 'secret', 'use_totp' => false]);
-
- $this->repository->shouldReceive('find')->with($model->id)->once()->andReturn($model);
- $this->google2FA->shouldReceive('verifyKey')->once()->andReturn(true);
- $this->repository->shouldReceive('withoutFresh->update')->once()->andReturnNull();
-
- $this->assertTrue($this->service->handle($model->id, 'test-token'));
+ return new ToggleTwoFactorService($this->encrypter, $this->google2FA, $this->config, $this->repository);
}
}
diff --git a/tests/Unit/Services/Users/TwoFactorSetupServiceTest.php b/tests/Unit/Services/Users/TwoFactorSetupServiceTest.php
index e58d99f2c..d6f5f8b90 100644
--- a/tests/Unit/Services/Users/TwoFactorSetupServiceTest.php
+++ b/tests/Unit/Services/Users/TwoFactorSetupServiceTest.php
@@ -1,43 +1,37 @@
.
- *
- * This software is licensed under the terms of the MIT license.
- * https://opensource.org/licenses/MIT
- */
namespace Tests\Unit\Services\Users;
use Mockery as m;
use Tests\TestCase;
use Pterodactyl\Models\User;
+use PragmaRX\Google2FA\Google2FA;
use Illuminate\Contracts\Config\Repository;
-use PragmaRX\Google2FA\Contracts\Google2FA;
+use Illuminate\Contracts\Encryption\Encrypter;
use Pterodactyl\Services\Users\TwoFactorSetupService;
use Pterodactyl\Contracts\Repository\UserRepositoryInterface;
class TwoFactorSetupServiceTest extends TestCase
{
/**
- * @var \Illuminate\Contracts\Config\Repository
+ * @var \Illuminate\Contracts\Config\Repository|\Mockery\Mock
*/
- protected $config;
+ private $config;
/**
- * @var \PragmaRX\Google2FA\Contracts\Google2FA
+ * @var \Illuminate\Contracts\Encryption\Encrypter|\Mockery\Mock
*/
- protected $google2FA;
+ private $encrypter;
/**
- * @var \Pterodactyl\Contracts\Repository\UserRepositoryInterface
+ * @var \PragmaRX\Google2FA\Google2FA|\Mockery\Mock
*/
- protected $repository;
+ private $google2FA;
/**
- * @var \Pterodactyl\Services\Users\TwoFactorSetupService
+ * @var \Pterodactyl\Contracts\Repository\UserRepositoryInterface|\Mockery\Mock
*/
- protected $service;
+ private $repository;
/**
* Setup tests.
@@ -47,10 +41,9 @@ class TwoFactorSetupServiceTest extends TestCase
parent::setUp();
$this->config = m::mock(Repository::class);
+ $this->encrypter = m::mock(Encrypter::class);
$this->google2FA = m::mock(Google2FA::class);
$this->repository = m::mock(UserRepositoryInterface::class);
-
- $this->service = new TwoFactorSetupService($this->config, $this->google2FA, $this->repository);
}
/**
@@ -60,34 +53,25 @@ class TwoFactorSetupServiceTest extends TestCase
{
$model = factory(User::class)->make();
- $this->google2FA->shouldReceive('generateSecretKey')->withNoArgs()->once()->andReturn('secretKey');
+ $this->config->shouldReceive('get')->with('pterodactyl.auth.2fa.bytes')->once()->andReturn(32);
+ $this->google2FA->shouldReceive('generateSecretKey')->with(32)->once()->andReturn('secretKey');
$this->config->shouldReceive('get')->with('app.name')->once()->andReturn('CompanyName');
- $this->google2FA->shouldReceive('getQRCodeGoogleUrl')->with('CompanyName', $model->email, 'secretKey')
- ->once()->andReturn('http://url.com');
- $this->repository->shouldReceive('withoutFresh')->withNoArgs()->once()->andReturnSelf()
- ->shouldReceive('update')->with($model->id, ['totp_secret' => 'secretKey'])->once()->andReturnNull();
+ $this->google2FA->shouldReceive('getQRCodeGoogleUrl')->with('CompanyName', $model->email, 'secretKey')->once()->andReturn('http://url.com');
+ $this->encrypter->shouldReceive('encrypt')->with('secretKey')->once()->andReturn('encryptedSecret');
+ $this->repository->shouldReceive('withoutFresh->update')->with($model->id, ['totp_secret' => 'encryptedSecret'])->once()->andReturnNull();
- $response = $this->service->handle($model);
+ $response = $this->getService()->handle($model);
$this->assertNotEmpty($response);
- $this->assertArrayHasKey('qrImage', $response);
- $this->assertArrayHasKey('secret', $response);
- $this->assertEquals('http://url.com', $response['qrImage']);
- $this->assertEquals('secretKey', $response['secret']);
+ $this->assertSame('http://url.com', $response);
}
/**
- * Test that an integer can be passed in place of the user model.
+ * Return an instance of the service to test with mocked dependencies.
+ *
+ * @return \Pterodactyl\Services\Users\TwoFactorSetupService
*/
- public function testIntegerCanBePassedInPlaceOfUserModel()
+ private function getService(): TwoFactorSetupService
{
- $model = factory(User::class)->make();
-
- $this->repository->shouldReceive('find')->with($model->id)->once()->andReturn($model);
- $this->google2FA->shouldReceive('generateSecretKey')->withNoArgs()->once()->andReturnNull();
- $this->config->shouldReceive('get')->with('app.name')->once()->andReturnNull();
- $this->google2FA->shouldReceive('getQRCodeGoogleUrl')->once()->andReturnNull();
- $this->repository->shouldReceive('withoutFresh->update')->once()->andReturnNull();
-
- $this->assertTrue(is_array($this->service->handle($model->id)));
+ return new TwoFactorSetupService($this->config, $this->encrypter, $this->google2FA, $this->repository);
}
}