OAuth 2.0 and OpenID Connect authentication for Harper applications. Supports GitHub, Google, Azure AD, Auth0, and custom OIDC providers with automatic token refresh and lifecycle hooks for user provisioning.
Features
Multi-provider support - GitHub, Google, Azure AD, Auth0, and custom OIDC providers
Automatic token refresh - Proactive token renewal on every request
Lifecycle hooks - Extensible hooks for user provisioning and custom logic
CSRF protection - Distributed token storage for cluster support
ID token verification - Full OIDC support with signature validation
Zero configuration - Works with Harper's session system automatically
Installation
Requires Harper v5 (harper >=5.0.0). For Harper v4 (the legacy harperdb package), use the 1.x line.
'@harperfast/oauth': package: '@harperfast/oauth' redirectUri: ${OAUTH_REDIRECT_URI} # your app's public origin — required for any deployed app providers: github: clientId: ${OAUTH_GITHUB_CLIENT_ID} clientSecret: ${OAUTH_GITHUB_CLIENT_SECRET}
2. Set Environment Variables
export OAUTH_GITHUB_CLIENT_ID="your-client-id"export OAUTH_GITHUB_CLIENT_SECRET="your-client-secret"export OAUTH_REDIRECT_URI="http://localhost:9926/oauth/callback" # local dev value — must become your public origin when you deploy (step 3)
Note: The export commands above are for local development and quick testing only. You can also use a .env file with dotenv-cli for local dev — just don't commit it. For Harper Fabric deployments, see the Harper Fabric documentation for managing runtime environment variables.
3. Configure OAuth Callback
This has two sides — both are required:
In your app config — set redirectUri to your app's public origin plus /oauth/callback (step 1 above). The plugin appends the provider name for you, so one setting covers every provider.
In your provider settings — register the provider-specific URL the plugin will send:
https://your-domain/oauth/github/callback
Note:redirectUri is required — there is no localhost default. If you skip side 1, the app fails to start with a configuration error naming the provider and the setting to fix, rather than silently sending your users to localhost. See Understanding Redirects.
4. (Optional) Register Lifecycle Hooks
Create or update users when they log in:
// resources.tsimport { registerHooks } from '@harperfast/oauth';registerHooks({ onLogin: async (oauthUser, tokenResponse, session, request, provider) => { const { User } = tables; // Find or create user let user; for await (const existing of User.search({ email: oauthUser.email })) { user = existing; break; } if (!user) { user = await User.create({ email: oauthUser.email, name: oauthUser.name, provider: provider, }); } return { user: String(user.id) }; },});// Export your resources...
The hook can also gate the login: return { status: 'denied' } or { status: 'needs_confirmation', redirect } and no session is created — see Lifecycle Hooks.
Security: returning { user } is authoritative and bypasses the account-adoption gate. The example above is illustrative — do not resolve an existing account by email alone before you have confirmed the identity, because oauthUser.emailVerified is not proof the email came from an authenticated source (see onLogin). For adopting an existing account, bind to a stable provider identity (e.g. oauthUser.providerUserId) or use a confirmation flow.
5. Test Authentication
Navigate to:
http://localhost:9926/oauth/github/login
Usage
Access authenticated user in your resources:
export class MyResource extends tables.Resource { async get(target, request) { if (!request.session?.user) { throw new ClientError('Not authenticated', 401); } return { userId: request.session.user, email: request.session.oauthUser.email, }; }}
Supported Providers
Built-in provider templates (not active until configured):
GitHub - OAuth 2.0
Google - OpenID Connect
Azure AD - OpenID Connect
Auth0 - OpenID Connect
Okta - OpenID Connect (with multi-tenant support)
Custom OIDC - Any compliant provider
Note: Built-in providers are templates that require configuration. None are active until you provide OAuth credentials (clientId, clientSecret, etc.). Having provider code in the plugin does not enable authentication or create security exposure.
How It Works
The plugin automatically handles:
OAuth Flow - Redirects to provider, handles callback, exchanges code for tokens
Token Management - Validates and refreshes tokens on every HTTP request
Session Integration - Stores OAuth data in Harper sessions
CSRF Protection - Validates state parameter using distributed token storage
Auto-logout - Clears session when tokens expire and can't be refreshed
Documentation
Complete documentation is available in the docs directory:
login_handoffs — one-time codes that hand a finished sign-in to a postLoginRedirectOrigins origin (60-second expiration; keyed by the code's hash)
MCP OAuth (experimental)
The plugin can also act as an OAuth 2.1 authorization server for Model Context Protocol clients (Claude Desktop, Cursor, mcp-remote), letting them authenticate against the same upstream providers. When mcp.enabled: true on Harper with server.registerBearerValidator, native /mcp authentication is registered automatically; for a custom app-owned MCP route, wrap your listener with withMCPAuth.
# config.yaml'@harperfast/oauth': package: '@harperfast/oauth' providers: github: clientId: ${OAUTH_GITHUB_CLIENT_ID} clientSecret: ${OAUTH_GITHUB_CLIENT_SECRET} mcp: enabled: true issuer: https://my-app.example.com # required; pin to your public origin
// Optional custom MCP route (in config.yaml, also set mcp.resource: https://my-app.example.com/custom-mcp)import { server } from 'harper';import { withMCPAuth } from '@harperfast/oauth';// request.mcp (verified { sub, client_id, aud, scope }) is guaranteed present inside the guarded handler.server.http( withMCPAuth((request) => ({ status: 200, body: JSON.stringify({ user: request.mcp.sub }) })), { urlPath: '/custom-mcp', });
The plugin serves discovery (/.well-known/*), Dynamic Client Registration, the authorize/token endpoints, and JWKS; withMCPAuth verifies the audience-bound JWT on every call and fails closed. There's an onMCPTokenIssued hook to react when a client gains access (client→user mapping, monitoring, rate-limiting) and a built-in audit log.
Headless agents (machine-to-machine). An agent with no browser and no human authenticates as itself: grant_type=client_credentials with an RFC 7523 private_key_jwt client assertion (EdDSA), rate-limited per verified client. Client identity resolves CIMD-first — a URL-shaped client_id is fetched as a Client ID Metadata Document through an SSRF-guarded, rate-limited fetch. See Headless agents.
Status: experimental, opt-in. See MCP OAuth for the full flow, the withMCPAuth registration models and options, the hook, configuration, the production checklist, and troubleshooting — and what's not yet supported (#156) for v1.1 forward-work.
Security Considerations
HTTPS required - OAuth requires HTTPS in production
CSRF protection - Automatic via state parameter validation
Post-login redirects stay on this origin - The redirect parameter is reduced to its path, unless postLoginRedirectOrigins lists its origin; then the sign-in is handed there with a single-use, 60-second code bound to that origin and to the initiating browser. See Signing in on another origin.
ID token verification - OIDC providers verify token signatures
Secure sessions - Use Harper's secure session configuration
Token storage - Tokens stored in session (configure secure cookies)
Account adoption requires a verified claim (2.6.0+) - An OAuth login adopts an existing Harper hdb_user only when the claim is a verified email from an authenticated source (a signature-verified OIDC id token with a validated issuer, or GitHub's authenticated email). Typical Google/GitHub verified-email setups (and any onLogin-hook login) are unaffected; adoption from an unverified or non-email claim is now denied, or, when no account matches, given a roleless, non-resolvable identity. See Account-Adoption Gate.
MCP client registration (when mcp.enabled is true) - The /oauth/mcp/register endpoint defaults to open registration per RFC 7591. Set mcp.dynamicClientRegistration.initialAccessToken to require a bearer token on registration, or mcp.dynamicClientRegistration.allowedRedirectUriHosts to restrict which hosts may register redirect_uris. See docs/configuration.md.
CIMD resolution (when mcp.enabled is true) - URL-shaped client_ids are resolved as Client ID Metadata Documents by default. Disable with mcp.clientIdMetadataDocuments.enabled: false, or restrict which hosts are fetched with mcp.clientIdMetadataDocuments.allowedHosts.