DID Connect

Blocklet SDKは、DID Connectを使用して、分散型アイデンティティをアプリケーションに統合するための効率的な方法を提供します。これにより、ユーザーはDID Walletを使用して安全にログインし、データを管理できるようになり、パスワードレスでユーザー中心の認証体験が実現します。この機能の主要なコンポーネントはWalletAuthenticatorとWalletHandlerです。

これらのユーティリティは、堅牢な@arcblock/did-connect-jsライブラリを基盤として構築されており、Blocklet環境内でのセットアッププロセスを簡素化します。

仕組み

一般的なDID Connectのログインフローには、ユーザー、アプリケーションのフロントエンドとバックエンド、そしてユーザーのDID Walletが関与します。

基本的なセットアップ

BlockletでのDID Connectのセットアップは簡単です。WalletAuthenticatorとWalletHandlerをインスタンス化し、セッションデータ用のストレージメカニズムを提供する必要があります。

以下は、Express.jsアプリケーションでの典型的なセットアップです。

Basic DID Connect Setup

import path from 'path';
import AuthStorage from '@arcblock/did-connect-storage-nedb';
import WalletAuthenticator from '@blocklet/sdk/lib/wallet-authenticator';
import WalletHandler from '@blocklet/sdk/lib/wallet-handler';

// 1. authenticatorを初期化
export const authenticator = new WalletAuthenticator();

// 2. authenticatorとストレージソリューションでhandlerを初期化
export const handlers = new WalletHandler({
  authenticator,
  tokenStorage: new AuthStorage({
    dbPath: path.join(process.env.BLOCKLET_DATA_DIR, 'auth.db'),
  }),
});

// 3. handlerをExpressアプリにマウント
// app.use('/api/did/auth', handlers);

コードの内訳:

1. `WalletAuthenticator`

   このクラスはDID Connectセッションの作成と管理を担当します。ユーザーに表示されるQRコードにエンコードされるデータを生成します。

2. `@arcblock/did-connect-storage-nedb`

   これはセッショントークンを永続化するためのファイルベースのストレージアダプターです。Blockletのデータディレクトリ（BLOCKLET_DATA_DIR）内にデータを保存するため、Blockletにとって便利な選択肢です。

3. `WalletHandler`

   このクラスは認証ライフサイクル全体を処理します。セッションの作成、ステータスの更新（例：ユーザーがQRコードをスキャンしたとき）、およびウォレットからの最終的な認証応答を管理します。

設定

WalletHandlerのコンストラクタは、その動作をカスタマイズするためのオプションオブジェクトを受け入れます。以下に主要なパラメータをいくつか示します。

アプリケーション情報のカスタマイズ

ユーザーがQRコードをスキャンすると、DID Walletにはアプリケーションの名前、説明、アイコンなどの情報が表示されます。SDKはblockletのメタデータを使用してこれを自動的に入力します。ただし、WalletAuthenticatorのコンストラクタにappInfo関数を渡すことで、この情報を上書きすることができます。

Customizing App Info

import WalletAuthenticator from '@blocklet/sdk/lib/wallet-authenticator';

const authenticator = new WalletAuthenticator({
  async appInfo() {
    // この関数はカスタムのアプリ情報を返すことができます
    // 返されるオブジェクトはデフォルトの情報とマージされます
    return {
      name: 'My Custom App Name',
      description: 'A custom description for the DID Connect request.',
      icon: 'https://my-app.com/logo.png',
    };
  },
});

参考文献

Blocklet SDKが提供するWalletAuthenticatorとWalletHandlerは、より包括的な@arcblock/did-connect-jsライブラリの便利なラッパーです。高度なユースケース、より詳細なカスタマイズ、または基盤となる仕組みをより深く理解するためには、公式のDID Connect SDKドキュメントを参照してください。

ユーザーの認証が成功したら、次のステップはアプリケーション内でセッションを管理することです。Blocklet SDKはこの目的のために堅牢なミドルウェアを提供します。

ユーザーセッションを検証し、ルートを保護する方法については、次のセクション セッションミドルウェア に進んでください。