Package Exports
- @lance0/latch
- @lance0/latch/obo
- @lance0/latch/react
Readme
@lance0/latch
Security-first OIDC authentication for Next.js 15+ with native Azure Government cloud support
Latch is a lightweight authentication library built specifically for Next.js 15/16 App Router with first-class support for Azure Government clouds (GCC-High, DoD). Implements PKCE S256, encrypted HttpOnly cookies, and provides both Secure Proxy and Direct Token modes.
Features
- ✅ Azure Government Ready - Native GCC-High (IL4) and DoD (IL5) support
- ✅ Next.js 15+ Optimized - Built for App Router with React Server Components
- ✅ Security First - PKCE S256, AES-GCM cookies, CSRF protection, open redirect prevention
- ✅ Dual Auth Modes - PKCE-only (public) or client_secret (confidential)
- ✅ Zero-Downtime Rotation - Client secret rotation procedures included
- ✅ Type Safe - Full TypeScript strict mode with IntelliSense
- ✅ Lightweight - 186KB package, only depends on
jose - ✅ Battle Tested - 135 unit tests including security attack scenarios
Installation
pnpm add @lance0/latch
# or
npm install @lance0/latch
# or
yarn add @lance0/latchQuick Start
1. Setup with CLI (Recommended)
npx @lance0/latch-cli initThe interactive wizard will:
- Prompt for Azure AD configuration (Client ID, Tenant ID, Cloud)
- Choose authentication mode (PKCE vs client_secret)
- Generate secure cookie secret
- Create
.env.localwith all required variables - Provide tailored Azure AD app registration instructions
2. Manual Setup (Alternative)
Create .env.local:
# Azure AD Configuration
LATCH_CLIENT_ID=your-client-id
LATCH_TENANT_ID=your-tenant-id
LATCH_CLOUD=commercial # or gcc-high, dod
# Cookie Encryption (generate with: npx @lance0/latch-cli generate-secret)
LATCH_COOKIE_SECRET=your-base64-secret-here
# Optional: Confidential Client Mode
# LATCH_CLIENT_SECRET=your-client-secret
# Optional: Custom Configuration
# LATCH_SCOPES=openid profile User.Read
# LATCH_REDIRECT_URI=http://localhost:3000/api/latch/callbackCloud Options:
commercial- Azure Commercial (login.microsoftonline.com)gcc-high- GCC-High IL4 (login.microsoftonline.us)dod- DoD IL5 (login.microsoftonline.uswith DoD Graph)
3. Create API Routes
Create OAuth endpoints in your Next.js app. You can either copy the route handlers from the example app or implement them yourself.
See the example-app for complete reference implementations of:
GET /api/latch/start- Initiates OAuth flow with PKCEGET /api/latch/callback- Handles OAuth callbackGET /api/latch/session- Returns current userPOST /api/latch/refresh- Refreshes access tokenGET /api/latch/logout- Clears session
All crypto utilities (PKCE generation, cookie sealing, state/nonce) are exported from @lance0/latch.
4. Add React Provider
Wrap your app in app/layout.tsx:
import { LatchProvider } from '@lance0/latch/react';
export default function RootLayout({ children }) {
return (
<html>
<body>
<LatchProvider>
{children}
</LatchProvider>
</body>
</html>
);
}5. Use Authentication in Components
'use client';
import { useLatch } from '@lance0/latch/react';
export default function Dashboard() {
const { user, signIn, signOut, isLoading } = useLatch();
if (isLoading) return <div>Loading...</div>;
if (!user) {
return <button onClick={signIn}>Sign In</button>;
}
return (
<div>
<h1>Welcome, {user.name}</h1>
<p>{user.email}</p>
<button onClick={signOut}>Sign Out</button>
</div>
);
}6. Protect Routes with Middleware
Create middleware.ts:
import { NextResponse } from 'next/server';
import type { NextRequest } from 'next/server';
import { getLatchSession } from '@lance0/latch';
export async function middleware(request: NextRequest) {
const session = await getLatchSession();
if (!session) {
return NextResponse.redirect(new URL('/', request.url));
}
return NextResponse.next();
}
export const config = {
matcher: ['/dashboard/:path*', '/profile/:path*'],
};Authentication Modes
Secure Proxy Mode (Default)
Access tokens stay on the server. All Graph API calls proxied through Next.js routes.
// app/api/me/route.ts
import { getAccessToken } from '@lance0/latch';
export async function GET() {
const token = await getAccessToken();
if (!token) {
return Response.json({ error: 'Unauthorized' }, { status: 401 });
}
// Token never exposed to client
const res = await fetch('https://graph.microsoft.com/v1.0/me', {
headers: { Authorization: `Bearer ${token}` },
});
return Response.json(await res.json());
}Direct Token Mode (Advanced)
Short-lived access tokens sent to client with auto-refresh. Only use for performance-critical scenarios.
'use client';
import { useAccessToken } from '@lance0/latch/react';
export default function Profile() {
const { accessToken, error, expiresAt } = useAccessToken({
autoRefresh: true,
refreshThreshold: 300000, // 5 minutes
retryOnFailure: true,
});
// Use accessToken directly from browser for Graph API calls
}See AUTHENTICATION_SETUP.md for detailed comparison.
Cloud Configuration
Latch automatically configures endpoints based on LATCH_CLOUD:
| Cloud | Login URL | Graph API |
|---|---|---|
commercial |
login.microsoftonline.com |
graph.microsoft.com |
gcc-high |
login.microsoftonline.us |
graph.microsoft.us |
dod |
login.microsoftonline.us |
dod-graph.microsoft.us |
No manual URL configuration needed - scopes are automatically validated against the selected cloud.
Compliance Considerations
Important: Latch provides authentication patterns aligned with Azure Government security requirements, but does not certify IL4/IL5 compliance. Compliance is a system-wide concern requiring proper controls across your entire application and infrastructure.
What Latch provides:
- ✅ Government cloud endpoint configuration (GCC-High, DoD)
- ✅ Secure token handling (HttpOnly cookies, server-side storage)
- ✅ PKCE S256 flow per OAuth 2.0 best practices (RFC 7636)
- ✅ AES-GCM-256 encryption for cookie data
- ✅ Audit-friendly debug logging (tokens redacted)
Your responsibility:
- Run in FIPS-enabled environment if required (
node --force-fips) - Implement proper authorization (Latch only handles authentication)
- Configure audit logging per your ATO requirements
- Review and approve the security model for your threat model
- Ensure data residency and network controls meet your compliance needs
See SECURITY.md for detailed security practices.
Runtime Requirements
Latch requires Node.js runtime and is not compatible with Edge Runtime.
Why Node.js only:
- Cookie encryption uses Node.js
cryptomodule - JWKS verification via
joselibrary requires Node.js APIs - Server-side token storage requires full Node.js environment
Supported environments:
- ✅ Next.js App Router (Node runtime)
- ✅ Vercel (Node.js serverless functions)
- ✅ Azure App Service (Linux/Windows)
- ✅ Docker containers
- ✅ Any Node.js 18.17+ environment
Not supported:
- ❌ Edge Runtime (Vercel Edge, Cloudflare Workers)
- ❌ Middleware running on Edge
FIPS 140-2 Support:
Run Node.js with --force-fips flag to enable FIPS-validated cryptography. Requires OpenSSL FIPS module in your environment. Latch's AES-GCM and SHA-256 operations will use FIPS-validated implementations.
Tested with:
- Node.js 18.17+ (LTS)
- Node.js 20.0+ (LTS)
- Azure App Service (Linux)
- Azure Container Apps
Documentation
- API Reference - Complete API documentation
- Authentication Setup - PKCE vs client_secret modes
- Troubleshooting - Common issues and solutions
- Architecture - Technical implementation details
- Security - Threat model and security practices
License
MIT - see LICENSE file for details