@owox/idp-protocol

Identity Provider protocol package for OWOX Data Marts. Provides core types, middleware, and provider implementations for authentication and authorization.

Features

• 🔧 Core IDP interfaces and types
• 🔀 Express middleware for authentication routes
• 🚫 NULL IDP provider for single-user deployments (for development and testing)
• 🛡️ Built-in error handling
• ⚙️ Configurable routing

Installation

npm install @owox/idp-protocol

Architecture

@owox/idp-protocol
├── types/                    # Core interfaces and models
│   ├── provider.ts          # IdpProvider interface
│   ├── models.ts            # Payload, AuthResult, Role types
│   ├── config.ts            # Configuration types
│   ├── errors.ts            # Error classes
│   └── cli.ts               # CLI command interfaces
├── providers/               # Provider implementations
│   └── null-provider.ts     # NULL provider for development
└── middleware/              # Express middleware
    └── protocol-middleware.ts # Route handling middleware

Core Types

IdpProvider Interface

The main provider interface that all IDP implementations must follow:

import { IdpProvider } from '@owox/idp-protocol';

interface IdpProvider {
  // Middleware handlers
  signInMiddleware(req: Request, res: Response, next: NextFunction): Promise<void | Response>;
  signUpMiddleware(req: Request, res: Response, next: NextFunction): Promise<void | Response>;
  signOutMiddleware(req: Request, res: Response, next: NextFunction): Promise<void | Response>;
  accessTokenMiddleware(req: Request, res: Response, next: NextFunction): Promise<void | Response>;
  userApiMiddleware(req: Request, res: Response, next: NextFunction): Promise<Response<Payload>>;

  // Token management
  introspectToken(token: string): Promise<Payload | null>;
  parseToken(token: string): Promise<Payload | null>;
  refreshToken(refreshToken: string): Promise<AuthResult>;
  revokeToken(token: string): Promise<void>;

  // Lifecycle
  initialize(): Promise<void>;
  shutdown(): Promise<void>;
}

Domain Models

import { Payload, AuthResult, Role } from '@owox/idp-protocol';

type Role = 'admin' | 'editor' | 'viewer';

interface Payload {
  userId: string;
  projectId: string;
  email?: string;
  fullName?: string;
  avatar?: string;
  roles?: Role[];
  projectTitle?: string;
}

interface AuthResult {
  accessToken: string;
  refreshToken?: string;
}

Error Classes

import {
  IdpError,
  AuthenticationError,
  AuthorizationError,
  TokenExpiredError,
  InvalidTokenError,
} from '@owox/idp-protocol';

// CLI command interfaces
import {
  IdpProviderAddUserCommand,
  IdpProviderListUsersCommand,
  IdpProviderRemoveUserCommand,
  AddUserCommandResponse,
} from '@owox/idp-protocol';

Middleware

The protocol middleware handles authentication routes automatically:

import express from 'express';
import { IdpProtocolMiddleware, NullIdpProvider } from '@owox/idp-protocol';

const app = express();
const provider = new NullIdpProvider();

// Basic usage with default routes (/auth/sign-in, /auth/sign-up, /auth/sign-out, /auth/access-token, /auth/api/user, /auth/api/projects)
const middleware = new IdpProtocolMiddleware(provider);
middleware.register(app);

// Custom configuration
const middleware = new IdpProtocolMiddleware(provider, {
  basePath: '/api/v1/auth',
  routes: {
    signIn: '/login',
    signUp: '/register',
    signOut: '/logout',
    accessToken: '/token',
    user: '/me',
  },
});
middleware.register(app);

Middleware Features

• ✅ Configurable base path and route names
• ✅ Automatic error handling with try-catch
• ✅ Support for all HTTP methods (GET, POST, etc.)
• ✅ Route collision detection
• ✅ Path validation
• ✅ TypeScript support

NULL Provider

The included NULL provider is perfect for development and single-user deployments:

import { NullIdpProvider } from '@owox/idp-protocol';

const provider = new NullIdpProvider();

// Default user payload
const defaultPayload = {
  userId: '0',
  email: 'admin@localhost',
  roles: ['admin'],
  fullName: 'Admin',
  projectId: '0',
};

NULL Provider Features

NULL Provider is not recommended for production use. It is only intended for testing and development.

• ✅ Implements all IdpProvider methods
• 🔄 Returns consistent default user payload
• 🚫 No actual authentication (always succeeds)
• ⚡ Zero configuration required
• 🛠️ Perfect for testing and development

Usage Examples

Basic Setup

import express from 'express';
import { IdpProtocolMiddleware, NullIdpProvider } from '@owox/idp-protocol';

const app = express();
const provider = new NullIdpProvider();

// Initialize provider
await provider.initialize();

// Setup middleware
const middleware = new IdpProtocolMiddleware(provider);
middleware.register(app);

