ts-radius-client

A standards-compliant RADIUS client for TypeScript/Bun, extracted from a production OAuth2 proxy.

Features

• Standards Compliant: Supports RFC 2865 (PAP authentication) and RFC 2869.
• Failover: Automatic failover to backup hosts on timeout.
• Health Checks: Background health checks to restore primary hosts.
• Configurable: extensive configuration for timeouts, retries, and attribute extraction.
• TypeScript: Written in TypeScript with full type definitions.
• Bun: Optimized for Bun runtime.

Installation

Install directly from GitHub:

bun add github:essinghigh-org/ts-radius

Usage

import { RadiusClient, RadiusConfig } from "ts-radius-client";

const config: RadiusConfig = {
  host: "10.0.0.1",
  hosts: ["10.0.0.1", "10.0.0.2"], // Failover hosts
  secret: "my-shared-secret",
  timeoutMs: 5000,
};

const client = new RadiusClient(config);

try {
  const result = await client.authenticate("username", "password");

  if (result.ok) {
    console.log("Authentication successful!");
    if (result.class) {
      console.log("Received Class attribute:", result.class);
    }
  } else {
    console.log("Authentication failed:", result.error || "Unknown error");
  }
} catch (err) {
  console.error("Client error:", err);
} finally {
  // Clean up timers if shutting down the app
  client.shutdown();
}

Configuration (RadiusConfig)

| Option | Type | Default | Description | |Prefix|---|---|---| | host | string | (Required) | Primary RADIUS host IP/hostname. | | hosts | string[] | [host] | Ordered list of hosts for failover. | | secret | string | (Required) | Shared secret. | | port | number | 1812 | RADIUS port. | | timeoutMs | number | 5000 | Request timeout in milliseconds. | | healthCheckIntervalMs | number | 1800000 | (30m) Interval for background health checks. | | healthCheckUser | string | (Required) | Username for health probes. | | healthCheckPassword | string | (Required) | Password for health probes. | | assignmentAttributeId | number | 25 | Attribute ID to extract (e.g., 25 for Class). |

License

MIT