@azure/msal-node-extensions 1.0.0-alpha.9 → 1.0.0-beta.0

package/src/persistence/FilePersistenceWithDataProtection.ts

@@ -1,92 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { IPersistence } from "./IPersistence";
-import { FilePersistence } from "./FilePersistence";
-import { PersistenceError } from "../error/PersistenceError";
-import { Dpapi } from "../dpapi-addon/Dpapi";
-import { DataProtectionScope } from "./DataProtectionScope";
-import { Logger, LoggerOptions } from "@azure/msal-common";
-import { dirname } from "path";
-import { BasePersistence } from "./BasePersistence";
-
-/**
- * Uses CryptProtectData and CryptUnprotectData on Windows to encrypt and decrypt file contents.
- *
- * scope: Scope of the data protection. Either local user or the current machine
- * optionalEntropy: Password or other additional entropy used to encrypt the data
- */
-export class FilePersistenceWithDataProtection extends BasePersistence implements IPersistence {
-
-    private filePersistence: FilePersistence;
-    private scope: DataProtectionScope;
-    private optionalEntropy: Uint8Array;
-
-    private constructor(scope: DataProtectionScope, optionalEntropy?: string) {
-        super();
-        this.scope = scope;
-        this.optionalEntropy = optionalEntropy ? Buffer.from(optionalEntropy, "utf-8") : null;
-    }
-
-    public static async create(
-        fileLocation: string,
-        scope: DataProtectionScope,
-        optionalEntropy?: string,
-        loggerOptions?: LoggerOptions): Promise<FilePersistenceWithDataProtection> {
-
-        const persistence = new FilePersistenceWithDataProtection(scope, optionalEntropy);
-        persistence.filePersistence = await FilePersistence.create(fileLocation, loggerOptions);
-        return persistence;
-    }
-
-    public async save(contents: string): Promise<void> {
-        try {
-            const encryptedContents = Dpapi.protectData(
-                Buffer.from(contents, "utf-8"),
-                this.optionalEntropy,
-                this.scope.toString());
-            await this.filePersistence.saveBuffer(encryptedContents);
-        } catch (err) {
-            throw PersistenceError.createFilePersistenceWithDPAPIError(err.message);
-        }
-    }
-
-    public async load(): Promise<string | null> {
-        try {
-            const encryptedContents = await this.filePersistence.loadBuffer();
-            if (typeof encryptedContents === "undefined" || !encryptedContents || 0 === encryptedContents.length) {
-                this.filePersistence.getLogger().info("Encrypted contents loaded from file were null or empty");
-                return null;
-            }
-            return Dpapi.unprotectData(
-                encryptedContents,
-                this.optionalEntropy,
-                this.scope.toString()).toString();
-        } catch (err) {
-            throw PersistenceError.createFilePersistenceWithDPAPIError(err.message);
-        }
-    }
-
-    public async delete(): Promise<boolean> {
-        return this.filePersistence.delete();
-    }
-
-    public async reloadNecessary(lastSync: number): Promise<boolean> {
-        return this.filePersistence.reloadNecessary(lastSync);
-    }
-
-    public getFilePath(): string {
-        return this.filePersistence.getFilePath();
-    }
-
-    public getLogger(): Logger {
-        return this.filePersistence.getLogger();
-    }
-
-    public createForPersistenceValidation(): Promise<FilePersistenceWithDataProtection> {
-        const testCacheFileLocation = `${dirname(this.filePersistence.getFilePath())}/test.cache`;
-        return FilePersistenceWithDataProtection.create(testCacheFileLocation, DataProtectionScope.CurrentUser);
-    }
-}

package/src/persistence/IPersistence.ts

@@ -1,17 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { Logger } from "@azure/msal-common";
-
-export interface IPersistence {
-    save(contents: string): Promise<void>;
-    load(): Promise<string | null>;
-    delete(): Promise<boolean>;
-    reloadNecessary(lastSync: number): Promise<boolean>;
-    getFilePath(): string;
-    getLogger(): Logger;
-    verifyPersistence(): Promise<boolean>;
-    createForPersistenceValidation(): Promise<IPersistence>;
-}

package/src/persistence/IPersistenceConfiguration.ts

@@ -1,14 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { DataProtectionScope } from "./DataProtectionScope";
-
-export interface IPersistenceConfiguration {
-    cachePath?: string,
-    dataProtectionScope?: DataProtectionScope,
-    serviceName?: string,
-    accountName?: string,
-    usePlaintextFileOnLinux?: boolean,
-}

