[SM-1274] Add Project Events to the Log List in Admin Console (#15442)

* Adding enums for additional event logs for secrets * updating messages * Updating messages to be consistent for logs * Displaying project logs, and fixing search query param searching in projects list, having deleted log for secrets and projects not show as a link * Viewing secret and project event logs in event modal, adding to the context menu for secrets and projects the ability to view the logs if user has permission. Restricting logs to SM projs and Secs if the logged in user has event log access but not SM access. * lint * Lint Fixes * fix to messages file * fixing lint * Bug fix, make sure event logs related to service accounts are still links that take you to the object * removing unused import
2025-12-18 17:23:37 +00:00 · 2025-08-20 10:45:58 -04:00
parent 5483006ae4
commit ad145fc4ff
18 changed files with 611 additions and 47 deletions
--- a/bitwarden_license/bit-web/src/app/admin-console/providers/manage/events.component.ts
+++ b/bitwarden_license/bit-web/src/app/admin-console/providers/manage/events.component.ts
@@ -5,7 +5,9 @@ import { ActivatedRoute, Router } from "@angular/router";

 import { UserNamePipe } from "@bitwarden/angular/pipes/user-name.pipe";
 import { ApiService } from "@bitwarden/common/abstractions/api.service";
+import { OrganizationService } from "@bitwarden/common/admin-console/abstractions/organization/organization.service.abstraction";
 import { ProviderService } from "@bitwarden/common/admin-console/abstractions/provider.service";
+import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
 import { EventResponse } from "@bitwarden/common/models/response/event.response";
 import { FileDownloadService } from "@bitwarden/common/platform/abstractions/file-download/file-download.service";
 import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
@@ -41,6 +43,8 @@ export class EventsComponent extends BaseEventsComponent implements OnInit {
    private userNamePipe: UserNamePipe,
    fileDownloadService: FileDownloadService,
    toastService: ToastService,
+    accountService: AccountService,
+    organizationService: OrganizationService,
  ) {
    super(
      eventService,
@@ -50,6 +54,9 @@ export class EventsComponent extends BaseEventsComponent implements OnInit {
      logService,
      fileDownloadService,
      toastService,
+      route,
+      accountService,
+      organizationService,
    );
  }

@@ -69,6 +76,7 @@ export class EventsComponent extends BaseEventsComponent implements OnInit {
  }

  async load() {
+    this.initBase();
    const response = await this.apiService.getProviderUsers(this.providerId);
    response.data.forEach((u) => {
      const name = this.userNamePipe.transform(u);
--- a/bitwarden_license/bit-web/src/app/secrets-manager/projects/projects/projects.component.ts
+++ b/bitwarden_license/bit-web/src/app/secrets-manager/projects/projects/projects.component.ts
@@ -1,7 +1,7 @@
 // FIXME: Update this file to be type safe and remove this and next line
 // @ts-strict-ignore
 import { Component, OnInit } from "@angular/core";
-import { ActivatedRoute } from "@angular/router";
+import { ActivatedRoute, Router } from "@angular/router";
 import {
  combineLatest,
  firstValueFrom,
@@ -17,9 +17,12 @@ import {
 } from "@bitwarden/common/admin-console/abstractions/organization/organization.service.abstraction";
 import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
 import { getUserId } from "@bitwarden/common/auth/services/account.service";
-import { DialogService } from "@bitwarden/components";
+import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
+import { DialogRef, DialogService, ToastService } from "@bitwarden/components";
+import { openEntityEventsDialog } from "@bitwarden/web-vault/app/admin-console/organizations/manage/entity-events.component";

 import { ProjectListView } from "../../models/view/project-list.view";
+import { ProjectView } from "../../models/view/project.view";
 import {
  BulkConfirmationDetails,
  BulkConfirmationDialogComponent,
@@ -55,6 +58,9 @@ export class ProjectsComponent implements OnInit {
    private dialogService: DialogService,
    private organizationService: OrganizationService,
    private accountService: AccountService,
+    private toastService: ToastService,
+    private i18nService: I18nService,
+    private router: Router,
  ) {}

  ngOnInit() {
@@ -73,9 +79,53 @@ export class ProjectsComponent implements OnInit {
          )
        )?.enabled;

-        return await this.getProjects();
+        const projects = await this.getProjects();
+        const viewEvents = this.route.snapshot.queryParams.viewEvents;
+
+        if (viewEvents) {
+          const targetProject = projects.find((project) => project.id === viewEvents);
+
+          const userIsAdmin = (
+            await firstValueFrom(
+              this.organizationService
+                .organizations$(userId)
+                .pipe(getOrganizationById(params.organizationId)),
+            )
+          )?.isAdmin;
+
+          // They would fall into here if they don't have access to a project, or if it has been permanently deleted.
+          if (!targetProject) {
+            //If they are an admin it was permanently deleted and we can show the events with project name redacted
+            if (userIsAdmin) {
+              this.openEventsDialogFromEntityId(
+                this.i18nService.t("nameUnavailableProjectDeleted", viewEvents),
+                params.organizationId,
+                viewEvents,
+              );
+            } else {
+              //They aren't an admin so we don't know if they have access to it, lets show the unknown cipher toast.
+              this.toastService.showToast({
+                variant: "error",
+                title: null,
+                message: this.i18nService.t("unknownProject"),
+              });
+            }
+          } else {
+            this.openEventsDialog(targetProject);
+          }
+
+          await this.router.navigate([], {
+            queryParams: { search: this.search },
+          });
+        }
+
+        return projects;
      }),
    );
+
+    if (this.route.snapshot.queryParams.search) {
+      this.search = this.route.snapshot.queryParams.search;
+    }
  }

  private async getProjects(): Promise<ProjectListView[]> {
@@ -103,6 +153,30 @@ export class ProjectsComponent implements OnInit {
    });
  }

+  openEventsDialog = (project: ProjectView): DialogRef<void> =>
+    openEntityEventsDialog(this.dialogService, {
+      data: {
+        name: project.name,
+        organizationId: project.organizationId,
+        entityId: project.id,
+        entity: "project",
+      },
+    });
+
+  openEventsDialogFromEntityId = (
+    headerName: string,
+    organizationId: string,
+    entityId: string,
+  ): DialogRef<void> =>
+    openEntityEventsDialog(this.dialogService, {
+      data: {
+        name: headerName,
+        organizationId: organizationId,
+        entityId: entityId,
+        entity: "project",
+      },
+    });
+
  async openDeleteProjectDialog(projects: ProjectListView[]) {
    let projectsToDelete = projects;
    const readOnlyProjects = projects.filter((project) => project.write == false);
--- a/bitwarden_license/bit-web/src/app/secrets-manager/secrets/secrets.component.ts
+++ b/bitwarden_license/bit-web/src/app/secrets-manager/secrets/secrets.component.ts
@@ -1,7 +1,7 @@
 // FIXME: Update this file to be type safe and remove this and next line
 // @ts-strict-ignore
 import { Component, OnInit } from "@angular/core";
-import { ActivatedRoute } from "@angular/router";
+import { ActivatedRoute, Router } from "@angular/router";
 import { combineLatestWith, firstValueFrom, Observable, startWith, switchMap } from "rxjs";

 import {
@@ -13,7 +13,8 @@ import { getUserId } from "@bitwarden/common/auth/services/account.service";
 import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
 import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
 import { PlatformUtilsService } from "@bitwarden/common/platform/abstractions/platform-utils.service";
-import { DialogService } from "@bitwarden/components";
+import { DialogRef, DialogService, ToastService } from "@bitwarden/components";
+import { openEntityEventsDialog } from "@bitwarden/web-vault/app/admin-console/organizations/manage/entity-events.component";

 import { SecretListView } from "../models/view/secret-list.view";
 import { SecretsListComponent } from "../shared/secrets-list.component";
@@ -54,6 +55,8 @@ export class SecretsComponent implements OnInit {
    private organizationService: OrganizationService,
    private accountService: AccountService,
    private logService: LogService,
+    private toastService: ToastService,
+    private router: Router,
  ) {}

  ngOnInit() {
@@ -71,7 +74,53 @@ export class SecretsComponent implements OnInit {
          )
        )?.enabled;

-        return await this.getSecrets();
+        const secrets = await this.getSecrets();
+        const viewEvents = this.route.snapshot.queryParams.viewEvents;
+
+        if (viewEvents) {
+          let targetSecret = secrets.find((secret) => secret.id === viewEvents);
+
+          const userIsAdmin = (
+            await firstValueFrom(
+              this.organizationService
+                .organizations$(userId)
+                .pipe(getOrganizationById(params.organizationId)),
+            )
+          )?.isAdmin;
+
+          // Secret might be deleted, make sure they are an admin before checking the trashed secrets
+          if (!targetSecret && userIsAdmin) {
+            targetSecret = (await this.secretService.getTrashedSecrets(this.organizationId)).find(
+              (e) => e.id == viewEvents,
+            );
+          }
+
+          // They would fall into here if they don't have access to a secret, or if it has been permanently deleted.
+          if (!targetSecret) {
+            //If they are an admin it was permanently deleted and we can show the events even though we don't have the secret name
+            if (userIsAdmin) {
+              this.openEventsDialogByEntityId(
+                this.i18nService.t("nameUnavailableSecretDeleted", viewEvents),
+                viewEvents,
+              );
+            } else {
+              //They aren't an admin so we don't know if they have access to it, lets show the unknown secret toast.
+              this.toastService.showToast({
+                variant: "error",
+                title: null,
+                message: this.i18nService.t("unknownSecret"),
+              });
+            }
+          } else {
+            this.openEventsDialog(targetSecret);
+          }
+
+          await this.router.navigate([], {
+            queryParams: { search: this.search },
+          });
+        }
+
+        return secrets;
      }),
    );

@@ -80,6 +129,26 @@ export class SecretsComponent implements OnInit {
    }
  }

