[EC-320] Add organization vault export to event logs (#3136)

* Added organizationId to EventData and EventRequest

* Added EventType Organization_ClientExportedVault

* Sending organizationId on Organization Export event

* Checking that the user belongs to the organization

* Added organizationExportResponse model

* Added API method to get Organization vault export data

* Updated getOrganizationDecryptedExport to use new API method

apps/web/src/app/organizations/tools/import-export/org-export.component.ts

@@ -11,6 +11,7 @@ import { LogService } from "@bitwarden/common/abstractions/log.service";
 import { PlatformUtilsService } from "@bitwarden/common/abstractions/platformUtils.service";
 import { PolicyService } from "@bitwarden/common/abstractions/policy.service";
 import { UserVerificationService } from "@bitwarden/common/abstractions/userVerification.service";
+import { EventType } from "@bitwarden/common/enums/eventType";
 
 import { ExportComponent } from "../../../tools/import-export/export.component";
 
@@ -66,7 +67,11 @@ export class OrganizationExportComponent extends ExportComponent {
   }
 
   async collectEvent(): Promise<any> {
-    // TODO
+    await this.eventService.collect(
-    // await this.eventService.collect(EventType.Organization_ClientExportedVault);
+      EventType.Organization_ClientExportedVault,
+      null,
+      null,
+      this.organizationId
+    );
   }
 }

apps/web/src/app/services/event.service.ts

@@ -301,11 +301,9 @@ export class EventService {
       case EventType.Organization_PurgedVault:
         msg = humanReadableMsg = this.i18nService.t("purgedOrganizationVault");
         break;
-      /*
       case EventType.Organization_ClientExportedVault:
-                msg = this.i18nService.t('exportedOrganizationVault');
+        msg = humanReadableMsg = this.i18nService.t("exportedOrganizationVault");
         break;
-            */
       case EventType.Organization_VaultAccessed:
         msg = humanReadableMsg = this.i18nService.t("vaultAccessedByProvider");
         break;

libs/common/src/abstractions/api.service.ts

@@ -130,6 +130,7 @@ import {
   OrganizationConnectionConfigApis,
   OrganizationConnectionResponse,
 } from "../models/response/organizationConnectionResponse";
+import { OrganizationExportResponse } from "../models/response/organizationExportResponse";
 import { OrganizationKeysResponse } from "../models/response/organizationKeysResponse";
 import { OrganizationResponse } from "../models/response/organizationResponse";
 import { OrganizationSponsorshipSyncStatusResponse } from "../models/response/organizationSponsorshipSyncStatusResponse";
@@ -734,4 +735,5 @@ export abstract class ApiService {
     request: KeyConnectorUserKeyRequest
   ) => Promise<void>;
   getKeyConnectorAlive: (keyConnectorUrl: string) => Promise<void>;
+  getOrganizationExport: (organizationId: string) => Promise<OrganizationExportResponse>;
 }

libs/common/src/abstractions/event.service.ts

@@ -1,7 +1,12 @@
 import { EventType } from "../enums/eventType";
 
 export abstract class EventService {
-  collect: (eventType: EventType, cipherId?: string, uploadImmediately?: boolean) => Promise<any>;
+  collect: (
+    eventType: EventType,
+    cipherId?: string,
+    uploadImmediately?: boolean,
+    organizationId?: string
+  ) => Promise<any>;
   uploadEvents: (userId?: string) => Promise<any>;
   clearEvents: (userId?: string) => Promise<any>;
 }

libs/common/src/enums/eventType.ts

@@ -53,7 +53,7 @@ export enum EventType {
 
   Organization_Updated = 1600,
   Organization_PurgedVault = 1601,
-  // Organization_ClientExportedVault = 1602,
+  Organization_ClientExportedVault = 1602,
   Organization_VaultAccessed = 1603,
   Organization_EnabledSso = 1604,
   Organization_DisabledSso = 1605,

libs/common/src/models/data/eventData.ts

@@ -4,4 +4,5 @@ export class EventData {
   type: EventType;
   cipherId: string;
   date: string;
+  organizationId: string;
 }

libs/common/src/models/request/eventRequest.ts

@@ -4,4 +4,5 @@ export class EventRequest {
   type: EventType;
   cipherId: string;
   date: string;
+  organizationId: string;
 }

libs/common/src/models/response/organizationExportResponse.ts

@@ -0,0 +1,15 @@
+import { BaseResponse } from "./baseResponse";
+import { CipherResponse } from "./cipherResponse";
+import { CollectionResponse } from "./collectionResponse";
+import { ListResponse } from "./listResponse";
+
+export class OrganizationExportResponse extends BaseResponse {
+  collections: ListResponse<CollectionResponse>;
+  ciphers: ListResponse<CipherResponse>;
+
+  constructor(response: any) {
+    super(response);
+    this.collections = this.getResponseProperty("Collections");
+    this.ciphers = this.getResponseProperty("Ciphers");
+  }
+}

libs/common/src/services/api.service.ts

@@ -139,6 +139,7 @@ import {
   OrganizationConnectionConfigApis,
   OrganizationConnectionResponse,
 } from "../models/response/organizationConnectionResponse";
+import { OrganizationExportResponse } from "../models/response/organizationExportResponse";
 import { OrganizationKeysResponse } from "../models/response/organizationKeysResponse";
 import { OrganizationResponse } from "../models/response/organizationResponse";
 import { OrganizationSponsorshipSyncStatusResponse } from "../models/response/organizationSponsorshipSyncStatusResponse";
@@ -2323,6 +2324,17 @@ export class ApiService implements ApiServiceAbstraction {
     }
   }
 
