Add api authorization logging

app/routing/middleware/api/Permission.middleware.js

@@ -8,22 +8,34 @@ class PermissionMiddleware extends Middleware {
     async test(req, res, next, { check }) {
         const Policy = this.models.get('iam:Policy')
 
+        req.additional_api_log_data.permission_check = check
+
         // If the request was authorized using an OAuth2 bearer token,
         // make sure the associated client has permission to access this endpoint.
         if ( req?.oauth?.client ) {
             if ( !req.oauth.client.can(check) ) {
                 const reason = 'oauth-permission-fail'
-                await this.activity.api_access_denial({
+                const fail_activity = await this.activity.api_access_denial({
                     req,
                     reason,
                     check,
-                    oauth_client_id: req.oauth.client.id,
+                    oauth_client_id: req.oauth.client.uuid,
                 })
 
+                req.additional_api_log_data.permission_check_succeeded = false
+                req.additional_api_log_data.permission_check_activity_id = fail_activity.id
+
                 return res.status(401)
                     .message('Insufficient permissions (OAuth2 Client).')
                     .api()
             }
+
+            req.additional_api_log_data.permission_check_succeeded = true
+
+            // If the oauth2 client has this permission, then allow the request to continue,
+            // even if the user does not.
+            // OAuth2Clients need to be able to query users via the API.
+            return next()
         }
 
         const policy_denied = await Policy.check_user_denied(req.user, check)
@@ -33,13 +45,18 @@ class PermissionMiddleware extends Middleware {
         if ( policy_denied || (!req.user.can(check) && !policy_access) ) {
             // Record the failed API access
             const reason = policy_denied ? 'iam-denial' : (!req.user.can(check) ? 'user-permission-fail' : 'iam-not-granted')
-            await this.activity.api_access_denial({ req, reason, check })
+            const fail_activity = await this.activity.api_access_denial({ req, reason, check })
+
+            req.additional_api_log_data.permission_check_succeeded = false
+            req.additional_api_log_data.permission_check_reason = reason
+            req.additional_api_log_data.permission_check_activity_id = fail_activity.id
 
             return res.status(401)
                 .message('Insufficient permissions.')
                 .api()
         }
 
+        req.additional_api_log_data.permission_check_succeeded = true
         return next()
     }
 }

app/routing/middleware/auth/APIRoute.middleware.js

@@ -6,13 +6,21 @@ class APIRouteMiddleware extends Middleware {
     }
 
     async test(req, res, next, { allow_token = true, allow_user = true }) {
+        if ( !req.additional_api_log_data ) req.additional_api_log_data = {}
+
         // First, check if there is a user in the session.
-        if ( allow_user && req.is_auth ) {
+        if ( allow_user && req.user ) {
+            req.additional_api_log_data.authorized_by = 'user'
             return next()
         } else if ( allow_token ) {
             if ( !req.oauth ) req.oauth = {}
+            req.additional_api_log_data.attempted_token_auth = true
+
             return req.app.oauth2.authorise()(req, res, async e => {
                 if ( e ) return next(e)
+
+                req.additional_api_log_data.authorized_by = 'token'
+
                 // Look up the OAuth2 client an inject it into the route
                 if ( req.user && req.user.id ) {
                     const User = this.models.get('auth:User')
@@ -43,6 +51,9 @@ class APIRouteMiddleware extends Middleware {
                             .message('This OAuth2 client is no longer authorized.')
                             .api()
 
+                    req.additional_api_log_data.token_client_id = client.uuid
+                    req.additional_api_log_data.token = bearer
+
                     req.oauth.token = token
                     req.oauth.client = client
                 } else
@@ -52,10 +63,10 @@ class APIRouteMiddleware extends Middleware {
 
                 next()
             })
-        }
+        } else {
-
             return res.status(401).api()
         }
     }
+}
 
 module.exports = exports = APIRouteMiddleware

app/services/activity.service.js

@@ -36,6 +36,7 @@ class ActivityService extends Service {
         }
 
         await activity.save()
+        return activity
     }
 
     async mfa_enable({ req }) {

config/server.config.js

@@ -23,6 +23,8 @@ const server_config = {
         level: env("LOGGING_LEVEL", 2),
 
         include_timestamp: env("LOGGING_TIMESTAMP", false),
+
+        api_logging: env('LOG_API_RESPONSES', false),
     },
 
     session: {

package.json

@@ -33,7 +33,7 @@
     "ioredis": "^4.17.1",
     "is-absolute-url": "^3.0.3",
     "ldapjs": "^1.0.2",
-    "libflitter": "^0.53.1",
+    "libflitter": "^0.55.1",
     "moment": "^2.24.0",
     "mongodb": "^3.5.9",
     "nodemailer": "^6.4.6",

yarn.lock

@@ -3235,10 +3235,10 @@ leven@^1.0.2:
   resolved "https://registry.yarnpkg.com/leven/-/leven-1.0.2.tgz#9144b6eebca5f1d0680169f1a6770dcea60b75c3"
   integrity sha1-kUS27ryl8dBoAWnxpncNzqYLdcM=
 
-libflitter@^0.53.1:
+libflitter@^0.55.1:
-  version "0.53.1"
+  version "0.55.1"
-  resolved "https://registry.yarnpkg.com/libflitter/-/libflitter-0.53.1.tgz#30b1838763a228fba8b9c820d2cad501c3aa0117"
+  resolved "https://registry.yarnpkg.com/libflitter/-/libflitter-0.55.1.tgz#5fb35bedee8bc171de082c237d0d0bd0050c7d9f"
-  integrity sha512-EK3okZyt0pmnpsZNx2lYOIcwgtmSOEPh4a5xE3pXM9RVc3dtXXscgJ5h9OvLTIN9WfRc7T5VTdpOjeAK6Xmysg==
+  integrity sha512-XVv/uSpA/Obg3K3MytO0pvAezDeeh+/AZIShisvnSg3L8su6QNOuSoBZIjneIzCuZvDD/kZSCrsBupzr3VhpLA==
   dependencies:
     colors "^1.3.3"
     connect-mongodb-session "^2.2.0"