package/src/persistence/KeychainPersistence.ts

@@ -1,86 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { setPassword, getPassword, deletePassword } from "keytar";
-import { FilePersistence } from "./FilePersistence";
-import { IPersistence } from "./IPersistence";
-import { PersistenceError } from "../error/PersistenceError";
-import { Logger, LoggerOptions } from "@azure/msal-common";
-import { dirname } from "path";
-import { BasePersistence } from "./BasePersistence";
-
-/**
- * Uses reads and writes passwords to macOS keychain
- *
- * serviceName: Identifier used as key for whatever value is stored
- * accountName: Account under which password should be stored
- */
-export class KeychainPersistence extends BasePersistence implements IPersistence {
-
-    protected readonly serviceName;
-    protected readonly accountName;
-    private filePersistence: FilePersistence;
-
-    private constructor(serviceName: string, accountName: string) {
-        super();
-        this.serviceName = serviceName;
-        this.accountName = accountName;
-    }
-
-    public static async create(
-        fileLocation: string,
-        serviceName: string,
-        accountName: string,
-        loggerOptions?: LoggerOptions): Promise<KeychainPersistence> {
-
-        const persistence = new KeychainPersistence(serviceName, accountName);
-        persistence.filePersistence = await FilePersistence.create(fileLocation, loggerOptions);
-        return persistence;
-    }
-
-    public async save(contents: string): Promise<void> {
-        try {
-            await setPassword(this.serviceName, this.accountName, contents);
-        } catch (err) {
-            throw PersistenceError.createKeychainPersistenceError(err.message);
-        }
-        // Write dummy data to update file mtime
-        await this.filePersistence.save("{}");
-    }
-
-    public async load(): Promise<string | null> {
-        try{
-            return await getPassword(this.serviceName, this.accountName);
-        } catch(err){
-            throw PersistenceError.createKeychainPersistenceError(err.message);
-        }
-    }
-
-    public async delete(): Promise<boolean> {
-        try {
-            await this.filePersistence.delete();
-            return await deletePassword(this.serviceName, this.accountName);
-        } catch (err) {
-            throw PersistenceError.createKeychainPersistenceError(err.message);
-        }
-    }
-
-    public async reloadNecessary(lastSync: number): Promise<boolean> {
-        return this.filePersistence.reloadNecessary(lastSync);
-    }
-
-    public getFilePath(): string {
-        return this.filePersistence.getFilePath();
-    }
-
-    public getLogger(): Logger {
-        return this.filePersistence.getLogger();
-    }
-   
-    public createForPersistenceValidation(): Promise<KeychainPersistence> {
-        const testCacheFileLocation = `${dirname(this.filePersistence.getFilePath())}/test.cache`;
-        return KeychainPersistence.create(testCacheFileLocation, "persistenceValidationServiceName", "persistencValidationAccountName");
-    }
-}

package/src/persistence/LibSecretPersistence.ts

@@ -1,87 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { setPassword, getPassword, deletePassword } from "keytar";
-import { FilePersistence } from "./FilePersistence";
-import { IPersistence } from "./IPersistence";
-import { PersistenceError } from "../error/PersistenceError";
-import { Logger, LoggerOptions } from "@azure/msal-common";
-import { dirname } from "path";
-import { BasePersistence } from "./BasePersistence";
-
-/**
- * Uses reads and writes passwords to Secret Service API/libsecret. Requires libsecret
- * to be installed.
- *
- * serviceName: Identifier used as key for whatever value is stored
- * accountName: Account under which password should be stored
- */
-export class LibSecretPersistence extends BasePersistence implements IPersistence {
-
-    protected readonly serviceName;
-    protected readonly accountName;
-    private filePersistence: FilePersistence;
-
-    private constructor(serviceName: string, accountName: string) {
-        super();
-        this.serviceName = serviceName;
-        this.accountName = accountName;
-    }
-
-    public static async create(
-        fileLocation: string,
-        serviceName: string,
-        accountName: string,
-        loggerOptions?: LoggerOptions): Promise<LibSecretPersistence> {
-
-        const persistence = new LibSecretPersistence(serviceName, accountName);
-        persistence.filePersistence = await FilePersistence.create(fileLocation, loggerOptions);
-        return persistence;
-    }
-
-    public async save(contents: string): Promise<void> {
-        try {
-            await setPassword(this.serviceName, this.accountName, contents);
-        } catch (err) {
-            throw PersistenceError.createLibSecretError(err.message);
-        }
-        // Write dummy data to update file mtime
-        await this.filePersistence.save("{}");
-    }
-
-    public async load(): Promise<string | null> {
-        try {
-            return await getPassword(this.serviceName, this.accountName);
-        } catch (err) {
-            throw PersistenceError.createLibSecretError(err.message);
-        }
-    }
-
-    public async delete(): Promise<boolean> {
-        try {
-            await this.filePersistence.delete();
-            return await deletePassword(this.serviceName, this.accountName);
-        } catch (err) {
-            throw PersistenceError.createLibSecretError(err.message);
-        }
-    }
-
-    public async reloadNecessary(lastSync: number): Promise<boolean> {
-        return this.filePersistence.reloadNecessary(lastSync);
-    }
-
-    public getFilePath(): string {
-        return this.filePersistence.getFilePath();
-    }
-
-    public getLogger(): Logger {
-        return this.filePersistence.getLogger();
-    }
-      
-    public createForPersistenceValidation(): Promise<LibSecretPersistence> {
-        const testCacheFileLocation = `${dirname(this.filePersistence.getFilePath())}/test.cache`;
-        return LibSecretPersistence.create(testCacheFileLocation, "persistenceValidationServiceName", "persistencValidationAccountName");
-    }
-}

