@hawcx/oauth-client 0.2.0 → 4.0.1

package/README.md

@@ -1,310 +1,575 @@
-# Hawcx OAuth Client SDK (Node.js)
+# @hawcx/oauth-client
 
-A lightweight, production-ready Node.js/TypeScript library for exchanging OAuth authorization codes and verifying JWT claims. Built with security, reliability, and ease of use in mind.
+Simple, production-ready OAuth client SDK for Hawcx authentication.
 
 ## Features
 
-- 🔐 **Secure JWT Verification**: RS256/ES256/EdDSA signature verification with configurable validation
-- 🆕 **PKCE Support**: Native PKCE (RFC 7636) support for enhanced OAuth security
-- 🚀 **Simple API**: One function call to go from code to verified claims
-- 🎯 **High-Level Hawcx Client**: One-line MFA setup with automatic encryption/signing
-- 🛡️ **Comprehensive Error Handling**: Clear, actionable error messages for all failure scenarios
-- 📝 **TypeScript First**: Full type definitions for better IDE support and type checking
-- 🧪 **Production Ready**: Extensive error handling and security best practices
-- 🔧 **Express/Fastify Compatible**: Works with any Node.js framework
-- 🔍 **Detailed Logging**: Structured logging for debugging (no sensitive data logged)
+- **Simple JWT Verification** - Uses `jose` library for automatic JWKS caching and signature handling
+- **PKCE Support** - Native PKCE (RFC 7636) support for enhanced OAuth security
+- **Delegation API** - Server-to-server user management (MFA, devices)
+- **Step-Up Auth** - Step-up authentication flows for sensitive operations
+- **TypeScript First** - Full type definitions included
+- **Zero Config Crypto** - All cryptographic complexity hidden behind a single secret key
 
 ## Installation
 
 ```bash
 npm install @hawcx/oauth-client
+```
+
+## Quick Start
 
-# or with yarn
-yarn add @hawcx/oauth-client
+```typescript
+import { HawcxOAuth } from '@hawcx/oauth-client';
+
+const oauth = new HawcxOAuth({ configId: 'your-config-id' });
 
-# or with pnpm
-pnpm add @hawcx/oauth-client
+// Exchange authorization code for tokens
+const { idToken, claims } = await oauth.exchangeCode(code, codeVerifier);
+console.log(claims.sub);   // user ID
+console.log(claims.email); // user email
 ```
 
-## Quick Start
+---
+
+## Modules
+
+| Module | Purpose |
+|--------|---------|
+| **OAuth** | Token exchange and JWT verification |
+| **Delegation** | Server-to-server user management (MFA, devices) |
+| **Step-Up** | Step-up authentication flows |
+
+---
+
+## OAuth Module
+
+Core module for OAuth 2.1 + PKCE authentication.
 
