@binsky/passman-client-ts 0.1.0-7

package/README.md

@@ -0,0 +1,9 @@
+# Passman Client TS
+
+A TypeScript based Passman client library
+
+> This is currently under development, do not use in productive!
+> Things should break :D
+
+---
+

package/lib/BrowserStorage.d.ts

@@ -0,0 +1,39 @@
+export declare enum BrowserStorageType {
+    MEMORY = "memory",
+    SESSION = "sessionStorage",
+    PERSISTENT = "localStorage"
+}
+/**
+ * Custom encrypted browser storage handler that uses sessionStorage by default.
+ * The get, set, del methods automatically use the storage type stored in the localStorage, or SESSION by default.
+ */
+export declare class BrowserStorage {
+    private secretKey;
+    private identifier;
+    private storageType;
+    private static defaultStorageType;
+    private static instances;
+    private encryptStorage;
+    private fakeMemoryStorage;
+    private constructor();
+    /**
+     * Returns an existing BrowserStorage instance or creates a new one based on a unique identifier with the given storage type.
+     */
+    static getInstance(secretKey: string, identifier?: string, storageType?: BrowserStorageType): BrowserStorage;
+    /**
+     * Check if there is at least one instance with the specified identifier, ignoring the BrowserStorageType.
+     * @param identifier
+     */
+    static hasInstance(identifier: string): boolean;
+    static getDefaultStorageType(): string;
+    static setDefaultStorageType(storageType: BrowserStorageType): void;
+    static clearAllStorageTypesForVaultGUID(vaultGUID: string): void;
+    static ensureDeleteKeyForAllStorageTypes(storageIdentifier: string, keyToDelete: string): void;
+    updateStorageType(storageType: BrowserStorageType): void;
+    getStorageType(): BrowserStorageType;
+    getIdentifier(): string;
+    get: (key: string) => any | undefined;
+    set: (key: string, value: any) => void;
+    del: (key: string) => void;
+    clearDeleteStorage(): void;
+}

