Wondering what’s next for npm?Check out our public roadmap! »

    oidc-provider
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/oidc-provider package

    7.3.1 • Public • Published

    oidc-provider

    oidc-provider is an OAuth 2.0 Authorization Server with OpenID Connect and many additional features and standards implemented.

    Table of Contents

    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.

    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.

    Certification

    OpenID Certification
    Filip Skokan has certified that oidc-provider conforms to the following profiles of the OpenID Connect™ protocol

    • OP Basic, Implicit, Hybrid, Config, Dynamic, Form Post, and 3rd Party-Init
    • OP Back-Channel Logout and RP-Initiated Logout
    • OP FAPI R/W MTLS and Private Key

    Sponsor

    auth0-logo 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/developers.

    Support

    If you or your business use oidc-provider, 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. I make it a best effort to try and answer newcomers regardless of being a supporter or not, but if you're asking your n-th question and don't get an answer it's because I'm out of handouts and spare time to give.

    Get started

    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.

    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.

    const { Provider } = require('oidc-provider');
    const configuration = {
      // ... see available options /docs
      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);
    
    // express/nodejs style application callback (req, res, next) for use with express apps, see /examples/express.js
    oidc.callback()
    
    // koa application for use with koa apps, see /examples/koa.js
    oidc.app
    
    // or just expose a server standalone, see /examples/standalone.js
    const server = oidc.listen(3000, () => {
      console.log('oidc-provider listening on port 3000, check http://localhost:3000/.well-known/openid-configuration');
    });

    Recipes

    Collection of useful configurations use cases are available over at recipes.

    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.

    Install

    npm i oidc-provider

    DownloadsWeekly Downloads

    14,948

    Version

    7.3.1

    License

    MIT

    Unpacked Size

    634 kB

    Total Files

    193

    Last publish

    Collaborators

    • avatar