oidc-provider
Advanced tools
OAuth 2.0 Authorization Server implementation for Node.js with OpenID Connect
oidc-provider is an OAuth 2.0 Authorization Server with OpenID Connect and many additional features and standards implemented.
Table of Contents
The following specifications are implemented by oidc-provider:
Note that not all features are enabled by default, check the configuration section on how to enable them.
Supported Access Token formats:
The following draft specifications are implemented by oidc-provider:
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.
Filip Skokan has certified that oidc-provider
conforms to the following profiles of the OpenID Connect™ protocol
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!
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.
You may check the example folder or follow a step by step example to see which of those fits your desired application setup.
Also be sure to check the available configuration docs section.
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.
import Provider from 'oidc-provider';
const configuration = {
// ... see /docs for 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');
});
Collection of useful configurations use cases are available over at recipes.
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.
8.0.0 (2022-12-03)
clockTolerance configuration option.x-fapi-interaction-id headers. This can be reverted using a custom pre-middleware.request_uri parameter is no longer supported at the Device Authorization Endpoint.features.requestObjects.requireSignedRequestObject to true as a global policy or set require_signed_request_object or backchannel_authentication_request_signing_alg client metadata.features.pushedAuthorizationRequests and features.requestObjects.request.features.ciba and features.requestObjects.request.features.pushedAuthorizationRequests.enabled configuration option.expiresWithSession() for access tokens issued by the authorization endpoint will now only be invoked for opaque format access tokens.enabledJWA.dPoPSigningAlgValues configuration option.allowOmittingSingleRegisteredRedirectUri configuration option.features.fapi.profile is now a required configuration option when features.fapi.enabled is true.id_token_signed_response_alg now must be set when id_token_encrypted_response_alg is also set on a client.userinfo_signed_response_alg now must be set when userinfo_encrypted_response_alg is also set on a client.introspection_signed_response_alg now must be set when introspection_encrypted_response_alg is also set on a client.authorization_signed_response_alg now must be set when authorization_encrypted_response_alg is also set on a client.request_uri parameter support is now disabled by default. This can be reverted using the features.requestObjects.requestUri configuration option.httpOptions return property lookup was renamed to dnsLookup.httpOptions return property timeout was removed, return an AbortSignal instance as signal property instead.oidc-provider is now an ESM-only module, it must now be imported using the import declaration or the import() syntax, the Provider constructor is the module's default export, the errors and interactionPolicy exports are the package's named exports. There is no Provider named export.httpOptions no longer defaults to using the npm module cacheable-lookup as its dnsLookup option. It defaults to node:dns module's lookup export instead.ttl.AuthorizationCode configuration option.features.requestObjects.mode configuration option.features.registrationManagement.rotateRegistrationAccessToken configuration option.access_token query string parameter. This can be reverted using the acceptQueryParamAccessTokens configuration option.tokenEndpointAuthMethods configuration method was renamed to clientAuthMethods.enabledJWA.tokenEndpointAuthSigningAlgValues configuration method was renamed to enabledJWA.clientAuthSigningAlgValues.introspection_endpoint_auth_method, and introspection_endpoint_auth_signing_alg client metadata properties were removed. The client's token_endpoint_auth_method, and token_endpoint_auth_signing_alg properties are now used as the only indication of how a client must authenticate at the introspection endpoint. The accompanying JWA and authentication methods configuration properties were also removed.revocation_endpoint_auth_method, and revocation_endpoint_auth_signing_alg client metadata properties were removed. The client's token_endpoint_auth_method, and token_endpoint_auth_signing_alg properties are now used as the only indication of how a client must authenticate at the revocation endpoint. The accompanying JWA and authentication methods configuration properties were also removed."cty": "json" JWEs (b4b837b)FAQs
OAuth 2.0 Authorization Server implementation for Node.js with OpenID Connect
The npm package oidc-provider receives a total of 24,839 weekly downloads. As such, oidc-provider popularity was classified as popular.
We found that oidc-provider demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.