Change the way API keys are stored and validated; clarify API namespacing

Previously, a single key was used to access the API, this has not changed in terms of what the user sees. However, API keys now use an identifier and token internally. The identifier is the first 16 characters of the key, and the token is the remaining 32. The token is stored encrypted at rest in the database and the identifier is used by the API middleware to grab that record and make a timing attack safe comparison.

tests/Unit/Http/Middleware/Api/Admin/AuthenticateIPAccessTest.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Tests\Unit\Http\Middleware\Api\Admin;
+
+use Pterodactyl\Models\APIKey;
+use Tests\Unit\Http\Middleware\MiddlewareTestCase;
+use Pterodactyl\Http\Middleware\Api\Admin\AuthenticateIPAccess;
+
+class AuthenticateIPAccessTest extends MiddlewareTestCase
+{
+    /**
+     * Test middleware when there are no IP restrictions.
+     */
+    public function testWithNoIPRestrictions()
+    {
+        $model = factory(APIKey::class)->make(['allowed_ips' => []]);
+        $this->setRequestAttribute('api_key', $model);
+
+        $this->getMiddleware()->handle($this->request, $this->getClosureAssertions());
+    }
+
+    /**
+     * Test middleware works correctly when a valid IP accesses
+     * and there is an IP restriction.
+     */
+    public function testWithValidIP()
+    {
+        $model = factory(APIKey::class)->make(['allowed_ips' => ['127.0.0.1']]);
+        $this->setRequestAttribute('api_key', $model);
+
+        $this->request->shouldReceive('ip')->withNoArgs()->once()->andReturn('127.0.0.1');
+
+        $this->getMiddleware()->handle($this->request, $this->getClosureAssertions());
+    }
+
+    /**
+     * Test that a CIDR range can be used.
+     */
+    public function testValidIPAganistCIDRRange()
+    {
+        $model = factory(APIKey::class)->make(['allowed_ips' => ['192.168.1.1/28']]);
+        $this->setRequestAttribute('api_key', $model);
+
+        $this->request->shouldReceive('ip')->withNoArgs()->once()->andReturn('192.168.1.15');
+
+        $this->getMiddleware()->handle($this->request, $this->getClosureAssertions());
+    }
+
+    /**
+     * Test that an exception is thrown when an invalid IP address
+     * tries to connect and there is an IP restriction.
+     *
+     * @expectedException \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
+     */
+    public function testWithInvalidIP()
+    {
+        $model = factory(APIKey::class)->make(['allowed_ips' => ['127.0.0.1']]);
+        $this->setRequestAttribute('api_key', $model);
+
+        $this->request->shouldReceive('ip')->withNoArgs()->once()->andReturn('127.0.0.2');
+
+        $this->getMiddleware()->handle($this->request, $this->getClosureAssertions());
+    }
+
+    /**
+     * Return an instance of the middleware to be used when testing.
+     *
+     * @return \Pterodactyl\Http\Middleware\Api\Admin\AuthenticateIPAccess
+     */
+    private function getMiddleware(): AuthenticateIPAccess
+    {
+        return new AuthenticateIPAccess();
+    }
+}

tests/Unit/Http/Middleware/Api/Admin/AuthenticateKeyTest.php