package/src/persistence/PersistenceCreator.ts

@@ -1,73 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-import { FilePersistenceWithDataProtection } from "../persistence/FilePersistenceWithDataProtection";
-import { LibSecretPersistence } from "../persistence/LibSecretPersistence";
-import { KeychainPersistence } from "../persistence/KeychainPersistence";
-import { DataProtectionScope } from "../persistence/DataProtectionScope";
-import { Environment } from "../utils/Environment";
-import { IPersistence } from "./IPersistence";
-import { FilePersistence } from "./FilePersistence";
-import { PersistenceError } from "../error/PersistenceError";
-import { IPersistenceConfiguration } from "../persistence/IPersistenceConfiguration";
-
-export class PersistenceCreator {
-    static async createPersistence(config: IPersistenceConfiguration): Promise<IPersistence> {
-        let peristence: IPersistence;
-
-        // On Windows, uses a DPAPI encrypted file
-        if (Environment.isWindowsPlatform()) {
-            if (!config.cachePath || !config.dataProtectionScope) {
-                throw PersistenceError.createPersistenceNotValidatedError(`Cache path and/or data protection scope not provided for the FilePersistenceWithDataProtection cache plugin`);
-            }
-
-            peristence = await FilePersistenceWithDataProtection.create(config.cachePath, DataProtectionScope.CurrentUser);
-        }
-
-        // On Mac, uses keychain.
-        else if (Environment.isMacPlatform()) {
-            if (!config.cachePath || !config.serviceName || !config.accountName) {
-                throw PersistenceError.createPersistenceNotValidatedError(`Cache path, service name and/or account name not provided for the KeychainPersistence cache plugin`);
-            }
-
-            peristence = await KeychainPersistence.create(config.cachePath, config.serviceName, config.accountName);
-        }
-
-        // On Linux, uses  libsecret to store to secret service. Libsecret has to be installed.
-        else if (Environment.isLinuxPlatform()) {
-            if (!config.cachePath || !config.serviceName || !config.accountName) {
-                throw PersistenceError.createPersistenceNotValidatedError(`Cache path, service name and/or account name not provided for the LibSecretPersistence cache plugin`);
-            }
-
-            peristence = await LibSecretPersistence.create(config.cachePath, config.serviceName, config.accountName);
-        }
-
-        else {
-            throw PersistenceError.createNotSupportedError("The current environment is not supported by msal-node-extensions yet.");
-        }
-
-        // Initially suppress the error thrown during persistence verification to allow us to fallback to plain text
-        const isPersistenceVerified = await peristence.verifyPersistence().catch(() => false);
-        
-        if (!isPersistenceVerified) {
-            if (Environment.isLinuxPlatform() && config.usePlaintextFileOnLinux) {
-                if (!config.cachePath) {
-                    throw PersistenceError.createPersistenceNotValidatedError(`Cache path not provided for the FilePersistence cache plugin`);
-                }
-
-                peristence = await FilePersistence.create(config.cachePath);
-
-                const isFilePersistenceVerified = await peristence.verifyPersistence();
-                if (isFilePersistenceVerified) {
-                    return peristence;
-                }
-            }
-
-            throw PersistenceError.createPersistenceNotVerifiedError("Persistence could not be verified");
-        }
-
-        return peristence;
-    }
-}