@azure/msal-node-extensions 1.0.0-alpha.2 → 1.0.0-alpha.20

package/src/dpapi-addon/Dpapi.ts

@@ -1,12 +1,17 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-export interface DpapiBindings{
-    protectData(dataToEncrypt: Uint8Array, optionalEntropy: Uint8Array, scope: string): Uint8Array
-    unprotectData(encryptData: Uint8Array, optionalEntropy: Uint8Array, scope: string): Uint8Array
-}
-
-export var Dpapi: DpapiBindings = require("bindings")("dpapi");
-export default Dpapi;
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export interface DpapiBindings{
+    protectData(dataToEncrypt: Uint8Array, optionalEntropy: Uint8Array, scope: string): Uint8Array
+    unprotectData(encryptData: Uint8Array, optionalEntropy: Uint8Array, scope: string): Uint8Array
+}
+/* eslint-disable-next-line @typescript-eslint/no-var-requires, no-var, import/no-commonjs */
+export var Dpapi: DpapiBindings = require("bindings")({
+    bindings: "dpapi",
+    userDefinedTries: [
+        ["module_root", "node_modules", "@azure", "msal-node-extensions", "build", "Release",  "bindings"],
+    ]
+});
+export default Dpapi;

package/src/dpapi-addon/dpapi_addon.h

@@ -1,6 +1,6 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-void ProtectDataCommon(bool protect, Nan::NAN_METHOD_ARGS_TYPE info);
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+void ProtectDataCommon(bool protect, Nan::NAN_METHOD_ARGS_TYPE info);

package/src/dpapi-addon/dpapi_not_supported.cpp

@@ -1,19 +1,19 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-#include <node.h>
-
-v8::Local<v8::String> CreateUtf8String(v8::Isolate* isolate, char* strData)
-{
-	return v8::String::NewFromUtf8(isolate, strData, v8::NewStringType::kNormal).ToLocalChecked();
-}
-
-void ProtectDataCommon(bool protect, Nan::NAN_METHOD_ARGS_TYPE info)
-{
-	v8::Isolate* isolate = info.GetIsolate();
-
-	isolate->ThrowException(v8::Exception::Error(
-		CreateUtf8String(isolate, "Data protection API is not available on macOs or Linux")));
-}
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+#include <node.h>
+
+v8::Local<v8::String> CreateUtf8String(v8::Isolate* isolate, char* strData)
+{
+	return v8::String::NewFromUtf8(isolate, strData, v8::NewStringType::kNormal).ToLocalChecked();
+}
+
+void ProtectDataCommon(bool protect, Nan::NAN_METHOD_ARGS_TYPE info)
+{
+	v8::Isolate* isolate = info.GetIsolate();
+
+	isolate->ThrowException(v8::Exception::Error(
+		CreateUtf8String(isolate, "Data protection API is not available on macOs or Linux")));
+}

package/src/dpapi-addon/dpapi_win.cpp