+  async getOrganizationExport(organizationId: string): Promise<OrganizationExportResponse> {
+    const r = await this.send(
+      "GET",
+      "/organizations/" + organizationId + "/export",
+      null,
+      true,
+      true
+    );
+    return new OrganizationExportResponse(r);
+  }
+
   // Helpers
 
   async getActiveBearerToken(): Promise<string> {

libs/common/src/services/event.service.ts

@@ -34,7 +34,8 @@ export class EventService implements EventServiceAbstraction {
   async collect(
     eventType: EventType,
     cipherId: string = null,
-    uploadImmediately = false
+    uploadImmediately = false,
+    organizationId: string = null
   ): Promise<any> {
     const authed = await this.stateService.getIsAuthenticated();
     if (!authed) {
@@ -54,6 +55,11 @@ export class EventService implements EventServiceAbstraction {
         return;
       }
     }
+    if (organizationId != null) {
+      if (!orgIds.has(organizationId)) {
+        return;
+      }
+    }
     let eventCollection = await this.stateService.getEventCollection();
     if (eventCollection == null) {
       eventCollection = [];
@@ -62,6 +68,7 @@ export class EventService implements EventServiceAbstraction {
     event.type = eventType;
     event.cipherId = cipherId;
     event.date = new Date().toISOString();
+    event.organizationId = organizationId;
     eventCollection.push(event);
     await this.stateService.setEventCollection(eventCollection);
     if (uploadImmediately) {
@@ -83,6 +90,7 @@ export class EventService implements EventServiceAbstraction {
       req.type = e.type;
       req.cipherId = e.cipherId;
       req.date = e.date;
+      req.organizationId = e.organizationId;
       return req;
     });
     try {

libs/common/src/services/export.service.ts

@@ -245,38 +245,41 @@ export class ExportService implements ExportServiceAbstraction {
     const promises = [];
 
     promises.push(
-      this.apiService.getCollections(organizationId).then((collections) => {
+      this.apiService.getOrganizationExport(organizationId).then((exportData) => {
-        const collectionPromises: any = [];
+        const exportPromises: any = [];
-        if (collections != null && collections.data != null && collections.data.length > 0) {
+        if (exportData != null) {
-          collections.data.forEach((c) => {
+          if (
+            exportData.collections != null &&
+            exportData.collections.data != null &&
+            exportData.collections.data.length > 0
+          ) {
+            exportData.collections.data.forEach((c) => {
               const collection = new Collection(new CollectionData(c as CollectionDetailsResponse));
-            collectionPromises.push(
+              exportPromises.push(
                 collection.decrypt().then((decCol) => {
                   decCollections.push(decCol);
                 })
               );
             });
           }
-        return Promise.all(collectionPromises);
+          if (
-      })
+            exportData.ciphers != null &&
-    );
+            exportData.ciphers.data != null &&
-
+            exportData.ciphers.data.length > 0
-    promises.push(
+          ) {
-      this.apiService.getCiphersOrganization(organizationId).then((ciphers) => {
+            exportData.ciphers.data
-        const cipherPromises: any = [];
-        if (ciphers != null && ciphers.data != null && ciphers.data.length > 0) {
-          ciphers.data
               .filter((c) => c.deletedDate === null)
               .forEach((c) => {
                 const cipher = new Cipher(new CipherData(c));
-              cipherPromises.push(
+                exportPromises.push(
                   cipher.decrypt().then((decCipher) => {
                     decCiphers.push(decCipher);
                   })
                 );
               });
           }
-        return Promise.all(cipherPromises);
+        }
+        return Promise.all(exportPromises);
       })
     );