Oauth

作者 val-town2d3ec654b6a7無授權條款收錄於 2026年10月8日更新於 2026年10月8日

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.

AI 產生的概覽

指導使用 std/oauth 中介軟體、工作階段與使用者資料,為 val 加入 Val Town 帳號登入。

功能
此技能說明如何使用 std/oauth 為 val 加入「使用 Val Town 登入」。它說明以 oauthMiddleware 包裝 Hono 的 fetch 處理函式,藉此自動加入 /auth/login、/auth/callback 與 /auth/logout 路由,並透過 getOAuthUserData 讀取目前使用者。它也說明如何檢查工作階段來保護路由並回傳 401 或重新導向,以及無需設定的項目與驗證變更的方法。
適用情境
當 val 需要要求以 Val Town 帳號登入、辨識目前使用者,或建立特定使用者專屬的儀表板時使用。它僅適用於 Val Town 帳號登入;Google、GitHub 等第三方提供者由另一個技能說明,而僅限團隊內部使用的應用較適合採用受限存取。
執行需求
在 Val Town 上執行,需從 esm.town 匯入 std/oauth 模組並使用 Hono 應用程式;不需要環境變數、回呼 URL 設定或工作階段儲存。僅為說明文件,不含指令碼。驗證完整登入流程需要真實瀏覽器工作階段。

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.

If the goal is to keep an app internal to a team rather than to give it its own logged-in users, restricting the val's app access is the simpler answer — the platform gates the endpoint before your code runs, and you write no auth code. See the restricted-access skill. Don't apply both to one val: a restricted val that also runs oauthMiddleware makes visitors authenticate twice.

Imports

ts
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:

ts
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.

ts
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}
ts
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:

ts
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.

來源與署名

來源:val-town/plugins位於plugin/skills/oauth提交2d3ec65

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架