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 从公开仓库中收录这些内容。

举报或申请下架