メインコンテンツまでスキップ
バージョン: 0.5.0 (最新)

🔐 認証バリデーターブロック

認証バリデーターブロックは、NodeBlocks アプリケーションにおける認証関連操作のための検証関数を提供します。これらのバリデーターは、保護されたルートとリソースに対する適切な認証を確保します。

🎯 概要​

認証バリデーターブロックは次のことを目的として設計されています:

  • ルートアクセス前に認証トークンを検証する
  • 複数の認証方法をサポートする（Bearer トークン、クッキー）
  • ルート保護のための再利用可能な認証ロジックを提供する
  • 適切なエラーレスポンスで認証エラーを処理する

📋 認証バリデータータイプ​

トークンバリデーター​

認証トークンをチェックおよび検証するバリデーター。

🔧 利用可能な認証バリデーター​

isAuthenticated​

リクエストコンテキスト内の Bearer トークンを検証することでユーザーを認証します。

目的: 続行前にリクエストが認証されていることを確保します

パラメーター:

  • なし

戻り値: void - 認証が成功した場合に通過します

スロー: "Invalid or missing authentication token" というメッセージの NodeblocksError (401)

使用例:

import { validators } from '@nodeblocks/backend-sdk';

const { isAuthenticated } = validators;

withRoute({
  validators: [isAuthenticated()]
});

verifyAuthentication​

提供された認証関数を使用して認証を検証します。

Deprecated

このバリデーターは廃止予定です。 置き換え: isAuthenticated。

目的: 操作を続行する前にリクエストが適切に認証されていることを確保します

パラメーター:

  • authenticate: Authenticator - トークンを検証する認証関数
  • payload: RouteHandlerPayload - リクエストコンテキストとデータを含む

戻り値: void - 認証が成功した場合に通過します

スロー: authenticate 関数によってスローされたエラー（通常、関連メッセージを含む NodeblocksError）

使用例:

import { validators } from '@nodeblocks/backend-sdk';

const { verifyAuthentication } = validators;

withRoute({
  validators: [verifyAuthentication(getBearerTokenInfo)]
});

🔗 関連ドキュメント​