ノードのMicrosoft認証拡張機能でのキャッシュ

Node のMicrosoft認証拡張機能を使用すると、開発者はクロスプラットフォーム トークン キャッシュのシリアル化とディスクへの永続化を実行できます。 ノードのMicrosoft Authentication Library (MSAL) を追加でサポートします。

MSAL ノードでは、既定でメモリ内キャッシュがサポートされ、キャッシュのシリアル化を実行するための ICachePlugin インターフェイスが提供されますが、トークン キャッシュをディスクに格納する既定の方法は提供されません。 ノードのMicrosoft認証拡張機能は、異なるプラットフォーム間でキャッシュをディスクに保持するための既定の実装です。

Node のMicrosoft認証拡張機能では、次のプラットフォームがサポートされています。

  • Windows - データ保護 API (DPAPI) が保護に使用されます。
  • Mac - Mac キーチェーンが使用されます。
  • Linux - LibSecret は、"Secret Service" への格納に使用されます。

Installation

msal-node-extensions パッケージは、Node パッケージ マネージャー (NPM) で使用できます。

npm i @azure/msal-node-extensions --save

トークン キャッシュを構成する

ノードの認証拡張機能Microsoft使用してトークン キャッシュを構成するコードの例を次に示します。

const {
  DataProtectionScope,
  Environment,
  PersistenceCreator,
  PersistenceCachePlugin,
} = require("@azure/msal-node-extensions");

// You can use the helper functions provided through the Environment class to construct your cache path
// The helper functions provide consistent implementations across Windows, Mac and Linux.
const cachePath = path.join(Environment.getUserRootDirectory(), "./cache.json");

const persistenceConfiguration = {
  cachePath,
  dataProtectionScope: DataProtectionScope.CurrentUser,
  serviceName: "<SERVICE-NAME>",
  accountName: "<ACCOUNT-NAME>",
  usePlaintextFileOnLinux: false,
};

// The PersistenceCreator obfuscates a lot of the complexity by doing the following actions for you :-
// 1. Detects the environment the application is running on and initializes the right persistence instance for the environment.
// 2. Performs persistence validation for you.
// 3. Performs any fallbacks if necessary.
PersistenceCreator.createPersistence(persistenceConfiguration).then(
  async (persistence) => {
    const publicClientConfig = {
      auth: {
        clientId: "<CLIENT-ID>",
        authority: "<AUTHORITY>",
      },

      // This hooks up the cross-platform cache into MSAL
      cache: {
        cachePlugin: new PersistenceCachePlugin(persistence),
      },
    };

    const pca = new msal.PublicClientApplication(publicClientConfig);

    // Use the public client application as required...
  }
);

次の表に、永続化構成のすべての引数について説明します。

フィールド名 説明 次の場合は必須
cachePath ライブラリが読み取りと書き込みの同期に使用するロック ファイルへのパス Windows、Mac、Linux
dataProtectionScope 現在のユーザーまたはローカル コンピューター Windowsデータ保護のスコープを指定します。 Windows
serviceName Mac または Linux で使用するサービス名を指定します Mac と Linux
accountName Mac または Linux で使用するアカウント名を指定します Mac と Linux
usePlaintextFileOnLinux LibSecret が失敗した場合に linux で既定でプレーン テキストに設定されるフラグ。 既定値は false に設定されます Linux