// Server will handle:
// ALL /auth/sign-in
// ALL /auth/sign-out
// ALL /auth/access-token
// ALL /auth/api/user

app.listen(3000);

Custom Provider Implementation

import { IdpProvider, Payload, AuthResult } from '@owox/idp-protocol';
import { Request, Response, NextFunction } from 'express';

class CustomIdpProvider implements IdpProvider {
  async signInMiddleware(req: Request, res: Response, next: NextFunction): Promise<Response> {
    // Handle OAuth redirect, validate credentials, etc.
    return res.json({ success: true, redirectUrl: '/dashboard' });
  }

  async signOutMiddleware(req: Request, res: Response, next: NextFunction): Promise<Response> {
    // Clear session, revoke tokens
    return res.json({ success: true });
  }

  async accessTokenMiddleware(req: Request, res: Response, next: NextFunction): Promise<Response> {
    // Return access token
    return res.json({ accessToken: 'access-token-here' });
  }

  async userApiMiddleware(req: Request, res: Response, next: NextFunction): Promise<Response> {
    // Return user info
    const payload = await this.introspectToken(req.headers.authorization);
    return res.json(payload);
  }

  async introspectToken(token: string): Promise<Payload | null> {
    // Validate JWT or call external IDP
    return {
      userId: 'user123',
      projectId: 'proj456',
      email: '[email protected]',
      roles: ['editor'],
    };
  }

  async parseToken(token: string): Promise<Payload | null> {
    // Parse token without validation (for development/testing)
    return this.introspectToken(token);
  }

  async refreshToken(refreshToken: string): Promise<AuthResult> {
    // Exchange refresh token for new access token
    return { accessToken: 'new-jwt-token' };
  }

  async revokeToken(token: string): Promise<void> {
    // Invalidate token
  }

  async initialize(): Promise<void> {
    // Setup external connections, validate config
  }

  async shutdown(): Promise<void> {
    // Cleanup resources
  }
}

Advanced Middleware Configuration

import { IdpProtocolMiddleware, ProtocolRoute } from '@owox/idp-protocol';

const middleware = new IdpProtocolMiddleware(provider, {
  basePath: '/api/v1/auth',
  routes: {
    signIn: ProtocolRoute.SIGN_IN, // '/sign-in'
    signUp: ProtocolRoute.SIGN_UP, // '/sign-up'
    signOut: ProtocolRoute.SIGN_OUT, // '/sign-out'
    accessToken: '/token', // Custom route
    user: ProtocolRoute.USER, // '/api/user'
  },
});

// Results in:
// ALL /api/v1/auth/sign-in
// ALL /api/v1/auth/sign-out
// ALL /api/v1/auth/token
// ALL /api/v1/auth/api/user

Error Handling

Use provided error classes for consistent error handling:

import { AuthenticationError, InvalidTokenError } from '@owox/idp-protocol';

class MyProvider implements IdpProvider {
  async introspectToken(token: string): Promise<Payload | null> {
    if (!token) {
      throw new InvalidTokenError('Token is required');
    }

    try {
      // Validate token
      return payload;
    } catch (error) {
      throw new AuthenticationError('Token validation failed');
    }
  }
}

CLI Commands Interface

The protocol defines optional CLI command interfaces that providers can implement for user management:

User Management Commands

import {
  IdpProviderAddUserCommand,
  IdpProviderListUsersCommand,
  IdpProviderRemoveUserCommand,
} from '@owox/idp-protocol';

// Add user command
interface IdpProviderAddUserCommand {
  addUser(username: string, password?: string): Promise<AddUserCommandResponse>;
}

// List users command
interface IdpProviderListUsersCommand {
  listUsers(): Promise<Payload[]>;
}

// Remove user command
interface IdpProviderRemoveUserCommand {
  removeUser(userId: string): Promise<void>;
}

// Response format for adding users
interface AddUserCommandResponse {
  username: string;
  magicLink?: string; // Optional magic link for passwordless setup
}

Usage Example

class CustomIdpProvider
  implements IdpProvider, IdpProviderAddUserCommand, IdpProviderListUsersCommand
{
  async addUser(username: string, password?: string): Promise<AddUserCommandResponse> {
    // Implementation for adding user
    const user = await this.createUser(username, password);
    return {
      username: user.username,
      magicLink: user.setupLink,
    };
  }

  async listUsers(): Promise<Payload[]> {
    // Return all users as Payload objects
    return await this.getAllUsers();
  }

  async removeUser(userId: string): Promise<void> {
    // Remove user from IDP
    await this.deleteUser(userId);
  }
}

Development

# Install dependencies
npm install

# Build
npm run build

# Type checking
npm run typecheck

# Linting
npm run lint
npm run lint:fix

# Formatting
npm run format
npm run format:check