@@ -1,114 +1,114 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
- // Implementation referenced from https://github.com/bradhugh/node-dpapi
-
-#include <node.h>
-#include <nan.h>
-#include <Windows.h>
-#include <dpapi.h>
-#include <functional>
-#include <iostream>
-#include <string>
-
-v8::Local<v8::String> CreateUtf8String(v8::Isolate* isolate, char* strData)
-{
-	return v8::String::NewFromUtf8(isolate, strData, v8::NewStringType::kNormal).ToLocalChecked();
-}
-
-void ProtectDataCommon(bool protect, Nan::NAN_METHOD_ARGS_TYPE info)
-{
-	v8::Isolate* isolate = info.GetIsolate();
-
-	if (info.Length() != 3) {
-		isolate->ThrowException(v8::Exception::RangeError(
-			CreateUtf8String(isolate, "3 arguments are required")));
-	}
-
-	if (info[0]->IsNullOrUndefined() || !info[0]->IsUint8Array())
-	{
-		isolate->ThrowException(v8::Exception::TypeError(
-			CreateUtf8String(isolate, "First argument, data, must be a valid Uint8Array")));
-	}
-
-	if (!info[1]->IsNull() && !info[1]->IsUint8Array())
-	{
-		isolate->ThrowException(v8::Exception::TypeError(
-			CreateUtf8String(isolate, "Second argument, optionalEntropy, must be null or an ArrayBuffer")));
-	}
-
-	if (info[2]->IsNullOrUndefined() || !info[2]->IsString())
-	{
-		isolate->ThrowException(v8::Exception::TypeError(
-			CreateUtf8String(isolate, "Third argument, scope, must be a string")));
-	}
-
-	DWORD flags = 0;
-	v8::String::Utf8Value strData(isolate, info[2]);
-	std::string scope(*strData);
-	if (stricmp(scope.c_str(), "LocalMachine") == 0)
-	{
-		flags = CRYPTPROTECT_LOCAL_MACHINE;
-	}
-
-	auto buffer = node::Buffer::Data(info[0]);
-	auto len = node::Buffer::Length(info[0]);
-
-	DATA_BLOB entropyBlob;
-	entropyBlob.pbData = nullptr;
-	if (!info[1]->IsNull())
-	{
-		entropyBlob.pbData = reinterpret_cast<BYTE*>(node::Buffer::Data(info[1]));
-		entropyBlob.cbData = node::Buffer::Length(info[1]);
-	}
-
-	DATA_BLOB dataIn;
-	DATA_BLOB dataOut;
-
-	// initialize input data
-	dataIn.pbData = reinterpret_cast<BYTE*>(buffer);
-	dataIn.cbData = len;
-
-	bool success = false;
-
-	// Call either Protect or Unprotect based on the flag
-	if (protect)
-	{
-		success = CryptProtectData(
-			&dataIn,
-			nullptr, // Description string
-			entropyBlob.pbData ? &entropyBlob : nullptr,
-			nullptr, // reserved
-			nullptr, // pass null for the prompt structure
-			flags, // dwFlags
-			&dataOut);
-	}
-	else
-	{
-		success = CryptUnprotectData(
-			&dataIn,
-			nullptr, // Description string
-			entropyBlob.pbData ? &entropyBlob : nullptr,
-			nullptr, // reserved
-			nullptr, // pass null for the prompt structure
-			flags, // dwFlags
-			&dataOut);
-	}
-
-	if (!success)
-	{
-		DWORD errorCode = GetLastError();
-		std::string errorMessage = std::string("Encryption/Decryption failed. Error code: ") + std::to_string(errorCode);
-		isolate->ThrowException(v8::Exception::Error(
-			CreateUtf8String(isolate, &errorMessage[0])));
-
-		return;
-	}
-
-	// Copy and free the buffer
-	auto returnBuffer = Nan::CopyBuffer(reinterpret_cast<const char*>(dataOut.pbData), dataOut.cbData).ToLocalChecked();
-	LocalFree(dataOut.pbData);
-
-	info.GetReturnValue().Set(returnBuffer);
-}
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+ // Implementation referenced from https://github.com/bradhugh/node-dpapi
+
+#include <node.h>
+#include <nan.h>
+#include <Windows.h>
+#include <dpapi.h>
+#include <functional>
+#include <iostream>
+#include <string>
+
+v8::Local<v8::String> CreateUtf8String(v8::Isolate* isolate, char* strData)
+{
+	return v8::String::NewFromUtf8(isolate, strData, v8::NewStringType::kNormal).ToLocalChecked();
+}
+
+void ProtectDataCommon(bool protect, Nan::NAN_METHOD_ARGS_TYPE info)
+{
+	v8::Isolate* isolate = info.GetIsolate();
+
+	if (info.Length() != 3) {
+		isolate->ThrowException(v8::Exception::RangeError(
+			CreateUtf8String(isolate, "3 arguments are required")));
+	}
+
+	if (info[0]->IsNullOrUndefined() || !info[0]->IsUint8Array())
+	{
+		isolate->ThrowException(v8::Exception::TypeError(
+			CreateUtf8String(isolate, "First argument, data, must be a valid Uint8Array")));
+	}
+
+	if (!info[1]->IsNull() && !info[1]->IsUint8Array())
+	{
+		isolate->ThrowException(v8::Exception::TypeError(
+			CreateUtf8String(isolate, "Second argument, optionalEntropy, must be null or an ArrayBuffer")));
+	}
+
+	if (info[2]->IsNullOrUndefined() || !info[2]->IsString())
+	{
+		isolate->ThrowException(v8::Exception::TypeError(
+			CreateUtf8String(isolate, "Third argument, scope, must be a string")));
+	}
+
+	DWORD flags = 0;
+	v8::String::Utf8Value strData(isolate, info[2]);
+	std::string scope(*strData);
+	if (stricmp(scope.c_str(), "LocalMachine") == 0)
+	{
+		flags = CRYPTPROTECT_LOCAL_MACHINE;
+	}
+
+	auto buffer = node::Buffer::Data(info[0]);
+	auto len = node::Buffer::Length(info[0]);
+
+	DATA_BLOB entropyBlob;
+	entropyBlob.pbData = nullptr;
+	if (!info[1]->IsNull())
+	{
+		entropyBlob.pbData = reinterpret_cast<BYTE*>(node::Buffer::Data(info[1]));
+		entropyBlob.cbData = node::Buffer::Length(info[1]);
+	}
+
+	DATA_BLOB dataIn;
+	DATA_BLOB dataOut;
+
+	// initialize input data
+	dataIn.pbData = reinterpret_cast<BYTE*>(buffer);
+	dataIn.cbData = len;
+
+	bool success = false;
+
+	// Call either Protect or Unprotect based on the flag
+	if (protect)
+	{
+		success = CryptProtectData(
+			&dataIn,
+			nullptr, // Description string
+			entropyBlob.pbData ? &entropyBlob : nullptr,
+			nullptr, // reserved
+			nullptr, // pass null for the prompt structure
+			flags, // dwFlags
+			&dataOut);
+	}
+	else
+	{
+		success = CryptUnprotectData(
+			&dataIn,
+			nullptr, // Description string
+			entropyBlob.pbData ? &entropyBlob : nullptr,
+			nullptr, // reserved
+			nullptr, // pass null for the prompt structure
+			flags, // dwFlags
+			&dataOut);
+	}
+
+	if (!success)
+	{
+		DWORD errorCode = GetLastError();
+		std::string errorMessage = std::string("Encryption/Decryption failed. Error code: ") + std::to_string(errorCode);
+		isolate->ThrowException(v8::Exception::Error(
+			CreateUtf8String(isolate, &errorMessage[0])));
+
+		return;
+	}
+
+	// Copy and free the buffer
+	auto returnBuffer = Nan::CopyBuffer(reinterpret_cast<const char*>(dataOut.pbData), dataOut.cbData).ToLocalChecked();
+	LocalFree(dataOut.pbData);
+
+	info.GetReturnValue().Set(returnBuffer);
+}