package/lib/BrowserStorage.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrowserStorage = exports.BrowserStorageType = void 0;
+const encrypt_storage_1 = require("encrypt-storage");
+var BrowserStorageType;
+(function (BrowserStorageType) {
+    BrowserStorageType["MEMORY"] = "memory";
+    BrowserStorageType["SESSION"] = "sessionStorage";
+    BrowserStorageType["PERSISTENT"] = "localStorage";
+})(BrowserStorageType || (exports.BrowserStorageType = BrowserStorageType = {}));
+/**
+ * Custom encrypted browser storage handler that uses sessionStorage by default.
+ * The get, set, del methods automatically use the storage type stored in the localStorage, or SESSION by default.
+ */
+class BrowserStorage {
+    secretKey;
+    identifier;
+    storageType;
+    static defaultStorageType = localStorage.getItem("storage");
+    static instances = [];
+    encryptStorage;
+    fakeMemoryStorage = {};
+    constructor(secretKey, identifier, storageType) {
+        this.secretKey = secretKey;
+        this.identifier = identifier;
+        this.storageType = storageType;
+        this.encryptStorage = new encrypt_storage_1.EncryptStorage(this.secretKey, {
+            prefix: '@' + identifier,
+            storageType: storageType === BrowserStorageType.PERSISTENT ? BrowserStorageType.PERSISTENT : BrowserStorageType.SESSION
+        });
+        BrowserStorage.instances.push(this);
+    }
+    /**
+     * Returns an existing BrowserStorage instance or creates a new one based on a unique identifier with the given storage type.
+     */
+    static getInstance(secretKey, identifier = "default", storageType = undefined) {
+        for (let i = 0; i < BrowserStorage.instances.length; i++) {
+            if (BrowserStorage.instances[i].identifier === identifier) {
+                return BrowserStorage.instances[i];
+            }
+        }
+        return new BrowserStorage(secretKey, identifier, storageType ?? BrowserStorage.defaultStorageType);
+    }
+    /**
+     * Check if there is at least one instance with the specified identifier, ignoring the BrowserStorageType.
+     * @param identifier
+     */
+    static hasInstance(identifier) {
+        for (let i = 0; i < BrowserStorage.instances.length; i++) {
+            if (BrowserStorage.instances[i].identifier === identifier) {
+                return true;
+            }
+        }
+        return false;
+    }
+    static getDefaultStorageType() {
+        return BrowserStorage.defaultStorageType;
+    }
+    static setDefaultStorageType(storageType) {
+        BrowserStorage.defaultStorageType = storageType;
+        localStorage.setItem("storage", storageType);
+    }
+    static clearAllStorageTypesForVaultGUID(vaultGUID) {
+        // delete all vault browser storage instances, if exists
+        BrowserStorage.getInstance('vault-' + vaultGUID, BrowserStorageType.MEMORY).clearDeleteStorage();
+        BrowserStorage.getInstance('vault-' + vaultGUID, BrowserStorageType.SESSION).clearDeleteStorage();
+        BrowserStorage.getInstance('vault-' + vaultGUID, BrowserStorageType.PERSISTENT).clearDeleteStorage();
+    }
+    static ensureDeleteKeyForAllStorageTypes(storageIdentifier, keyToDelete) {
+        BrowserStorage.getInstance(storageIdentifier, BrowserStorageType.MEMORY).del(keyToDelete);
+        BrowserStorage.getInstance(storageIdentifier, BrowserStorageType.SESSION).del(keyToDelete);
+        BrowserStorage.getInstance(storageIdentifier, BrowserStorageType.PERSISTENT).del(keyToDelete);
+    }
+    updateStorageType(storageType) {
+        if (this.storageType !== storageType) {
+            this.storageType = storageType;
+            if (storageType !== BrowserStorageType.MEMORY) {
+                this.encryptStorage = new encrypt_storage_1.EncryptStorage(this.secretKey, {
+                    prefix: '@' + this.identifier,
+                    storageType: storageType === BrowserStorageType.PERSISTENT ? BrowserStorageType.PERSISTENT : BrowserStorageType.SESSION,
+                });
+            }
+        }
+    }
+    getStorageType() {
+        return this.storageType;
+    }
+    getIdentifier() {
+        return this.identifier;
+    }
+    get = (key) => {
+        if (BrowserStorage.defaultStorageType === BrowserStorageType.MEMORY) {
+            if (key in Object.keys(this.fakeMemoryStorage)) {
+                return this.fakeMemoryStorage[key];
+            }
+        }
+        else {
+            return this.encryptStorage.getItem(key);
+        }
+        return undefined;
+    };
+    set = (key, value) => {
+        if (BrowserStorage.defaultStorageType === BrowserStorageType.MEMORY) {
+            this.fakeMemoryStorage[key] = value;
+        }
+        else {
+            this.encryptStorage.setItem(key, value);
+        }
+    };
+    del = (key) => {
+        if (BrowserStorage.defaultStorageType === BrowserStorageType.MEMORY) {
+            delete this.fakeMemoryStorage[key];
+        }
+        else {
+            this.encryptStorage.removeItem(key);
+        }
+    };
+    clearDeleteStorage() {
+        /*
+            this.encryptStorage.clear(); clears the complete storage of the selected type and does not difference by identifier.
+            So we use this custom implementation to clear by identifier prefix.
+         */
+        if (this.storageType !== BrowserStorageType.MEMORY) {
+            const selectedStorage = this.storageType === BrowserStorageType.SESSION ? sessionStorage : localStorage;
+            Object.keys(selectedStorage)
+                .filter(x => x.startsWith('@' + this.identifier))
+                .forEach(x => selectedStorage.removeItem(x));
+        }
+        for (let i = 0; i < BrowserStorage.instances.length; i++) {
+            if (BrowserStorage.instances[i].identifier === this.identifier) {
+                BrowserStorage.instances.splice(i, 1);
+                break;
+            }
+        }
+    }
+}
+exports.BrowserStorage = BrowserStorage;

package/lib/Exception/ConfigurationError.d.ts

@@ -0,0 +1,6 @@
+export default class ConfigurationError extends Error {
+    /**
+     * @returns {String}
+     */
+    get name(): string;
+}

