oidc-provider
This module provides an OAuth 2.0 (RFC 6749) Authorization Server with support for OpenID Connect (OIDC) and many other additional features and standards.
Table of Contents
- Implemented specs & features
- Certification
- Documentation & Configuration
- Community Guides
- Events
Implemented specs & features
The following specifications are implemented by oidc-provider (not exhaustive):
Note that not all features are enabled by default, check the configuration section on how to enable them.
RFC6749- OAuth 2.0 &OIDCCore 1.0- OIDC
Discovery 1.0&RFC8414Authorization Server Metadata - Dynamic Client Registration
- OIDC
RP-Initiated Logout 1.0 - OIDC
Back-Channel Logout 1.0 RFC7009- OAuth 2.0 Token RevocationRFC7636- Proof Key for Code Exchange (PKCE)RFC7662- OAuth 2.0 Token IntrospectionRFC8252- OAuth 2.0 for Native Apps BCP (AppAuth)RFC8628- OAuth 2.0 Device Authorization Grant (Device Flow)RFC8705- OAuth 2.0 Mutual TLS Client Authentication and Certificate Bound Access Tokens (MTLS)RFC8707- OAuth 2.0 Resource IndicatorsRFC9101- OAuth 2.0 JWT-Secured Authorization Request (JAR)RFC9126- OAuth 2.0 Pushed Authorization Requests (PAR)RFC9207- OAuth 2.0 Authorization Server Issuer Identifier in Authorization ResponseRFC9449- OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)RFC9701- JWT Response for OAuth Token Introspection- FAPI 1.0 Security Profile - Part 2: Advanced (
FAPI 1.0) - FAPI 2.0 Security Profile (
FAPI 2.0) - FAPI 2.0 Message Signing (
FAPI 2.0) - JWT Secured Authorization Response Mode for OAuth 2.0 (
JARM) - OIDC Client Initiated Backchannel Authentication Flow (
CIBA)
Supported Access Token formats:
The following specifications and drafts are implemented as experimental features:
- Financial-grade API: Client Initiated Backchannel Authentication Profile (
FAPI-CIBA) - Implementers Draft 01 - OIDC Relying Party Metadata Choices 1.0 - Implementers Draft 01
- OAuth 2.0 Attestation-Based Client Authentication - Draft 06
Updates to experimental feature specification versions are released as MINOR library versions,
if you utilize these features consider using the tilde ~ operator in your
package.json since breaking changes may be introduced as part of these version updates. Alternatively
acknowledge the version and be notified of breaking changes as part of
your CI.
Certification
Filip Skokan has certified that oidc-provider
conforms to the following profiles of the OpenID Connect(tm) protocol.
- Basic, Implicit, Hybrid, Config, Form Post, and 3rd Party-Init
- Back-Channel Logout and RP-Initiated Logout
- FAPI 1.0
- FAPI CIBA
- FAPI 2.0
Sponsor
If you want to quickly add OpenID Connect authentication to Node.js apps, feel free to check out Auth0's Node.js SDK and free plan. Create an Auth0 account; it's free!
Support
If you or your company use this module, or you need help using/upgrading the module, please consider becoming a sponsor so I can continue maintaining it and adding new features carefree. The only way to guarantee you get feedback from the author & sole maintainer of this module is to support the package through GitHub Sponsors.
Documentation & Configuration
oidc-provider can be mounted to existing connect, express, fastify, hapi, or koa applications, see how. The authorization server allows to be extended and configured in various ways to fit a variety of uses. See the documentation and example folder.
const provider = new oidc.Provider("http://localhost:3000", {
// refer to the documentation for other available configuration
clients: [
{
client_id: "foo",
client_secret: "bar",
redirect_uris: ["http://localhost:8080/cb"],
// ... other client properties
},
],
});
const server = provider.listen(3000, () => {
console.log(
"oidc-provider listening on port 3000, check http://localhost:3000/.well-known/openid-configuration",
);
});
External type definitions are available via DefinitelyTyped.
Community Guides
Collection of Community-maintained configuration use cases are in the Community Guides Discussions section
Events
oidc-provider instances are event emitters, using event handlers you can hook into the various actions and i.e. emit metrics that react to specific triggers. See the list of available emitted event names and their description.
Supported Versions
| Version | Security Fixes | Other Bug Fixes | New Features |
|---|---|---|---|
| v9.x | Security Policy | ||
| v8.x | Security Policy |