-### OAuth Code Exchange
+### `HawcxOAuth`
 
 ```typescript
-import { exchangeCodeForClaims } from '@hawcx/oauth-client';
-
-// Exchange authorization code for verified claims
-const claims = await exchangeCodeForClaims({
-  code: req.body.code,
-  oauthTokenUrl: process.env.OAUTH_TOKEN_ENDPOINT!,
-  clientId: process.env.OAUTH_CLIENT_ID!,
-  apiKey: process.env.HAWCX_API_KEY!,
-  publicKey: process.env.OAUTH_PUBLIC_KEY!,
-  // Optional (recommended for production):
-  codeVerifier: session.pkceVerifier,  // PKCE support
-  audience: 'my-app',  // Validate 'aud' claim
-  issuer: 'https://oauth.example.com',  // Validate 'iss' claim
-  leeway: 10  // Clock skew tolerance
+import { HawcxOAuth } from '@hawcx/oauth-client';
+
+const oauth = new HawcxOAuth({
+  configId: 'your-config-id',        // Required: Your Hawcx config ID
+  baseUrl: 'https://api.hawcx.com',  // Optional: API base URL
+  timeout: 10000,                     // Optional: Request timeout in ms
 });
+```
+
+### Methods
+
+#### `exchangeCode(code, codeVerifier): Promise<ExchangeResult>`
+
+Exchange an authorization code for tokens.
+
+```typescript
+const { idToken, claims } = await oauth.exchangeCode(
+  'authorization-code',
+  'pkce-code-verifier'
+);
+```
+
+**Returns:**
+```typescript
+interface ExchangeResult {
+  idToken: string;    // Raw JWT token
+  claims: JwtClaims;  // Verified claims
+}
+```
+
+#### `verifyToken(token): Promise<JwtClaims>`
+
+Verify an existing JWT token.
+
+```typescript
+const claims = await oauth.verifyToken(idToken);
+```
+
+**Returns:**
+```typescript
+interface JwtClaims {
+  sub?: string;            // User ID
+  iss?: string;            // Issuer
+  aud?: string | string[]; // Audience
+  iat?: number;            // Issued at (unix timestamp)
+  exp?: number;            // Expiration (unix timestamp)
+  email?: string;          // User email
+  name?: string;           // User name
+  amr?: string[];          // Authentication methods
+  mfa_method?: string;     // MFA method used
+}
+```
+
+#### `clearCache(): void`
+
+Clear the JWKS cache (useful for testing or key rotation).
+
+```typescript
+oauth.clearCache();
+```
+
+### Errors
+
+```typescript
+import {
+  HawcxOAuthError,        // Base error class
+  TokenExchangeError,     // Code exchange failed
+  TokenVerificationError  // JWT verification failed
+} from '@hawcx/oauth-client';
 
-// Use the verified claims
-const userId = claims.sub;
-// Mint your own access token (SDK only verifies, doesn't mint)
+try {
+  await oauth.exchangeCode(code, verifier);
+} catch (error) {
+  if (error instanceof TokenExchangeError) {
+    console.log(error.statusCode); // HTTP status code
+  }
+  if (error instanceof TokenVerificationError) {
+    console.log(error.message); // "Token expired", "Invalid signature", etc.
+  }
+}
 ```
 
-### Hawcx Delegation (MFA Setup)
+---
+
+## Delegation Module
 
-For Hawcx MFA setup and user management, use the delegation client:
+Server-to-server API for managing users, MFA, and devices. Requires a Hawcx secret key.
+
+### `DelegationClient`
 
 ```typescript
-import { HawcxDelegationClient, MfaMethod } from '@hawcx/oauth-client';
-
-// 🎉 One-line initialization from explicit keys!
-const client = HawcxDelegationClient.fromKeys({
-  spSigningKey: process.env.SP_ED25519_PRIVATE_KEY_PEM!,
-  spEncryptionKey: process.env.SP_X25519_PRIVATE_KEY_PEM!,
-  idpVerifyKey: process.env.IDP_ED25519_PUBLIC_KEY_PEM!,
-  idpEncryptionKey: process.env.IDP_X25519_PUBLIC_KEY_PEM!,
-  baseUrl: 'https://example.hawcx.com',
-  spId: process.env.OAUTH_CLIENT_ID!
+import { DelegationClient, MfaMethod } from '@hawcx/oauth-client';
+
+const client = DelegationClient.fromSecretKey({
+  baseUrl: 'https://api.hawcx.com',
+  secretKey: process.env.HAWCX_SECRET_KEY!,
+  apiKey: 'optional-api-key',  // Optional
+  timeoutSeconds: 15,          // Optional (default: 15)
+  clockSkewSeconds: 300,       // Optional (default: 300)
 });
+```
+
+### MFA Operations
+
+#### `client.mfa.initiate(options): Promise<object>`
+
+Initiate MFA setup or change for a user.
 