package/lib/Exception/ConfigurationError.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ConfigurationError extends Error {
+    /**
+     * @returns {String}
+     */
+    get name() {
+        return 'ConfigurationError';
+    }
+}
+exports.default = ConfigurationError;

package/lib/Exception/FormFieldError.d.ts

@@ -0,0 +1,4 @@
+export interface IFormFieldError {
+    error: string;
+    field?: string;
+}

package/lib/Exception/FormFieldError.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/Credential/CredentialInterface.d.ts

@@ -0,0 +1,33 @@
+import { CustomFieldInterface } from "./CustomFieldInterface";
+import { TagInterface } from "./TagInterface";
+import { IconInterface } from "./IconInterface";
+import { FileInterface } from "../File/FileInterface";
+import { OTPConfigInterface } from "./OTPConfigInterface";
+export interface CredentialInterface {
+    credential_id?: number;
+    guid?: string;
+    user_id: string;
+    vault_id: number;
+    label: string;
+    description: string;
+    tags: TagInterface[];
+    email: string;
+    username: string;
+    password: string;
+    url: string;
+    files: FileInterface[];
+    custom_fields: CustomFieldInterface[];
+    otp: OTPConfigInterface;
+    compromised: boolean;
+    shared_key: string | null;
+    favicon: string;
+    icon: IconInterface | null;
+    renew_interval: number | null;
+    expire_time: number;
+    delete_time: number;
+    hidden: boolean;
+    created: number;
+    changed: number;
+    set_share_key: boolean | null;
+    skip_revision: boolean | null;
+}

package/lib/Interfaces/Credential/CredentialInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/Credential/CustomFieldInterface.d.ts

@@ -0,0 +1,6 @@
+export interface CustomFieldInterface {
+    label: string;
+    secret: boolean;
+    field_type: string;
+    value: string | object | any;
+}

package/lib/Interfaces/Credential/CustomFieldInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/Credential/EncryptedCredentialInterface.d.ts

@@ -0,0 +1,31 @@
+import { IconInterface } from "./IconInterface";
+import { ACLInterface } from "../ShareService/ACLInterface";
+export interface EncryptedCredentialInterface {
+    credential_id?: number;
+    guid?: string;
+    user_id: string;
+    vault_id: number;
+    label: string;
+    description: string;
+    tags: string;
+    email: string;
+    username: string;
+    password: string;
+    url: string;
+    files: string;
+    custom_fields: string;
+    otp: string;
+    compromised: string;
+    shared_key: string | null;
+    favicon: string;
+    icon: IconInterface | null;
+    renew_interval: number | null;
+    expire_time: number;
+    delete_time: number;
+    hidden: boolean;
+    created: number;
+    changed: number;
+    set_share_key: boolean | null;
+    skip_revision: boolean | null;
+    acl?: ACLInterface;
+}

package/lib/Interfaces/Credential/EncryptedCredentialInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/Credential/IconInterface.d.ts

@@ -0,0 +1,4 @@
+export interface IconInterface {
+    type?: string | boolean;
+    content: string;
+}

package/lib/Interfaces/Credential/IconInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/Credential/OTPConfigInterface.d.ts

@@ -0,0 +1,14 @@
+import { Secret } from "otpauth";
+export interface OTPConfigInterface {
+    issuer?: string | undefined;
+    label?: string | undefined;
+    secret?: string | Secret | undefined;
+    algorithm?: string | undefined;
+    digits?: number | undefined;
+    period?: number | undefined;
+    qr_uri?: undefined | {
+        qrData: string;
+        image: any;
+    };
+    type?: string;
+}

package/lib/Interfaces/Credential/OTPConfigInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/Credential/TagInterface.d.ts

@@ -0,0 +1,3 @@
+export interface TagInterface {
+    text?: string;
+}

package/lib/Interfaces/Credential/TagInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/CredentialFilterService/FilterStatsInterface.d.ts

