@astro-my/oidc-provider-astro

!buildtravis-imagetravis-url !codecovcodecov-imagecodecov-url
oidc-provider is an OpenID Provider implementation of OpenID Connectopenid-connect. It allows to export a complete mountable or standalone OpenID Provider implementation. This implementation does not dictate a fixed data model or persistence store, instead, you must provide adapters for these. A generic in-memory adapter is available to get you started as well as feature-less dev-only views to be able to get off the ground.
NOTICE: oidc-provider ^4.0.0 drops support for Node.js versions less than lts/carbon(8.9.0) and introduces various breaking changes. See the CHANGELOG for a complete list of deprecations and changes.
Table of Contents

• Implemented specs & features
• Certification
• Get started
• Configuration and Initialization
• Debugging
• Events

Implemented specs & features

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.

• OpenID Connect Core 1.0core

- Authorization (Authorization Code Flow, Implicit Flow, Hybrid Flow) - UserInfo Endpoint and ID Tokens including Signing and Encryption - Passing a Request Object by Value or Reference including Signing and Encryption - Public and Pairwise Subject Identifier Types - Offline Access / Refresh Token Grant - Client Credentials Grant - Client Authentication incl. clientsecretjwt and privatekeyjwt methods

• OpenID Connect Discovery 1.0discovery
• OpenID Connect Dynamic Client Registration 1.0registration
• OAuth 2.0 Form Post Response Modeform-post
• RFC7636 - Proof Key for Code Exchange by OAuth Public Clientspkce
• RFC7009 - OAuth 2.0 Token Revocationrevocation
• RFC7662 - OAuth 2.0 Token Introspectionintrospection
• RFC8252 - OAuth 2.0 for Native Apps BCPoauth-native-apps

The following drafts/experimental specifications are implemented by oidc-provider.

• OpenID Connect Session Management 1.0 - draft 28session-management
• OpenID Connect Back-Channel Logout 1.0 - draft 04backchannel-logout
• OpenID Connect Front-Channel Logout 1.0 - draft 02frontchannel-logout
• RFC7592 - OAuth 2.0 Dynamic Client Registration Management Protocol (Update and Delete)registration-management
• OAuth 2.0 Web Message Response Mode - draft 00wmrm
• OAuth 2.0 Device Flow for Browserless and Input Constrained Devices - draft 12device-flow
• JWT Response for OAuth Token Introspection - draft 00jwt-introspection

Updates to draft and experimental 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.
Missing a feature? - If it wasn't already discussed before, ask for itsuggest-feature.
Found a bug? - report itbug.

Certification

openid-certified-link
Filip Skokan has certifiedopenid-certified-link that oidc-providernpm-url conforms to the OP Basic, OP Implicit, OP Hybrid, OP Config, OP Dynamic and OP Form Post profiles of the OpenID Connect™ protocol.
!buildconformance-imageconformance-url

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 at auth0.com/overviewsponsor-auth0.

Get started

You may follow an example step by step setupexample-repo (recommended), or run and experiment with an example server that's part of the repo (if you can follow the structure, if not check the step by step).
The example bundled in this repo's codebase is available for you to experiment with hereheroku-example. Dynamic Registration is open, you can literally register any client you want there.
An example client using this provider is available hereheroku-example-client (uses openid-clientopenid-client).

Configuration and Initialization

oidc-provider allows to be extended and configured in various ways to fit a variety of uses. See the available configuration.

const Provider = require('oidc-provider');
const configuration = {
  // ... see available options /docs/configuration.md
};
const 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);

(async () => {
  await oidc.initialize({ clients });
  // oidc.callback => express/nodejs style application callback (req, res)
  // oidc.app => koa2.x application
  oidc.listen(3000);
  console.log('oidc-provider listening on port 3000, check http://localhost:3000/.well-known/openid-configuration');
})().catch((err) => {
  console.error(err);
  process.exitCode = 1;
});

Debugging

oidc-provider uses the debugdebug-link module internally to log information about various states of authentication requests, errors and grants. To see all these set the DEBUG environment variable to oidc-provider:* when launching your app.
There is no filter on what is included in the debug output, since it may end-user Personally identifiable information or client credentials it's use is only advised for debugging, not regular logging. Use emitted events to cherry pick the one's of interest to your flows and form your own logs aware of what should and should not be a part of a logged message.

Events

Your oidc-provider instance is an event emitter, using event handlers you can hook into the various actions and i.e. emit metrics or that react to specific triggers. In some scenarios you can even change the defined behavior.
See the list of available emitted event names and their description.