claude-skills/

Anthropic公式スキル・プラグインの日本語ディレクトリ

last sync 22h ago
スキルOfficialdeployment

🔐oauth

プラグイン
valtown

説明

次のような場合に使用: val において Val Town アカウントによるログインを必須にする必要がある場合 — 認証によるルートの保護、現在のユーザーの識別、ユーザー固有のダッシュボードの構築など。 `std/oauth` の `oauthMiddleware` および `getOAuthUserData`、自動管理される `/auth/*` ルート、セッションの動作についてカバーしています。 Google や GitHub などのサードパーティ OAuth プロバイダーについては、代わりに `third-party-integrations` スキルを参照してください。

原文を表示

Use when a val needs to require login with a Val Town account — gating routes behind authentication, identifying the current user, building user-specific dashboards. Covers std/oauth's `oauthMiddleware` and `getOAuthUserData`, the auto-managed `/auth/*` routes, and session behavior. For third-party OAuth providers (Google, GitHub, etc.) see the `third-party-integrations` skill instead.

ユースケース

  • Val Town アカウントによるログインを必須にする
  • 認証によるルートを保護する
  • 現在のユーザーを識別する
  • ユーザー固有のダッシュボードを構築する

本文(日本語訳)

OAuth (std/oauth)

Val Townは、std/oauthを通じてゼロコンフィグの「Val Townでログイン」機能を提供します。 データベースのセットアップも、プロバイダーの設定も不要です。 Honoのfetchハンドラをラップするだけでログイン・ログアウト・セッション管理が自動的に利用できます。 セッションは暗号化されたCookieに保存され、30日間有効です。

この機能はVal Townアカウントへのログイン専用です。 Google / GitHub / Slack などのサードパーティOAuthについては、third-party-integrations skillを参照してください。各サービスごとのフローがドキュメント化されています。

インポート

import {
  getOAuthUserData,
  oauthMiddleware,
} from "https://esm.town/v/std/oauth/middleware.ts";

アプリをラップする

oauthMiddleware(handler)は、HonoのfetchハンドラをラップしたハンドラHonoを返します。 ラップされたハンドラは、以下の3つのルートを自動的に注入します。

  • GET /auth/login — ログインフローを開始する
  • GET /auth/callback — ログインフローを完了する
  • POST /auth/logout — セッションをクリアする

ラップされたハンドラをvalのデフォルトとしてエクスポートします。

import { Hono } from "npm:hono";
import { oauthMiddleware } from "https://esm.town/v/std/oauth/middleware.ts";

const app = new Hono();
app.onError((err) => Promise.reject(err));

app.get("/", (c) => c.text("hello"));

export default oauthMiddleware(app.fetch);

