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
• Certification
• Documentation & Configuration
• Recipes
• Events

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.0 & OIDC Core 1.0
• OIDC Discovery 1.0
• Dynamic Client Registration
  • OIDC Dynamic Client Registration 1.0
  • RFC7591 - OAuth 2.0 Dynamic Client Registration Protocol
  • RFC7592 - OAuth 2.0 Dynamic Client Registration Management Protocol
• OIDC RP-Initiated Logout 1.0
• OIDC Back-Channel Logout 1.0
• RFC7009 - OAuth 2.0 Token Revocation
• RFC7636 - Proof Key for Code Exchange (PKCE)
• RFC7662 - OAuth 2.0 Token Introspection
• RFC8252 - OAuth 2.0 for Native Apps BCP (AppAuth)
• RFC8628 - OAuth 2.0 Device Authorization Grant (Device Flow)
• RFC8705 - OAuth 2.0 Mutual TLS Client Authentication and Certificate Bound Access Tokens (MTLS)
• RFC8707 - OAuth 2.0 Resource Indicators
• RFC9101 - OAuth 2.0 JWT-Secured Authorization Request (JAR)
• RFC9126 - OAuth 2.0 Pushed Authorization Requests (PAR)
• RFC9207 - OAuth 2.0 Authorization Server Issuer Identifier in Authorization Response
• RFC9449 - OAuth 2.0 Demonstration of Proof-of-Possession at the Application Layer (DPoP)
• Financial-grade API Security Profile 1.0 - Part 2: Advanced (FAPI 1.0)
• JWT Secured Authorization Response Mode for OAuth 2.0 (JARM)
• OIDC Client Initiated Backchannel Authentication Flow (CIBA)

Supported Access Token formats:

• Opaque
• JSON Web Token (JWT) Profile for OAuth 2.0 Access Tokens

The following draft specifications are implemented by oidc-provider:

• JWT Response for OAuth Token Introspection - draft 10
• Financial-grade API: Client Initiated Backchannel Authentication Profile (FAPI-CIBA) - Implementer's Draft 01

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

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

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.

Тестирование

Устанавливаем, чтобы прокинуть данные наружу:

sudo snap install ngrok

Запускаем (возможно нужно будет применить токен, надо авторизоваться)

ngrok http 3000

Переходи на сайт https://oidcdebugger.com/ и заполняем информацию, тестируем

Хранилище

Провайдер работает только специальной БД для RPC-сервиса, например us-db-ci_purgeable. В указанную БД требуется добавить информацию из schema.sql

Примечание: набор информации для профиля может отличаться, поэтому может потребоваться корректировка функции oidc.sf_verify_user

Контейнер

Сборка

docker build -t akrasnov87/node-oidc-provider:0.0.1 .

Либо вызвать ./build.sh или yarn build:image

Примечание: при выполнении команды yarn build:image версия для контейнера берётся из ./package.json

Запуск

docker run -d --rm --env-file=./.env --name node-oidc-provider -p 3000:3000 akrasnov87/node-oidc-provider:0.0.1

После запуска хост будет доступен по адресу http://localhost:3000/dev/.well-known/openid-configuration

Примечание: виртуальный путь /dev может быть изменёт в файле .conf/dev.conf

Для удобства можно вывести каталог .conf через volumes, чтобы была возможность управлять настройками и данными по клиентским приложениям clients.json

Конфигурация

В папке .conf хранятся конфигурационные данные. Пример настройки для PostgreSQL:

connection_string="host:server;port:5432;user:root;password:secret;database:database-name"
virtual_dir_path="/dev/"
issuer="https://648d-94-232-56-134.ngrok-free.app"
debug=false
port=7001
couchdb_host=""

Получение последних изменений

git remote add upstream https://github.com/panva/node-oidc-provider.git
git pull upstream main

Интеграция с Budibase

Budibase