+  openEventsDialogByEntityId = (secretName: string, secretId: string): DialogRef<void> =>
+    openEntityEventsDialog(this.dialogService, {
+      data: {
+        name: secretName,
+        organizationId: this.organizationId,
+        entityId: secretId,
+        entity: "secret",
+      },
+    });
+
+  openEventsDialog = (secret: SecretListView): DialogRef<void> =>
+    openEntityEventsDialog(this.dialogService, {
+      data: {
+        name: secret.name,
+        organizationId: this.organizationId,
+        entityId: secret.id,
+        entity: "secret",
+      },
+    });
+
  private async getSecrets(): Promise<SecretListView[]> {
    return await this.secretService.getSecrets(this.organizationId);
  }
--- a/bitwarden_license/bit-web/src/app/secrets-manager/service-accounts/event-logs/service-accounts-events.component.ts
+++ b/bitwarden_license/bit-web/src/app/secrets-manager/service-accounts/event-logs/service-accounts-events.component.ts
@@ -2,8 +2,10 @@
 // @ts-strict-ignore
 import { Component, OnDestroy, OnInit } from "@angular/core";
 import { ActivatedRoute } from "@angular/router";
-import { Subject, takeUntil } from "rxjs";
+import { takeUntil } from "rxjs";

+import { OrganizationService } from "@bitwarden/common/admin-console/abstractions/organization/organization.service.abstraction";
+import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
 import { FileDownloadService } from "@bitwarden/common/platform/abstractions/file-download/file-download.service";
 import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
 import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
