oidc-provider
This module provides an OAuth 2.0 (RFC 6749oauth2) Authorization Server with support for OpenID Connect (OIDCopenid-connect) and many
other additional features and standards.Table of Contents
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.0oauth2 &OIDC
Core 1.0core- OIDC
Discovery 1.0
discovery - Dynamic Client Registration
Dynamic Client Registration 1.0
registration
- RFC7591
- OAuth 2.0 Dynamic Client Registration Protocoloauth2-registration
- RFC7592
- OAuth 2.0 Dynamic Client Registration Management Protocolregistration-management- OIDC
RP-Initiated Logout 1.0
rpinitiated-logout - OIDC
Back-Channel Logout 1.0
backchannel-logout RFC7009
- OAuth 2.0 Token RevocationrevocationRFC7636
- Proof Key for Code Exchange (PKCE
)pkceRFC7662
- OAuth 2.0 Token IntrospectionintrospectionRFC8252
- OAuth 2.0 for Native Apps BCP (AppAuth
)oauth-native-appsRFC8628
- OAuth 2.0 Device Authorization Grant (Device Flow
)device-flowRFC8705
- OAuth 2.0 Mutual TLS Client Authentication and Certificate Bound Access Tokens (MTLS
)mtlsRFC8707
- OAuth 2.0 Resource Indicatorsresource-indicatorsRFC9101
- OAuth 2.0 JWT-Secured Authorization Request (JAR
)jarRFC9126
- OAuth 2.0 Pushed Authorization Requests (PAR
)parRFC9207
- OAuth 2.0 Authorization Server Issuer Identifier in Authorization Responseiss-auth-respRFC9449
- OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP
)dpop- Financial-grade API Security Profile 1.0 - Part 2: Advanced (
FAPI 1.0
)fapi - JWT Secured Authorization Response Mode for OAuth 2.0 (
JARM
)jarm - OIDC Client Initiated Backchannel Authentication Flow (
CIBA
)ciba
Supported Access Token formats:
The following draft specifications are implemented by oidc-provider:
- JWT Response for OAuth Token Introspection - draft 10jwt-introspection
- Financial-grade API: Client Initiated Backchannel Authentication Profile (
FAPI-CIBA
) - Implementer's Draft 01fapi-ciba
Updates to draft specification versions are released as MINOR library versions, if you utilize these specification implementations 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
openid-certified-linkFilip Skokan has certifiedopenid-certified-link that oidc-providernpm-url conforms to the following profiles of the OpenID Connectâ„¢ protocol.
- Basic, Implicit, Hybrid, Config, Dynamic, Form Post, and 3rd Party-Init OP profiles
- Back-Channel Logout and RP-Initiated Logout
- FAPI 1.0 Advanced (w/ Private Key JWT, MTLS, JARM, PAR, CIBA)
Sponsor
sponsor-auth0 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!sponsor-auth0Support
If you or your company use this module, or you need help using/upgrading the module, please consider becoming a sponsorsupport-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 provider allows to be extended and configured in various ways to fit a variety of uses. See the documentation and example folder.import Provider from 'oidc-provider';
const configuration = {
// refer to the documentation for other available configuration
clients: [{
client_id: 'foo',
client_secret: 'bar',
redirect_uris: ['http://lvh.me:8080/cb'],
// ... other client properties
}],
};
const oidc = new Provider('http://localhost:3000', configuration);
oidc.listen(3000, () => {
console.log('oidc-provider listening on port 3000, check http://localhost:3000/.well-known/openid-configuration');
});