@azure/msal-node-extensions 1.0.0-alpha.1 → 1.0.0-alpha.13

package/src/persistence/FilePersistenceWithDataProtection.ts

@@ -1,84 +1,92 @@
-/*
- * 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";
-
-/**
- * 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 implements IPersistence {
-
-    private filePersistence: FilePersistence;
-    private scope: DataProtectionScope;
-    private optionalEntropy: Uint8Array;
-
-    private constructor(scope: DataProtectionScope, optionalEntropy?: string) {
-        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.code, 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.code, 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();
-    }
-}
+/*
+ * 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,15 +1,17 @@
-/*
- * 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>;
-    delete(): Promise<boolean>;
-    reloadNecessary(lastSync: number): Promise<boolean>;
-    getFilePath(): string;
-    getLogger(): Logger
-}
+/*
+ * 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

@@ -0,0 +1,14 @@
+/*
+ * 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,78 +1,86 @@
-/*
- * 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";
-
-/**
- * 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 implements IPersistence {
-
-    protected readonly serviceName;
-    protected readonly accountName;
-    private filePersistence: FilePersistence;
-
-    private constructor(serviceName: string, accountName: string) {
-        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.code, 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.code, 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.code, 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();
-    }
-}
+/*
+ * 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,79 +1,87 @@
-/*
- * 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";
-
-/**
- * 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 implements IPersistence {
-
-    protected readonly serviceName;
-    protected readonly accountName;
-    private filePersistence: FilePersistence;
-
-    private constructor(serviceName: string, accountName: string) {
-        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.code, 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.code, 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.code, 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();
-    }
-}
+/*
+ * 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");
+    }
+}