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.

app/Http/Controllers/Base/APIController.php

@@ -49,8 +49,6 @@ class APIController extends Controller
      *
      * @param \Illuminate\Http\Request $request
      * @return \Illuminate\View\View
-     *
-     * @throws \Pterodactyl\Exceptions\Repository\RecordNotFoundException
      */
     public function index(Request $request)
     {

app/Http/Kernel.php

@@ -14,19 +14,19 @@ use Pterodactyl\Http\Middleware\AdminAuthenticate;
 use Illuminate\Routing\Middleware\ThrottleRequests;
 use Pterodactyl\Http\Middleware\LanguageMiddleware;
 use Illuminate\Foundation\Http\Kernel as HttpKernel;
-use Pterodactyl\Http\Middleware\API\AuthenticateKey;
 use Illuminate\Routing\Middleware\SubstituteBindings;
 use Pterodactyl\Http\Middleware\AccessingValidServer;
-use Pterodactyl\Http\Middleware\API\SetSessionDriver;
 use Illuminate\View\Middleware\ShareErrorsFromSession;
 use Pterodactyl\Http\Middleware\RedirectIfAuthenticated;
 use Illuminate\Auth\Middleware\AuthenticateWithBasicAuth;
-use Pterodactyl\Http\Middleware\API\AuthenticateIPAccess;
-use Pterodactyl\Http\Middleware\Daemon\DaemonAuthenticate;
+use Pterodactyl\Http\Middleware\Api\Admin\AuthenticateKey;
 use Illuminate\Foundation\Http\Middleware\ValidatePostSize;
+use Pterodactyl\Http\Middleware\Api\Admin\SetSessionDriver;
 use Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse;
 use Pterodactyl\Http\Middleware\Server\AuthenticateAsSubuser;
+use Pterodactyl\Http\Middleware\Api\Daemon\DaemonAuthenticate;
 use Pterodactyl\Http\Middleware\Server\SubuserBelongsToServer;
+use Pterodactyl\Http\Middleware\Api\Admin\AuthenticateIPAccess;
 use Pterodactyl\Http\Middleware\RequireTwoFactorAuthentication;
 use Pterodactyl\Http\Middleware\Server\DatabaseBelongsToServer;
 use Pterodactyl\Http\Middleware\Server\ScheduleBelongsToServer;

app/Http/Middleware/Api/Admin/AuthenticateIPAccess.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Pterodactyl\Http\Middleware\API;
+namespace Pterodactyl\Http\Middleware\Api\Admin;
 
 use Closure;
 use IPTools\IP;

app/Http/Middleware/Api/Admin/AuthenticateKey.php

@@ -1,10 +1,12 @@
 <?php
 
-namespace Pterodactyl\Http\Middleware\API;
+namespace Pterodactyl\Http\Middleware\Api\Admin;
 
 use Closure;
 use Illuminate\Http\Request;
+use Pterodactyl\Models\APIKey;
 use Illuminate\Auth\AuthManager;
+use Illuminate\Contracts\Encryption\Encrypter;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 use Pterodactyl\Exceptions\Repository\RecordNotFoundException;
 use Pterodactyl\Contracts\Repository\ApiKeyRepositoryInterface;
@@ -17,6 +19,11 @@ class AuthenticateKey
      */
     private $auth;
 
+    /**
+     * @var \Illuminate\Contracts\Encryption\Encrypter
+     */
+    private $encrypter;
+
     /**
      * @var \Pterodactyl\Contracts\Repository\ApiKeyRepositoryInterface
      */
@@ -27,19 +34,18 @@ class AuthenticateKey
      *
      * @param \Pterodactyl\Contracts\Repository\ApiKeyRepositoryInterface $repository
      * @param \Illuminate\Auth\AuthManager                                $auth
+     * @param \Illuminate\Contracts\Encryption\Encrypter                  $encrypter
      */
-    public function __construct(
-        ApiKeyRepositoryInterface $repository,
-        AuthManager $auth
-    ) {
+    public function __construct(ApiKeyRepositoryInterface $repository, AuthManager $auth, Encrypter $encrypter)
+    {
         $this->auth = $auth;
+        $this->encrypter = $encrypter;
         $this->repository = $repository;
     }
 
     /**
      * Handle an API request by verifying that the provided API key
-     * is in a valid format, and the route being accessed is allowed
-     * for the given key.
+     * is in a valid format and exists in the database.
      *
      * @param \Illuminate\Http\Request $request
      * @param \Closure                 $next
@@ -54,12 +60,20 @@ class AuthenticateKey
             throw new HttpException(401, null, null, ['WWW-Authenticate' => 'Bearer']);
         }
 
+        $raw = $request->bearerToken();
+        $identifier = substr($raw, 0, APIKey::IDENTIFIER_LENGTH);
+        $token = substr($raw, APIKey::IDENTIFIER_LENGTH);
+
         try {
-            $model = $this->repository->findFirstWhere([['token', '=', $request->bearerToken()]]);
+            $model = $this->repository->findFirstWhere([['identifier', '=', $identifier]]);
         } catch (RecordNotFoundException $exception) {
             throw new AccessDeniedHttpException;
         }
 
+        if (! hash_equals($this->encrypter->decrypt($model->token), $token)) {
+            throw new AccessDeniedHttpException;
+        }
+
         $this->auth->guard()->loginUsingId($model->user_id);
         $request->attributes->set('api_key', $model);
 

app/Http/Middleware/Api/Admin/SetSessionDriver.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Pterodactyl\Http\Middleware\API;
+namespace Pterodactyl\Http\Middleware\Api\Admin;
 
 use Closure;
 use Illuminate\Http\Request;

app/Http/Middleware/Api/Daemon/DaemonAuthenticate.php

@@ -1,28 +1,6 @@
 <?php
-/*
- * Pterodactyl - Panel
- * Copyright (c) 2015 - 2017 Dane Everitt <dane@daneeveritt.com>.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
 
-namespace Pterodactyl\Http\Middleware\Daemon;
+namespace Pterodactyl\Http\Middleware\Api\Daemon;
 
 use Closure;
 use Illuminate\Http\Request;