package/src/dpapi-addon/main.cpp

@@ -1,32 +1,32 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-#include <nan.h>
-#include "dpapi_addon.h"
-
-NAN_METHOD(protectData)
-{
-	ProtectDataCommon(true, info);
-}
-
-NAN_METHOD(unprotectData)
-{
-	ProtectDataCommon(false, info);
-}
-
-NAN_MODULE_INIT(init)
-{
-	Nan::Set(
-		target,
-		Nan::New<v8::String>("protectData").ToLocalChecked(),
-		Nan::GetFunction(Nan::New<v8::FunctionTemplate>(protectData)).ToLocalChecked());
-
-	Nan::Set(
-		target,
-		Nan::New<v8::String>("unprotectData").ToLocalChecked(),
-		Nan::GetFunction(Nan::New<v8::FunctionTemplate>(unprotectData)).ToLocalChecked());
-}
-
-NODE_MODULE(binding, init)
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+#include <nan.h>
+#include "dpapi_addon.h"
+
+NAN_METHOD(protectData)
+{
+	ProtectDataCommon(true, info);
+}
+
+NAN_METHOD(unprotectData)
+{
+	ProtectDataCommon(false, info);
+}
+
+NAN_MODULE_INIT(init)
+{
+	Nan::Set(
+		target,
+		Nan::New<v8::String>("protectData").ToLocalChecked(),
+		Nan::GetFunction(Nan::New<v8::FunctionTemplate>(protectData)).ToLocalChecked());
+
+	Nan::Set(
+		target,
+		Nan::New<v8::String>("unprotectData").ToLocalChecked(),
+		Nan::GetFunction(Nan::New<v8::FunctionTemplate>(unprotectData)).ToLocalChecked());
+}
+
+NODE_MODULE(binding, init)

