mirror of
https://github.com/bitwarden/browser
synced 2025-12-18 01:03:35 +00:00
[PM-328] Move common/importer to libs/importer (tools-migration) (#5060)
* Create and register new libs/importer Create package.json Create tsconfig Create jest.config Extend shared and root tsconfig and jest.configs Register with eslint * Move importer-related files to libs/importer * Move importer-spec-related files to libs/importer Move import.service.spec * Update package-lock.json * Set CODEOWNERS for new libs/importer * Register libs/importer with cli and fix imports * Register libs/importer with web and fix imports * Move importOption into models Rename importOptions to import-options * Fix linting issues after updating prettier * Only expose necessary files from libs/importer Fix tsconfig files - Removes the trailing /index on imports in web/cli As the spec-files no longer can access the internals via @bitwarden/importer they import by path (../src/importers) * Add barrel files to vendors with more than one importer
This commit is contained in:
Daniel James Smith
committed by
GitHub
GitHub
parent
7cfabf053c
commit
a5a12a6723
390
libs/importer/src/services/import.service.ts
Normal file
390
libs/importer/src/services/import.service.ts
Normal file
@@ -0,0 +1,390 @@
|
||||
import { CryptoService } from "@bitwarden/common/abstractions/crypto.service";
|
||||
import { I18nService } from "@bitwarden/common/abstractions/i18n.service";
|
||||
import { CollectionService } from "@bitwarden/common/admin-console/abstractions/collection.service";
|
||||
import { CollectionRequest } from "@bitwarden/common/admin-console/models/request/collection.request";
|
||||
import { Utils } from "@bitwarden/common/misc/utils";
|
||||
import { ImportCiphersRequest } from "@bitwarden/common/models/request/import-ciphers.request";
|
||||
import { ImportOrganizationCiphersRequest } from "@bitwarden/common/models/request/import-organization-ciphers.request";
|
||||
import { KvpRequest } from "@bitwarden/common/models/request/kvp.request";
|
||||
import { ErrorResponse } from "@bitwarden/common/models/response/error.response";
|
||||
import { CipherService } from "@bitwarden/common/vault/abstractions/cipher.service";
|
||||
import { FolderService } from "@bitwarden/common/vault/abstractions/folder/folder.service.abstraction";
|
||||
import { CipherType } from "@bitwarden/common/vault/enums/cipher-type";
|
||||
import { CipherRequest } from "@bitwarden/common/vault/models/request/cipher.request";
|
||||
import { FolderRequest } from "@bitwarden/common/vault/models/request/folder.request";
|
||||
import { CipherView } from "@bitwarden/common/vault/models/view/cipher.view";
|
||||
|
||||
import {
|
||||
AscendoCsvImporter,
|
||||
AvastCsvImporter,
|
||||
AvastJsonImporter,
|
||||
AviraCsvImporter,
|
||||
BitwardenCsvImporter,
|
||||
BitwardenJsonImporter,
|
||||
BitwardenPasswordProtectedImporter,
|
||||
BlackBerryCsvImporter,
|
||||
BlurCsvImporter,
|
||||
ButtercupCsvImporter,
|
||||
ChromeCsvImporter,
|
||||
ClipperzHtmlImporter,
|
||||
CodebookCsvImporter,
|
||||
DashlaneCsvImporter,
|
||||
DashlaneJsonImporter,
|
||||
EncryptrCsvImporter,
|
||||
EnpassCsvImporter,
|
||||
EnpassJsonImporter,
|
||||
FirefoxCsvImporter,
|
||||
FSecureFskImporter,
|
||||
GnomeJsonImporter,
|
||||
KasperskyTxtImporter,
|
||||
KeePass2XmlImporter,
|
||||
KeePassXCsvImporter,
|
||||
KeeperCsvImporter,
|
||||
// KeeperJsonImporter,
|
||||
LastPassCsvImporter,
|
||||
LogMeOnceCsvImporter,
|
||||
MSecureCsvImporter,
|
||||
MeldiumCsvImporter,
|
||||
MykiCsvImporter,
|
||||
NordPassCsvImporter,
|
||||
OnePassword1PifImporter,
|
||||
OnePassword1PuxImporter,
|
||||
OnePasswordMacCsvImporter,
|
||||
OnePasswordWinCsvImporter,
|
||||
PadlockCsvImporter,
|
||||
PassKeepCsvImporter,
|
||||
PasskyJsonImporter,
|
||||
PassmanJsonImporter,
|
||||
PasspackCsvImporter,
|
||||
PasswordAgentCsvImporter,
|
||||
PasswordBossJsonImporter,
|
||||
PasswordDragonXmlImporter,
|
||||
PasswordSafeXmlImporter,
|
||||
PasswordWalletTxtImporter,
|
||||
PsonoJsonImporter,
|
||||
RememBearCsvImporter,
|
||||
RoboFormCsvImporter,
|
||||
SafariCsvImporter,
|
||||
SafeInCloudXmlImporter,
|
||||
SaferPassCsvImporter,
|
||||
SecureSafeCsvImporter,
|
||||
SplashIdCsvImporter,
|
||||
StickyPasswordXmlImporter,
|
||||
TrueKeyCsvImporter,
|
||||
UpmCsvImporter,
|
||||
YotiCsvImporter,
|
||||
ZohoVaultCsvImporter,
|
||||
} from "../importers";
|
||||
import { Importer } from "../importers/importer";
|
||||
import { ImportError } from "../models/import-error";
|
||||
import {
|
||||
featuredImportOptions,
|
||||
ImportOption,
|
||||
ImportType,
|
||||
regularImportOptions,
|
||||
} from "../models/import-options";
|
||||
import { ImportResult } from "../models/import-result";
|
||||
import { ImportApiServiceAbstraction } from "../services/import-api.service.abstraction";
|
||||
import { ImportServiceAbstraction } from "../services/import.service.abstraction";
|
||||
|
||||
export class ImportService implements ImportServiceAbstraction {
|
||||
featuredImportOptions = featuredImportOptions as readonly ImportOption[];
|
||||
|
||||
regularImportOptions = regularImportOptions as readonly ImportOption[];
|
||||
|
||||
constructor(
|
||||
private cipherService: CipherService,
|
||||
private folderService: FolderService,
|
||||
private importApiService: ImportApiServiceAbstraction,
|
||||
private i18nService: I18nService,
|
||||
private collectionService: CollectionService,
|
||||
private cryptoService: CryptoService
|
||||
) {}
|
||||
|
||||
getImportOptions(): ImportOption[] {
|
||||
return this.featuredImportOptions.concat(this.regularImportOptions);
|
||||
}
|
||||
|
||||
async import(
|
||||
importer: Importer,
|
||||
fileContents: string,
|
||||
organizationId: string = null
|
||||
): Promise<ImportError> {
|
||||
const importResult = await importer.parse(fileContents);
|
||||
if (importResult.success) {
|
||||
if (importResult.folders.length === 0 && importResult.ciphers.length === 0) {
|
||||
return new ImportError(this.i18nService.t("importNothingError"));
|
||||
} else if (importResult.ciphers.length > 0) {
|
||||
const halfway = Math.floor(importResult.ciphers.length / 2);
|
||||
const last = importResult.ciphers.length - 1;
|
||||
|
||||
if (
|
||||
this.badData(importResult.ciphers[0]) &&
|
||||
this.badData(importResult.ciphers[halfway]) &&
|
||||
this.badData(importResult.ciphers[last])
|
||||
) {
|
||||
return new ImportError(this.i18nService.t("importFormatError"));
|
||||
}
|
||||
}
|
||||
try {
|
||||
await this.postImport(importResult, organizationId);
|
||||
} catch (error) {
|
||||
const errorResponse = new ErrorResponse(error, 400);
|
||||
return this.handleServerError(errorResponse, importResult);
|
||||
}
|
||||
return null;
|
||||
} else {
|
||||
if (!Utils.isNullOrWhitespace(importResult.errorMessage)) {
|
||||
return new ImportError(importResult.errorMessage, importResult.missingPassword);
|
||||
} else {
|
||||
return new ImportError(
|
||||
this.i18nService.t("importFormatError"),
|
||||
importResult.missingPassword
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
getImporter(
|
||||
format: ImportType | "bitwardenpasswordprotected",
|
||||
organizationId: string = null,
|
||||
password: string = null
|
||||
): Importer {
|
||||
const importer = this.getImporterInstance(format, password);
|
||||
if (importer == null) {
|
||||
return null;
|
||||
}
|
||||
importer.organizationId = organizationId;
|
||||
return importer;
|
||||
}
|
||||
|
||||
private getImporterInstance(format: ImportType | "bitwardenpasswordprotected", password: string) {
|
||||
if (format == null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
switch (format) {
|
||||
case "bitwardencsv":
|
||||
return new BitwardenCsvImporter();
|
||||
case "bitwardenjson":
|
||||
return new BitwardenJsonImporter(this.cryptoService, this.i18nService);
|
||||
case "bitwardenpasswordprotected":
|
||||
return new BitwardenPasswordProtectedImporter(
|
||||
this.cryptoService,
|
||||
this.i18nService,
|
||||
password
|
||||
);
|
||||
case "lastpasscsv":
|
||||
case "passboltcsv":
|
||||
return new LastPassCsvImporter();
|
||||
case "keepassxcsv":
|
||||
return new KeePassXCsvImporter();
|
||||
case "aviracsv":
|
||||
return new AviraCsvImporter();
|
||||
case "blurcsv":
|
||||
return new BlurCsvImporter();
|
||||
case "safeincloudxml":
|
||||
return new SafeInCloudXmlImporter();
|
||||
case "padlockcsv":
|
||||
return new PadlockCsvImporter();
|
||||
case "keepass2xml":
|
||||
return new KeePass2XmlImporter();
|
||||
case "chromecsv":
|
||||
case "operacsv":
|
||||
case "vivaldicsv":
|
||||
return new ChromeCsvImporter();
|
||||
case "firefoxcsv":
|
||||
return new FirefoxCsvImporter();
|
||||
case "upmcsv":
|
||||
return new UpmCsvImporter();
|
||||
case "saferpasscsv":
|
||||
return new SaferPassCsvImporter();
|
||||
case "safaricsv":
|
||||
return new SafariCsvImporter();
|
||||
case "meldiumcsv":
|
||||
return new MeldiumCsvImporter();
|
||||
case "1password1pif":
|
||||
return new OnePassword1PifImporter();
|
||||
case "1password1pux":
|
||||
return new OnePassword1PuxImporter();
|
||||
case "1passwordwincsv":
|
||||
return new OnePasswordWinCsvImporter();
|
||||
case "1passwordmaccsv":
|
||||
return new OnePasswordMacCsvImporter();
|
||||
case "keepercsv":
|
||||
return new KeeperCsvImporter();
|
||||
// case "keeperjson":
|
||||
// return new KeeperJsonImporter();
|
||||
case "passworddragonxml":
|
||||
return new PasswordDragonXmlImporter();
|
||||
case "enpasscsv":
|
||||
return new EnpassCsvImporter();
|
||||
case "enpassjson":
|
||||
return new EnpassJsonImporter();
|
||||
case "pwsafexml":
|
||||
return new PasswordSafeXmlImporter();
|
||||
case "dashlanecsv":
|
||||
return new DashlaneCsvImporter();
|
||||
case "dashlanejson":
|
||||
return new DashlaneJsonImporter();
|
||||
case "msecurecsv":
|
||||
return new MSecureCsvImporter();
|
||||
case "stickypasswordxml":
|
||||
return new StickyPasswordXmlImporter();
|
||||
case "truekeycsv":
|
||||
return new TrueKeyCsvImporter();
|
||||
case "clipperzhtml":
|
||||
return new ClipperzHtmlImporter();
|
||||
case "roboformcsv":
|
||||
return new RoboFormCsvImporter();
|
||||
case "ascendocsv":
|
||||
return new AscendoCsvImporter();
|
||||
case "passwordbossjson":
|
||||
return new PasswordBossJsonImporter();
|
||||
case "zohovaultcsv":
|
||||
return new ZohoVaultCsvImporter();
|
||||
case "splashidcsv":
|
||||
return new SplashIdCsvImporter();
|
||||
case "passkeepcsv":
|
||||
return new PassKeepCsvImporter();
|
||||
case "gnomejson":
|
||||
return new GnomeJsonImporter();
|
||||
case "passwordagentcsv":
|
||||
return new PasswordAgentCsvImporter();
|
||||
case "passpackcsv":
|
||||
return new PasspackCsvImporter();
|
||||
case "passmanjson":
|
||||
return new PassmanJsonImporter();
|
||||
case "avastcsv":
|
||||
return new AvastCsvImporter();
|
||||
case "avastjson":
|
||||
return new AvastJsonImporter();
|
||||
case "fsecurefsk":
|
||||
return new FSecureFskImporter();
|
||||
case "kasperskytxt":
|
||||
return new KasperskyTxtImporter();
|
||||
case "remembearcsv":
|
||||
return new RememBearCsvImporter();
|
||||
case "passwordwallettxt":
|
||||
return new PasswordWalletTxtImporter();
|
||||
case "mykicsv":
|
||||
return new MykiCsvImporter();
|
||||
case "securesafecsv":
|
||||
return new SecureSafeCsvImporter();
|
||||
case "logmeoncecsv":
|
||||
return new LogMeOnceCsvImporter();
|
||||
case "blackberrycsv":
|
||||
return new BlackBerryCsvImporter();
|
||||
case "buttercupcsv":
|
||||
return new ButtercupCsvImporter();
|
||||
case "codebookcsv":
|
||||
return new CodebookCsvImporter();
|
||||
case "encryptrcsv":
|
||||
return new EncryptrCsvImporter();
|
||||
case "yoticsv":
|
||||
return new YotiCsvImporter();
|
||||
case "nordpasscsv":
|
||||
return new NordPassCsvImporter();
|
||||
case "psonojson":
|
||||
return new PsonoJsonImporter();
|
||||
case "passkyjson":
|
||||
return new PasskyJsonImporter();
|
||||
default:
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
private async postImport(importResult: ImportResult, organizationId: string = null) {
|
||||
if (organizationId == null) {
|
||||
const request = new ImportCiphersRequest();
|
||||
for (let i = 0; i < importResult.ciphers.length; i++) {
|
||||
const c = await this.cipherService.encrypt(importResult.ciphers[i]);
|
||||
request.ciphers.push(new CipherRequest(c));
|
||||
}
|
||||
if (importResult.folders != null) {
|
||||
for (let i = 0; i < importResult.folders.length; i++) {
|
||||
const f = await this.folderService.encrypt(importResult.folders[i]);
|
||||
request.folders.push(new FolderRequest(f));
|
||||
}
|
||||
}
|
||||
if (importResult.folderRelationships != null) {
|
||||
importResult.folderRelationships.forEach((r) =>
|
||||
request.folderRelationships.push(new KvpRequest(r[0], r[1]))
|
||||
);
|
||||
}
|
||||
return await this.importApiService.postImportCiphers(request);
|
||||
} else {
|
||||
const request = new ImportOrganizationCiphersRequest();
|
||||
for (let i = 0; i < importResult.ciphers.length; i++) {
|
||||
importResult.ciphers[i].organizationId = organizationId;
|
||||
const c = await this.cipherService.encrypt(importResult.ciphers[i]);
|
||||
request.ciphers.push(new CipherRequest(c));
|
||||
}
|
||||
if (importResult.collections != null) {
|
||||
for (let i = 0; i < importResult.collections.length; i++) {
|
||||
importResult.collections[i].organizationId = organizationId;
|
||||
const c = await this.collectionService.encrypt(importResult.collections[i]);
|
||||
request.collections.push(new CollectionRequest(c));
|
||||
}
|
||||
}
|
||||
if (importResult.collectionRelationships != null) {
|
||||
importResult.collectionRelationships.forEach((r) =>
|
||||
request.collectionRelationships.push(new KvpRequest(r[0], r[1]))
|
||||
);
|
||||
}
|
||||
return await this.importApiService.postImportOrganizationCiphers(organizationId, request);
|
||||
}
|
||||
}
|
||||
|
||||
private badData(c: CipherView) {
|
||||
return (
|
||||
(c.name == null || c.name === "--") &&
|
||||
c.type === CipherType.Login &&
|
||||
c.login != null &&
|
||||
Utils.isNullOrWhitespace(c.login.password)
|
||||
);
|
||||
}
|
||||
|
||||
private handleServerError(errorResponse: ErrorResponse, importResult: ImportResult): ImportError {
|
||||
if (errorResponse.validationErrors == null) {
|
||||
return new ImportError(errorResponse.message);
|
||||
}
|
||||
|
||||
let errorMessage = "";
|
||||
|
||||
Object.entries(errorResponse.validationErrors).forEach(([key, value], index) => {
|
||||
let item;
|
||||
let itemType;
|
||||
const i = Number(key.match(/[0-9]+/)[0]);
|
||||
|
||||
switch (key.match(/^\w+/)[0]) {
|
||||
case "Ciphers":
|
||||
item = importResult.ciphers[i];
|
||||
itemType = CipherType[item.type];
|
||||
break;
|
||||
case "Folders":
|
||||
item = importResult.folders[i];
|
||||
itemType = "Folder";
|
||||
break;
|
||||
case "Collections":
|
||||
item = importResult.collections[i];
|
||||
itemType = "Collection";
|
||||
break;
|
||||
default:
|
||||
return;
|
||||
}
|
||||
|
||||
if (index > 0) {
|
||||
errorMessage += "\n\n";
|
||||
}
|
||||
|
||||
if (itemType !== "Folder" && itemType !== "Collection") {
|
||||
errorMessage += "[" + (i + 1) + "] ";
|
||||
}
|
||||
|
||||
errorMessage += "[" + itemType + '] "' + item.name + '": ' + value;
|
||||
});
|
||||
|
||||
return new ImportError(errorMessage);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user