@@ -0,0 +1,10 @@
+export interface FilterStatsInterface {
+    allVisible: number;
+    compromised: number;
+    strengthLow: number;
+    strengthMedium: number;
+    strengthGood: number;
+    expired: number;
+    deleted: number;
+    encryptionBroken: number;
+}

package/lib/Interfaces/CredentialFilterService/FilterStatsInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/File/DeleteFilesRequestBodyInterface.d.ts

@@ -0,0 +1,3 @@
+export interface DeleteFilesRequestBodyInterface {
+    file_ids: string;
+}

package/lib/Interfaces/File/DeleteFilesRequestBodyInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/File/DeleteFilesResponseInterface.d.ts

@@ -0,0 +1,4 @@
+export interface DeleteFilesResponseInterface {
+    ok: boolean;
+    failed: number[];
+}

package/lib/Interfaces/File/DeleteFilesResponseInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/File/FileInterface.d.ts

@@ -0,0 +1,9 @@
+export interface FileInterface {
+    filename: string;
+    size: number;
+    mimetype: string;
+    data: string;
+    file_id?: number;
+    guid?: string;
+    created?: number;
+}

package/lib/Interfaces/File/FileInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/File/FileUploadResponseInterface.d.ts

@@ -0,0 +1,9 @@
+export interface FileUploadResponseInterface {
+    file_id: number;
+    filename: string;
+    guid: string;
+    size: number;
+    file_data: string;
+    created: number;
+    mimetype: string;
+}

package/lib/Interfaces/File/FileUploadResponseInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/LoggingHandlerInterface.d.ts

@@ -0,0 +1,9 @@
+export interface LoggingHandlerInterface {
+    onDebug(message: string): void;
+    onInfo(message: string): void;
+    onSuccess(message: string): void;
+    onWarning(message: string): void;
+    onError(message: string): void;
+    anyError(error: any): void;
+    onThrow(error: Error): void;
+}

package/lib/Interfaces/LoggingHandlerInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/NextcloudServer/NextcloudServerInterface.d.ts

@@ -0,0 +1,6 @@
+export interface NextcloudServerInterface {
+    baseUrl: string;
+    user: string;
+    token: string;
+    persistence: string;
+}

package/lib/Interfaces/NextcloudServer/NextcloudServerInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/PassmanCrypto/GenerateKeypairResponseInterface.d.ts

@@ -0,0 +1,5 @@
+import { RSAKeypairInterface } from "./RSAKeypairInterface";
+export interface GenerateKeypairResponseInterface {
+    error: Error;
+    keypair: RSAKeypairInterface;
+}

package/lib/Interfaces/PassmanCrypto/GenerateKeypairResponseInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/PassmanCrypto/PEMRSAKeypairInterface.d.ts

@@ -0,0 +1,4 @@
+export interface PEMRSAKeypairInterface {
+    privateKey: string;
+    publicKey: string;
+}

package/lib/Interfaces/PassmanCrypto/PEMRSAKeypairInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/PassmanCrypto/RSAKeypairInterface.d.ts

@@ -0,0 +1,5 @@
+import { pki } from "node-forge";
+export interface RSAKeypairInterface {
+    privateKey: pki.PrivateKey;
+    publicKey: pki.PublicKey;
+}

package/lib/Interfaces/PassmanCrypto/RSAKeypairInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/PasswordGeneratorService/PasswordGeneratorConfigurationInterface.d.ts

@@ -0,0 +1,9 @@
+export interface PasswordGeneratorConfigurationInterface {
+    length: number;
+    useUppercase: boolean;
+    useLowercase: boolean;
+    useDigits: boolean;
+    useSpecialChars: boolean;
+    avoidAmbiguousCharacters: boolean;
+    requireEveryCharType: boolean;
+}

package/lib/Interfaces/PasswordGeneratorService/PasswordGeneratorConfigurationInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/ReEncryptionService/ReEncryptionProgressInterface.d.ts

@@ -0,0 +1,7 @@
+import { ReEncryptionStageProgressInterface } from "./ReEncryptionStageProgressInterface";
+export interface ReEncryptionProgressInterface {
+    credentialsStage: ReEncryptionStageProgressInterface;
+    revisionsStage: ReEncryptionStageProgressInterface;
+    filesStage: ReEncryptionStageProgressInterface;
+    uploadStage: ReEncryptionStageProgressInterface;
+}

