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

🪪 認証バリデーター

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


🎯 概要

認証バリデーターは以下の目的で設計されています:

  • 認証トークンのバリデーション - ルートアクセス前の検証
  • 複数の認証方法のサポート(Bearerトークン、Cookie)
  • 再利用可能な認証ロジックの提供 - ルート保護のための実装
  • 認証エラーの処理 - 適切なエラーレスポンスを含む

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

トークンバリデーター

認証トークンをチェックしてバリデーションするバリデーター。


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

isAuthenticated

リクエストコンテキスト内のBearerトークンをバリデーションしてユーザーを認証します。

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

パラメータ:

  • なし

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

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

使用例:

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

const { isAuthenticated } = validators;

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

verifyAuthentication

提供された認証器関数を使用して認証をバリデーションします。

非推奨

このバリデーターは非推奨です。
代替: isAuthenticated

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

パラメータ:

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

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

スロー: authenticate関数によってスローされたエラー(通常は関連するメッセージを含むNodeblocksError

使用例:

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

const { verifyAuthentication } = validators;

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

🔗 関連ドキュメント