@@ -0,0 +1,114 @@
+<?php
+
+namespace Tests\Unit\Http\Middleware\Api;
+
+use Mockery as m;
+use Pterodactyl\Models\APIKey;
+use Illuminate\Auth\AuthManager;
+use Illuminate\Contracts\Encryption\Encrypter;
+use Tests\Unit\Http\Middleware\MiddlewareTestCase;
+use Symfony\Component\HttpKernel\Exception\HttpException;
+use Pterodactyl\Http\Middleware\Api\Admin\AuthenticateKey;
+use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
+use Pterodactyl\Contracts\Repository\ApiKeyRepositoryInterface;
+
+class AuthenticateKeyTest extends MiddlewareTestCase
+{
+    /**
+     * @var \Illuminate\Auth\AuthManager|\Mockery\Mock
+     */
+    private $auth;
+
+    /**
+     * @var \Illuminate\Contracts\Encryption\Encrypter|\Mockery\Mock
+     */
+    private $encrypter;
+
+    /**
+     * @var \Pterodactyl\Contracts\Repository\ApiKeyRepositoryInterface|\Mockery\Mock
+     */
+    private $repository;
+
+    /**
+     * Setup tests.
+     */
+    public function setUp()
+    {
+        parent::setUp();
+
+        $this->auth = m::mock(AuthManager::class);
+        $this->encrypter = m::mock(Encrypter::class);
+        $this->repository = m::mock(ApiKeyRepositoryInterface::class);
+    }
+
+    /**
+     * Test that a missing bearer token will throw an exception.
+     */
+    public function testMissingBearerTokenThrowsException()
+    {
+        $this->request->shouldReceive('bearerToken')->withNoArgs()->once()->andReturnNull();
+
+        try {
+            $this->getMiddleware()->handle($this->request, $this->getClosureAssertions());
+        } catch (HttpException $exception) {
+            $this->assertEquals(401, $exception->getStatusCode());
+            $this->assertEquals(['WWW-Authenticate' => 'Bearer'], $exception->getHeaders());
+        }
+    }
+
+    /**
+     * Test that an invalid API identifer throws an exception.
+     *
+     * @expectedException \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
+     */
+    public function testInvalidIdentifier()
+    {
+        $this->request->shouldReceive('bearerToken')->withNoArgs()->twice()->andReturn('abcd1234');
+        $this->repository->shouldReceive('findFirstWhere')->andThrow(new RecordNotFoundException);
+
+        $this->getMiddleware()->handle($this->request, $this->getClosureAssertions());
+    }
+
+    /**
+     * Test that a valid token can continue past the middleware.
+     */
+    public function testValidToken()
+    {
+        $model = factory(APIKey::class)->make();
+
+        $this->request->shouldReceive('bearerToken')->withNoArgs()->twice()->andReturn($model->identifier . 'decrypted');
+        $this->repository->shouldReceive('findFirstWhere')->with([['identifier', '=', $model->identifier]])->once()->andReturn($model);
+        $this->encrypter->shouldReceive('decrypt')->with($model->token)->once()->andReturn('decrypted');
+        $this->auth->shouldReceive('guard->loginUsingId')->with($model->user_id)->once()->andReturnNull();
+
+        $this->getMiddleware()->handle($this->request, $this->getClosureAssertions());
+        $this->assertEquals($model, $this->request->attributes->get('api_key'));
+    }
+
+    /**
+     * Test that a valid token identifier with an invalid token attached to it
+     * triggers an exception.
+     *
+     * @expectedException \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
+     */
+    public function testInvalidTokenForIdentifier()
+    {
+        $model = factory(APIKey::class)->make();
+
+        $this->request->shouldReceive('bearerToken')->withNoArgs()->twice()->andReturn($model->identifier . 'asdf');
+        $this->repository->shouldReceive('findFirstWhere')->with([['identifier', '=', $model->identifier]])->once()->andReturn($model);
+        $this->encrypter->shouldReceive('decrypt')->with($model->token)->once()->andReturn('decrypted');
+
+        $this->getMiddleware()->handle($this->request, $this->getClosureAssertions());
+    }
+
+    /**
+     * Return an instance of the middleware with mocked dependencies for testing.
+     *
+     * @return \Pterodactyl\Http\Middleware\Api\Admin\AuthenticateKey
+     */
+    private function getMiddleware(): AuthenticateKey
+    {
+        return new AuthenticateKey($this->repository, $this->auth, $this->encrypter);
+    }
+}

tests/Unit/Http/Middleware/Api/Admin/SetSessionDriverTest.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace Tests\Unit\Http\Middleware\Api\Admin;
+
+use Mockery as m;
+use Barryvdh\Debugbar\LaravelDebugbar;
+use Illuminate\Contracts\Config\Repository;
+use Illuminate\Contracts\Foundation\Application;
+use Tests\Unit\Http\Middleware\MiddlewareTestCase;
+use Pterodactyl\Http\Middleware\Api\Admin\SetSessionDriver;
+
+class SetSessionDriverTest extends MiddlewareTestCase
+{
+    /**
+     * @var \Illuminate\Contracts\Foundation\Application|\Mockery\Mock
+     */
+    private $appMock;
+
+    /**
+     * @var \Illuminate\Contracts\Config\Repository|\Mockery\Mock
+     */
+    private $config;
+
+    /**
+     * Setup tests.
+     */
+    public function setUp()
+    {
+        parent::setUp();
+
+        $this->appMock = m::mock(Application::class);
+        $this->config = m::mock(Repository::class);
+    }
+
+    /**
+     * Test that a production environment does not try to disable debug bar.
+     */
+    public function testProductionEnvironment()
+    {
+        $this->appMock->shouldReceive('environment')->withNoArgs()->once()->andReturn('production');
+        $this->config->shouldReceive('set')->with('session.driver', 'array')->once()->andReturnNull();
+
+        $this->getMiddleware()->handle($this->request, $this->getClosureAssertions());
+    }
+
+    /**
+     * Test that a local environment does disable debug bar.
+     */
+    public function testLocalEnvironment()
+    {
+        $this->appMock->shouldReceive('environment')->withNoArgs()->once()->andReturn('local');
+        $this->appMock->shouldReceive('make')->with(LaravelDebugbar::class)->once()->andReturnSelf();
+        $this->appMock->shouldReceive('disable')->withNoArgs()->once()->andReturnNull();
+
+        $this->config->shouldReceive('set')->with('session.driver', 'array')->once()->andReturnNull();
+
+        $this->getMiddleware()->handle($this->request, $this->getClosureAssertions());
+    }
+
+    /**
+     * Return an instance of the middleware with mocked dependencies for testing.
+     *
+     * @return \Pterodactyl\Http\Middleware\Api\Admin\SetSessionDriver
+     */
+    private function getMiddleware(): SetSessionDriver
+    {
+        return new SetSessionDriver($this->appMock, $this->config);
+    }
+}