@@ -25,7 +27,6 @@ export class ServiceAccountEventsComponent
  implements OnInit, OnDestroy
 {
  exportFileName = "machine-account-events";
-  private destroy$ = new Subject<void>();
  private serviceAccountId: string;

  constructor(
@@ -38,6 +39,8 @@ export class ServiceAccountEventsComponent
    logService: LogService,
    fileDownloadService: FileDownloadService,
    toastService: ToastService,
+    protected organizationService: OrganizationService,
+    protected accountService: AccountService,
  ) {
    super(
      eventService,
@@ -47,10 +50,14 @@ export class ServiceAccountEventsComponent
      logService,
      fileDownloadService,
      toastService,
+      route,
+      accountService,
+      organizationService,
    );
  }

  async ngOnInit() {
+    this.initBase();
    // eslint-disable-next-line rxjs/no-async-subscribe
    this.route.params.pipe(takeUntil(this.destroy$)).subscribe(async (params) => {
      this.serviceAccountId = params.serviceAccountId;
@@ -78,9 +85,4 @@ export class ServiceAccountEventsComponent
      email: "",
    };
  }
-
-  ngOnDestroy() {
-    this.destroy$.next();
-    this.destroy$.complete();
-  }
 }
--- a/bitwarden_license/bit-web/src/app/secrets-manager/service-accounts/service-accounts-list.component.ts
+++ b/bitwarden_license/bit-web/src/app/secrets-manager/service-accounts/service-accounts-list.component.ts
@@ -5,7 +5,6 @@ import { Component, EventEmitter, Input, OnDestroy, Output } from "@angular/core
 import { Subject, takeUntil } from "rxjs";

 import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
-import { PlatformUtilsService } from "@bitwarden/common/platform/abstractions/platform-utils.service";
 import { TableDataSource, ToastService } from "@bitwarden/components";

 import {
@@ -49,7 +48,6 @@ export class ServiceAccountsListComponent implements OnDestroy {

  constructor(
    private i18nService: I18nService,
-    private platformUtilsService: PlatformUtilsService,
    private toastService: ToastService,
  ) {
    this.selection.changed
--- a/bitwarden_license/bit-web/src/app/secrets-manager/shared/projects-list.component.html
+++ b/bitwarden_license/bit-web/src/app/secrets-manager/shared/projects-list.component.html
@@ -114,6 +114,15 @@
          <i class="bwi bwi-fw bwi-trash tw-text-danger" aria-hidden="true"></i>
          <span class="tw-text-danger">{{ "deleteProject" | i18n }}</span>
        </button>
+        <button
+          type="button"
+          bitMenuItem
+          *ngIf="viewEventsAllowed$ | async as allowed"
+          (click)="openEventsDialog(project)"
+        >
+          <i class="bwi bwi-fw bwi-billing" aria-hidden="true"></i>
+          <span> {{ "viewEvents" | i18n }} </span>
+        </button>
      </bit-menu>
    </tr>
  </ng-template>
--- a/bitwarden_license/bit-web/src/app/secrets-manager/shared/projects-list.component.ts
+++ b/bitwarden_license/bit-web/src/app/secrets-manager/shared/projects-list.component.ts
@@ -1,21 +1,31 @@
 // FIXME: Update this file to be type safe and remove this and next line
 // @ts-strict-ignore
 import { SelectionModel } from "@angular/cdk/collections";
-import { Component, EventEmitter, Input, Output } from "@angular/core";
-import { map } from "rxjs";
+import { Component, EventEmitter, Input, Output, OnInit } from "@angular/core";
+import { ActivatedRoute } from "@angular/router";
+import { catchError, concatMap, map, Observable, of, Subject, switchMap, takeUntil } from "rxjs";

+import {
+  getOrganizationById,
+  OrganizationService,
+} from "@bitwarden/common/admin-console/abstractions/organization/organization.service.abstraction";
+import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
+import { getUserId } from "@bitwarden/common/auth/services/account.service";
 import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
 import { PlatformUtilsService } from "@bitwarden/common/platform/abstractions/platform-utils.service";
-import { TableDataSource, ToastService } from "@bitwarden/components";
+import { DialogRef, DialogService, TableDataSource, ToastService } from "@bitwarden/components";
+import { LogService } from "@bitwarden/logging";
+import { openEntityEventsDialog } from "@bitwarden/web-vault/app/admin-console/organizations/manage/entity-events.component";

 import { ProjectListView } from "../models/view/project-list.view";
+import { ProjectView } from "../models/view/project.view";

@Component({
  selector: "sm-projects-list",
  templateUrl: "./projects-list.component.html",
  standalone: false,
 })
-export class ProjectsListComponent {
+export class ProjectsListComponent implements OnInit {
  @Input()
  get projects(): ProjectListView[] {
    return this._projects;
@@ -26,6 +36,9 @@ export class ProjectsListComponent {
    this.dataSource.data = projects;
  }
  private _projects: ProjectListView[];
+  protected viewEventsAllowed$: Observable<boolean>;
+  protected isAdmin$: Observable<boolean>;
+  private destroy$: Subject<void> = new Subject<void>();

  @Input() showMenus?: boolean = true;

@@ -50,8 +63,41 @@ export class ProjectsListComponent {
    private i18nService: I18nService,
    private platformUtilsService: PlatformUtilsService,
    private toastService: ToastService,
+    private dialogService: DialogService,
+    private organizationService: OrganizationService,
+    private activatedRoute: ActivatedRoute,
+    private accountService: AccountService,
+    private logService: LogService,
  ) {}

+  ngOnInit(): void {
+    this.viewEventsAllowed$ = this.activatedRoute.params.pipe(
+      concatMap((params) =>
+        getUserId(this.accountService.activeAccount$).pipe(
+          switchMap((userId) =>
+            this.organizationService
+              .organizations$(userId)
+              .pipe(getOrganizationById(params.organizationId)),
+          ),
+        ),
+      ),
+      map((org) => org.canAccessEventLogs),
+      catchError((error: unknown) => {
+        if (typeof error === "string") {
+          this.toastService.showToast({
+            message: error,
+            variant: "error",
+            title: "",
+          });
+        } else {
+          this.logService.error(error);
+        }
+        return of(false);
+      }),
+      takeUntil(this.destroy$),
+    );
+  }
+
  isAllSelected() {
    if (this.selection.selected?.length > 0) {
      const numSelected = this.selection.selected.length;
@@ -87,6 +133,16 @@ export class ProjectsListComponent {
    }
  }

+  openEventsDialog = (project: ProjectView): DialogRef<void> =>
+    openEntityEventsDialog(this.dialogService, {
+      data: {
+        name: project.name,
+        organizationId: project.organizationId,
+        entityId: project.id,
+        entity: "project",
+      },
+    });
+
  private selectedHasWriteAccess() {
    const selectedProjects = this.projects.filter((project) =>
      this.selection.isSelected(project.id),
--- a/bitwarden_license/bit-web/src/app/secrets-manager/shared/secrets-list.component.html
+++ b/bitwarden_license/bit-web/src/app/secrets-manager/shared/secrets-list.component.html
@@ -148,6 +148,15 @@
          <i class="bwi bwi-fw bwi-refresh" aria-hidden="true"></i>
          {{ "restoreSecret" | i18n }}
        </button>
+        <button
+          type="button"
+          bitMenuItem
+          *ngIf="viewEventsAllowed$ | async as allowed"
+          (click)="openEventsDialog(secret)"
+        >
+          <i class="bwi bwi-fw bwi-billing" aria-hidden="true"></i>
+          <span> {{ "viewEvents" | i18n }} </span>
+        </button>
        <button
          type="button"
          bitMenuItem
--- a/bitwarden_license/bit-web/src/app/secrets-manager/shared/secrets-list.component.ts
+++ b/bitwarden_license/bit-web/src/app/secrets-manager/shared/secrets-list.component.ts
@@ -1,15 +1,24 @@
 // FIXME: Update this file to be type safe and remove this and next line
 // @ts-strict-ignore
 import { SelectionModel } from "@angular/cdk/collections";
-import { Component, EventEmitter, Input, OnDestroy, Output } from "@angular/core";
-import { Subject, takeUntil } from "rxjs";
+import { Component, EventEmitter, Input, OnDestroy, Output, OnInit } from "@angular/core";
+import { ActivatedRoute } from "@angular/router";
+import { catchError, concatMap, map, Observable, of, Subject, switchMap, takeUntil } from "rxjs";

+import {
+  getOrganizationById,
+  OrganizationService,
+} from "@bitwarden/common/admin-console/abstractions/organization/organization.service.abstraction";
+import { AccountService } from "@bitwarden/common/auth/abstractions/account.service";
+import { getUserId } from "@bitwarden/common/auth/services/account.service";
 import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
 import { LogService } from "@bitwarden/common/platform/abstractions/log.service";
 import { PlatformUtilsService } from "@bitwarden/common/platform/abstractions/platform-utils.service";
-import { TableDataSource, ToastService } from "@bitwarden/components";
+import { DialogRef, DialogService, TableDataSource, ToastService } from "@bitwarden/components";
+import { openEntityEventsDialog } from "@bitwarden/web-vault/app/admin-console/organizations/manage/entity-events.component";

 import { SecretListView } from "../models/view/secret-list.view";
+import { SecretView } from "../models/view/secret.view";
 import { SecretService } from "../secrets/secret.service";

@Component({
@@ -17,7 +26,7 @@ import { SecretService } from "../secrets/secret.service";
  templateUrl: "./secrets-list.component.html",
  standalone: false,
 })
-export class SecretsListComponent implements OnDestroy {
+export class SecretsListComponent implements OnDestroy, OnInit {
  protected dataSource = new TableDataSource<SecretListView>();

  @Input()
@@ -52,17 +61,51 @@ export class SecretsListComponent implements OnDestroy {
  private destroy$: Subject<void> = new Subject<void>();

  selection = new SelectionModel<string>(true, []);
+  protected viewEventsAllowed$: Observable<boolean>;
+  protected isAdmin$: Observable<boolean>;

  constructor(
    private i18nService: I18nService,
-    private platformUtilsService: PlatformUtilsService,
    private toastService: ToastService,
+    private dialogService: DialogService,
+    private organizationService: OrganizationService,
+    private activatedRoute: ActivatedRoute,
+    private accountService: AccountService,
+    private logService: LogService,
  ) {
    this.selection.changed
      .pipe(takeUntil(this.destroy$))
      .subscribe((_) => this.onSecretCheckedEvent.emit(this.selection.selected));
  }

+  ngOnInit(): void {
+    this.viewEventsAllowed$ = this.activatedRoute.params.pipe(
+      concatMap((params) =>
+        getUserId(this.accountService.activeAccount$).pipe(
+          switchMap((userId) =>
+            this.organizationService
+              .organizations$(userId)
+              .pipe(getOrganizationById(params.organizationId)),
+          ),
+        ),
+      ),
+      map((org) => org.canAccessEventLogs),
+      catchError((error: unknown) => {
+        if (typeof error === "string") {
+          this.toastService.showToast({
+            message: error,
+            variant: "error",
+            title: "",
+          });
+        } else {
+          this.logService.error(error);
+        }
+        return of(false);
+      }),
+      takeUntil(this.destroy$),
+    );
+  }
+
  ngOnDestroy(): void {
    this.destroy$.next();
    this.destroy$.complete();
@@ -76,6 +119,15 @@ export class SecretsListComponent implements OnDestroy {
    }
    return false;
  }
+  openEventsDialog = (secret: SecretView): DialogRef<void> =>
+    openEntityEventsDialog(this.dialogService, {
+      data: {
+        name: secret.name,
+        organizationId: secret.organizationId,
+        entityId: secret.id,
+        entity: "secret",
+      },
+    });

  toggleAll() {
    if (this.isAllSelected()) {