Merge pull request #847 from lenisko/hide_pii_log

feat: switch for hiding pii on channel log
WatWowMap · Sep 14, 2023 · 2cee7b2 · 2cee7b2
2 parents 4cff1c1 + 69d3ebb
commit 2cee7b2
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/server/src/configs/default.json b/server/src/configs/default.json
@@ -627,6 +627,7 @@
         "type": "discord",
         "enabled": false,
         "logChannelId": "",
+        "logChannelHidePii": false,
         "scanNextLogChannelId": "",
         "scanZoneLogChannelId": "",
         "eventLogChannelId": "",

diff --git a/server/src/services/DiscordClient.js b/server/src/services/DiscordClient.js
@@ -43,6 +43,7 @@ class DiscordClient {
       scanNext: strategy.scanNextLogChannelId,
       scanZone: strategy.scanZoneLogChannelId,
     }
+    this.loggingChannelHidePii = strategy.loggingChannelHidePii
     this.perms = config.getSafe('authentication.perms')
     this.alwaysEnabledPerms = config.getSafe(
       'authentication.alwaysEnabledPerms',
@@ -269,7 +270,7 @@ class DiscordClient {
       }
       discordUser.valid = discordUser.perms.map !== false
 
-      const embed = await logUserAuth(req, discordUser, 'Discord')
+      const embed = await logUserAuth(req, discordUser, 'Discord', this.loggingChannelHidePii)
       await this.sendMessage(embed)
 
       if (discordUser.perms.blocked) {

diff --git a/server/src/services/logUserAuth.js b/server/src/services/logUserAuth.js
@@ -2,6 +2,9 @@
 const { default: fetch } = require('node-fetch')
 const { log, HELPERS } = require('@rm/logger')
 
+// PII fields inside getAuthInfo embed
+const PII_FIELDS = ['Ip Address', 'Geo Lookup', 'Google Map', 'Network Provider']
+
 /**
  * Convert camelCase to Capitalized Words
  * @param {string} str
@@ -31,9 +34,10 @@ const mapPerms = (perms, userPerms) =>
  * @param {import('express').Request} req
  * @param {{ id: string, username: string, perms: import("@rm/types").Permissions, valid: boolean, avatar: string }} user
  * @param {string} strategy
+ * @param {boolean} hidePii
  * @returns {Promise<import('discord.js').APIEmbed>}
  */
-async function getAuthInfo(req, user, strategy = 'custom') {
+async function getAuthInfo(req, user, strategy = 'custom', hidePii) {
   const ip =
     req.headers['cf-connecting-ip'] ||
     `${req.headers['x-forwarded-for'] || ''}`.split(', ')[0] ||
@@ -199,6 +203,11 @@ async function getAuthInfo(req, user, strategy = 'custom') {
       'Not authorized to access map',
     )
   }
+  if (hidePii) {
+    embed.fields = embed.fields.filter(field => {
+      return !PII_FIELDS.includes(field.name)
+    });
+  }
   return embed
 }