Log the error output for API

Author: DaneEveritt

app/Http/Middleware/APISecretToken.php

@@ -62,15 +62,15 @@ public function getAuthorizationMethod()
     public function authenticate(Request $request, Route $route)
     {
         if (!$request->bearerToken() || empty($request->bearerToken())) {
-            APILogService::log($request);
-            throw new UnauthorizedHttpException('The authentication header was missing or malformed');
+            APILogService::log($request, 'The authentication header was missing or malformed.');
+            throw new UnauthorizedHttpException('The authentication header was missing or malformed.');
         }
 
         list($public, $hashed) = explode('.', $request->bearerToken());
 
         $key = APIKey::where('public', $public)->first();
         if (!$key) {
-            APILogService::log($request);
+            APILogService::log($request, 'Invalid API Key.');
             throw new AccessDeniedHttpException('Invalid API Key.');
         }
 
@@ -85,7 +85,7 @@ public function authenticate(Request $request, Route $route)
                     }
                 }
                 if (!$inRange) {
-                    APILogService::log($request);
+                    APILogService::log($request, 'This IP address <' . $request->ip() . '> does not have permission to use this API key.');
                     throw new AccessDeniedHttpException('This IP address <' . $request->ip() . '> does not have permission to use this API key.');
                 }
             }
@@ -98,26 +98,26 @@ public function authenticate(Request $request, Route $route)
             }
 
             if (!$this->permissionAllowed) {
-                APILogService::log($request);
+                APILogService::log($request, 'You do not have permission to access this resource.');
                 throw new AccessDeniedHttpException('You do not have permission to access this resource.');
             }
         }
 
         try {
             $decrypted = Crypt::decrypt($key->secret);
         } catch (\Illuminate\Contracts\Encryption\DecryptException $ex) {
-            APILogService::log($request);
+            APILogService::log($request, 'There was an error while attempting to check your secret key.');
             throw new HttpException('There was an error while attempting to check your secret key.');
         }
 
         $this->url = urldecode($request->fullUrl());
         if($this->_generateHMAC($request->getContent(), $decrypted) !== base64_decode($hashed)) {
-            APILogService::log($request);
+            APILogService::log($request, 'The hashed body was not valid. Potential modification of contents in route.');
             throw new BadRequestHttpException('The hashed body was not valid. Potential modification of contents in route.');
         }
 
         // Log the Route Access
-        APILogService::log($request, true);
+        APILogService::log($request, null, true);
         return true;
 
     }

app/Services/APILogService.php

@@ -36,7 +36,7 @@ public function __constructor()
         //
     }
 
-    public static function log(Request $request, $authorized = false)
+    public static function log(Request $request, $error = null, $authorized = false)
     {
         if ($request->bearerToken() && !empty($request->bearerToken())) {
             list($public, $hashed) = explode('.', $request->bearerToken());
@@ -47,6 +47,7 @@ public static function log(Request $request, $authorized = false)
         try {
             $log = APILog::create([
                 'authorized' => $authorized,
+                'error' => $error,
                 'key' => $public,
                 'method' => $request->method(),
                 'route' => $request->fullUrl(),

database/migrations/2016_10_07_152117_build_api_log_table.php

@@ -16,6 +16,7 @@ public function up()
         Schema::create('api_logs', function (Blueprint $table) {
             $table->increments('id');
             $table->boolean('authorized');
+            $table->text('error')->nullable();
             $table->char('key', 16)->nullable();
             $table->char('method', 6);
             $table->text('route');