2024-01-31 23:17:04 +01:00
|
|
|
import { OptionValues } from "commander";
|
2021-12-20 18:04:00 +01:00
|
|
|
import * as inquirer from "inquirer";
|
2018-05-17 16:58:30 +02:00
|
|
|
|
2023-11-09 21:17:25 +01:00
|
|
|
import { EventCollectionService } from "@bitwarden/common/abstractions/event/event-collection.service";
|
[AC-1011] Admin Console / Billing code ownership (#4973)
* refactor: move SCIM component to admin-console, refs EC-1011
* refactor: move scimProviderType to admin-console, refs EC-1011
* refactor: move scim-config.api to admin-console, refs EC-1011
* refactor: create models folder and nest existing api contents, refs EC-1011
* refactor: move scim-config to admin-console models, refs EC-1011
* refactor: move billing.component to billing, refs EC-1011
* refactor: remove nested app folder from new billing structure, refs EC-1011
* refactor: move organizations/billing to billing, refs EC-1011
* refactor: move add-credit and adjust-payment to billing/settings, refs EC-1011
* refactor: billing history/sync to billing, refs EC-1011
* refactor: move org plans, payment/method to billing/settings, refs EC-1011
* fix: update legacy file paths for payment-method and tax-info, refs EC-1011
* fix: update imports for scim component, refs EC-1011
* refactor: move subscription and tax-info into billing, refs EC-1011
* refactor: move user-subscription to billing, refs EC-1011
* refactor: move images/cards to billing and update base path, refs EC-1011
* refactor: move payment-method, plan subscription, and plan to billing, refs EC-1011
* refactor: move transaction-type to billing, refs EC-1011
* refactor: move billing-sync-config to billing, refs EC-1011
* refactor: move billing-sync and bit-pay-invoice request to billing, refs EC-1011
* refactor: move org subscription and tax info update requests to billing, refs EC-1011
* fix: broken paths to billing, refs EC-1011
* refactor: move payment request to billing, refs EC-1011
* fix: update remaining imports for payment-request, refs EC-1011
* refactor: move tax-info-update to billing, refs EC-1011
* refactor: move billing-payment, billing-history, and billing responses to billing, refs EC-1011
* refactor: move organization-subscription-responset to billing, refs EC-1011
* refactor: move payment and plan responses to billing, refs EC-1011
* refactor: move subscription response to billing ,refs EC-1011
* refactor: move tax info and rate responses to billing, refs EC-1011
* fix: update remaining path to base response for tax-rate response, refs EC-1011
* refactor: (browser) move organization-service to admin-console, refs EC-1011
* refactor: (browser) move organizaiton-service to admin-console, refs EC-1011
* refactor: (cli) move share command to admin-console, refs EC-1011
* refactor: move organization-collect request model to admin-console, refs EC-1011
* refactor: (web) move organization, collection/user responses to admin-console, refs EC-1011
* refactor: (cli) move selection-read-only to admin-console, refs EC-1011
* refactor: (desktop) move organization-filter to admin-console, refs EC-1011
* refactor: (web) move organization-switcher to admin-console, refs EC-1011
* refactor: (web) move access-selector to admin-console, refs EC-1011
* refactor: (web) move create folder to admin-console, refs EC-1011
* refactor: (web) move org guards folder to admin-console, refs EC-1011
* refactor: (web) move org layout to admin-console, refs EC-1011
* refactor: move manage collections to admin console, refs EC-1011
* refactor: (web) move collection-dialog to admin-console, refs EC-1011
* refactor: (web) move entity users/events and events component to admin-console, refs EC-1011
* refactor: (web) move groups/group-add-edit to admin-console, refs EC-1011
* refactor: (web) move manage, org-manage module, and user-confirm to admin-console, refs EC-1011
* refactor: (web) move people to admin-console, refs EC-1011
* refactor: (web) move reset-password to admin-console, refs EC-1011
* refactor: (web) move organization-routing and module to admin-console, refs EC-1011
* refactor: move admin-console and billing within app scope, refs EC-1011
* fix: update leftover merge conflicts, refs EC-1011
* refactor: (web) member-dialog to admin-console, refs EC-1011
* refactor: (web) move policies to admin-console, refs EC-1011
* refactor: (web) move reporting to admin-console, refs EC-1011
* refactor: (web) move settings to admin-console, refs EC-1011
* refactor: (web) move sponsorships to admin-console, refs EC-1011
* refactor: (web) move tools to admin-console, refs EC-1011
* refactor: (web) move users to admin-console, refs EC-1011
* refactor: (web) move collections to admin-console, refs EC-1011
* refactor: (web) move create-organization to admin-console, refs EC-1011
* refactor: (web) move licensed components to admin-console, refs EC-1011
* refactor: (web) move bit organization modules to admin-console, refs EC-1011
* fix: update leftover import statements for organizations.module, refs EC-1011
* refactor: (web) move personal vault and max timeout to admin-console, refs EC-1011
* refactor: (web) move providers to admin-console, refs EC-1011
* refactor: (libs) move organization service to admin-console, refs EC-1011
* refactor: (libs) move profile org/provider responses and other misc org responses to admin-console, refs EC-1011
* refactor: (libs) move provider request and selectionion-read-only request to admin-console, refs EC-1011
* fix: update missed import path for provider-user-update request, refs EC-1011
* refactor: (libs) move abstractions to admin-console, refs EC-1011
* refactor: (libs) move org/provider enums to admin-console, refs EC-1011
* fix: update downstream import statements from libs changes, refs EC-1011
* refactor: (libs) move data files to admin-console, refs EC-1011
* refactor: (libs) move domain to admin-console, refs EC-1011
* refactor: (libs) move request objects to admin-console, refs EC-1011
* fix: update downstream import changes from libs, refs EC-1011
* refactor: move leftover provider files to admin-console, refs EC-1011
* refactor: (browser) move group policy environment to admin-console, refs EC-1011
* fix: (browser) update downstream import statements, refs EC-1011
* fix: (desktop) update downstream libs moves, refs EC-1011
* fix: (cli) update downstream import changes from libs, refs EC-1011
* refactor: move org-auth related files to admin-console, refs EC-1011
* refactor: (libs) move request objects to admin-console, refs EC-1011
* refactor: move persmissions to admin-console, refs EC-1011
* refactor: move sponsored families to admin-console and fix libs changes, refs EC-1011
* refactor: move collections to admin-console, refs EC-1011
* refactor: move spec file back to spec scope, refs EC-1011
* fix: update downstream imports due to libs changes, refs EC-1011
* fix: udpate downstream import changes due to libs, refs EC-1011
* fix: update downstream imports due to libs changes, refs EC-1011
* fix: update downstream imports from libs changes, refs EC-1011
* fix: update path malformation in jslib-services.module, refs EC-1011
* fix: lint errors from improper casing, refs AC-1011
* fix: update downstream filename changes, refs AC-1011
* fix: (cli) update downstream filename changes, refs AC-1011
* fix: (desktop) update downstream filename changes, refs AC-1011
* fix: (browser) update downstream filename changes, refs AC-1011
* fix: lint errors, refs AC-1011
* fix: prettier, refs AC-1011
* fix: lint fixes for import order, refs AC-1011
* fix: update import path for provider user type, refs AC-1011
* fix: update new codes import paths for admin console structure, refs AC-1011
* fix: lint/prettier, refs AC-1011
* fix: update layout stories path, refs AC-1011
* fix: update comoponents card icons base variable in styles, refs AC-1011
* fix: update provider service path in permissions guard spec, refs AC-1011
* fix: update provider permission guard path, refs AC-1011
* fix: remove unecessary TODO for shared index export statement, refs AC-1011
* refactor: move browser-organization service and cli organization-user response out of admin-console, refs AC-1011
* refactor: move web/browser/desktop collections component to vault domain, refs AC-1011
* refactor: move organization.module out of admin-console scope, refs AC-1011
* fix: prettier, refs AC-1011
* refactor: move organizations-api-key.request out of admin-console scope, refs AC-1011
2023-03-22 16:03:50 +01:00
|
|
|
import { PolicyService } from "@bitwarden/common/admin-console/abstractions/policy/policy.service.abstraction";
|
2023-04-06 03:34:23 +02:00
|
|
|
import { PolicyType } from "@bitwarden/common/admin-console/enums";
|
2023-11-09 21:17:25 +01:00
|
|
|
import { EventType } from "@bitwarden/common/enums";
|
2023-06-06 22:34:53 +02:00
|
|
|
import { Utils } from "@bitwarden/common/platform/misc/utils";
|
2023-04-19 11:30:46 +02:00
|
|
|
import {
|
|
|
|
ExportFormat,
|
|
|
|
EXPORT_FORMATS,
|
|
|
|
VaultExportServiceAbstraction,
|
2024-02-13 20:22:37 +01:00
|
|
|
} from "@bitwarden/vault-export-core";
|
2019-10-07 17:01:30 +02:00
|
|
|
|
2022-11-18 13:20:19 +01:00
|
|
|
import { Response } from "../models/response";
|
2021-12-20 18:04:00 +01:00
|
|
|
import { CliUtils } from "../utils";
|
2021-09-15 15:57:43 +02:00
|
|
|
|
2018-05-17 16:58:30 +02:00
|
|
|
export class ExportCommand {
|
2023-04-19 11:30:46 +02:00
|
|
|
constructor(
|
|
|
|
private exportService: VaultExportServiceAbstraction,
|
2023-11-09 21:17:25 +01:00
|
|
|
private policyService: PolicyService,
|
2023-11-29 22:15:20 +01:00
|
|
|
private eventCollectionService: EventCollectionService,
|
2023-04-19 11:30:46 +02:00
|
|
|
) {}
|
2021-12-20 18:04:00 +01:00
|
|
|
|
2024-01-31 23:17:04 +01:00
|
|
|
async run(options: OptionValues): Promise<Response> {
|
2021-12-20 18:04:00 +01:00
|
|
|
if (
|
|
|
|
options.organizationid == null &&
|
2022-11-10 13:19:50 +01:00
|
|
|
(await this.policyService.policyAppliesToUser(PolicyType.DisablePersonalVaultExport))
|
2021-12-20 18:04:00 +01:00
|
|
|
) {
|
|
|
|
return Response.badRequest(
|
2023-11-29 22:15:20 +01:00
|
|
|
"One or more organization policies prevents you from exporting your personal vault.",
|
2021-12-20 18:04:00 +01:00
|
|
|
);
|
2018-05-17 16:58:30 +02:00
|
|
|
}
|
|
|
|
|
2024-01-29 10:38:16 +01:00
|
|
|
let password = options.password;
|
|
|
|
|
|
|
|
// has password and format is 'json' => should have the same behaviour as 'encrypted_json'
|
|
|
|
// format is 'undefined' => Defaults to 'csv'
|
|
|
|
// Any other case => returns the options.format
|
|
|
|
const format =
|
|
|
|
password && options.format == "json" ? "encrypted_json" : options.format ?? "csv";
|
|
|
|
|
2023-04-17 21:54:03 +02:00
|
|
|
if (!this.isSupportedExportFormat(format)) {
|
|
|
|
return Response.badRequest(
|
|
|
|
`'${format}' is not a supported export format. Supported formats: ${EXPORT_FORMATS.join(
|
2023-11-29 22:15:20 +01:00
|
|
|
", ",
|
|
|
|
)}.`,
|
2023-04-17 21:54:03 +02:00
|
|
|
);
|
|
|
|
}
|
2021-05-27 22:47:39 +02:00
|
|
|
|
2021-12-20 18:04:00 +01:00
|
|
|
if (options.organizationid != null && !Utils.isGuid(options.organizationid)) {
|
|
|
|
return Response.error("`" + options.organizationid + "` is not a GUID.");
|
|
|
|
}
|
2022-02-23 22:47:32 +01:00
|
|
|
|
2021-12-20 18:04:00 +01:00
|
|
|
let exportContent: string = null;
|
|
|
|
try {
|
2024-01-29 10:38:16 +01:00
|
|
|
if (format === "encrypted_json") {
|
|
|
|
password = await this.promptPassword(password);
|
|
|
|
}
|
|
|
|
|
2021-12-20 18:04:00 +01:00
|
|
|
exportContent =
|
2024-01-29 10:38:16 +01:00
|
|
|
options.organizationid == null
|
|
|
|
? await this.exportService.getExport(format, password)
|
|
|
|
: await this.exportService.getOrganizationExport(
|
|
|
|
options.organizationid,
|
|
|
|
format,
|
|
|
|
password,
|
|
|
|
);
|
2023-11-09 21:17:25 +01:00
|
|
|
|
|
|
|
const eventType = options.organizationid
|
|
|
|
? EventType.Organization_ClientExportedVault
|
|
|
|
: EventType.User_ClientExportedVault;
|
2024-02-02 21:13:37 +01:00
|
|
|
// FIXME: Verify that this floating promise is intentional. If it is, add an explanatory comment and ensure there is proper error handling.
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-floating-promises
|
2023-11-09 21:17:25 +01:00
|
|
|
this.eventCollectionService.collect(eventType, null, true, options.organizationid);
|
2021-12-20 18:04:00 +01:00
|
|
|
} catch (e) {
|
|
|
|
return Response.error(e);
|
|
|
|
}
|
|
|
|
return await this.saveFile(exportContent, options, format);
|
|
|
|
}
|
|
|
|
|
2022-02-23 22:47:32 +01:00
|
|
|
private async saveFile(
|
2021-12-20 18:04:00 +01:00
|
|
|
exportContent: string,
|
2024-01-31 23:17:04 +01:00
|
|
|
options: OptionValues,
|
2023-11-29 22:15:20 +01:00
|
|
|
format: ExportFormat,
|
2021-12-20 18:04:00 +01:00
|
|
|
): Promise<Response> {
|
|
|
|
try {
|
|
|
|
const fileName = this.getFileName(format, options.organizationid != null ? "org" : null);
|
|
|
|
return await CliUtils.saveResultToFile(exportContent, options.output, fileName);
|
|
|
|
} catch (e) {
|
|
|
|
return Response.error(e.toString());
|
2021-11-16 10:42:30 +01:00
|
|
|
}
|
2021-12-20 18:04:00 +01:00
|
|
|
}
|
|
|
|
|
2022-02-23 22:47:32 +01:00
|
|
|
private getFileName(format: ExportFormat, prefix?: string) {
|
2021-12-20 18:04:00 +01:00
|
|
|
if (format === "encrypted_json") {
|
|
|
|
if (prefix == null) {
|
|
|
|
prefix = "encrypted";
|
|
|
|
} else {
|
|
|
|
prefix = "encrypted_" + prefix;
|
|
|
|
}
|
|
|
|
format = "json";
|
|
|
|
}
|
|
|
|
return this.exportService.getFileName(prefix, format);
|
|
|
|
}
|
|
|
|
|
2022-02-23 22:47:32 +01:00
|
|
|
private async promptPassword(password: string | boolean) {
|
|
|
|
// boolean => flag set with no value, we need to prompt for password
|
|
|
|
// string => flag set with value, use this value for password
|
|
|
|
// undefined/null/false => account protect, not password, no password needed
|
|
|
|
if (typeof password === "string") {
|
|
|
|
return password;
|
|
|
|
} else if (password) {
|
2021-12-20 18:04:00 +01:00
|
|
|
const answer: inquirer.Answers = await inquirer.createPromptModule({
|
|
|
|
output: process.stderr,
|
|
|
|
})({
|
|
|
|
type: "password",
|
|
|
|
name: "password",
|
2022-02-23 22:47:32 +01:00
|
|
|
message: "Export file password:",
|
2021-12-20 18:04:00 +01:00
|
|
|
});
|
2022-02-23 22:47:32 +01:00
|
|
|
return answer.password as string;
|
2021-12-20 18:04:00 +01:00
|
|
|
}
|
2022-02-23 22:47:32 +01:00
|
|
|
return null;
|
2021-12-20 18:04:00 +01:00
|
|
|
}
|
2023-04-17 21:54:03 +02:00
|
|
|
|
|
|
|
private isSupportedExportFormat(format: string): format is ExportFormat {
|
|
|
|
return EXPORT_FORMATS.includes(format as ExportFormat);
|
|
|
|
}
|
2018-05-17 16:58:30 +02:00
|
|
|
}
|