Skip to content

client-certificate-auth API Reference


client-certificate-auth API Reference / clientCertificateAuth / default

Function: default()

default(callback, options?): Middleware

Defined in: clientCertificateAuth.d.ts:159

Express/Connect middleware for client SSL certificate authentication.

Parameters

callback

ValidationCallback

Validation function that receives the client certificate and returns true/false (sync) or Promise<boolean> (async).

options?

ClientCertificateAuthOptions

Configuration options

Returns

Middleware

Express middleware function

Examples

ts
// Socket-based validation (original behavior)
app.use(clientCertificateAuth((cert) => cert.subject.CN === 'admin'));
ts
// AWS ALB mTLS passthrough
app.use(clientCertificateAuth((cert) => cert.subject.CN === 'admin', {
  certificateSource: 'aws-alb'
}));
ts
// Custom header with nginx/HAProxy
app.use(clientCertificateAuth((cert) => cert.subject.CN === 'admin', {
  certificateHeader: 'X-SSL-Client-Cert',
  headerEncoding: 'url-pem'
}));

Released under the MIT License.