Neonatal Penguin March

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

    8.1.0 • Public • Published

    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

    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.

    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.

    Certification

    OpenID Certification
    Filip Skokan has certified that oidc-provider 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

    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. 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 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');
    });

    Recipes

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

    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.

    Install

    npm i oidc-provider

    DownloadsWeekly Downloads

    29,912

    Version

    8.1.0

    License

    MIT

    Unpacked Size

    528 kB

    Total Files

    198

    Last publish

    Collaborators

    • panva