package/lib/Interfaces/ReEncryptionService/ReEncryptionProgressInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/ReEncryptionService/ReEncryptionStageProgressInterface.d.ts

@@ -0,0 +1,5 @@
+export interface ReEncryptionStageProgressInterface {
+    doneSteps: number;
+    totalSteps: number;
+    messages: string[];
+}

package/lib/Interfaces/ReEncryptionService/ReEncryptionStageProgressInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/Revision/RevisionInterface.d.ts

@@ -0,0 +1,8 @@
+import { EncryptedCredentialInterface } from "../Credential/EncryptedCredentialInterface";
+export interface RevisionInterface {
+    revision_id: number;
+    guid: string;
+    created: number;
+    credential_data: EncryptedCredentialInterface;
+    edited_by: string;
+}

package/lib/Interfaces/Revision/RevisionInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/ShareService/ACLInterface.d.ts

@@ -0,0 +1,15 @@
+import { SharingACL } from "../../Model/SharingACL";
+export interface ACLInterface {
+    acl_id: number;
+    item_id: number;
+    item_guid: string;
+    user_id: string;
+    created: number;
+    expire: number;
+    expire_views: number;
+    permissions: SharingACL;
+    vault_id: number;
+    vault_guid: string;
+    shared_key: string;
+    pending: boolean;
+}

package/lib/Interfaces/ShareService/ACLInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/ShareService/CredentialShareRequestInterface.d.ts

@@ -0,0 +1,16 @@
+import { EncryptedCredentialInterface } from "../Credential/EncryptedCredentialInterface";
+export interface CredentialShareRequestInterface {
+    acl_id: number;
+    item_id: number;
+    item_guid: string;
+    user_id: string;
+    created: number;
+    expire: number;
+    expire_views: number;
+    permissions: number;
+    vault_id: number;
+    vault_guid: string;
+    shared_key: string;
+    pending: boolean;
+    credential_data?: EncryptedCredentialInterface;
+}

package/lib/Interfaces/ShareService/CredentialShareRequestInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/Vault/VaultInterface.d.ts

@@ -0,0 +1,15 @@
+import Credential from "../../Model/Credential";
+export interface VaultInterface {
+    vault_id?: number;
+    guid?: string;
+    name: string;
+    created: number;
+    public_sharing_key: string;
+    private_sharing_key: string;
+    sharing_keys_generated: number;
+    last_access: number;
+    challenge_password: string;
+    delete_request_pending: boolean;
+    vault_settings: null;
+    credentials: Credential[];
+}

package/lib/Interfaces/Vault/VaultInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Interfaces/Vault/VaultResponseInterface.d.ts

@@ -0,0 +1,15 @@
+import { EncryptedCredentialInterface } from "../Credential/EncryptedCredentialInterface";
+export interface VaultResponseInterface {
+    vault_id?: number;
+    guid?: string;
+    name: string;
+    created: number;
+    public_sharing_key: string;
+    private_sharing_key: string;
+    sharing_keys_generated: number;
+    last_access: number;
+    challenge_password: string;
+    delete_request_pending: boolean;
+    vault_settings: null;
+    credentials: EncryptedCredentialInterface[];
+}

package/lib/Interfaces/Vault/VaultResponseInterface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/LocalPassmanStore.d.ts

@@ -0,0 +1,4 @@
+export declare class LocalPassmanStore {
+    private store;
+    constructor();
+}

package/lib/LocalPassmanStore.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalPassmanStore = void 0;
+const datastore_core_1 = require("datastore-core");
+const interface_datastore_1 = require("interface-datastore");
+class LocalPassmanStore {
+    store;
+    constructor() {
+        this.store = new datastore_core_1.MountDatastore([
+            { prefix: new interface_datastore_1.Key('memory'), datastore: new datastore_core_1.MemoryDatastore() }
+        ]);
+    }
+}
+exports.LocalPassmanStore = LocalPassmanStore;