@stonyx/oauth 0.1.1-beta.2 → 0.1.1-beta.200

package/src/providers/{discord.js → discord.ts}

@@ -1,7 +1,33 @@
 import OAuthFlow from '../oauth-flow.js';
+import type { TokenResult } from '../oauth-flow.js';
+
+interface DiscordProviderConfig {
+  clientId: string;
+  clientSecret: string;
+  redirectUri: string;
+  scopes?: string[];
+  [key: string]: unknown;
+}
+
+interface DiscordUser {
+  id: string;
+  username: string;
+  global_name?: string;
+  avatar: string | null;
+  email?: string | null;
+}
+
+interface NormalizedDiscordUser {
+  id: string;
+  username: string;
+  displayName: string;
+  avatar: string | null;
+  email: string | null;
+  raw: DiscordUser;
+}
 
 export default class DiscordProvider extends OAuthFlow {
-  constructor(config) {
+  constructor(config: DiscordProviderConfig) {
     super({
       ...config,
       authorizationUrl: 'https://discord.com/oauth2/authorize',
@@ -10,7 +36,7 @@ export default class DiscordProvider extends OAuthFlow {
     });
   }
 
-  async exchangeCode(code) {
+  async exchangeCode(code: string): Promise<TokenResult> {
     const response = await fetch(this.tokenUrl, {
       method: 'POST',
       headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
@@ -34,7 +60,7 @@ export default class DiscordProvider extends OAuthFlow {
     };
   }
 
-  normalizeUser(rawUser) {
+  override normalizeUser(rawUser: DiscordUser): NormalizedDiscordUser {
     const { id, username, global_name, avatar, email } = rawUser;
 
     return {

package/src/{session-manager.js → session-manager.ts}

@@ -1,13 +1,26 @@
 import { randomUUID } from 'node:crypto';
 
+interface SessionData {
+  user: unknown;
+  tokens: unknown;
+  expiresAt: number;
+}
+
+export interface SessionResult {
+  sessionId: string;
+  user: unknown;
+  expiresAt: number;
+}
+
 export default class SessionManager {
-  sessions = new Map();
+  sessions = new Map<string, SessionData>();
+  duration: number;
 
-  constructor(duration) {
+  constructor(duration: number) {
     this.duration = duration;
   }
 
-  create(user, tokens) {
+  create(user: unknown, tokens: unknown): SessionResult {
     const sessionId = randomUUID();
     const expiresAt = Date.now() + (this.duration * 1000);
 
@@ -16,15 +29,15 @@ export default class SessionManager {
     return { sessionId, user, expiresAt };
   }
 
-  get(sessionId) {
+  get(sessionId: string): SessionData | null {
     return this.sessions.get(sessionId) || null;
   }
 
-  destroy(sessionId) {
+  destroy(sessionId: string): void {
     this.sessions.delete(sessionId);
   }
 
-  validate(sessionId) {
+  validate(sessionId: string): unknown {
     const session = this.get(sessionId);
     if (!session) return null;
 

package/src/ticket-store.ts

@@ -0,0 +1,158 @@
+import { createHash, randomBytes } from 'node:crypto';
+
+/**
+ * Lifetime of an exchange ticket.
+ *
+ * Sized for one redirect plus one page load, and deliberately two orders of
+ * magnitude tighter than the 10-minute state TTL: the ticket is a bearer value
+ * travelling in a URL, and the whole point of #45 is that a bearer value in a
+ * URL must not be long-lived — in the fragment, so it reaches no server, but
+ * still into browser history and readable by scripts on the landing page.
+ */
+export const TICKET_TTL_MS = 60 * 1000;
+
+/** Entropy of a ticket, in bytes. */
+export const TICKET_BYTES = 32;
+
+interface TicketRecord {
+  sessionId: string;
+  expiresAt: number;
+  createdAt: number;
+}
+
+export interface RedeemedTicket {
+  sessionId: string;
+  expiresAt: number;
+}
+
+/**
+ * Single-use, short-lived tickets that stand in for a session id on the wire.
+ *
+ * The callback redirect hands the browser a ticket instead of the session id
+ * (#45), in the URL *fragment*, which no user agent transmits to any server.
+ * The ticket authenticates nothing — `GET /auth` reads the `session-id` header
+ * and knows only about `SessionManager` — so a ticket observed in history or
+ * by a script reading `location.hash` is worth something only inside the
+ * sub-second window before the landing page redeems it, and nothing at all
+ * afterwards.
+ *
+ * Known residual, stated rather than papered over: a ticket observed *within*
+ * that window is redeemable by the observer, because nothing here binds a
+ * ticket to the client that started the flow. Closing it means binding the way
+ * #36 bound the state, and that binding has to travel on a cookie the
+ * cross-origin exchange cannot carry.
+ *
+ * The blocker is `abofs/stonyx-rest-server#63`: `@stonyx/rest-server` calls
+ * `cors({ origin, methods })` and has no `credentials` support at all. It is
+ * *not* `abofs/stonyx-rest-server#45` — that issue is the response-header half
+ * and is already worked around in `auth-request.ts`, which sets and clears the
+ * binding cookie on a redirect by reaching through `req.res`. Closing #45
+ * would not make this residual closeable. It is a reduction, not an
+ * elimination.
+ *
+ * Like `OAuth.pendingStates`, an abandoned ticket is never collected. That is
+ * a pre-existing pattern in this module, not something this store introduces,
+ * and it is bounded here by a 60-second TTL rather than a 10-minute one.
+ * Tracked, with both maps named, at `abofs/stonyx-oauth#43`.
+ *
+ * ---
+ *
+ * **Why this is a second store rather than a reuse of `OAuth.pendingStates`.**
+ *
+ * The duplication is real and is not an oversight: `pendingStates` is also a
+ * single-use, TTL-bounded, consume-on-recognition map keyed by a
+ * `randomBytes`-minted opaque token, with the same delete-before-TTL-check
+ * ordering and the same never-collected caveat. The shared shape could be
+ * extracted into one primitive, and the two constants homes (`STATE_TTL_MS`
+ * and `BINDING_VALUE_BYTES` in `main.ts`, `TICKET_TTL_MS` and `TICKET_BYTES`
+ * here) could then live together.
+ *
+ * It is deliberately not done in the change that fixes #45. Widening a
+ * security fix into a refactor of the CSRF store means the #36 binding
+ * mechanism — whose invariants are load-bearing and separately guarded — moves
+ * in the same commit as the fix, for no security gain in either. The two also
+ * do not have the same invariants: `pendingStates` is a security control fed
+ * by an unauthenticated `GET`, holding a *digest* of a client secret, with a
+ * 10-minute budget sized for a provider round trip; this is a delivery
+ * convenience reachable only after a successfully bound callback, holding a
+ * value it hands back, with a 60-second budget sized for a page load.
+ * Collapsing them would couple the control to the convenience.
+ *
+ * The extraction is tracked at `abofs/stonyx-oauth#58`.
+ */
+export default class TicketStore {
+  /**
+   * Live tickets, keyed by the **SHA-256 of the ticket**, never by the ticket.
+   *
+   * Keying by the digest means the map holds no redeemable *ticket*: a ticket
+   * is a client-presented secret looked up server-side, so what a reader of
+   * this map gets is a digest, and a digest cannot be presented to `redeem`.
+   *
+   * That does not make the map safe to expose. The record *value* holds a
+   * plaintext, live `sessionId` — the 24-hour bearer credential this store
+   * exists to keep out of URLs — so a heap dump, a debug serialisation or an
+   * accidental log of this map yields live session ids. The map is sensitive
+   * on that basis and must not be dumped or logged. Whether the stored
+   * `sessionId` should itself be protected is a separate question, and is not
+   * settled here.
+   *
+   * This is the mirror image of `OAuth.pendingStates`, not the same shape:
+   * there the *key* is the plaintext state token and the digest
+   * (`bindingHash`) sits in the value, so that record unlocks nothing on its
+   * own; here the digest is the key and the value is a live credential. What
+   * the two stores share is the discipline of never keeping a
+   * client-presented secret in the clear — neither the ticket nor the binding
+   * value is on the heap — but they place the digest on opposite sides of the
+   * entry.
+   *
+   * No constant-time comparison is needed and none is used: lookup is a hash
+   * probe on a 256-bit high-entropy key, not a secret-dependent byte
+   * comparison, so there is no early-exit timing signal to exploit. That is
+   * the same reason `redeem` can stay an ordinary `Map.get`.
+   */
+  tickets = new Map<string, TicketRecord>();
+  ttl = TICKET_TTL_MS;
+
+  /** SHA-256 of a ticket, hex — the only form of the *ticket* this store keeps. */
+  static hash(ticket: string): string {
+    return createHash('sha256').update(ticket).digest('hex');
+  }
+
+  /**
+   * Mints a ticket for a freshly created session.
+   *
+   * The ticket is independent entropy, never a transform of the session id:
+   * anything derived from the credential is the credential.
+   */
+  issue(sessionId: string, expiresAt: number): string {
+    const ticket = randomBytes(TICKET_BYTES).toString('base64url');
+    this.tickets.set(TicketStore.hash(ticket), { sessionId, expiresAt, createdAt: Date.now() });
+    return ticket;
+  }
+
+  /**
+   * Spends a ticket, if it is live.
+   *
+   * Consumed on recognition, *before* the TTL check, for the same reason
+   * `OAuth.handleCallback` consumes a pending state before validating its
+   * binding: every ticket gets exactly one attempt whatever the outcome, so
+   * this endpoint is never a repeatable oracle. Deleting after the TTL check
+   * instead would leave an expired ticket in the map answering `400` forever
+   * while a live one answers `200` — an unauthenticated distinguisher.
+   *
+   * Returns `null` for unknown, spent and expired tickets alike. The caller
+   * maps all three to the same `400`; telling them apart is information the
+   * holder of a ticket they did not mint has no business having.
+   */
+  redeem(ticket: string): RedeemedTicket | null {
+    const key = ticket ? TicketStore.hash(ticket) : null;
+    const record = key ? this.tickets.get(key) : undefined;
+    if (!record) return null;
+
+    this.tickets.delete(key!);
+
+    if (Date.now() - record.createdAt > this.ttl) return null;
+
+    return { sessionId: record.sessionId, expiresAt: record.expiresAt };
+  }
+}

package/src/token-manager.ts

@@ -0,0 +1,35 @@
+import type OAuthFlow from './oauth-flow.js';
+import type { TokenResult } from './oauth-flow.js';
+
+export interface TokenData extends TokenResult {
+  expiresAt: number;
+}
+
+export default class TokenManager {
+  flow: OAuthFlow;
+
+  constructor(flow: OAuthFlow) {
+    this.flow = flow;
+  }
+
+  async getTokens(code: string): Promise<TokenData> {
+    const tokens = await this.flow.exchangeCode(code) as TokenData;
+    tokens.expiresAt = Date.now() + (tokens.expiresIn * 1000);
+    return tokens;
+  }
+
+  async refresh(refreshToken: string): Promise<TokenData> {
+    const tokens = await this.flow.refreshAccessToken(refreshToken) as TokenData;
+    tokens.expiresAt = Date.now() + (tokens.expiresIn * 1000);
+    return tokens;
+  }
+
+  async revoke(accessToken: string): Promise<void> {
+    return this.flow.revokeToken(accessToken);
+  }
+
+  isExpired(tokenData: { expiresAt?: number } | null | undefined): boolean {
+    if (!tokenData?.expiresAt) return true;
+    return Date.now() >= tokenData.expiresAt;
+  }
+}

package/src/types/node.d.ts

@@ -0,0 +1,19 @@
+declare module 'node:crypto' {
+  export function randomUUID(): string;
+
+  /**
+   * Structural stand-ins: this repo declares its own node shims rather than
+   * depending on `@types/node`, so only the surface actually used is typed.
+   */
+  interface BinaryLike {
+    toString(encoding: string): string;
+  }
+
+  interface Hash {
+    update(data: string): Hash;
+    digest(encoding: string): string;
+  }
+
+  export function randomBytes(size: number): BinaryLike;
+  export function createHash(algorithm: string): Hash;
+}

package/src/types/stonyx-events.d.ts

@@ -0,0 +1,4 @@
+declare module '@stonyx/events' {
+  export function setup(events: string[]): void;
+  export function emit(event: string, ...args: unknown[]): Promise<void>;
+}

package/src/types/stonyx-rest-server.d.ts

@@ -0,0 +1,11 @@
+declare module '@stonyx/rest-server' {
+  export class Request {
+    constructor();
+  }
+
+  export default class RestServer {
+    static instance: RestServer;
+    static close(): void;
+    mountRoute(RequestClass: unknown, options: { name: string; options?: unknown }): void;
+  }
+}

package/src/types/stonyx.d.ts

@@ -0,0 +1,38 @@
+declare module 'stonyx/config' {
+  interface OAuthConfig {
+    providers: Record<string, { module?: string; [key: string]: unknown }>;
+    sessionDuration: number;
+    frontendCallbackUrl?: string;
+    logColor?: string;
+    logMethod?: string;
+  }
+  interface Config {
+    oauth: OAuthConfig;
+    rootPath: string;
+    [key: string]: unknown;
+  }
+  const config: Config;
+  export default config;
+}
+
+declare module 'stonyx/log' {
+  interface Log {
+    oauth(message: string): void;
+    error(message: string): void;
+    defineType(type: string, setting: string, options?: Record<string, unknown> | null): void;
+    [key: string]: unknown;
+  }
+  const log: Log;
+  export default log;
+}
+
+declare module 'stonyx' {
+  export function waitForModule(name: string): Promise<void>;
+}
+
+declare module 'stonyx/test-helpers' {
+  export function setupIntegrationTests(hooks: {
+    before(fn: () => void | Promise<void>): void;
+    after(fn: () => void | Promise<void>): void;
+  }): void;
+}

package/.github/workflows/ci.yml

@@ -1,16 +0,0 @@
-name: CI
-
-on:
-  pull_request:
-    branches: [dev, main]
-
-concurrency:
-  group: ci-${{ github.head_ref || github.ref }}
-  cancel-in-progress: true
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-    uses: abofs/stonyx-workflows/.github/workflows/ci.yml@main

package/.github/workflows/publish.yml

@@ -1,51 +0,0 @@
-name: Publish to NPM
-
-on:
-  repository_dispatch:
-    types: [cascade-publish]
-  workflow_dispatch:
-    inputs:
-      version-type:
-        description: 'Version type'
-        required: true
-        type: choice
-        options:
-          - patch
-          - minor
-          - major
-      custom-version:
-        description: 'Custom version (optional, overrides version-type)'
-        required: false
-        type: string
-  pull_request:
-    types: [opened, synchronize, reopened]
-    branches: [main]
-  push:
-    branches: [main]
-
-concurrency:
-  group: ${{ github.event_name == 'repository_dispatch' && 'cascade-update' || format('publish-{0}', github.ref) }}
-  cancel-in-progress: false
-
-permissions:
-  contents: write
-  id-token: write
-  pull-requests: write
-
-jobs:
-  publish:
-    if: "!contains(github.event.head_commit.message, '[skip ci]')"
-    uses: abofs/stonyx-workflows/.github/workflows/npm-publish.yml@main
-    with:
-      version-type: ${{ github.event.inputs.version-type }}
-      custom-version: ${{ github.event.inputs.custom-version }}
-      cascade-source: ${{ github.event.client_payload.source_package || '' }}
-    secrets: inherit
-
-  cascade:
-    needs: publish
-    uses: abofs/stonyx-workflows/.github/workflows/cascade.yml@main
-    with:
-      package-name: ${{ needs.publish.outputs.package-name }}
-      published-version: ${{ needs.publish.outputs.published-version }}
-    secrets: inherit

package/src/auth-request.js

@@ -1,74 +0,0 @@
-import { Request } from '@stonyx/rest-server';
-
-export default class AuthRequest extends Request {
-  constructor(oauth) {
-    super();
-    this.oauth = oauth;
-  }
-
-  handlers = {
-    get: {
-      '/': ({ headers }) => {
-        const sessionId = headers['session-id'];
-        if (!sessionId) return 401;
-
-        const user = this.oauth.getSession(sessionId);
-        if (!user) return 401;
-
-        return user;
-      },
-
-      '/login/:provider': (req, state) => {
-        const { provider: providerName } = req.params;
-
-        try {
-          const url = this.oauth.getAuthorizationUrl(providerName);
-          state.redirect = url;
-        } catch {
-          return 404;
-        }
-      },
-
-      '/callback/:provider': async (req, state) => {
-        const { provider: providerName } = req.params;
-        const { code, state: stateToken, error } = req.query;
-
-        if (error) {
-          if (this.oauth.frontendCallbackUrl) {
-            state.redirect = `${this.oauth.frontendCallbackUrl}?error=${encodeURIComponent(error)}`;
-            return;
-          }
-          return 400;
-        }
-
-        if (!code) return 400;
-
-        try {
-          const session = await this.oauth.handleCallback(providerName, code, stateToken);
-
-          if (this.oauth.frontendCallbackUrl) {
-            const params = new URLSearchParams({
-              sessionId: session.sessionId,
-              expiresAt: session.expiresAt,
-            });
-            state.redirect = `${this.oauth.frontendCallbackUrl}?${params}`;
-            return;
-          }
-
-          return session;
-        } catch {
-          if (this.oauth.frontendCallbackUrl) {
-            state.redirect = `${this.oauth.frontendCallbackUrl}?error=auth_failed`;
-            return;
-          }
-          return 500;
-        }
-      },
-
-      '/logout': ({ headers }) => {
-        const sessionId = headers['session-id'];
-        if (sessionId) this.oauth.logout(sessionId);
-      },
-    }
-  };
-}

package/src/main.js

@@ -1,79 +0,0 @@
-import config from 'stonyx/config';
-import log from 'stonyx/log';
-import { waitForModule } from 'stonyx';
-import RestServer from '@stonyx/rest-server';
-import TokenManager from './token-manager.js';
-import SessionManager from './session-manager.js';
-import AuthRequest from './auth-request.js';
-
-export default class OAuth {
-  providers = new Map();
-  pendingStates = new Map();
-
-  constructor() {
-    if (OAuth.instance) return OAuth.instance;
-    OAuth.instance = this;
-  }
-
-  async init() {
-    const { providers, sessionDuration, frontendCallbackUrl } = config.oauth;
-    this.frontendCallbackUrl = frontendCallbackUrl;
-
-    for (const [name, providerConfig] of Object.entries(providers)) {
-      const modulePath = providerConfig.module
-        ? `${config.rootPath}/${providerConfig.module}`
-        : `./providers/${name}.js`;
-      const { default: Provider } = await import(modulePath);
-      const flow = new Provider(providerConfig);
-      this.providers.set(name, { flow, tokenManager: new TokenManager(flow) });
-    }
-
-    this.sessionManager = new SessionManager(sessionDuration);
-
-    await waitForModule('rest-server');
-    RestServer.instance.mountRoute(AuthRequest, { name: 'auth', options: this });
-
-    log.oauth?.('OAuth module initialized');
-  }
-
-  getProvider(name) {
-    const provider = this.providers.get(name);
-    if (!provider) throw new Error(`OAuth provider "${name}" is not configured`);
-    return provider;
-  }
-
-  getAuthorizationUrl(providerName) {
-    const { flow } = this.getProvider(providerName);
-    const stateToken = crypto.randomUUID();
-    this.pendingStates.set(stateToken, Date.now());
-    return flow.buildAuthorizationUrl(stateToken);
-  }
-
-  async handleCallback(providerName, code, stateToken) {
-    if (!stateToken || !this.pendingStates.has(stateToken)) {
-      throw new Error('Invalid or missing state token');
-    }
-
-    const stateCreatedAt = this.pendingStates.get(stateToken);
-    this.pendingStates.delete(stateToken);
-
-    const TEN_MINUTES = 10 * 60 * 1000;
-    if (Date.now() - stateCreatedAt > TEN_MINUTES) {
-      throw new Error('State token has expired');
-    }
-
-    const { flow, tokenManager } = this.getProvider(providerName);
-    const tokens = await tokenManager.getTokens(code);
-    const rawUser = await flow.fetchUserInfo(tokens.accessToken);
-    const user = flow.normalizeUser(rawUser);
-    return this.sessionManager.create(user, tokens);
-  }
-
-  getSession(sessionId) {
-    return this.sessionManager.validate(sessionId);
-  }
-
-  logout(sessionId) {
-    this.sessionManager.destroy(sessionId);
-  }
-}

package/src/token-manager.js

@@ -1,26 +0,0 @@
-export default class TokenManager {
-  constructor(flow) {
-    this.flow = flow;
-  }
-
-  async getTokens(code) {
-    const tokens = await this.flow.exchangeCode(code);
-    tokens.expiresAt = Date.now() + (tokens.expiresIn * 1000);
-    return tokens;
-  }
-
-  async refresh(refreshToken) {
-    const tokens = await this.flow.refreshAccessToken(refreshToken);
-    tokens.expiresAt = Date.now() + (tokens.expiresIn * 1000);
-    return tokens;
-  }
-
-  async revoke(accessToken) {
-    return this.flow.revokeToken(accessToken);
-  }
-
-  isExpired(tokenData) {
-    if (!tokenData?.expiresAt) return true;
-    return Date.now() >= tokenData.expiresAt;
-  }
-}

package/test/config/environment.js

@@ -1,18 +0,0 @@
-export default {
-  restServer: {
-    dir: './test/sample/requests',
-  },
-  oauth: {
-    providers: {
-      mock: {
-        clientId: 'test-client-id',
-        clientSecret: 'test-client-secret',
-        redirectUri: 'http://localhost:2666/auth/callback/mock',
-        scopes: ['identify'],
-        module: './test/sample/providers/mock.js',
-      }
-    },
-    sessionDuration: 3600,
-    frontendCallbackUrl: 'http://localhost:4200/auth/callback',
-  }
-};