package/src/error/PersistenceError.ts

@@ -1,65 +1,101 @@
-/*
- * Copyright (c) Microsoft Corporation. All rights reserved.
- * Licensed under the MIT License.
- */
-
-/**
- * Error thrown when trying to write MSAL cache to persistence.
- */
-export class PersistenceError extends Error {
-
-    // Short string denoting error
-    errorCode: string;
-    // Detailed description of error
-    errorMessage: string;
-
-    constructor(errorCode: string, errorMessage: string) {
-        const errorString = errorMessage ? `${errorCode}: ${errorMessage}` : errorCode;
-        super(errorString);
-        Object.setPrototypeOf(this, PersistenceError.prototype);
-
-        this.errorCode = errorCode;
-        this.errorMessage = errorMessage;
-        this.name = "PersistenceError";
-    }
-
-    /**
-     * Error thrown when trying to access the file system.
-     */
-    static createFileSystemError(errorCode: string, errorMessage: string): PersistenceError {
-        return new PersistenceError(errorCode, errorMessage);
-    }
-
-    /**
-     * Error thrown when trying to write, load, or delete data from secret service on linux.
-     * Libsecret is used to access secret service.
-     */
-    static createLibSecretError(errorCode: string, errorMessage: string): PersistenceError {
-        const updatedErrorMessage = `Error accessing Gnome Keyring: ${errorCode}- ${errorMessage}`;
-        return new PersistenceError("GnomeKeyringError", updatedErrorMessage);
-    }
-
-    /**
-     * Error thrown when trying to write, load, or delete data from keychain on macOs.
-     */
-    static createKeychainPersistenceError(errorCode: string, errorMessage: string): PersistenceError {
-        const updatedErrorMessage = `Error accessing Keychain: ${errorCode}- ${errorMessage}`;
-        return new PersistenceError("KeychainError", updatedErrorMessage);
-    }
-
-    /**
-     * Error thrown when trying to encrypt or decrypt data using DPAPI on Windows.
-     */
-    static createFilePersistenceWithDPAPIError(errorCode: string, errorMessage: string): PersistenceError {
-        const updatedErrorMessage = `Error accessing DPAPI encrypted file: ${errorCode}- ${errorMessage}`;
-        return new PersistenceError("DPAPIEncryptedFileError", updatedErrorMessage);
-    }
-
-    /**
-     * Error thrown when using the cross platform lock.
-     */
-    static createCrossPlatformLockError(errorCode: string, errorMessage: string): PersistenceError {
-        const updatedErrorMessage = `Error acquiring lock: ${errorCode}- ${errorMessage}`;
-        return new PersistenceError("CrossPlatformLockError", updatedErrorMessage);
-    }
-}
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Error thrown when trying to write MSAL cache to persistence.
+ */
+export class PersistenceError extends Error {
+
+    // Short string denoting error
+    errorCode: string;
+    // Detailed description of error
+    errorMessage: string;
+
+    constructor(errorCode: string, errorMessage: string) {
+        const errorString = errorMessage ? `${errorCode}: ${errorMessage}` : errorCode;
+        super(errorString);
+        Object.setPrototypeOf(this, PersistenceError.prototype);
+
+        this.errorCode = errorCode;
+        this.errorMessage = errorMessage;
+        this.name = "PersistenceError";
+    }
+
+    /**
+     * Error thrown when trying to access the file system.
+     */
+    static createFileSystemError(errorCode: string, errorMessage: string): PersistenceError {
+        return new PersistenceError(errorCode, errorMessage);
+    }
+
+    /**
+     * Error thrown when trying to write, load, or delete data from secret service on linux.
+     * Libsecret is used to access secret service.
+     */
+    static createLibSecretError(errorMessage: string): PersistenceError {
+        return new PersistenceError("GnomeKeyringError", errorMessage);
+    }
+
+    /**
+     * Error thrown when trying to write, load, or delete data from keychain on macOs.
+     */
+    static createKeychainPersistenceError(errorMessage: string): PersistenceError {
+        return new PersistenceError("KeychainError", errorMessage);
+    }
+
+    /**
+     * Error thrown when trying to encrypt or decrypt data using DPAPI on Windows.
+     */
+    static createFilePersistenceWithDPAPIError(errorMessage: string): PersistenceError {
+        return new PersistenceError("DPAPIEncryptedFileError", errorMessage);
+    }
+
+    /**
+     * Error thrown when using the cross platform lock.
+     */
+    static createCrossPlatformLockError(errorMessage: string): PersistenceError {
+        return new PersistenceError("CrossPlatformLockError", errorMessage);
+    }
+
+    /**
+     * Throw cache persistence error
+     * 
+     * @param errorMessage string
+     * @returns PersistenceError
+     */
+    static createCachePersistenceError(errorMessage: string): PersistenceError {
+        return new PersistenceError("CachePersistenceError", errorMessage);
+    }
+
+    /**
+     * Throw unsupported error
+     * 
+     * @param errorMessage string
+     * @returns PersistenceError
+     */
+    static createNotSupportedError(errorMessage: string): PersistenceError {
+        return new PersistenceError("NotSupportedError", errorMessage);
+    }
+
+    /**
+     * Throw persistence not verified error
+     * 
+     * @param errorMessage string
+     * @returns PersistenceError
+     */
+    static createPersistenceNotVerifiedError(errorMessage: string): PersistenceError {
+        return new PersistenceError("PersistenceNotVerifiedError", errorMessage);
+    }
+
+    /**
+     * Throw persistence creation validation error
+     * 
+     * @param errorMessage string
+     * @returns PersistenceError
+     */
+    static createPersistenceNotValidatedError(errorMessage: string): PersistenceError {
+        return new PersistenceError("PersistenceNotValidatedError", errorMessage);
+    }
+}