/auth/* ルートはご自身で記述する必要はありません。middlewareが自動的に追加します。 アプリ内でこれらのルートを上書きしないようにしてください。

現在のユーザーを取得する

任意のルートから getOAuthUserData(rawRequest) を呼び出します。 Honoでは、rawRequestc.req.raw に相当します。 リクエストが認証済みであればセッションデータを返し、未認証であれば null を返します。

interface SessionData {
  user: {
    id: string;
    username: string | null;
    email: string | null;
    bio: string | null;
    tier: "free" | "pro" | null;
    type: "user" | "org";
    url: string;
    links: {
      self: string;
      profileImageUrl: string | null;
    };
  };
  accessToken: string; // Val Town APIトークン(ユーザーの代わりに操作する)
  refreshToken?: string;
  idToken?: string;
  expiresAt: number; // Unixタイムスタンプ(ミリ秒)
  isOrgMember?: boolean; // このvalが属するorgのメンバーであればtrue
}
app.get("/", async (c) => {
  const session = await getOAuthUserData(c.req.raw);
  if (session?.user) {
    return c.html(
      `<p>Logged in as ${session.user.username}</p>` +
      `<form method="POST" action="/auth/logout"><button>Log out</button></form>`
    );
  }
  return c.html(`<a href="/auth/login">Log in with Val Town</a>`);
});

ルートにアクセス制限をかける

「ログイン必須」のヘルパーは組み込まれていません。 getOAuthUserData でセッションを確認し、セッションが存在しない場合は401を返すか /auth/login にリダイレクトすることでルートを保護します。

app.get("/dashboard", async (c) => {
  const session = await getOAuthUserData(c.req.raw);
  if (!session?.user) return c.redirect("/auth/login");
  return c.html(`<h1>Welcome ${session.user.username}</h1>`);
});

設定が不要な項目

  • 環境変数不要 — 認証情報とリダイレクトURLはプラットフォームが管理します。
  • コールバックURLの設定不要 — /auth/callback は自動的に接続されます。
  • セッションストア不要 — セッションは暗号化されたCookieで管理されます。

変更の確認

OAuthを追加した後、fetch_val_endpoint をアクセス制限されたルートに対して呼び出し、未認証時にリダイレクトまたは401が返されることを確認します。 完全なログインフローには実際のブラウザセッションが必要であり、fetch_val_endpoint 単独では検証できません。 実際のURLを共有し、ユーザー自身にログインを試してもらってください。

原文(English)を表示

OAuth (std/oauth)

Val Town provides zero-config "Log in with Val Town" via std/oauth. No database setup, no provider config — wrap your Hono fetch handler and you get login, logout, and session management for free. Sessions are stored in encrypted cookies and last 30 days.

This is for Val Town account login only. For Google / GitHub / Slack / etc. OAuth, see the third-party-integrations skill — those flows are documented per-service.

Imports

import {
  getOAuthUserData,
  oauthMiddleware,
} from "https://esm.town/v/std/oauth/middleware.ts";

Wrapping your app

oauthMiddleware(handler) takes your Hono fetch handler and returns a wrapped handler that injects three auto-managed routes:

  • GET /auth/login — starts the login flow
  • GET /auth/callback — completes the login flow
  • POST /auth/logout — clears the session

Export the wrapped handler as the val's default:

import { Hono } from "npm:hono";
import { oauthMiddleware } from "https://esm.town/v/std/oauth/middleware.ts";

const app = new Hono();
app.onError((err) => Promise.reject(err));

app.get("/", (c) => c.text("hello"));

export default oauthMiddleware(app.fetch);

You don't write the /auth/* routes yourself — the middleware adds them. Don't shadow them in your own app.

Reading the current user

Call getOAuthUserData(rawRequest) from any route. In Hono, rawRequest is c.req.raw. It returns the session data if the request is authenticated, or null otherwise.

interface SessionData {
  user: {
    id: string;
    username: string | null;
    email: string | null;
    bio: string | null;
    tier: "free" | "pro" | null;
    type: "user" | "org";
    url: string;
    links: {
      self: string;
      profileImageUrl: string | null;
    };
  };
  accessToken: string; // Val Town API token (act on behalf of the user)
  refreshToken?: string;
  idToken?: string;
  expiresAt: number; // Unix timestamp (ms)
  isOrgMember?: boolean; // true if user belongs to this val's org
}
app.get("/", async (c) => {
  const session = await getOAuthUserData(c.req.raw);
  if (session?.user) {
    return c.html(
      `<p>Logged in as ${session.user.username}</p>` +
      `<form method="POST" action="/auth/logout"><button>Log out</button></form>`
    );
  }
  return c.html(`<a href="/auth/login">Log in with Val Town</a>`);
});

Gating routes

There's no built-in "require login" helper — gate routes by checking getOAuthUserData and returning a 401 or redirecting to /auth/login when the session is missing:

app.get("/dashboard", async (c) => {
  const session = await getOAuthUserData(c.req.raw);
  if (!session?.user) return c.redirect("/auth/login");
  return c.html(`<h1>Welcome ${session.user.username}</h1>`);
});

What you don't need to configure

  • No env vars — credentials and redirect URLs are handled by the platform.
  • No callback URL setup — /auth/callback is wired automatically.
  • No session store — sessions live in encrypted cookies.

Verifying changes

After adding OAuth, call fetch_val_endpoint on a gated route to confirm it redirects or 401s when unauthenticated. The full login flow requires a real browser session and can't be exercised by fetch_val_endpoint alone — share the live URL and have the user try logging in.

原文・著作権は Anthropic および各プラグイン作者に帰属します。日本語訳は Claude API による自動翻訳です。