Audit Logs Page Implementation (#174)

* Added Implementation of AuditLogs GUI * Added error handling for download all * removed the AuditLogEntry condition * Added success toast * Added dropdown from id and message string * rverted commits * Addresed review comments
ibm-openbmc · Feb 20, 2024 · 38d9b57 · 38d9b57
1 parent 08a7899
commit 38d9b57
Show file tree

Hide file tree

Showing 10 changed files with 440 additions and 0 deletions.
diff --git a/src/components/AppNavigation/AppNavigationMixin.js b/src/components/AppNavigation/AppNavigationMixin.js
@@ -37,6 +37,11 @@ const AppNavigationMixin = {
               label: this.$t('appNavigation.eventLogs'),
               route: '/logs/event-logs',
             },
+            {
+              id: 'audit-logs',
+              label: this.$t('appNavigation.auditLogs'),
+              route: '/logs/audit-logs',
+            },
             {
               id: 'post-code-logs',
               label: this.$t('appNavigation.postCodeLogs'),

diff --git a/src/env/components/AppNavigation/ibm.js b/src/env/components/AppNavigation/ibm.js
@@ -157,6 +157,12 @@ const AppNavigationMixin = {
               route: '/logs/event-logs',
               restrictTo: [],
             },
+            {
+              id: 'audit-logs',
+              label: this.$t('appNavigation.auditLogs'),
+              route: '/logs/audit-logs',
+              restrictTo: [],
+            },
             {
               id: 'dumps',
               label: this.$t('appNavigation.dumps'),

diff --git a/src/env/router/ibm.js b/src/env/router/ibm.js
@@ -1,4 +1,5 @@
 import AppLayout from '@/layouts/AppLayout.vue';
+import AuditLogs from '@/views/Logs/AuditLogs';
 import ChangePassword from '@/views/ChangePassword';
 import ConcurrentMaintenance from '@/views/HardwareStatus/ConcurrentMaintenance';
 import Sessions from '@/views/SecurityAndAccess/Sessions';
@@ -166,6 +167,14 @@ const routes = [
           title: i18n.t('appPageTitle.eventLogs'),
         },
       },
+      {
+        path: '/logs/audit-logs',
+        name: 'audit-logs',
+        component: AuditLogs,
+        meta: {
+          title: i18n.t('appPageTitle.auditLogs'),
+        },
+      },
       {
         path: '/logs/post-code-logs',
         name: 'post-code-logs',

diff --git a/src/locales/en-US.json b/src/locales/en-US.json
@@ -122,6 +122,7 @@
     "titleShowNavigation": "Show navigation"
   },
   "appNavigation": {
+    "auditLogs": "@:appPageTitle.auditLogs",
     "capacityOnDemand": "@:appPageTitle.capacityOnDemand",
     "certificates": "@:appPageTitle.certificates",
     "concurrentMaintenance": "@:appPageTitle.concurrentMaintenance",
@@ -166,6 +167,7 @@
     "virtualMedia": "@:appPageTitle.virtualMedia"
   },
   "appPageTitle": {
+    "auditLogs": "Audit logs",
     "capacityOnDemand": "Capacity on demand",
     "certificates": "Certificates",
     "changePassword": "Change password",
@@ -207,6 +209,24 @@
     "userManagement": "User management",
     "virtualMedia": "Virtual media"
   },
+  "pageAuditLogs": {
+    "table": {
+      "id": "ID",
+      "op": "Operation",
+      "acct": "Account",
+      "addr": "Address",
+      "res": "Response",
+      "messageArgs": "MessageArgs",
+      "message": "Message",
+      "searchLogs": "Search logs",
+      "eventTimeStamp": "Date"
+    },
+    "toast": {
+      "infoStartDownload": "Download might take several minutes to complete.",
+      "errorStartDownload": "Error downloading Logs",
+      "successStartDownload": "Logs downloaded successfully"
+    }
+},
   "pageCapacityOnDemand": {
     "absent": "Absent",
     "deferring": "Deferring",

diff --git a/src/router/routes.js b/src/router/routes.js
@@ -1,4 +1,5 @@
 import AppLayout from '@/layouts/AppLayout.vue';
+import AuditLogs from '@/views/Logs/AuditLogs';
 import ChangePassword from '@/views/ChangePassword';
 import ConsoleLayout from '@/layouts/ConsoleLayout.vue';
 import ConcurrentMaintenance from '@/views/HardwareStatus/ConcurrentMaintenance';
@@ -126,6 +127,14 @@ const routes = [
           title: i18n.t('appPageTitle.eventLogs'),
         },
       },
+      {
+        path: '/logs/audit-logs',
+        name: 'audit-logs',
+        component: AuditLogs,
+        meta: {
+          title: i18n.t('appPageTitle.auditLogs'),
+        },
+      },
       {
         path: '/logs/post-code-logs',
         name: 'post-code-logs',

diff --git a/src/store/index.js b/src/store/index.js
@@ -26,6 +26,7 @@ import ProcessorStore from './modules/HardwareStatus/ProcessorStore';
 import AssemblyStore from './modules/HardwareStatus/AssemblyStore';
 import PcieTopologyStore from './modules/HardwareStatus/PcieTopologyStore';
 import PostCodeLogsStore from './modules/Logs/PostCodeLogsStore';
+import AuditLogsStore from './modules/Logs/AuditLogsStore';
 import PoliciesStore from './modules/SecurityAndAccess/PoliciesStore';
 import FactoryResetStore from './modules/Operations/FactoryResetStore';
 import HardwareDeconfigurationStore from './modules/Settings/HardwareDeconfigurationStore';
@@ -77,6 +78,7 @@ export default new Vuex.Store({
     assemblies: AssemblyStore,
     pcieSlots: PcieSlotsStore,
     postCodeLogs: PostCodeLogsStore,
+    auditLogs: AuditLogsStore,
     virtualMedia: VirtualMediaStore,
     policies: PoliciesStore,
     factoryReset: FactoryResetStore,

diff --git a/src/store/modules/Logs/AuditLogsStore.js b/src/store/modules/Logs/AuditLogsStore.js
@@ -0,0 +1,49 @@
+import api from '@/store/api';
+
+const AuditLogsStore = {
+  namespaced: true,
+  state: {
+    allAuditLogs: [],
+  },
+  getters: {
+    allAuditLogs: (state) => state.allAuditLogs,
+  },
+  mutations: {
+    setAllAuditLogs: (state, allAuditLogs) =>
+      (state.allAuditLogs = allAuditLogs),
+  },
+  actions: {
+    async getAuditLogData({ commit }) {
+      return await api
+        .get('/redfish/v1/Systems/system/LogServices/AuditLog/Entries')
+        .then(({ data: { Members = [] } = {} }) => {
+          const auditLogs = Members.map((log) => {
+            const { EventTimestamp, Id, Message, MessageArgs, Oem } = log;
+            const [, operation, account, , , address, , result] = MessageArgs;
+            return {
+              auditId: Id,
+              operation: operation,
+              message: Message,
+              account: account || '--',
+              date: new Date(EventTimestamp),
+              addr: address ? address.split('::ffff:').pop() : '--',
+              res: result || '--',
+              uri: log['@odata.id'],
+              additionalDataUri: Oem.IBM.AdditionalDataFullAuditLogURI,
+            };
+          });
+          commit('setAllAuditLogs', auditLogs);
+        })
+        .catch((error) => {
+          console.log(error);
+        });
+    },
+    async downloadLogData(_, uri) {
+      return await api.get(uri).then((response) => {
+        return response;
+      });
+    },
+  },
+};
+
+export default AuditLogsStore;