AuthHandler | SignalWire

AuthHandler provides a unified authentication layer supporting Bearer tokens, API keys, and HTTP Basic Auth. All credential comparisons use constant-time algorithms to prevent timing attacks. It can be used as Hono middleware or as a standalone request validator.

1 import { AuthHandler } from '@signalwire/sdk';
2 
3 const auth = new AuthHandler({
4   bearerToken: 'my-secret-token',
5   apiKey: 'my-api-key',
6 });

Constructor

config

AuthConfigRequired

Authentication configuration object with the following optional fields:

config.bearerToken

string

Bearer token matched against the Authorization: Bearer <token> header.

config.apiKey

string

API key matched against the X-Api-Key header (or the custom header named by config.apiKeyHeader).

config.apiKeyHeader

stringDefaults to 'X-Api-Key'

Custom header name to use for API key lookup instead of the default X-Api-Key. Lookup is case-insensitive.

config.basicAuth

[string, string]

Basic auth credentials as a [username, password] tuple.

config.customValidator

(request: { headers, method, url }) => boolean | Promise<boolean>

Custom validator function. Return true to allow the request.

config.allowUnauthenticated

boolean

When explicitly set to false, deny requests if no auth methods are configured. By default, unauthenticated access is allowed when no methods are set.

Methods

validate

Validate request headers against all configured auth methods.

middleware

Create a Hono-compatible middleware that rejects unauthorized requests.

expressMiddleware

Create an Express/Connect-compatible middleware adapter.

verifyBasicAuth

Verify a username/password pair with constant-time comparison.

verifyBearerToken

Verify a Bearer token with constant-time comparison.

verifyApiKey

Verify an API key with constant-time comparison.

getAuthInfo

Get metadata describing the enabled auth methods.

hasBearerAuth

Check whether Bearer token authentication is configured.

hasApiKeyAuth

Check whether API key authentication is configured.

hasBasicAuth

Check whether Basic authentication is configured.

Example

1 import { AuthHandler } from '@signalwire/sdk';
2 
3 const auth = new AuthHandler({
4   bearerToken: process.env.AUTH_TOKEN,
5   basicAuth: ['admin', 'secret'],
6   apiKey: process.env.API_KEY,
7 });
8 
9 // Check which methods are configured
10 console.log('Bearer:', auth.hasBearerAuth());   // true
11 console.log('API Key:', auth.hasApiKeyAuth());   // true
12 console.log('Basic:', auth.hasBasicAuth());      // true
13 
14 // Validate incoming request headers
15 const isValid = await auth.validate({
16   authorization: 'Bearer my-secret-token',
17 });
18 console.log('Valid:', isValid);