-// Initiate MFA setup (Email, SMS, or TOTP)
-const result = await client.initiateMfaChange({
-  userid: "user@example.com",
-  mfaMethod: MfaMethod.SMS, 
-  phoneNumber: "+15551234567"
+```typescript
+// Email MFA
+const result = await client.mfa.initiate({
+  userId: 'user@example.com',
+  mfaMethod: MfaMethod.EMAIL,
+});
+
+// SMS MFA (requires phone number)
+const result = await client.mfa.initiate({
+  userId: 'user@example.com',
+  mfaMethod: MfaMethod.SMS,
+  phoneNumber: '+1234567890',
 });
 
-// Verify OTP and complete MFA setup
-await client.verifyMfaChange({
-  userid: "user@example.com",
-  sessionId: result.session_id,
-  otp: "123456"
+// TOTP MFA
+const result = await client.mfa.initiate({
+  userId: 'user@example.com',
+  mfaMethod: MfaMethod.TOTP,
 });
 
-// Get user credentials
-const creds = await client.getUserCredentials("user@example.com");
-console.log(`MFA method: ${creds.mfa_method}`);
+// Change MFA method
+const result = await client.mfa.initiate({
+  userId: 'user@example.com',
+  mfaMethod: MfaMethod.EMAIL,   // Current method for verification
+  mfaChangeTo: MfaMethod.TOTP,  // New method to switch to
+});
 ```
 
-**What it does automatically**: ECIES encryption, Ed25519 signatures, request/response crypto, Hawcx payload formatting, type-safe `MfaMethod` enum
+**MFA Methods:**
+```typescript
+enum MfaMethod {
+  EMAIL = 'email',
+  SMS = 'sms',
+  TOTP = 'totp',
+}
+```
 
-## Demo App
+#### `client.mfa.verify(options): Promise<object>`
 
-A simple demo application is included to show the OAuth and delegation flows in action:
+Verify MFA setup with OTP.
 
-```bash
-cd demo
-cp env.template .env
-# Edit .env with your credentials
-npm install
-npm run dev
-# Visit http://localhost:3000
+```typescript
+const result = await client.mfa.verify({
+  userId: 'user@example.com',
+  sessionId: 'session-from-initiate',
+  otp: '123456',  // 6-digit code
+});
 ```
 
-See [demo/README.md](demo/README.md) for details.
+### User Operations
 
-## Configuration
+#### `client.users.getCredentials(userId): Promise<object>`
 
-### Environment Variables
+Get user credentials/metadata.
 
-**For OAuth Code Exchange:**
-```bash
-OAUTH_TOKEN_ENDPOINT="https://oauth.example.com/token"
-OAUTH_CLIENT_ID="your-client-id"
-OAUTH_PUBLIC_KEY="-----BEGIN PUBLIC KEY-----\n..."
-OAUTH_ISSUER="https://oauth.example.com"  # Optional but recommended
-OAUTH_AUDIENCE="your-client-id"  # Optional but recommended
+```typescript
+const creds = await client.users.getCredentials('user@example.com');
+console.log(creds.mfa_method);
 ```
 
-**For Hawcx Delegation:**
-```bash
-SP_ED25519_PRIVATE_KEY_PEM="-----BEGIN PRIVATE KEY-----..."
-SP_X25519_PRIVATE_KEY_PEM="-----BEGIN PRIVATE KEY-----..."
-IDP_ED25519_PUBLIC_KEY_PEM="-----BEGIN PUBLIC KEY-----..."
-IDP_X25519_PUBLIC_KEY_PEM="-----BEGIN PUBLIC KEY-----..."
+### Device Operations
+
+#### `client.devices.list(userId): Promise<object>`
+
+List all devices for a user.
+
+```typescript
+const { devices } = await client.devices.list('user@example.com');
 ```
 
-### Public Key Formats
+#### `client.devices.revoke(options): Promise<object>`
 
-The SDK accepts public keys in multiple formats:
+Revoke a device (block it from authenticating).
 
-**From file:**
 ```typescript
-const claims = await exchangeCodeForClaims({
-  // ...
-  apiKey: process.env.HAWCX_API_KEY!,
-  publicKey: '/path/to/public.pem'  // Absolute path
+await client.devices.revoke({
+  userId: 'user@example.com',
+  deviceId: 'device-h2index',
 });
 ```
 
-**From environment variable:**
+#### `client.devices.unrevoke(options): Promise<object>`
+
+Unrevoke a previously revoked device.
+
 ```typescript
-const claims = await exchangeCodeForClaims({
-  // ...
-  apiKey: process.env.HAWCX_API_KEY!,
-  publicKey: process.env.OAUTH_PUBLIC_KEY!  // PEM string
+await client.devices.unrevoke({
+  userId: 'user@example.com',
+  deviceId: 'device-h2index',
 });
 ```
 
-**Expected PEM format:**
+#### `client.devices.delete(options): Promise<object>`
+
+Permanently delete a device.
+
+```typescript
+await client.devices.delete({
+  userId: 'user@example.com',
+  deviceId: 'device-h2index',
+});
+```
+
+### Generic Request
+
+#### `client.request<TReq, TRes>(options): Promise<TRes>`
+
+Send a custom encrypted request to any delegation endpoint.
+
+```typescript
+const result = await client.request({
+  endpoint: '/hc_auth/v5/custom/endpoint',
+  payload: { userid: 'user@example.com', custom_field: 'value' },
+  headers: { 'X-Custom-Header': 'value' },
+  includeBaseUrl: true,  // Optional (default: true)
+});
 ```
------BEGIN PUBLIC KEY-----
-MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...
------END PUBLIC KEY-----
+
+### Credential Utilities
+
+#### `parseHawcxSecretKey(secretKey): ParsedCredentials`
+
+Parse a secret key into usable key material (advanced usage).
+
+```typescript
+import { parseHawcxSecretKey } from '@hawcx/oauth-client';
+
+const creds = parseHawcxSecretKey(process.env.HAWCX_SECRET_KEY!);
+// Returns: { kid, hkid, signingKeyPem, verifyKeyPem, encryptKeyPem, decryptKeyPem }
 ```
 
-## Error Handling
+#### `generateCredentialBlob(options): string`
 
-The SDK provides specific exceptions for different failure scenarios:
+Generate a new credential blob (for admin tooling).
+
+```typescript
+import { generateCredentialBlob } from '@hawcx/oauth-client';
+
+const secretKey = generateCredentialBlob({
+  kid: 'customer-key-id',
+  hkid: 'hawcx-key-id',
+  edPrivate: Buffer.alloc(32),     // Ed25519 private key (32 bytes)
+  xPrivate: Buffer.alloc(32),      // X25519 private key (32 bytes)
+  hawcxEdPublic: Buffer.alloc(32), // Hawcx Ed25519 public key (32 bytes)
+  hawcxXPublic: Buffer.alloc(32),  // Hawcx X25519 public key (32 bytes)
+});
+// Returns: "hwx_sk_v1_<base64url>"
+```
+
+### Delegation Errors
 
 ```typescript
 import {
-  exchangeCodeForClaims,
-  OAuthExchangeError,
-  JWTVerificationError,
-  InvalidPublicKeyError
+  DelegationError,         // Base delegation error
+  DelegationCryptoError,   // Encryption/signing failed
+  DelegationRequestError,  // Request to IDP failed
+  DelegationResponseError, // Invalid response from IDP
 } from '@hawcx/oauth-client';
 
 try {
-  const claims = await exchangeCodeForClaims({
-    code,
-    oauthTokenUrl,
-    clientId,
-    apiKey,
-    publicKey
-  });
+  await client.mfa.initiate({ userId: 'user@example.com', mfaMethod: MfaMethod.EMAIL });
 } catch (error) {
-  if (error instanceof OAuthExchangeError) {
-    // Code exchange failed (invalid code, network error, etc.)
-    console.error(`Exchange failed: ${error.message}`);
-    console.error(`HTTP Status: ${error.statusCode}`);
-    console.error(`Response: ${error.responseBody}`);
-  } else if (error instanceof JWTVerificationError) {
-    // JWT verification failed (invalid signature, expired, etc.)
-    console.error(`Verification failed: ${error.message}`);
-    console.error(`Original error: ${error.originalError}`);
-  } else if (error instanceof InvalidPublicKeyError) {
-    // Public key is invalid or unreadable
-    console.error(`Key error: ${error.message}`);
+  if (error instanceof DelegationRequestError) {
+    console.log(error.statusCode);   // HTTP status
+    console.log(error.responseBody); // Response body
   }
 }
 ```
 
-### Common Error Scenarios
+---
 
-| Exception | Common Causes | Recommended Action |
-|-----------|--------------|-------------------|
-| `OAuthExchangeError` | Invalid/expired code, network issues | Ask user to re-authenticate |
-| `JWTVerificationError` | Token tampering, expired token | Log incident, ask user to re-authenticate |
-| `InvalidPublicKeyError` | Wrong key, file not found | Check configuration, verify key format |
+## Step-Up Module
 
-## Security Best Practices
+For step-up authentication flows (e.g., changing MFA method requires re-authentication).
 
-### ✅ DO
+### `StepUpClient`
 
-- **Always validate audience and issuer** in production environments
-- **Use HTTPS** for all OAuth endpoints
-- **Store keys securely** (environment variables, secrets manager)
-- **Set appropriate leeway** for clock skew (5-10 seconds typical)
-- **Log authentication failures** for security monitoring
-- **Rotate keys regularly** following your security policy
+```typescript
+import { StepUpClient } from '@hawcx/oauth-client';
+
+const stepUp = StepUpClient.fromSecretKey({
+  baseUrl: 'https://api.hawcx.com',
+  secretKey: process.env.HAWCX_SECRET_KEY!,
+  relyingParty: 'your-app.com',       // Required
+  apiKey: 'optional-api-key',          // Optional
+  apiPrefix: '/v1',                    // Optional (default: '/v1')
+  timeoutSeconds: 15,                  // Optional
+  clockSkewSeconds: 300,               // Optional
+});
+```
+
+### Methods
+
+#### `stepUp.startToken(options): Promise<StepUpStartTokenResponse>`
 
-### ❌ DON'T
+Start a step-up authentication flow.
 
-- **Never log JWT tokens** or claims containing sensitive data
-- **Don't disable signature verification** in production
-- **Don't use the id_token as your application's access token** (mint your own)
-- **Don't commit keys** to version control
-- **Don't ignore verification errors** or catch them silently
+```typescript
+const { start_token, expires_in } = await stepUp.startToken({
+  userId: 'user@example.com',
+  purpose: 'change_mfa_method',
+  newMfaMethod: 'totp',  // 'email_otp' | 'sms_otp' | 'totp'
+});
+// Send start_token to client for step-up authentication
+```
 
-## API Reference
+#### `stepUp.consumeReceipt(options): Promise<StepUpConsumeResponse>`
 
-### `exchangeCodeForClaims()`
+Consume a step-up receipt after user completes authentication.
 
 ```typescript
-async function exchangeCodeForClaims(
-  options: ExchangeCodeOptions
-): Promise<Record<string, any>>
-```
-
-**Parameters:**
-- `code` (string): Authorization code from OAuth flow
-- `oauthTokenUrl` (string): Token endpoint URL
-- `clientId` (string): OAuth client identifier
-- `apiKey` (string): API key for Hawcx OAuth
-- `publicKey` (string, optional): RS256 public key (PEM string or file path) - optional if jwksUrl provided
-- `jwksUrl` (string, optional): JWKS URL for dynamic key fetching (alternative to publicKey)
-- `codeVerifier` (string, optional): PKCE code verifier (RFC 7636)
-- `redirectUri` (string, optional): OAuth redirect URI
-- `timeout` (number, optional): Request timeout in seconds (default: 20)
-- `audience` (string, optional): Expected 'aud' claim (recommended)
-- `issuer` (string, optional): Expected 'iss' claim (recommended)
-- `verifyExp` (boolean, optional): Verify token expiration (default: true)
-- `leeway` (number, optional): Clock skew tolerance in seconds (default: 0)
-- `algorithms` (string[], optional): Allowed signing algorithms (default: RS256, ES256/384/512, EdDSA)
-
-**Returns:** `Promise<Record<string, any>>` - Verified JWT claims
-
-**Throws:**
-- `OAuthExchangeError`: Code exchange failed
-- `JWTVerificationError`: JWT verification failed
-- `InvalidPublicKeyError`: Public key invalid
-
-### `verifyJwt()`
+const { ok } = await stepUp.consumeReceipt({
+  receipt: 'step-up-receipt-from-client',
+});
+
+if (ok) {
+  // Step-up verified, proceed with sensitive operation
+}
+```
+
+### Types
 
 ```typescript
-function verifyJwt(
-  options: VerifyJwtOptions
-): Record<string, any>
+type StepUpPurpose = 'change_mfa_method';
+
+type HxAuthMfaMethod = 'sms_otp' | 'email_otp' | 'totp';
+
+interface StepUpStartTokenResponse {
+  start_token: string;
+  expires_in: number;
+}
+
+interface StepUpConsumeResponse {
+  ok: boolean;
+}
 ```
 
-Verify a JWT and return its claims. See full documentation in [API.md](./API.md).
+---
 
-### HawcxDelegationClient
+## Examples
 
-See [DELEGATION.md](./DELEGATION.md) for full Hawcx delegation client documentation.
+### Next.js Auth Callback
 
-## TypeScript Support
+```typescript
+// app/api/auth/callback/route.ts
+import { HawcxOAuth, TokenExchangeError } from '@hawcx/oauth-client';
+import { cookies } from 'next/headers';
+
+const oauth = new HawcxOAuth({
+  configId: process.env.HAWCX_CONFIG_ID!,
+});
 
-This package is written in TypeScript and includes full type definitions:
+export async function GET(request: Request) {
+  const url = new URL(request.url);
+  const code = url.searchParams.get('code');
+
+  const cookieStore = cookies();
+  const codeVerifier = cookieStore.get('code_verifier')?.value;
+
+  if (!code || !codeVerifier) {
+    return Response.redirect('/login?error=missing_params');
+  }
+
+  try {
+    const { idToken, claims } = await oauth.exchangeCode(code, codeVerifier);
+    // Create session with claims.sub, claims.email, etc.
+    return Response.redirect('/dashboard');
+  } catch (error) {
+    if (error instanceof TokenExchangeError) {
+      console.error('Token exchange failed:', error.message);
+    }
+    return Response.redirect('/login?error=auth_failed');
+  }
+}
+```
+
+### Admin MFA Management
 
 ```typescript
-import type {
-  ExchangeCodeOptions,
-  VerifyJwtOptions
-} from '@hawcx/oauth-client';
+import { DelegationClient, MfaMethod } from '@hawcx/oauth-client';
+
+const admin = DelegationClient.fromSecretKey({
+  baseUrl: process.env.HAWCX_API_URL!,
+  secretKey: process.env.HAWCX_SECRET_KEY!,
+});
+
+// Reset user MFA to email
+async function resetUserMfa(userId: string, otp: string) {
+  const initResult = await admin.mfa.initiate({
+    userId,
+    mfaMethod: MfaMethod.EMAIL,
+  });
 
-// All options are fully typed
-const options: ExchangeCodeOptions = {
-  code: 'abc123',
-  oauthTokenUrl: 'https://oauth.example.com/token',
-  clientId: 'my-app',
-  publicKey: process.env.OAUTH_PUBLIC_KEY!,
-  audience: 'my-app',  // TypeScript will catch typos!
-};
+  const verifyResult = await admin.mfa.verify({
+    userId,
+    sessionId: initResult.session_id,
+    otp,
+  });
+
+  return verifyResult;
+}
+
+// Revoke all user devices
+async function revokeAllDevices(userId: string) {
+  const { devices } = await admin.devices.list(userId);
+
+  for (const device of devices) {
+    await admin.devices.revoke({
+      userId,
+      deviceId: device.h2index,
+    });
+  }
+}
 ```
 
-## Development
+### Step-Up for MFA Change
 
-### Building
+```typescript
+import { StepUpClient, DelegationClient, MfaMethod } from '@hawcx/oauth-client';
 
-```bash
-npm install
-npm run build
+const stepUp = StepUpClient.fromSecretKey({
+  baseUrl: process.env.HAWCX_API_URL!,
+  secretKey: process.env.HAWCX_SECRET_KEY!,
+  relyingParty: 'myapp.com',
+});
+
+const delegation = DelegationClient.fromSecretKey({
+  baseUrl: process.env.HAWCX_API_URL!,
+  secretKey: process.env.HAWCX_SECRET_KEY!,
+});
+
+async function changeMfaMethod(userId: string, newMethod: 'totp' | 'sms_otp' | 'email_otp') {
+  // 1. Start step-up flow
+  const { start_token } = await stepUp.startToken({
+    userId,
+    purpose: 'change_mfa_method',
+    newMfaMethod: newMethod,
+  });
+
+  // 2. Send start_token to client, user completes step-up auth
+  // 3. Client sends back receipt
+
+  // 4. Verify step-up receipt
+  const { ok } = await stepUp.consumeReceipt({ receipt: 'receipt-from-client' });
+
+  if (!ok) {
+    throw new Error('Step-up verification failed');
+  }
+
+  // 5. Now safe to change MFA
+  await delegation.mfa.initiate({
+    userId,
+    mfaMethod: MfaMethod.EMAIL,
+    mfaChangeTo: newMethod,
+  });
+}
 ```
 
-### Testing
+---
 
-```bash
-npm test
-npm run test:coverage
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `HAWCX_CONFIG_ID` | Your Hawcx OAuth config ID (for token verification) |
+| `HAWCX_SECRET_KEY` | Your Hawcx secret key (for delegation/step-up APIs) |
+| `HAWCX_API_URL` | API base URL (default: `https://api.hawcx.com`) |
+
+### Secret Key Format
+
+The `HAWCX_SECRET_KEY` is a compact credential blob:
+
+```
+hwx_sk_v1_<base64url-encoded-json>
 ```
 
-### Linting
+It contains:
+- Your Ed25519 signing key (for request authentication)
+- Your X25519 decryption key (for response decryption)
+- Hawcx's Ed25519 public key (for response verification)
+- Hawcx's X25519 public key (for request encryption)
+- Key IDs for rotation tracking
 
-```bash
-npm run lint
-npm run format
+Generate via the Hawcx Dashboard or admin tools.
+
+---
+
+## JWKS Caching
+
+The SDK automatically caches JWKS (JSON Web Key Set) for JWT verification:
+
+- Keys are fetched lazily on first `verifyToken()` call
+- Cached in memory for the lifetime of the `HawcxOAuth` instance
+- Auto-refreshes if a key ID isn't found (handles key rotation)
+- Call `clearCache()` to force a refresh
+
+```typescript
+// Keys fetched once, cached thereafter
+const claims1 = await oauth.verifyToken(token1); // Fetches JWKS
+const claims2 = await oauth.verifyToken(token2); // Uses cache
+const claims3 = await oauth.verifyToken(token3); // Uses cache
+
+// Force refresh if needed
+oauth.clearCache();
+const claims4 = await oauth.verifyToken(token4); // Fetches JWKS again
 ```
+
+---
+
+## Requirements
+
+- Node.js >= 18.0.0
+
+## License
+
+MIT