package/src/index.ts

@@ -1,8 +1,16 @@
-export { PersistenceCachePlugin } from "./persistence/PersistenceCachePlugin"
-export { FilePersistence } from "./persistence/FilePersistence";
-export { FilePersistenceWithDataProtection } from "./persistence/FilePersistenceWithDataProtection";
-export { DataProtectionScope } from "./persistence/DataProtectionScope";
-export { KeychainPersistence } from "./persistence/KeychainPersistence";
-export { LibSecretPersistence } from "./persistence/LibSecretPersistence";
-export { IPersistence } from "./persistence/IPersistence";
-export { CrossPlatformLockOptions } from "./lock/CrossPlatformLockOptions";
+/*
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+export { PersistenceCachePlugin } from "./persistence/PersistenceCachePlugin";
+export { FilePersistence } from "./persistence/FilePersistence";
+export { FilePersistenceWithDataProtection } from "./persistence/FilePersistenceWithDataProtection";
+export { DataProtectionScope } from "./persistence/DataProtectionScope";
+export { KeychainPersistence } from "./persistence/KeychainPersistence";
+export { LibSecretPersistence } from "./persistence/LibSecretPersistence";
+export { IPersistence } from "./persistence/IPersistence";
+export { CrossPlatformLockOptions } from "./lock/CrossPlatformLockOptions";
+export { PersistenceCreator } from "./persistence/PersistenceCreator";
+export { IPersistenceConfiguration } from "./persistence/IPersistenceConfiguration";
+export { Environment } from "./utils/Environment";