mirror of
https://github.com/bitwarden/browser
synced 2025-12-15 15:53:27 +00:00
[PM-2899] Implement ProtonPass json importer (#5766)
* Implement ProtonPass json importer * Add protonpass-importer json type definition * Fix alphabetical order in importer imports * Add importer error message for encrypted protonpass imports * Add i18n to protonpass importer * Add protonpass (zip) importer * Fix protonpass importer * Add unit tests for protonpass importer * Make protonpass importer not discard totp codes * Merge protonpass json & zip importers * Add protonpass creditcard import & fix note import * Fix protonpass zip import not recognizing zip files on windows/chrome * Make protonpass importer use vault types * Make protonpass importer treat vaults as folders * Make protonpass importer treat folders as collections for organizations Co-authored-by: Daniel James Smith <djsmith85@users.noreply.github.com> * Add types to protonpass test data * Fix protonpass importer's moveFoldersToCollections * Add tests for folders/collections * Remove unecessary type cast in protonpass importer * Remove unecessary type annotations in protonpass importer * Add assertion for credit card cvv in protonpass importer * Handle trashed items in protonpass importer * Fix setting expiry month on credit cards * Fix wrong folder-assignment Only the first item of a "vault" was getting assigned to a folder Extend unit tests to verify behaviour --------- Co-authored-by: Daniel James Smith <djsmith85@users.noreply.github.com> Co-authored-by: Daniel James Smith <djsmith@web.de>
This commit is contained in:
Bernd Schoolmann
GitHub
117
libs/importer/spec/protonpass-json-importer.spec.ts
Normal file
117
libs/importer/spec/protonpass-json-importer.spec.ts
Normal file
@@ -0,0 +1,117 @@
|
||||
import { MockProxy } from "jest-mock-extended";
|
||||
|
||||
import { FieldType } from "@bitwarden/common/enums";
|
||||
import { I18nService } from "@bitwarden/common/platform/abstractions/i18n.service";
|
||||
import { Utils } from "@bitwarden/common/platform/misc/utils";
|
||||
import { CipherType } from "@bitwarden/common/vault/enums/cipher-type";
|
||||
|
||||
import { ProtonPassJsonImporter } from "../src/importers";
|
||||
|
||||
import { testData } from "./test-data/protonpass-json/protonpass.json";
|
||||
|
||||
describe("Protonpass Json Importer", () => {
|
||||
let importer: ProtonPassJsonImporter;
|
||||
let i18nService: MockProxy<I18nService>;
|
||||
beforeEach(() => {
|
||||
importer = new ProtonPassJsonImporter(i18nService);
|
||||
});
|
||||
|
||||
it("should parse login data", async () => {
|
||||
const testDataJson = JSON.stringify(testData);
|
||||
|
||||
const result = await importer.parse(testDataJson);
|
||||
expect(result != null).toBe(true);
|
||||
|
||||
const cipher = result.ciphers.shift();
|
||||
expect(cipher.name).toEqual("Test Login - Personal Vault");
|
||||
expect(cipher.type).toEqual(CipherType.Login);
|
||||
expect(cipher.login.username).toEqual("Username");
|
||||
expect(cipher.login.password).toEqual("Password");
|
||||
expect(cipher.login.uris.length).toEqual(2);
|
||||
const uriView = cipher.login.uris.shift();
|
||||
expect(uriView.uri).toEqual("https://example.com/");
|
||||
expect(cipher.notes).toEqual("My login secure note.");
|
||||
|
||||
expect(cipher.fields.at(2).name).toEqual("second 2fa secret");
|
||||
expect(cipher.fields.at(2).value).toEqual("TOTPCODE");
|
||||
expect(cipher.fields.at(2).type).toEqual(FieldType.Hidden);
|
||||
});
|
||||
|
||||
it("should parse note data", async () => {
|
||||
const testDataJson = JSON.stringify(testData);
|
||||
|
||||
const result = await importer.parse(testDataJson);
|
||||
expect(result != null).toBe(true);
|
||||
|
||||
result.ciphers.shift();
|
||||
const noteCipher = result.ciphers.shift();
|
||||
expect(noteCipher.type).toEqual(CipherType.SecureNote);
|
||||
expect(noteCipher.name).toEqual("My Secure Note");
|
||||
expect(noteCipher.notes).toEqual("Secure note contents.");
|
||||
});
|
||||
|
||||
it("should parse credit card data", async () => {
|
||||
const testDataJson = JSON.stringify(testData);
|
||||
|
||||
const result = await importer.parse(testDataJson);
|
||||
expect(result != null).toBe(true);
|
||||
|
||||
result.ciphers.shift();
|
||||
result.ciphers.shift();
|
||||
|
||||
const creditCardCipher = result.ciphers.shift();
|
||||
expect(creditCardCipher.type).toBe(CipherType.Card);
|
||||
expect(creditCardCipher.card.number).toBe("1234222233334444");
|
||||
expect(creditCardCipher.card.cardholderName).toBe("Test name");
|
||||
expect(creditCardCipher.card.expMonth).toBe("1");
|
||||
expect(creditCardCipher.card.expYear).toBe("2025");
|
||||
expect(creditCardCipher.card.code).toBe("333");
|
||||
expect(creditCardCipher.fields.at(0).name).toEqual("PIN");
|
||||
expect(creditCardCipher.fields.at(0).value).toEqual("1234");
|
||||
expect(creditCardCipher.fields.at(0).type).toEqual(FieldType.Hidden);
|
||||
});
|
||||
|
||||
it("should create folders if not part of an organization", async () => {
|
||||
const testDataJson = JSON.stringify(testData);
|
||||
const result = await importer.parse(testDataJson);
|
||||
|
||||
const folders = result.folders;
|
||||
expect(folders.length).toBe(2);
|
||||
expect(folders[0].name).toBe("Personal");
|
||||
expect(folders[1].name).toBe("Test");
|
||||
|
||||
// "My Secure Note" is assigned to folder "Personal"
|
||||
expect(result.folderRelationships[1]).toEqual([1, 0]);
|
||||
// "Other vault login" is assigned to folder "Test"
|
||||
expect(result.folderRelationships[3]).toEqual([3, 1]);
|
||||
});
|
||||
|
||||
it("should create collections if part of an organization", async () => {
|
||||
const testDataJson = JSON.stringify(testData);
|
||||
importer.organizationId = Utils.newGuid();
|
||||
const result = await importer.parse(testDataJson);
|
||||
expect(result != null).toBe(true);
|
||||
|
||||
const collections = result.collections;
|
||||
expect(collections.length).toBe(2);
|
||||
expect(collections[0].name).toBe("Personal");
|
||||
expect(collections[1].name).toBe("Test");
|
||||
|
||||
// "My Secure Note" is assigned to folder "Personal"
|
||||
expect(result.collectionRelationships[1]).toEqual([1, 0]);
|
||||
// "Other vault login" is assigned to folder "Test"
|
||||
expect(result.collectionRelationships[3]).toEqual([3, 1]);
|
||||
});
|
||||
|
||||
it("should not add deleted items", async () => {
|
||||
const testDataJson = JSON.stringify(testData);
|
||||
const result = await importer.parse(testDataJson);
|
||||
|
||||
const ciphers = result.ciphers;
|
||||
for (const cipher of ciphers) {
|
||||
expect(cipher.name).not.toBe("My Deleted Note");
|
||||
}
|
||||
|
||||
expect(ciphers.length).toBe(4);
|
||||
});
|
||||
});
|
||||
174
libs/importer/spec/test-data/protonpass-json/protonpass.json.ts
Normal file
174
libs/importer/spec/test-data/protonpass-json/protonpass.json.ts
Normal file
@@ -0,0 +1,174 @@
|
||||
import { ProtonPassJsonFile } from "../../../src/importers/protonpass/types/protonpass-json-type";
|
||||
|
||||
export const testData: ProtonPassJsonFile = {
|
||||
version: "1.3.1",
|
||||
userId: "REDACTED_USER_ID",
|
||||
encrypted: false,
|
||||
vaults: {
|
||||
REDACTED_VAULT_ID_A: {
|
||||
name: "Personal",
|
||||
description: "Personal vault",
|
||||
display: {
|
||||
color: 0,
|
||||
icon: 0,
|
||||
},
|
||||
items: [
|
||||
{
|
||||
itemId:
|
||||
"yZENmDjtmZGODNy3Q_CZiPAF_IgINq8w-R-qazrOh-Nt9YJeVF3gu07ovzDS4jhYHoMdOebTw5JkYPGgIL1mwQ==",
|
||||
shareId:
|
||||
"SN5uWo4WZF2uT5wIDqtbdpkjuxCbNTOIdf-JQ_DYZcKYKURHiZB5csS1a1p9lklvju9ni42l08IKzwQG0B2ySg==",
|
||||
data: {
|
||||
metadata: {
|
||||
name: "Test Login - Personal Vault",
|
||||
note: "My login secure note.",
|
||||
itemUuid: "e8ee1a0c",
|
||||
},
|
||||
extraFields: [
|
||||
{
|
||||
fieldName: "non-hidden field",
|
||||
type: "text",
|
||||
data: {
|
||||
content: "non-hidden field content",
|
||||
},
|
||||
},
|
||||
{
|
||||
fieldName: "hidden field",
|
||||
type: "hidden",
|
||||
data: {
|
||||
content: "hidden field content",
|
||||
},
|
||||
},
|
||||
{
|
||||
fieldName: "second 2fa secret",
|
||||
type: "totp",
|
||||
data: {
|
||||
totpUri: "TOTPCODE",
|
||||
},
|
||||
},
|
||||
],
|
||||
type: "login",
|
||||
content: {
|
||||
username: "Username",
|
||||
password: "Password",
|
||||
urls: ["https://example.com/", "https://example2.com/"],
|
||||
totpUri:
|
||||
"otpauth://totp/Test%20Login%20-%20Personal%20Vault:Username?issuer=Test%20Login%20-%20Personal%20Vault&secret=TOTPCODE&algorithm=SHA1&digits=6&period=30",
|
||||
},
|
||||
},
|
||||
state: 1,
|
||||
aliasEmail: null,
|
||||
contentFormatVersion: 1,
|
||||
createTime: 1689182868,
|
||||
modifyTime: 1689182868,
|
||||
},
|
||||
{
|
||||
itemId:
|
||||
"xqq_Bh8RxNMBerkiMvRdH427yswZznjYwps-f6C5D8tmKiPgMxCSPNz1BOd4nRJ309gciDiPhXcCVWOyfJ66ZA==",
|
||||
shareId:
|
||||
"SN5uWo4WZF2uT5wIDqtbdpkjuxCbNTOIdf-JQ_DYZcKYKURHiZB5csS1a1p9lklvju9ni42l08IKzwQG0B2ySg==",
|
||||
data: {
|
||||
metadata: {
|
||||
name: "My Secure Note",
|
||||
note: "Secure note contents.",
|
||||
itemUuid: "ad618070",
|
||||
},
|
||||
extraFields: [],
|
||||
type: "note",
|
||||
content: {},
|
||||
},
|
||||
state: 1,
|
||||
aliasEmail: null,
|
||||
contentFormatVersion: 1,
|
||||
createTime: 1689182908,
|
||||
modifyTime: 1689182908,
|
||||
},
|
||||
{
|
||||
itemId:
|
||||
"ZmGzd-HNQYTr6wmfWlSfiStXQLqGic_PYB2Q2T_hmuRM2JIA4pKAPJcmFafxJrDpXxLZ2EPjgD6Noc9a0U6AVQ==",
|
||||
shareId:
|
||||
"SN5uWo4WZF2uT5wIDqtbdpkjuxCbNTOIdf-JQ_DYZcKYKURHiZB5csS1a1p9lklvju9ni42l08IKzwQG0B2ySg==",
|
||||
data: {
|
||||
metadata: {
|
||||
name: "Test Card",
|
||||
note: "Credit Card Note",
|
||||
itemUuid: "d8f45370",
|
||||
},
|
||||
extraFields: [],
|
||||
type: "creditCard",
|
||||
content: {
|
||||
cardholderName: "Test name",
|
||||
cardType: 0,
|
||||
number: "1234222233334444",
|
||||
verificationNumber: "333",
|
||||
expirationDate: "012025",
|
||||
pin: "1234",
|
||||
},
|
||||
},
|
||||
state: 1,
|
||||
aliasEmail: null,
|
||||
contentFormatVersion: 1,
|
||||
createTime: 1691001643,
|
||||
modifyTime: 1691001643,
|
||||
},
|
||||
{
|
||||
itemId:
|
||||
"xqq_Bh8RxNMBerkiMvRdH427yswZznjYwps-f6C5D8tmKiPgMxCSPNz1BOd4nRJ309gciDiPhXcCVWOyfJ66ZA==",
|
||||
shareId:
|
||||
"SN5uWo4WZF2uT5wIDqtbdpkjuxCbNTOIdf-JQ_DYZcKYKURHiZB5csS1a1p9lklvju9ni42l08IKzwQG0B2ySg==",
|
||||
data: {
|
||||
metadata: {
|
||||
name: "My Deleted Note",
|
||||
note: "Secure note contents.",
|
||||
itemUuid: "ad618070",
|
||||
},
|
||||
extraFields: [],
|
||||
type: "note",
|
||||
content: {},
|
||||
},
|
||||
state: 2,
|
||||
aliasEmail: null,
|
||||
contentFormatVersion: 1,
|
||||
createTime: 1689182908,
|
||||
modifyTime: 1689182908,
|
||||
},
|
||||
],
|
||||
},
|
||||
REDACTED_VAULT_ID_B: {
|
||||
name: "Test",
|
||||
description: "",
|
||||
display: {
|
||||
color: 4,
|
||||
icon: 2,
|
||||
},
|
||||
items: [
|
||||
{
|
||||
itemId:
|
||||
"U_J8-eUR15sC-PjUhjVcixDcayhjGuoerUZCr560RlAi0ZjBNkSaSKAytVzZn4E0hiFX1_y4qZbUetl6jO3aJw==",
|
||||
shareId:
|
||||
"OJz-4MnPqAuYnyemhctcGDlSLJrzsTnf2FnFSwxh1QP_oth9xyGDc2ZAqCv5FnqkVgTNHT5aPj62zcekNemfNw==",
|
||||
data: {
|
||||
metadata: {
|
||||
name: "Other vault login",
|
||||
note: "",
|
||||
itemUuid: "f3429d44",
|
||||
},
|
||||
extraFields: [],
|
||||
type: "login",
|
||||
content: {
|
||||
username: "other vault username",
|
||||
password: "other vault password",
|
||||
urls: [],
|
||||
totpUri: "",
|
||||
},
|
||||
},
|
||||
state: 1,
|
||||
aliasEmail: null,
|
||||
contentFormatVersion: 1,
|
||||
createTime: 1689182949,
|
||||
modifyTime: 1689182949,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
Reference in New Issue
Block a user